MainJavadocSource
ParametricSearchSource

com.raritantechnologies.verity.parametric
Class ParametricSearchSource

java.lang.Object
  extended bycom.raritantechnologies.searchApp.SearchSource
      extended bycom.raritantechnologies.verity.VeritySearchSource
          extended bycom.raritantechnologies.verity.parametric.ParametricSearchSource
All Implemented Interfaces:
java.io.Serializable

public class ParametricSearchSource
extends VeritySearchSource
implements java.io.Serializable

ParametricSearchSource - organizes the Verity Parametric Indexes (PIs) and Collections to be used for an integrated parametric search. Constructed from an IParametricSourceSpec.

XML Configuration Template:
 <SourceType 
        name="[Parametric Source Name]" 
        type="ParametricSearchSource" 
        displayName="[Source Name displayed to User]"
        sourceFactoryClass="com.raritantechnologies.verity.parametric.ParametricSearchSourceFactory" 
        queryProcessor="com.raritantechnologies.verity.parametric.SortingParametricQueryProcessor" >

    <PIConfig
       PI="[PI Alias on K2 server]" 
       hostPortString="[K2 server hostport]" 
       collectionFields="[comma separated list of collection field aliases]" 
       DidYouMeanCollection="[colon-separated list of collections to use for Did You Mean lookups]" 
       selectFields="[comma separated list of select (dropdown) fields]"
       defaultSortField="[default sorting field]"
       taxFields="[comma separated list of taxonomy fields]" 
       maxDoc = "0"
       numPerPage = "10"
       searchCaseSensitive="true/false"  
       browseClearsSearch="true/false"   
       >

    <QueryParser class="[queryParser class]" >
       <!-- parameters needed by QueryParser -->
    </QueryParser>

    <QueryCooker class="[queryCooker class]" >
       <!-- parameters needed by QueryCooker -->
    </QueryCooker>

    <SecurityModel>
      <search>[public/restricted]
      <fullText>[public/restricted]
    </SecurityModel>

   </SourceType>
 

Developed by Raritan Technologies .

Author:
Ted Sullivan
See Also:
Serialized Form

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
ParametricSearchSource()
           
ParametricSearchSource(java.lang.String sourceName)
           
 
Method Summary
static SearchSourcecreateSearchSource(java.lang.String sourceName, IParametricSourceSpec pss)
           
 java.lang.String[]getAllFields()
           
 booleangetClearQueryOnBrowsePolicy()
           
 java.lang.String[]getCollectionFields()
           
 java.lang.StringgetDefaultSortField()
           
 java.lang.StringgetDidYouMeanCollection()
           
 java.lang.StringgetHostPortString()
           
 java.lang.StringgetK2ServerSpec()
           
 intgetMaxDoc()
           
 intgetNumPerPage()
           
 java.lang.StringgetPI()
           
 java.lang.ObjectgetProperty(java.lang.String property)
          returns a Source Property.
 IQueryProcessorgetQueryProcessor()
          returns the type of QueryProcessor that can access this SearchSource.
 java.lang.String[]getSelectFields()
           
 java.lang.String[]getSourcePropertyNames()
          Returns a list of Source type specific property names.
 java.lang.String[]getTaxonomyFields()
           
 booleanhaveBrowseField(ServletRequest request)
           
 booleansearchCaseSensitive()
           
 voidsetClearQueryOnBrowsePolicy(boolean clearQueryOnBrowse)
           
 voidsetCollectionFields(java.lang.String collFieldList)
           
 voidsetCollectionFields(java.lang.String[] collectionFields)
           
 voidsetDefaultSortField(java.lang.String defaultSortField)
           
 voidsetDidYouMeanCollection(java.lang.String collection)
           
 voidsetHostPortString(java.lang.String hostPortString)
           
 voidsetMaxDoc(int maxDoc)
           
 voidsetNumPerPage(int numPerPage)
           
 voidsetPI(java.lang.String PI)
           
 voidsetQueryProcessorClass(java.lang.String queryProcessorClass)
           
 voidsetSearchCaseSensitive(boolean caseSensitive)
           
 voidsetSelectFields(java.lang.String selectFields)
           
 voidsetSelectFields(java.lang.String[] selectFields)
           
 voidsetTaxonomyFields(java.lang.String taxFieldList)
           
 voidsetTaxonomyFields(java.lang.String[] taxFields)
           
 java.lang.StringtoString()
           
 
