MainJavadocExampleSource
LuceneSearchSource

com.raritantechnologies.federated.lucene
Class LuceneSearchSource

java.lang.Object
  extended bycom.raritantechnologies.searchApp.SearchSource
      extended bycom.raritantechnologies.federated.lucene.LuceneSearchSource

public class LuceneSearchSource
extends SearchSource

Describes an Lucene SearchSource. See LuceneSearchSourceFactory for XML Configuration information.


Developed by Raritan Technologies Inc..

Author:
Ted Sullivan

Field Summary
 
Fields inherited from class com.raritantechnologies.searchApp.SearchSource
ID_FIELD, IS_FEDERATED, NUMBER_OF_FIELDS, SECURE, SOURCE_NAME, SOURCE_TYPE, TITLE_FIELD, URL_FIELD
 
Constructor Summary
LuceneSearchSource()
           
 
Method Summary
 voidaddExactMatchField(java.lang.String exactMatchField)
           
 voidaddFreeTextField(java.lang.String freeTextField)
           
 java.lang.StringgetAbstractField(java.lang.String luceneField)
           
 QuerygetLuceneQuery(ISearchFieldMap searchMap, OrderedMap inputParameters)
           
static QuerygetLuceneQuery(ISearchFieldMap searchMap, OrderedMap inputParameters, java.util.Map luceneSearchFields, java.util.Set freeTextFields, java.util.Set exactMatchFields, boolean caseSensitive, boolean blankQueryReturnsAll, boolean useAnd, java.lang.String wildcardField)
           
 SortgetLuceneSort(ISearchFieldMap searchMap, OrderedMap inputParameters)
           
static SortgetLuceneSort(ISearchFieldMap searchMap, OrderedMap inputParameters, java.util.Map luceneSearchFields)
           
 IQueryProcessorgetQueryProcessor()
          returns the type of QueryProcessor that can access this SearchSource.
 voidsetBlankQueryReturnsAll(boolean blankQueryReturnsAll)
           
 voidsetCaseSensitive(boolean caseSensitive)
           
 voidsetFreeTextFieldOperator(java.lang.String freeTextFieldOperator)
           
 voidsetIndexDir(java.lang.String indexDir)
           
 voidsetLuceneSearchFields(java.util.Map fields)
           
 voidsetWildcardField(java.lang.String wildcardField)
           
 
Methods inherited from class com.raritantechnologies.searchApp.SearchSource
addFieldFormatter, addSearchField, addSourceAttributes, addStaticField, addStaticFields, addUserSearchField, canAccess, canConsolidateSources, consolidateSources, delSearchField, formatResult, formatResult, formatResultField, formatResultField, formatResults, formatResults, getAccessableFields, getAttributes, getBasePath, getConfigPath, getDisplayName, getFieldFormatters, getIDField, getName, getProperty, getSearchField, getSearchFieldID, getSearchFields, getSearchFields, getSecondarySortSpec, getSecurityManager, getSecurityManagerName, getSecurityModel, getSortSpec, getSourceCredentials, getSourcePropertyNames, getTitleField, getType, getURLField, getUserSearchFields, isMultiThreaded, setConfigPath, setDisplayName, setIDField, setMultiThreaded, setName, setSecurityManagerName, setSecurityModel, setSortMap, setSourcePropertyInfoSource, setTitleField, setType, setURLField, shouldFormatResults, supportsBackgroundSort
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LuceneSearchSource

public LuceneSearchSource()
Method Detail

getQueryProcessor

public IQueryProcessor getQueryProcessor()
Description copied from class: SearchSource
returns the type of QueryProcessor that can access this SearchSource.

Specified by:
getQueryProcessor in class SearchSource

getLuceneQuery

public Query getLuceneQuery(ISearchFieldMap searchMap,
                            OrderedMap inputParameters)

getLuceneQuery

public static Query getLuceneQuery(ISearchFieldMap searchMap,
                                   OrderedMap inputParameters,
                                   java.util.Map luceneSearchFields,
                                   java.util.Set freeTextFields,
                                   java.util.Set exactMatchFields,
                                   boolean caseSensitive,
                                   boolean blankQueryReturnsAll,
                                   boolean useAnd,
                                   java.lang.String wildcardField)

getLuceneSort

public Sort getLuceneSort(ISearchFieldMap searchMap,
                          OrderedMap inputParameters)

getLuceneSort

public static Sort getLuceneSort(ISearchFieldMap searchMap,
                                 OrderedMap inputParameters,
                                 java.util.Map luceneSearchFields)

getAbstractField

public java.lang.String getAbstractField(java.lang.String luceneField)

setIndexDir

public void setIndexDir(java.lang.String indexDir)

setLuceneSearchFields

public void setLuceneSearchFields(java.util.Map fields)

setWildcardField

public void setWildcardField(java.lang.String wildcardField)

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

addFreeTextField

public void addFreeTextField(java.lang.String freeTextField)

addExactMatchField

public void addExactMatchField(java.lang.String exactMatchField)

setBlankQueryReturnsAll

public void setBlankQueryReturnsAll(boolean blankQueryReturnsAll)

setFreeTextFieldOperator

public void setFreeTextFieldOperator(java.lang.String freeTextFieldOperator)