com.sapportals.wcm.service.indexmanagement.retrieval.search
Interface ISearchIndex

[contained in: com.sap.km.cm.service.par - km.shared.service.indexmanagement_api.jar]

All Superinterfaces:

IIndex

public interface ISearchIndex

extends IIndex

Index for search and retrieval operations.

Field Summary

static java.lang.String	PROP_NAME_EXPERT Name of the resource property that identifies the responsible for the documents content
static java.lang.String	PROP_NAME_PATH Name of the resource path property when restricting queries by a path.

Method Summary

java.util.Map	doGeneric(java.lang.String function, java.util.Map parameters) this method enables an index service to perform classification actions that are not reflected by the interface.
ISearchResultList	executeQuery(IQueryEntryList queryEntryList, IResourceContext context, int maxResults) Executes the search
ISearchResultList	executeQuery(IQueryEntryList queryEntryList, IResourceContext context, int maxResults, ICollection searchFromHere) Executes the search
ISearchSession	executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context) Executes the search
ISearchSession	executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, ICollection searchFromHere) Executes the search
java.util.Collection	getDocumentAbstracts(IResourceList resourceDocuments) gets the abstract of documents
java.util.Collection	getDocumentFeatures(IResourceList resourceDocuments, int maxFeatures) gets the features of documents
IQueryEntry	getNewQueryEntry()
IQueryEntryList	getNewQueryEntryList()
ISearchIndexCollection	getNewSearchIndexCollection()
java.lang.String	getQueryAsString() Deprecated. as of NW04.
void	loadQuery(java.util.Properties props) Deprecated. as of NW04.
ISearchResultList	searchSimilarDocuments(IResourceList searchDocuments, int maxResults) searches similar documents
ISearchSession	searchSimilarDocumentsWithSession(IResourceList searchDocuments) searches similar documents
java.util.Collection	searchSimilarTerms(java.util.Collection terms, int maxTerms) searches similar terms to a collection of terms

Methods inherited from interface com.sapportals.wcm.service.indexmanagement.IIndex

addFolderUri, checkProperties, clear, createIndexOnServer, deindexDocument, deindexDocument, deindexDocument, deindexDocuments, deindexDocuments, deindexDocuments, delete, delete, deleteOnServer, deltaReindex, generate, generate, getCrawlerProfileId, getFolderUris, getIndexedProperties, getIndexFolderForDocument, getIndexFolders, getIndexGroup, getIndexId, getIndexingState, getIndexName, getLanguagesOfIndexedDocuments, getProperties, getResourceInfo, getRID, getSchedulerTimeTable, getServiceId, getServiceTypes, getServiceTypes, getSupportedOptions, getWhatToIndexString, indexDocument, indexDocument, indexDocuments, indexDocuments, indexInternalLinks, init, isActive, reduceNumberOfCrawler, reindex, reindex, removeAllFolderUris, removeFolderUri, setActive, setActiveDuringStartup, setCrawlerProfileId, setInactiveIndexHasChanged, setIndexGroup, setIndexingState, setIndexName, setProperties, setSchedulerTimeTable, setStateAndNumberOfCrawler, setWhatToIndex, typeShouldBeIndexed

Field Detail

PROP_NAME_EXPERT

public static final java.lang.String PROP_NAME_EXPERT

Name of the resource property that identifies the responsible for the documents content

PROP_NAME_PATH

public static final java.lang.String PROP_NAME_PATH

Name of the resource path property when restricting queries by a path. For searching documents in all sub folders of the path, add a star(*) behind the path.

Method Detail

executeQuery

public ISearchResultList executeQuery(IQueryEntryList queryEntryList,
                                      IResourceContext context,
                                      int maxResults)
                               throws WcmException

Executes the search

Parameters:

queryEntryList - - list of query entries for the search

context - - user context

maxResults - - maximum number of search results

Returns:

search result list with the found documents

executeQuery

public ISearchResultList executeQuery(IQueryEntryList queryEntryList,
                                      IResourceContext context,
                                      int maxResults,
                                      ICollection searchFromHere)
                               throws WcmException

Executes the search

Parameters:

queryEntryList - - list of query entries for the search

context - - user context

maxResults - - maximum number of search results

searchFromHere - - folder from where search results must be direct or indirect children

Returns:

search result list with the found documents

executeQueryWithSession

public ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList,
                                              IResourceContext context)
                                       throws WcmException

Executes the search

Parameters:

queryEntryList - - list of query entries for the search

context - - user context

Returns:

search session result

executeQueryWithSession

public ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList,
                                              IResourceContext context,
                                              ICollection searchFromHere)
                                       throws WcmException

Executes the search

Parameters:

queryEntryList - - list of query entries for the search

context - - user context

searchFromHere - - folder from where search results must be direct or indirect children

Returns:

search session result

searchSimilarDocuments

public ISearchResultList searchSimilarDocuments(IResourceList searchDocuments,
                                                int maxResults)
                                         throws WcmException

searches similar documents

Parameters:

searchDocuments - - list of documents for that similar documents have to be found

maxResults - - maximum number of similar documents

Returns:

search result list with the found similar documents

searchSimilarDocumentsWithSession

public ISearchSession searchSimilarDocumentsWithSession(IResourceList searchDocuments)
                                                 throws WcmException

searches similar documents

Parameters:

searchDocuments - - list of documents for that similar documents have to be found

session - - search session for paging

Returns:

search session result

searchSimilarTerms

public java.util.Collection searchSimilarTerms(java.util.Collection terms,
                                               int maxTerms)
                                        throws WcmException

searches similar terms to a collection of terms

Parameters:

terms - Collection of terms (Strings)

maxTerms - - maximum number of returned similar terms

Returns:

Collection of ITextminingTerm

getDocumentFeatures

public java.util.Collection getDocumentFeatures(IResourceList resourceDocuments,
                                                int maxFeatures)
                                         throws WcmException

gets the features of documents

Parameters:

resourceDocuments - resource list of documents for that features have to be returned

maxFeatures - - maximum number of returned document features

Returns:

Collection of ITextminingResult

getDocumentAbstracts

public java.util.Collection getDocumentAbstracts(IResourceList resourceDocuments)
                                          throws WcmException

gets the abstract of documents

Parameters:

resourceDocuments - resource list of documents for that abstracts have to be returned

Returns:

Collection of ITextminingResult

getQueryAsString

public java.lang.String getQueryAsString()
                                  throws WcmException

Deprecated. as of NW04.

Returns the momentary query as a string, ready to be saved as a .properties file

loadQuery

public void loadQuery(java.util.Properties props)
               throws WcmException

Deprecated. as of NW04.

loads a complete Query from the given properites object.

getNewQueryEntry

public IQueryEntry getNewQueryEntry()

Returns:

a new query entry instance

getNewQueryEntryList

public IQueryEntryList getNewQueryEntryList()

Returns:

a new query entry list instance

getNewSearchIndexCollection

public ISearchIndexCollection getNewSearchIndexCollection()
                                                   throws ResourceException

Returns:

new search index collection to search in more than one index

doGeneric

public java.util.Map doGeneric(java.lang.String function,
                               java.util.Map parameters)
                        throws WcmException

this method enables an index service to perform classification actions that are not reflected by the interface.

Parameters:

function - - name of the function that has to be performed

function - parameters (name, value pairs stored as objects)

Returns:

map with results of the executed function