ParametricSearchSource

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.raritantechnologies.verity.parametric
Class ParametricSearchSource

java.lang.Object
  com.raritantechnologies.searchApp.SearchSource
      com.raritantechnologies.verity.VeritySearchSource
          com.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"  <!-- default is false -->
       browseClearsSearch="true/false"   <!-- default is 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 SearchSource`	`createSearchSource(java.lang.String sourceName, IParametricSourceSpec pss)`
`java.lang.String[]`	`getAllFields()`
`boolean`	`getClearQueryOnBrowsePolicy()`
`java.lang.String[]`	`getCollectionFields()`
`java.lang.String`	`getDefaultSortField()`
`java.lang.String`	`getDidYouMeanCollection()`
`java.lang.String`	`getHostPortString()`
`java.lang.String`	`getK2ServerSpec()`
`int`	`getMaxDoc()`
`int`	`getNumPerPage()`
`java.lang.String`	`getPI()`
`java.lang.Object`	`getProperty(java.lang.String property)` returns a Source Property.
`IQueryProcessor`	`getQueryProcessor()` 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()`
`boolean`	`haveBrowseField(ServletRequest request)`
`boolean`	`searchCaseSensitive()`
`void`	`setClearQueryOnBrowsePolicy(boolean clearQueryOnBrowse)`
`void`	`setCollectionFields(java.lang.String collFieldList)`
`void`	`setCollectionFields(java.lang.String[] collectionFields)`
`void`	`setDefaultSortField(java.lang.String defaultSortField)`
`void`	`setDidYouMeanCollection(java.lang.String collection)`
`void`	`setHostPortString(java.lang.String hostPortString)`
`void`	`setMaxDoc(int maxDoc)`
`void`	`setNumPerPage(int numPerPage)`
`void`	`setPI(java.lang.String PI)`
`void`	`setQueryProcessorClass(java.lang.String queryProcessorClass)`
`void`	`setSearchCaseSensitive(boolean caseSensitive)`
`void`	`setSelectFields(java.lang.String selectFields)`
`void`	`setSelectFields(java.lang.String[] selectFields)`
`void`	`setTaxonomyFields(java.lang.String taxFieldList)`
`void`	`setTaxonomyFields(java.lang.String[] taxFields)`
`java.lang.String`	`toString()`

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