com.raritantechnologies.marklogic
Class MarkLogicSearchSource

java.lang.Object
  com.raritantechnologies.searchApp.SearchSource
      com.raritantechnologies.marklogic.MarkLogicSearchSource

public class MarkLogicSearchSource

extends SearchSource

SearchSource that queries a MarkLogic Server.

XML Configuration Template:

   <SourceType name="[ name of source ]" 
                  type="MarkLogicSearchSource" 
                  displayName="[ display name ]" 
                  sourceFactoryClass="com.raritantechnologies.marklogic.MarkLogicSearchSourceFactory" 
                  queryProcessor="com.raritantechnologies.marklogic.MarkLogicQueryProcessor"
                  IDField="[ name of result field to be used as result ID ]"
                  titleField="[ name of result field to be used as result title ]"
                  urlField="[ name of result field to be used as result URL ]"
                  serverURI="[ full MarkLogic server URI ]"
                  serverHost="[ host name of server ]"
                  serverPort="[ port number ]"
                  user="[ admin user name ]"
                  password="[ admin password ]"
                  contentbaseName="[ name of database ]" >

     
     <MarkLogicQueryParser>

     </MarkLogicQueryParser>

     <XMLResultProcessor>

     </XMLResultProcessor>

   </SourceType>
 

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

MarkLogicSearchSource()

Method Summary

IResultSet	convertResponse(ResultSequence resultSequence, java.lang.Integer startRec, java.lang.Integer pageSize, int totalDocs)
java.lang.String	createXQuery(OrderedMap inputParameters, ILoginInfo userInfo, java.lang.Integer startRec, java.lang.Integer pageSize)
Session	getMarkLogicSession(java.lang.Integer queryID)
IQueryProcessor	getQueryProcessor() returns the type of QueryProcessor that can access this SearchSource.
int	getTotalDocs(OrderedMap inputParameters)

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

MarkLogicSearchSource

public MarkLogicSearchSource()

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

getMarkLogicSession

public Session getMarkLogicSession(java.lang.Integer queryID)

createXQuery

public java.lang.String createXQuery(OrderedMap inputParameters,
                                     ILoginInfo userInfo,
                                     java.lang.Integer startRec,
                                     java.lang.Integer pageSize)

getTotalDocs

public int getTotalDocs(OrderedMap inputParameters)

convertResponse

public IResultSet convertResponse(ResultSequence resultSequence,
                                  java.lang.Integer startRec,
                                  java.lang.Integer pageSize,
                                  int totalDocs)