Methods inherited from class com.raritantechnologies.verity.VeritySearchSource
formatResult, formatResult, formatResults, formatResults, getBlankQueryReturnsAll, getCharMap, getCollectionNames, getCollectionNamesStr, getDefaultSortSpec, getDisplayFields, getMaxDocCount, getQueryCooker, getQueryParser, getSearchField, getSecurityModel, getServerHost, getServerPort, getZoneCollectionTypeField, getZoneIDField, getZoneNameField, getZonePollInterval, getZoneSearchField, getZoneSource, getZoneSourceQuery, getZoneTypeField, hasCollection, isCaseSensitive, isExternalZoneSource, setBlankQueryReturnsAll, setCaseSensitiveSearch, setCharMap, setCollectionNames, setCollectionSecurityModel, setDefaultSortSpec, setDisplayFields, setExternalZoneSource, setQueryCookerElement, setQueryParserElement, setServerHost, setServerPort, setZoneCollectionTypeField, setZoneIDField, setZoneNameField, setZonePollInterval, setZoneSearchField, setZoneSource, setZoneSourceQuery, setZoneTypeField, zonePoll, zonePollCheck
 
Methods inherited from class com.raritantechnologies.searchApp.SearchSource
addFieldFormatter, addSearchField, addSourceAttributes, addStaticField, addStaticFields, addUserSearchField, canAccess, canConsolidateSources, consolidateSources, delSearchField, formatResultField, formatResultField, getAccessableFields, getAttributes, getBasePath, getConfigPath, getDisplayName, getFieldFormatters, getIDField, getName, getSearchFieldID, getSearchFields, getSearchFields, getSecondarySortSpec, getSecurityManager, getSecurityManagerName, getSecurityModel, getSortSpec, getSourceCredentials, 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, wait, wait, wait
 

Constructor Detail

ParametricSearchSource

public ParametricSearchSource()

ParametricSearchSource

public ParametricSearchSource(java.lang.String sourceName)
Method Detail

createSearchSource

public static SearchSource createSearchSource(java.lang.String sourceName,
                                              IParametricSourceSpec pss)

getQueryProcessor

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

Overrides:
getQueryProcessor in class VeritySearchSource

setQueryProcessorClass

public void setQueryProcessorClass(java.lang.String queryProcessorClass)

setPI

public void setPI(java.lang.String PI)

getPI

public java.lang.String getPI()

setHostPortString

public void setHostPortString(java.lang.String hostPortString)

getHostPortString

public java.lang.String getHostPortString()

getK2ServerSpec

public java.lang.String getK2ServerSpec()
Overrides:
getK2ServerSpec in class VeritySearchSource

setCollectionFields

public void setCollectionFields(java.lang.String[] collectionFields)

setCollectionFields

public void setCollectionFields(java.lang.String collFieldList)

getCollectionFields

public java.lang.String[] getCollectionFields()

setDidYouMeanCollection

public void setDidYouMeanCollection(java.lang.String collection)

getDidYouMeanCollection

public java.lang.String getDidYouMeanCollection()

setSelectFields

public void setSelectFields(java.lang.String[] selectFields)

setSelectFields

public void setSelectFields(java.lang.String selectFields)

getSelectFields

public java.lang.String[] getSelectFields()

setTaxonomyFields

public void setTaxonomyFields(java.lang.String[] taxFields)

setTaxonomyFields

public void setTaxonomyFields(java.lang.String taxFieldList)

getTaxonomyFields

public java.lang.String[] getTaxonomyFields()

getAllFields

public java.lang.String[] getAllFields()

setMaxDoc

public void setMaxDoc(int maxDoc)

getMaxDoc

public int getMaxDoc()

setNumPerPage

public void setNumPerPage(int numPerPage)

getNumPerPage

public int getNumPerPage()

setDefaultSortField

public void setDefaultSortField(java.lang.String defaultSortField)

getDefaultSortField

public java.lang.String getDefaultSortField()

getSourcePropertyNames

public java.lang.String[] getSourcePropertyNames()
Description copied from class: SearchSource
Returns a list of Source type specific property names.

Overrides:
getSourcePropertyNames in class SearchSource

getProperty

public java.lang.Object getProperty(java.lang.String property)
Description copied from class: SearchSource
returns a Source Property. The standard pattern is to return a String or Object if a property has a single value and a String or Object Array if the property has multiple values.

Overrides:
getProperty in class SearchSource

haveBrowseField

public boolean haveBrowseField(ServletRequest request)

setSearchCaseSensitive

public void setSearchCaseSensitive(boolean caseSensitive)

searchCaseSensitive

public boolean searchCaseSensitive()

setClearQueryOnBrowsePolicy

public void setClearQueryOnBrowsePolicy(boolean clearQueryOnBrowse)

getClearQueryOnBrowsePolicy

public boolean getClearQueryOnBrowsePolicy()

toString

public java.lang.String toString()
Overrides:
toString in class VeritySearchSource