com.raritantechnologies.verity
Class VeritySearchSource

java.lang.Object
  com.raritantechnologies.searchApp.SearchSource
      com.raritantechnologies.verity.VeritySearchSource

Direct Known Subclasses:

DynamicVeritySearchSource, ParametricSearchSource

public class VeritySearchSource

extends SearchSource

Represents a Verity K2 Collection or collections. Adds Verity-specific properties to a Raritan SearchSource.

Attributes:

• QueryCooker class
• K2 Server host
• K2 Server port
• List of collection aliases

Constructed from Configuration XML by VeritySearchSourceFactory.

Developed by Raritan Technologies .

Author:

Ted Sullivan, Glenn Robitaille, Jim Nicholson

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

VeritySearchSource()

Method Summary

void	formatResult(IResult result)
void	formatResult(java.lang.String sessionID, IResult result)
void	formatResults(IResultSet resultSet) Applies all IFieldFormatter(s) registered with this SearchSource to an IResult.
void	formatResults(java.lang.String sessionID, IResultSet resultSet)
boolean	getBlankQueryReturnsAll()
java.lang.String	getCharMap()
java.lang.String[]	getCollectionNames(ILoginInfo userInfo, OrderedMap searchParams)
java.lang.String	getCollectionNamesStr()
java.lang.String	getDefaultSortSpec()
java.lang.String[]	getDisplayFields()
java.lang.String	getK2ServerSpec()
int	getMaxDocCount(int pageSize, int startRec)
IQueryCooker	getQueryCooker()
IQueryParser	getQueryParser()
IQueryProcessor	getQueryProcessor() returns the type of QueryProcessor that can access this SearchSource.
SearchField	getSearchField(java.lang.String fieldID) Overrides SearchSource.getSearchField( ) - Verity search fields are not case sensitive
SecurityModel	getSecurityModel(java.lang.String collectionName)
java.lang.String	getServerHost()
java.lang.String	getServerPort()
java.lang.String	getZoneCollectionTypeField()
java.lang.String	getZoneIDField()
java.lang.String	getZoneNameField()
int	getZonePollInterval()
java.lang.String	getZoneSearchField()
java.lang.String	getZoneSource()
OrderedMap	getZoneSourceQuery()
java.lang.String	getZoneTypeField()
boolean	hasCollection(java.lang.String collectionName)
boolean	isCaseSensitive()
boolean	isExternalZoneSource()
void	setBlankQueryReturnsAll(boolean blankQueryReturnsAll)
void	setCaseSensitiveSearch(boolean caseSensitive)
void	setCharMap(java.lang.String charMap)
void	setCollectionNames(java.lang.String[] collectionNames)
void	setCollectionSecurityModel(java.lang.String collectionName, SecurityModel securityModel)
void	setDefaultSortSpec(java.lang.String defaultSortSpec)
void	setDisplayFields(java.lang.String[] displayFields)
void	setExternalZoneSource(boolean externalZoneSource)
void	setQueryCookerElement(org.w3c.dom.Element cookerEl)
void	setQueryParserElement(org.w3c.dom.Element parserEl)
void	setServerHost(java.lang.String sHost) set VeritySearchSource serverHost property
void	setServerPort(java.lang.String sPort)
void	setZoneCollectionTypeField(java.lang.String zoneCollectionTypeField)
void	setZoneIDField(java.lang.String zoneIDField)
void	setZoneNameField(java.lang.String zoneNameField)
void	setZonePollInterval(int zonePollInterval)
void	setZoneSearchField(java.lang.String zoneSearchNameField)
void	setZoneSource(java.lang.String zoneSource)
void	setZoneSourceQuery(OrderedMap zoneSourceQuery)
void	setZoneTypeField(java.lang.String zoneTypeField)
java.lang.String	toString()
protected void	zonePoll()
boolean	zonePollCheck() Returns a boolean indicating whether a poll operation is required.

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, getProperty, 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, wait, wait, wait

Constructor Detail

VeritySearchSource

public VeritySearchSource()

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

setQueryCookerElement

public void setQueryCookerElement(org.w3c.dom.Element cookerEl)

getQueryCooker

public IQueryCooker getQueryCooker()

setQueryParserElement

public void setQueryParserElement(org.w3c.dom.Element parserEl)

getQueryParser

public IQueryParser getQueryParser()

formatResults

public void formatResults(IResultSet resultSet)

Description copied from class: SearchSource

Applies all IFieldFormatter(s) registered with this SearchSource to an IResult. Generally used to convert source-specific format to common or normalized formats or to correct data errors or anomalies.

Overrides:

formatResults in class SearchSource

formatResults

public void formatResults(java.lang.String sessionID,
                          IResultSet resultSet)

Overrides:

formatResults in class SearchSource

formatResult

public void formatResult(IResult result)

Overrides:

formatResult in class SearchSource

formatResult

public void formatResult(java.lang.String sessionID,
                         IResult result)

Overrides:

formatResult in class SearchSource

setServerHost

public void setServerHost(java.lang.String sHost)

set VeritySearchSource serverHost property

getServerHost

public java.lang.String getServerHost()

setServerPort

public void setServerPort(java.lang.String sPort)

getServerPort

public java.lang.String getServerPort()

getK2ServerSpec

public java.lang.String getK2ServerSpec()

setCollectionNames

public void setCollectionNames(java.lang.String[] collectionNames)

getCollectionNames

public java.lang.String[] getCollectionNames(ILoginInfo userInfo,
                                             OrderedMap searchParams)

hasCollection

public boolean hasCollection(java.lang.String collectionName)

setCollectionSecurityModel

public void setCollectionSecurityModel(java.lang.String collectionName,
                                       SecurityModel securityModel)

getSecurityModel

public SecurityModel getSecurityModel(java.lang.String collectionName)

toString

public java.lang.String toString()

getCollectionNamesStr

public java.lang.String getCollectionNamesStr()

getSearchField

public SearchField getSearchField(java.lang.String fieldID)

Overrides SearchSource.getSearchField( ) - Verity search fields are not case sensitive

Overrides:

getSearchField in class SearchSource

getMaxDocCount

public int getMaxDocCount(int pageSize,
                          int startRec)

setCharMap

public void setCharMap(java.lang.String charMap)

getCharMap

public java.lang.String getCharMap()

setDefaultSortSpec

public void setDefaultSortSpec(java.lang.String defaultSortSpec)

getDefaultSortSpec

public java.lang.String getDefaultSortSpec()

setDisplayFields

public void setDisplayFields(java.lang.String[] displayFields)

getDisplayFields

public java.lang.String[] getDisplayFields()

setBlankQueryReturnsAll

public void setBlankQueryReturnsAll(boolean blankQueryReturnsAll)

getBlankQueryReturnsAll

public boolean getBlankQueryReturnsAll()

setCaseSensitiveSearch

public void setCaseSensitiveSearch(boolean caseSensitive)

isCaseSensitive

public boolean isCaseSensitive()

getZonePollInterval

public int getZonePollInterval()

Returns:

Returns the zonePollInterval.

setZonePollInterval

public void setZonePollInterval(int zonePollInterval)

Parameters:

zonePollInterval - The zonePollInterval to set.

getZoneSource

public java.lang.String getZoneSource()

Returns:

Returns the zoneSource.

setZoneSource

public void setZoneSource(java.lang.String zoneSource)

Parameters:

zoneSource - The zoneSource to set.

getZoneSourceQuery

public OrderedMap getZoneSourceQuery()

Returns:

Returns the zoneSourceQuery.

setZoneSourceQuery

public void setZoneSourceQuery(OrderedMap zoneSourceQuery)

Parameters:

zoneSourceQuery - The zoneSourceQuery to set.

getZoneNameField

public java.lang.String getZoneNameField()

Returns:

Returns the zoneNameField.

setZoneNameField

public void setZoneNameField(java.lang.String zoneNameField)

Parameters:

zoneNameField - The zoneNameField to set.

getZoneTypeField

public java.lang.String getZoneTypeField()

Returns:

Returns the zoneTypeField.

setZoneTypeField

public void setZoneTypeField(java.lang.String zoneTypeField)

Parameters:

zoneTypeField - The zoneTypeField to set.

getZoneCollectionTypeField

public java.lang.String getZoneCollectionTypeField()

setZoneCollectionTypeField

public void setZoneCollectionTypeField(java.lang.String zoneCollectionTypeField)

Parameters:

zoneCollectionTypeField - The zoneCollectionTypeField to set.

getZoneIDField

public java.lang.String getZoneIDField()

Returns:

Returns the zoneIDField.

setZoneIDField

public void setZoneIDField(java.lang.String zoneIDField)

Parameters:

zoneIDField - The zoneIDField to set.

getZoneSearchField

public java.lang.String getZoneSearchField()

Returns:

Returns the zoneSearchField.

setZoneSearchField

public void setZoneSearchField(java.lang.String zoneSearchNameField)

isExternalZoneSource

public boolean isExternalZoneSource()

Returns:

Returns true if this VeritySearchSource is obtaining field information by reading another search source.

setExternalZoneSource

public void setExternalZoneSource(boolean externalZoneSource)

Parameters:

externalZoneSource - The externalZoneSource to set.

zonePollCheck

public boolean zonePollCheck()

Returns a boolean indicating whether a poll operation is required. This will be true if one of the following criteria are met: 1) this search source has never polled for zones. 2) zonePollInterval minutes have occured since the last poll was performed.

Returns:

zonePoll

protected void zonePoll()