public interface IFederatedSearch
To get a IFederatedSearch
instance follow this example:
IIndexService indexService = (IIndexService)ResourceFactory.getInstance() .getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE); IFederatedSearch federatedSearch = (IFederatedSearch)indexService .getObjectInstance(IWcmIndexConst.FEDERATED_SEARCH_INSTANCE);
setSearchWithoutCache(boolean)
Modifier and Type | Method and Description |
---|---|
ISearchResultList |
getEmptySearchResultList()
Empty search result list where search results from other
search result lists can be added to.
|
int |
getMaxSnippetWords()
Sets the number of snippet words returned for documents in a search.
|
IQueryEntry |
getNewQueryEntry()
Initial query entry as part of a search query.
|
IQueryEntryList |
getNewQueryEntryList()
Empty list for adding query entries when creating a search query.
|
List |
getSearchIndexes()
Deprecated.
as of NW04. Use
getSearchIndexes(IResourceContext) |
List |
getSearchIndexes(IResourceContext context)
Gets all indexes that contain one ore more repositories
where the index is a search index.
|
ISearchSession |
restoreFederatedSearchSession() |
ISearchResultList |
search(IQueryEntryList queryEntryList,
ICollection searchFromHere,
int maxResults,
IResourceContext context)
Performs a search within a list of search indexes restricted by a path.
|
ISearchResultList |
search(IQueryEntryList queryEntryList,
List indexes,
int maxResults,
IResourceContext context)
Performs a search within a list of search indexes.
|
ISearchResultList |
searchSimilarDocuments(List indexes,
IResourceList documents,
int maxResults)
Performs a federated similar document search.
|
ISearchSession |
searchSimilarDocumentsWithSession(List indexes,
IResourceList documents)
Performs a federated similar document search.
|
ISearchSession |
searchSimilarDocumentsWithSession(List indexes,
IResourceList documents,
ISortPropertyName sortProperty)
Performs a federated similar document search.
|
List |
searchSimilarTerms(List indexes,
Collection terms,
int maxResults)
Searches for terms to a similar to a collection of terms.
|
ISearchSession |
searchWithSession(IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context)
Performs a search within a list of search indexes restricted by a path.
|
ISearchSession |
searchWithSession(IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context,
ISortPropertyName sortProperty)
Performs a search within a list of search indexes restricted by a path.
|
ISearchSession |
searchWithSession(IQueryEntryList queryEntryList,
ICollection searchFromHere,
IResourceContext context,
ISortPropertyName sortProperty,
Set languages)
Performs a search within a list of search indexes restricted by a path.
|
ISearchSession |
searchWithSession(IQueryEntryList queryEntryList,
IRidList searchFromHereList,
IResourceContext context,
ISortPropertyName sortProperty,
Set languages)
Performs a search within a list of search indexes restricted by the paths specified by the list of RIDs
searchFromHereList.
|
ISearchSession |
searchWithSession(IQueryEntryList queryEntryList,
List indexes,
IResourceContext context)
Performs a search within a list of search indexes.
|
ISearchSession |
searchWithSession(IQueryEntryList queryEntryList,
List indexes,
IResourceContext context,
ISortPropertyName sortProperty)
Performs a search within a list of search indexes.
|
ISearchSession |
searchWithSession(IQueryEntryList queryEntryList,
List indexes,
IResourceContext context,
ISortPropertyName sortProperty,
Set languages)
Performs a search within a list of search indexes.
|
ISearchSession |
searchWithSessionFilterIndexes(IQueryEntryList queryEntryList,
IRidList searchFromHereListIn,
IResourceContext context,
ISortPropertyName sortProperty,
Set languages)
Performs a search within a list of search indexes restricted by the paths specified by the list of RIDs
searchFromHereListIn.
|
ISearchSession |
searchWithSessionFilterIndexes(IQueryEntryList queryEntryList,
List indexes,
IResourceContext context,
ISortPropertyName sortProperty,
Set languages)
Performs a search within a list of search indexes.
|
void |
setFetchedProperties(Set propNames)
If supported by the search engine, only these properties are fetched from the server.
|
void |
setMaxSnippetWords(int numOfWords)
Sets the number of snippet words returned for documents in a search.
|
void |
setRequestContentSnippets(boolean b)
Specifies if content snippets should be fetched.
|
void |
setRequestDidYouMean(boolean b)
Specifies if do you mean terms should be fetched.
|
void |
setSearchWithoutCache(boolean b)
If supported by the underlying search services, search caches are disabled if set on true.
|
List getSearchIndexes() throws WcmException
getSearchIndexes(IResourceContext)
IIndex
objectsWcmException
- WcmExceptionList getSearchIndexes(IResourceContext context) throws WcmException
context
- user contextIIndex
objectsWcmException
- WcmExceptionISearchResultList search(IQueryEntryList queryEntryList, List indexes, int maxResults, IResourceContext context) throws WcmException
queryEntryList
- list of query entries for the searchindexes
- list of IIndex
objects that have been chosen for the search.
To get all existing search indexes call the getSearchIndexes
method.maxResults
- maximum number of search resultscontext
- user contextWcmException
- WcmExceptionISearchSession searchWithSession(IQueryEntryList queryEntryList, List indexes, IResourceContext context) throws WcmException
getSearchResults
must be called on that session.
The session concept optimises performance because only for the displayed results resources
must be retrieved from the resource factory.queryEntryList
- list of query entries for the searchindexes
- list of IIndex
objects that have been chosen for the search.
To get all existing search indexes call the getSearchIndexes
method.context
- user contextWcmException
- WcmExceptionISearchSession searchWithSession(IQueryEntryList queryEntryList, List indexes, IResourceContext context, ISortPropertyName sortProperty) throws WcmException
getSearchResults
must be called on that session.
The session concept optimises performance because only for the displayed results resources
must be retrieved from the resource factory.queryEntryList
- list of query entries for the searchindexes
- list of IIndex
objects that have been chosen for the search.
To get all existing search indexes call the getSearchIndexes
method.context
- user contextsortProperty
- property name for sorting the results; if null, the results are
sorted according to their rank valueWcmException
- WcmExceptionISearchSession searchWithSessionFilterIndexes(IQueryEntryList queryEntryList, List indexes, IResourceContext context, ISortPropertyName sortProperty, Set languages) throws WcmException
languages
describes a set
of languages, on which the search is restricted.
To get search results getSearchResults
must be called on that session.
The session concept optimises performance because only for the displayed results resources
must be retrieved from the resource factory.queryEntryList
- list of query entries for the searchindexes
- list of IIndex
objects that have been choosen for the search.
To get all existing search indexes call the getSearchIndexes
method.context
- user contextsortProperty
- property name for sorting the results; if null, the results are
sorted according to their rank valuelanguages
- set of strings, each describing a languageWcmException
- WcmExceptionISearchSession searchWithSession(IQueryEntryList queryEntryList, List indexes, IResourceContext context, ISortPropertyName sortProperty, Set languages) throws WcmException
languages
describes a set
of languages, on which the search is restricted.
To get search results getSearchResults
must be called on that session.
The session concept optimies performance because only for the displayed results resources
must be retrieved from the resource factory.queryEntryList
- list of query entries for the searchindexes
- list of IIndex
objects that have been chosen for the search.
To get all existing search indexes call the getSearchIndexes
method.context
- user contextsortProperty
- property name for sorting the results; if null, the results are
sorted according to their rank valuelanguages
- set of strings, each describing a languageWcmException
- WcmExceptionISearchResultList search(IQueryEntryList queryEntryList, ICollection searchFromHere, int maxResults, IResourceContext context) throws WcmException
queryEntryList
- list of query entries for the searchsearchFromHere
- folder from where search results must be direct or indirect childrenmaxResults
- maximum number of search resultscontext
- user contextWcmException
- WcmExceptionISearchSession searchWithSession(IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context) throws WcmException
getSearchResults
must be called on that session.
The session concept optimises performance because only for the displayed results resources
must be retrieved from the resource factory.queryEntryList
- list of query entries for the searchsearchFromHere
- folder from where search results must be direct or indirect childrencontext
- user contextWcmException
- WcmExceptionISearchSession searchWithSession(IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, ISortPropertyName sortProperty) throws WcmException
getSearchResults
must be called on that session.
The session concept optimises performance because only for the displayed results resources
must be retrieved from the resource factory.queryEntryList
- list of query entries for the searchsearchFromHere
- folder from where search results must be direct or indirect childrencontext
- user contextsortProperty
- property name for sorting the resultsWcmException
- WcmExceptionISearchSession searchWithSession(IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, ISortPropertyName sortProperty, Set languages) throws WcmException
languages
describes a set
of languages, on which the search is restricted. If this parameter is null or empty,
no restriction takes place.
It returns a session object that contains the search results in a raw format.
To get search results getSearchResults
must be called on that session.
The session concept optimises performance because only for the displayed results resources
must be retrieved from the resource factory.queryEntryList
- list of query entries for the searchsearchFromHere
- folder from where search results must be direct or indirect childrencontext
- user contextsortProperty
- property name for sorting the resultslanguages
- set of strings, each describing a languageWcmException
- WcmExceptionISearchSession searchWithSessionFilterIndexes(IQueryEntryList queryEntryList, IRidList searchFromHereListIn, IResourceContext context, ISortPropertyName sortProperty, Set languages) throws WcmException
languages
describes a set
of languages, on which the search is restricted. If this parameter is null or empty,
no restriction takes place.
It returns a session object that contains the search results in a raw format.
To get search results getSearchResults
must be called on that session.
The session concept optimises performance because only for the displayed results resources
must be retrieved from the resource factory. queryEntryList
- list of query entries for the searchsearchFromHereListIn
- folder from where search results must be direct or indirect childrencontext
- user contextsortProperty
- property name for sorting the resultslanguages
- set of strings, each describing a languageWcmException
- WcmExceptionISearchSession searchWithSession(IQueryEntryList queryEntryList, IRidList searchFromHereList, IResourceContext context, ISortPropertyName sortProperty, Set languages) throws WcmException
languages
describes a set
of languages, on which the search is restricted. If this parameter is null or empty,
no restriction takes place.
It returns a session object that contains the search results in a raw format.
To get search results getSearchResults
must be called on that session.
The session concept optimises performance because only for the displayed results resources
must be retrieved from the resource factory.queryEntryList
- list of query entries for the searchsearchFromHereList
- folder from where search results must be direct or indirect childrencontext
- user contextsortProperty
- property name for sorting the resultslanguages
- set of strings, each describing a languageWcmException
- WcmExceptionISearchResultList searchSimilarDocuments(List indexes, IResourceList documents, int maxResults) throws WcmException
indexes
- list of IIndex
objects that have been chosen for the search.
To get all existing search indexes call the getSearchIndexes
method.documents
- list of documents for that similar documents have to be foundmaxResults
- maximum number of search resultsWcmException
- WcmExceptionISearchSession searchSimilarDocumentsWithSession(List indexes, IResourceList documents) throws WcmException
getSearchResults
must be called on that session.
The session concept optimises performance because only for the displayed results resources
must be retrieved from the resource factory.indexes
- is a list of (IIndex)index objects that have been chosen for the search.
To get all existing search indexes call the getSearchIndexes method.documents
- list of documents for that similar documents have to be foundWcmException
- WcmExceptionISearchSession searchSimilarDocumentsWithSession(List indexes, IResourceList documents, ISortPropertyName sortProperty) throws WcmException
getSearchResults
must be called on that session.
The session concept optimises performance because only for the displayed results resources
must be retrieved from the resource factory.indexes
- is a list of (IIndex)index objects that have been chosen for the search.
To get all existing search indexes call the getSearchIndexes method.documents
- list of documents for that similar documents have to be foundsortProperty
- property name for sorting the results; if null, the results are
sorted according to their rank valueWcmException
- WcmExceptionList searchSimilarTerms(List indexes, Collection terms, int maxResults) throws WcmException
indexes
- list of IIndex
objects that have been chosen for the search.
To get all existing search indexes call the getSearchIndexes
method.terms
- collection of terms of type String
maxResults
- maximum number of returned similar termsITextminingTerm
WcmException
- WcmExceptionIQueryEntry getNewQueryEntry()
IQueryEntryList getNewQueryEntryList()
ISearchResultList getEmptySearchResultList()
void setMaxSnippetWords(int numOfWords)
numOfWords
- numOfWordsint getMaxSnippetWords()
void setSearchWithoutCache(boolean b)
b
- bvoid setFetchedProperties(Set propNames)
propNames
- Set of IPropertyNamesvoid setRequestContentSnippets(boolean b)
b
- bvoid setRequestDidYouMean(boolean b)
b
- bISearchSession restoreFederatedSearchSession() throws WcmException
WcmException
- WcmExceptionAccess Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice