com.raritantechnologies.federated.verity.webServices
Class VWebServiceCurrentResultsSource

java.lang.Object
  extended bycom.raritantechnologies.searchApp.SearchSource
      extended bycom.raritantechnologies.quickstart.CurrentResultsSource
          extended bycom.raritantechnologies.federated.verity.webServices.VWebServiceCurrentResultsSource
All Implemented Interfaces:
IQueryProcessor, IXMLSearchSourceFactory, java.io.Serializable

public class VWebServiceCurrentResultsSource
extends CurrentResultsSource
implements java.io.Serializable

Converts cuurent Verity/Autonomy Federated ResultSet into a RTI IResultSet.

XML Configuration Template:
  <SourceType name="currentSource" type="CurrentResultsSource"
            sourceFactoryClass="com.raritantechnologies.federated.verity.VerityCurrentResultsSource" 
            queryProcessor="com.raritantechnologies.federated.verity.VerityCurrentResultsSource"
            searchWithin="true(default)|false"
            blankQueryReturnsAll="true"
            sessionIDParam="[ query parameter that contains session ID]" >

    <!-- Map of Verity Federator field names (including standard fields: title,url,summary and source) to RTI field names -->
    <FieldMap textField="[ name of RTI field that gets Federator text field ]" >
      <Field ID="[ RTI Field ID ]" verityField="[ verity federator field ]" />

      <Field ID="[ RTI Field ID ]" verityField="[ verity federator field ]" >
        <!-- Optional String filter to apply to value before inserting into the Raritan Result -->
        <StringFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter ]" >

        </StringFilter>

      </Field>

      <Field ID="[ RTI Field ID ]" verityField="[ verity federatr field ]" multiple="[ true ]" delimiter="[ delimiter for value ]"  >

      </Field>

    </FieldMap>

    <!-- Optional result matcher filter to select results for 
    <ResultMatcher class="[ class of com.raritantechnologies.searchApp.IResultMatcher ]" >

    </ResultMatcher>

  </SourceType>
 

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.raritantechnologies.quickstart.CurrentResultsSource
cachedResultsName
 
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
VWebServiceCurrentResultsSource()
           
 
Method Summary
 SearchSource[] createSearchSources(org.w3c.dom.Element sourceElem, ISearchFieldMapFactory factory)
           
protected  IResultSet getCurrentResults(java.lang.String sessionID)
           
 IQueryProcessor getQueryProcessor()
          returns the type of QueryProcessor that can access this SearchSource.
 void initializeSource(org.w3c.dom.Element sourceElem, SearchSource source)
           
 
Methods inherited from class com.raritantechnologies.quickstart.CurrentResultsSource
executeQuery, filterResults, getName, setCachedResultName, setName, setSearchWithin
 
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, getProperty, getSearchField, getSearchFieldID, getSearchFields, getSearchFields, getSecondarySortSpec, getSecurityManager, getSecurityManagerName, getSecurityModel, getSortSpec, getSourceCredentials, getSourcePropertyNames, getTitleField, getType, getURLField, getUserSearchFields, isMultiThreaded, setConfigPath, setDisplayName, setIDField, setMultiThreaded, 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

VWebServiceCurrentResultsSource

public VWebServiceCurrentResultsSource()
Method Detail

getQueryProcessor

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

Overrides:
getQueryProcessor in class CurrentResultsSource

getCurrentResults

protected IResultSet getCurrentResults(java.lang.String sessionID)
Overrides:
getCurrentResults in class CurrentResultsSource

createSearchSources

public SearchSource[] createSearchSources(org.w3c.dom.Element sourceElem,
                                          ISearchFieldMapFactory factory)
Specified by:
createSearchSources in interface IXMLSearchSourceFactory
Overrides:
createSearchSources in class CurrentResultsSource

initializeSource

public void initializeSource(org.w3c.dom.Element sourceElem,
                             SearchSource source)
Specified by:
initializeSource in interface IXMLSearchSourceFactory
Overrides:
initializeSource in class CurrentResultsSource