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

Interface ISearchIndexCollection

All Superinterfaces:

Collection, Iterable

All Known Implementing Classes:

AbstractSearchIndexCollection

public interface ISearchIndexCollection
extends Collection

Offers search calls for more than one index.
Changes between major releases 7.0 and 7.X

• Added methods: getDocumentFeatures(IQueryEntryList, int, int) getPropertyDistributionOverview(IQueryEntryList, ICollection, IResourceContext, Collection, IPropertyNameList) getPropertyDistributionOverview(IQueryEntryList, ICollection, IResourceContext, IPropertyNameList) getPropertyDistributionOverview(IQueryEntryList, IRidList, IResourceContext, Set) getPropertyDistributionOverview(IQueryEntryList, IRidList, IResourceContext, IPropertyNameList, Set) getPropertyRanges(IPropertyName, IQueryEntryList, ICollection, IResourceContext, DistributionParameter) getPropertyRanges(IPropertyName, IQueryEntryList, IRidList, IResourceContext, DistributionParameter, Set) getPropertyValues(List, IPropertyName, IQueryEntryList, ICollection, IResourceContext) getPropertyValues(List, IPropertyName, IQueryEntryList, ICollection, IResourceContext, Integer) getPropertyValues(List, IPropertyName, IQueryEntryList, IRidList, IResourceContext, Set) #getPropertyValues(IPropertyName, IQueryEntryList, IRidList, IResourceContext, Integer, Set) getPropertyValues(Map, IPropertyNameList, IQueryEntryList, IRidList, IResourceContext, Set) getPropertyValues(Map, IPropertyNameList, IQueryEntryList, IRidList, IResourceContext, boolean, Set) isSearchWithoutCache() setSearchWithoutCache(boolean)

Field Summary

static int

DEFAULT_INIT_MAX_RAW_RESULTS Search with session: default maximum number of raw results for the initial search The number is increased automatically when the result session requests more raw results.

Method Summary

void	addIndex(IIndex index) Adds an index to the index collection
ISearchResultList	executeQuery(IQueryEntryList queryEntryList, IResourceContext context, int maxResults) Executes the search
ISearchResultList	executeQuery(IQueryEntryList queryEntryList, IResourceContext context, int maxResults, ICollection searchFromHere) Executes the search
ISearchResultList	executeQuery(IQueryEntryList queryEntryList, IResourceContext context, int maxResults, ICollection searchFromHere, Set languages) Executes the search
ISearchSession	executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context) Executes the search
ISearchSession	executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, ICollection searchFromHere) Executes the search
ISearchSession	executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, int initNumberMaxRawResults) Executes the search
ISearchSession	executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, int initNumberMaxRawResults, ICollection searchFromHere) Executes the search
ISearchSession	executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, int initNumberMaxRawResults, ICollection searchFromHere, ISortPropertyName sortProperty) Executes the search
ISearchSession	executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, int initNumberMaxRawResults, ICollection searchFromHere, ISortPropertyName sortProperty, Set languages) Executes the search
ISearchSession	executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, int initNumberMaxRawResults, com.sapportals.wcm.util.uri.IRidList searchFromHereList, ISortPropertyName sortProperty, Set languages) Executes the search
Collection	getDocumentFeatures(IQueryEntryList queryEntryList, int maxNumberOfDocs, int maxFeatures)
Set	getFetchedProperties() Returns the properties which should be fetched for serch results from the search engine (if suported by it).
int	getMaxSnippetWords() Sets the number of snippet words returned for documents in a search.
IQueryEntry	getNewQueryEntry()
IQueryEntryList	getNewQueryEntryList()
IPropertyDistributionList	getPropertyDistributionOverview(IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context) Returns basic information about the distribution of the properties of the indexes, of the SearchIndexCollection only considering the documents fullfilling the search restriction.
IPropertyDistributionList	getPropertyDistributionOverview(IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, Collection indexList) Returns basic information about the distribution of the properties of the indexes, only considering the documents fullfilling the search restriction.
IPropertyDistributionList	getPropertyDistributionOverview(IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, Collection indexList, IPropertyNameList propertyNameList) Returns basic information about the distribution of the properties of the indexes, only considering the documents fullfilling the search restriction.
IPropertyDistributionList	getPropertyDistributionOverview(IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, IPropertyNameList propertyNameList) Returns basic information about the distribution of the properties of the indexes, only considering the documents fullfilling the search restriction.
IPropertyDistributionList	getPropertyDistributionOverview(IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, ISearchIndex index) Returns basic information about the distribution of the properties of an index, only considering the documents fullfilling the search restriction.
IPropertyDistributionList	getPropertyDistributionOverview(IQueryEntryList queryEntryList, com.sapportals.wcm.util.uri.IRidList searchFromHereList, IResourceContext context, IPropertyNameList propNameList, Set languages) Returns basic information about the distribution of the properties of the indexes, of the SearchIndexCollection only considering the documents fullfilling the search restriction.
IPropertyDistributionList	getPropertyDistributionOverview(IQueryEntryList queryEntryList, com.sapportals.wcm.util.uri.IRidList searchFromHereList, IResourceContext context, Set languages) Returns basic information about the distribution of the properties of the indexes, of the SearchIndexCollection only considering the documents fullfilling the search restriction.
IPropertyRangeList	getPropertyRanges(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context) Returns the ranges of the properties of the indexes of the ISearchIndexCollection, only considering the documents fullfilling the search restriction.
IPropertyRangeList	getPropertyRanges(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, Collection indexList) Returns the ranges of the properties of the indexes, only considering the documents fullfilling the search restriction.
IPropertyRangeList	getPropertyRanges(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, DistributionParameter parameters) Returns the ranges of the properties of the indexes of the ISearchIndexCollection, only considering the documents fullfilling the search restriction.
IPropertyRangeList	getPropertyRanges(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, ISearchIndex index) Returns the ranges of the properties of an index, only considering the documents fullfilling the search restriction.
IPropertyRangeList	getPropertyRanges(IPropertyName propertyName, IQueryEntryList queryEntryList, com.sapportals.wcm.util.uri.IRidList searchFromHereList, IResourceContext context, DistributionParameter parameters, Set languages) Returns the ranges of the properties of the indexes of the ISearchIndexCollection, only considering the documents fullfilling the search restriction.
Collection	getPropertyValues(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context) Returns the distinct property values of all indexes of the ISearchIndexCollection for the specified property, only considering the documents fullfilling the search restriction.
Collection	getPropertyValues(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, Collection indexes) Returns the distinct property values of the indexes for the specified property, only considering the documents fullfilling the search restriction.
Collection	getPropertyValues(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, ISearchIndex index) Returns the distinct property values of an index, only considering the documents fullfilling the search restriction.
List	getPropertyValues(List numberOfDocList, IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context) Returns the distinct property values of all indexes of the ISearchIndexCollection for the specified property, only considering the documents fullfilling the search restriction.
List	getPropertyValues(List numOfDocs, IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, Integer maxNumberOfValues) Returns the distinct property values of all indexes of the ISearchIndexCollection for the specified property, only considering the documents fullfilling the search restriction.
List	getPropertyValues(List numOfDocs, IPropertyName propertyName, IQueryEntryList queryEntryList, com.sapportals.wcm.util.uri.IRidList searchFromHereList, IResourceContext context, Integer maxNumberOfValues, Set languages) Returns the distinct property values of all indexes of the ISearchIndexCollection for the specified property, only considering the documents fullfilling the search restriction.
List	getPropertyValues(List numOfDocs, IPropertyName propertyName, IQueryEntryList queryEntryList, com.sapportals.wcm.util.uri.IRidList searchFromHereList, IResourceContext context, Set languages) Returns the distinct property values of all indexes of the ISearchIndexCollection for the specified property, only considering the documents fullfilling the search restriction.
Map	getPropertyValues(Map numOfDocsListsMap, IPropertyNameList propertyNames, IQueryEntryList queryEntryList, com.sapportals.wcm.util.uri.IRidList searchFromHereList, IResourceContext context, boolean noEmptyValues, Set languages) Returns the distinct property values of all indexes of the ISearchIndexCollection for the specified properties, only considering the documents fullfilling the search restriction.
Map	getPropertyValues(Map numOfDocsListsMap, IPropertyNameList propertyNames, IQueryEntryList queryEntryList, com.sapportals.wcm.util.uri.IRidList searchFromHereList, IResourceContext context, Set languages) Returns the distinct property values of all indexes of the ISearchIndexCollection for the specified properties, only considering the documents fullfilling the search restriction.
String	getQueryAsString() Deprecated. as of NW04.
ISearchResultList	getSearchResults(List rawSearchResults, IResourceContext context)
boolean	isSearchWithoutCache() If supported by the underlying search services, search caches are disabled if set on true.
void	loadQuery(Properties props) Deprecated. as of NW04.
ISearchResultList	searchSimilarDocuments(IResourceList searchDocuments, int maxResults) searches similar documents
ISearchSession	searchSimilarDocumentsWithSession(IResourceList searchDocuments) searches similar documents
ISearchSession	searchSimilarDocumentsWithSession(IResourceList searchDocuments, int initNumberMaxRawResults) searches similar documents
ISearchSession	searchSimilarDocumentsWithSession(IResourceList searchDocuments, int initNumberMaxRawResults, ISortPropertyName sortProperty) searches similar documents
Collection	searchSimilarTerms(Collection terms, int maxTerms) searches similar terms to a collection of terms
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.

Methods inherited from interface java.util.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Field Detail

DEFAULT_INIT_MAX_RAW_RESULTS

static final int DEFAULT_INIT_MAX_RAW_RESULTS

Search with session: default maximum number of raw results for the initial search The number is increased automatically when the result session requests more raw results.

See Also:

Constant Field Values

Method Detail

executeQueryWithSession

ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList,
                                       IResourceContext context)
                                       throws com.sapportals.wcm.WcmException

Executes the search

Parameters:

queryEntryList - - list of query entries for the search

context - - user context

Returns:

search session result

Throws:

com.sapportals.wcm.WcmException

executeQueryWithSession

ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList,
                                       IResourceContext context,
                                       int initNumberMaxRawResults)
                                       throws com.sapportals.wcm.WcmException

Executes the search

Parameters:

queryEntryList - - list of query entries for the search

context - - user context

initNumberResults - initial maximum number of raw results. The number is increased automatically when the result session requests more raw results.

Returns:

search session result

Throws:

com.sapportals.wcm.WcmException

executeQuery

ISearchResultList executeQuery(IQueryEntryList queryEntryList,
                               IResourceContext context,
                               int maxResults)
                               throws com.sapportals.wcm.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

Throws:

com.sapportals.wcm.WcmException

executeQuery

ISearchResultList executeQuery(IQueryEntryList queryEntryList,
                               IResourceContext context,
                               int maxResults,
                               ICollection searchFromHere)
                               throws com.sapportals.wcm.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

Throws:

com.sapportals.wcm.WcmException

executeQuery

ISearchResultList executeQuery(IQueryEntryList queryEntryList,
                               IResourceContext context,
                               int maxResults,
                               ICollection searchFromHere,
                               Set languages)
                               throws com.sapportals.wcm.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

languages - - set of strings, representing languages on which the search is restricted

Returns:

search result list with the found documents

Throws:

com.sapportals.wcm.WcmException

executeQueryWithSession

ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList,
                                       IResourceContext context,
                                       ICollection searchFromHere)
                                       throws com.sapportals.wcm.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

Throws:

com.sapportals.wcm.WcmException

executeQueryWithSession

ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList,
                                       IResourceContext context,
                                       int initNumberMaxRawResults,
                                       ICollection searchFromHere)
                                       throws com.sapportals.wcm.WcmException

Executes the search

Parameters:

queryEntryList - - list of query entries for the search

context - - user context

initNumberMaxRawResults - initial maximum number of raw results. The number is increased automatically when the result session requests more raw results.

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

Returns:

search session result

Throws:

com.sapportals.wcm.WcmException

executeQueryWithSession

ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList,
                                       IResourceContext context,
                                       int initNumberMaxRawResults,
                                       ICollection searchFromHere,
                                       ISortPropertyName sortProperty)
                                       throws com.sapportals.wcm.WcmException

Executes the search

Parameters:

queryEntryList - - list of query entries for the search

context - - user context

initNumberMaxRawResults - initial maximum number of raw results. The number is increased automatically when the result session requests more raw results.

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

sortProperty - property name for sorting the results

Returns:

search session result

Throws:

com.sapportals.wcm.WcmException

executeQueryWithSession

ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList,
                                       IResourceContext context,
                                       int initNumberMaxRawResults,
                                       ICollection searchFromHere,
                                       ISortPropertyName sortProperty,
                                       Set languages)
                                       throws com.sapportals.wcm.WcmException

Executes the search

Parameters:

queryEntryList - - list of query entries for the search

context - - user context

initNumberMaxRawResults - initial maximum number of raw results. The number is increased automatically when the result session requests more raw results.

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

languages - - restricts the search on the languages contained (as strings)

sortProperty - property name for sorting the results

Returns:

search session result

Throws:

com.sapportals.wcm.WcmException

executeQueryWithSession

ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList,
                                       IResourceContext context,
                                       int initNumberMaxRawResults,
                                       com.sapportals.wcm.util.uri.IRidList searchFromHereList,
                                       ISortPropertyName sortProperty,
                                       Set languages)
                                       throws com.sapportals.wcm.WcmException

Executes the search

Parameters:

queryEntryList - - list of query entries for the search

context - - user context

initNumberMaxRawResults - initial maximum number of raw results. The number is increased automatically when the result session requests more raw results.

searchFromHereList - - folder with ICollections from where search results must be a direct or indirect children

languages - - restricts the search on the languages contained (as strings)

sortProperty - property name for sorting the results

Returns:

search session result

Throws:

com.sapportals.wcm.WcmException

searchSimilarDocuments

ISearchResultList searchSimilarDocuments(IResourceList searchDocuments,
                                         int maxResults)
                                         throws com.sapportals.wcm.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

Throws:

com.sapportals.wcm.WcmException

searchSimilarDocumentsWithSession

ISearchSession searchSimilarDocumentsWithSession(IResourceList searchDocuments)
                                                 throws com.sapportals.wcm.WcmException

searches similar documents

Parameters:

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

Returns:

search session result

Throws:

com.sapportals.wcm.WcmException

searchSimilarDocumentsWithSession

ISearchSession searchSimilarDocumentsWithSession(IResourceList searchDocuments,
                                                 int initNumberMaxRawResults)
                                                 throws com.sapportals.wcm.WcmException

searches similar documents

Parameters:

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

initNumberMaxRawResults - initial maximum number of raw results. The number is increased automatically when the result session requests more raw results.

Returns:

search session result

Throws:

com.sapportals.wcm.WcmException

searchSimilarDocumentsWithSession

ISearchSession searchSimilarDocumentsWithSession(IResourceList searchDocuments,
                                                 int initNumberMaxRawResults,
                                                 ISortPropertyName sortProperty)
                                                 throws com.sapportals.wcm.WcmException

searches similar documents

Parameters:

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

initNumberMaxRawResults - initial maximum number of raw results. The number is increased automatically when the result session requests more raw results.

sortProperty - property name for sorting the results

Returns:

search session result

Throws:

com.sapportals.wcm.WcmException

searchSimilarTerms

Collection searchSimilarTerms(Collection terms,
                              int maxTerms)
                              throws com.sapportals.wcm.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

Throws:

com.sapportals.wcm.WcmException

getQueryAsString

String getQueryAsString()
                        throws com.sapportals.wcm.WcmException

Deprecated. as of NW04.

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

Throws:

com.sapportals.wcm.WcmException

loadQuery

void loadQuery(Properties props)
               throws com.sapportals.wcm.WcmException

Deprecated. as of NW04.

loads a complete Query from the given properites object.

Throws:

com.sapportals.wcm.WcmException

getNewQueryEntry

IQueryEntry getNewQueryEntry()

Returns:

a new query entry instance

getNewQueryEntryList

IQueryEntryList getNewQueryEntryList()

Returns:

a new query entry list instance

addIndex

void addIndex(IIndex index)
              throws com.sapportals.wcm.WcmException

Adds an index to the index collection

Parameters:

index - - index that is added to the collection

Throws:

com.sapportals.wcm.WcmException

getSearchResults

ISearchResultList getSearchResults(List rawSearchResults,
                                   IResourceContext context)
                                   throws ResourceException

Parameters:

rawSearchResults - list of IRawSearchResult

Returns:

list of search results

Throws:

ResourceException

getPropertyDistributionOverview

IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList,
                                                          ICollection searchFromHere,
                                                          IResourceContext context,
                                                          ISearchIndex index)
                                                          throws com.sapportals.wcm.WcmException

Returns basic information about the distribution of the properties of an index, only considering the documents fullfilling the search restriction.

Parameters:

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHere - restricts the considered documents to those located under this collection

context - resource context, not used to filter the result applying the access rights to the documents.

indexID -

Returns:

list of search results

Throws:

ResourceException - in case of an error

com.sapportals.wcm.WcmException

getPropertyDistributionOverview

IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList,
                                                          ICollection searchFromHere,
                                                          IResourceContext context,
                                                          Collection indexList,
                                                          IPropertyNameList propertyNameList)
                                                          throws com.sapportals.wcm.WcmException

Returns basic information about the distribution of the properties of the indexes, only considering the documents fullfilling the search restriction.

Parameters:

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHere - restricts the considered documents to those located under this collection

context - resource context, not used to filter the result applying the access rights to the documents.

indexList -

propertyNameList - specifies the properties for which an overview is computed. If null an overview for all attributes is computed.

Returns:

list of search results

Throws:

ResourceException - in case of an error

com.sapportals.wcm.WcmException

getPropertyDistributionOverview

IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList,
                                                          ICollection searchFromHere,
                                                          IResourceContext context,
                                                          IPropertyNameList propertyNameList)
                                                          throws com.sapportals.wcm.WcmException

Returns basic information about the distribution of the properties of the indexes, only considering the documents fullfilling the search restriction.

Parameters:

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHere - restricts the considered documents to those located under this collection

context - resource context, not used to filter the result applying the access rights to the documents.

propertyNameList - specifies the properties for which an overview is computed. If null an overview for all attributes is computed.

Returns:

list of search results

Throws:

ResourceException - in case of an error

com.sapportals.wcm.WcmException

getPropertyDistributionOverview

IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList,
                                                          ICollection searchFromHere,
                                                          IResourceContext context,
                                                          Collection indexList)
                                                          throws com.sapportals.wcm.WcmException

Returns basic information about the distribution of the properties of the indexes, only considering the documents fullfilling the search restriction.

Parameters:

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHere - restricts the considered documents to those located under this collection

context - resource context, not used to filter the result applying the access rights to the documents.

indexList - list of ISearchIndex of one type, e.g. AbstractTrexSearchIndex

Returns:

list of search results

Throws:

ResourceException - in case of an error

com.sapportals.wcm.WcmException

getPropertyDistributionOverview

IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList,
                                                          ICollection searchFromHere,
                                                          IResourceContext context)
                                                          throws com.sapportals.wcm.WcmException

Returns basic information about the distribution of the properties of the indexes, of the SearchIndexCollection only considering the documents fullfilling the search restriction.

Parameters:

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHere - restricts the considered documents to those located under this collection

context - resource context, not used to filter the result applying the access rights to the documents.

Throws:

ResourceException - in case of an error

com.sapportals.wcm.WcmException

getPropertyDistributionOverview

IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList,
                                                          com.sapportals.wcm.util.uri.IRidList searchFromHereList,
                                                          IResourceContext context,
                                                          Set languages)
                                                          throws com.sapportals.wcm.WcmException

Returns basic information about the distribution of the properties of the indexes, of the SearchIndexCollection only considering the documents fullfilling the search restriction.

Parameters:

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHereList - restricts the considered documents to those located under the specified paths

context - resource context, not used to filter the result applying the access rights to the documents.

languages - list of languages specifying that only documents in such language specific sub indexes are considered.

Throws:

com.sapportals.wcm.WcmException - in case of an error

getPropertyDistributionOverview

IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList,
                                                          com.sapportals.wcm.util.uri.IRidList searchFromHereList,
                                                          IResourceContext context,
                                                          IPropertyNameList propNameList,
                                                          Set languages)
                                                          throws com.sapportals.wcm.WcmException

Returns basic information about the distribution of the properties of the indexes, of the SearchIndexCollection only considering the documents fullfilling the search restriction.

Parameters:

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHereList - restricts the considered documents to those located under the specified paths

context - resource context, not used to filter the result applying the access rights to the documents.

propNameList - only information about the properties in this list is returned

languages - list of languages specifying that only documents in such language specific sub indexes are considered.

Throws:

com.sapportals.wcm.WcmException - in case of an error

getPropertyRanges

IPropertyRangeList getPropertyRanges(IPropertyName propertyName,
                                     IQueryEntryList queryEntryList,
                                     ICollection searchFromHere,
                                     IResourceContext context,
                                     ISearchIndex index)
                                     throws com.sapportals.wcm.WcmException

Returns the ranges of the properties of an index, only considering the documents fullfilling the search restriction.

Parameters:

propertyName - the property for which the ranges are extracted

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHere - restricts the considered documents to those located under this collection

context - resource context, not used to filter the result applying the access rights to the documents.

index -

Returns:

list of ranges

Throws:

com.sapportals.wcm.WcmException - in case of an error

getPropertyRanges

IPropertyRangeList getPropertyRanges(IPropertyName propertyName,
                                     IQueryEntryList queryEntryList,
                                     ICollection searchFromHere,
                                     IResourceContext context,
                                     Collection indexList)
                                     throws com.sapportals.wcm.WcmException

Returns the ranges of the properties of the indexes, only considering the documents fullfilling the search restriction.

Parameters:

propertyName - the property for which the ranges are extracted

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHere - restricts the considered documents to those located under this collection

context - resource context, not used to filter the result applying the access rights to the documents.

indexList -

Returns:

list of ranges

Throws:

com.sapportals.wcm.WcmException - in case of an error

getPropertyRanges

IPropertyRangeList getPropertyRanges(IPropertyName propertyName,
                                     IQueryEntryList queryEntryList,
                                     ICollection searchFromHere,
                                     IResourceContext context)
                                     throws com.sapportals.wcm.WcmException

Returns the ranges of the properties of the indexes of the ISearchIndexCollection, only considering the documents fullfilling the search restriction.

Parameters:

propertyName - the property for which the ranges are extracted

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHere - restricts the considered documents to those located under this collection

context - resource context, not used to filter the result applying the access rights to the documents.

Returns:

list of ranges

Throws:

com.sapportals.wcm.WcmException - in case of an error

getPropertyRanges

IPropertyRangeList getPropertyRanges(IPropertyName propertyName,
                                     IQueryEntryList queryEntryList,
                                     ICollection searchFromHere,
                                     IResourceContext context,
                                     DistributionParameter parameters)
                                     throws com.sapportals.wcm.WcmException

Returns the ranges of the properties of the indexes of the ISearchIndexCollection, only considering the documents fullfilling the search restriction.

Parameters:

propertyName - the property for which the ranges are extracted

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHere - restricts the considered documents to those located under this collection

context - resource context, not used to filter the result applying the access rights to the documents.

parameters - specifies the strategy according which the ranges are determined.

Returns:

list of ranges

Throws:

com.sapportals.wcm.WcmException - in case of an error

getPropertyRanges

IPropertyRangeList getPropertyRanges(IPropertyName propertyName,
                                     IQueryEntryList queryEntryList,
                                     com.sapportals.wcm.util.uri.IRidList searchFromHereList,
                                     IResourceContext context,
                                     DistributionParameter parameters,
                                     Set languages)
                                     throws com.sapportals.wcm.WcmException

Returns the ranges of the properties of the indexes of the ISearchIndexCollection, only considering the documents fullfilling the search restriction.

Parameters:

propertyName - the property for which the ranges are extracted

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHereList - restricts the considered documents to those located under the specified paths

context - resource context, not used to filter the result applying the access rights to the documents.

parameters - specifies the strategy according which the ranges are determined.

languages - restricts the considered documents to the languages specified here.

Returns:

list of ranges

Throws:

com.sapportals.wcm.WcmException - in case of an error

getPropertyValues

Collection getPropertyValues(IPropertyName propertyName,
                             IQueryEntryList queryEntryList,
                             ICollection searchFromHere,
                             IResourceContext context,
                             ISearchIndex index)
                             throws com.sapportals.wcm.WcmException

Returns the distinct property values of an index, only considering the documents fullfilling the search restriction.

Parameters:

propertyName - the property for which the values are extracted

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHere - restricts the considered documents to those located under this collection

context - resource context, not used to filter the result applying the access rights to the documents.

index -

Returns:

list of IProperty objects

Throws:

com.sapportals.wcm.WcmException - in case of an error

getPropertyValues

Collection getPropertyValues(IPropertyName propertyName,
                             IQueryEntryList queryEntryList,
                             ICollection searchFromHere,
                             IResourceContext context,
                             Collection indexes)
                             throws com.sapportals.wcm.WcmException

Returns the distinct property values of the indexes for the specified property, only considering the documents fullfilling the search restriction.

Parameters:

propertyName - the property for which the values are extracted

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHere - restricts the considered documents to those located under this collection

context - resource context, not used to filter the result applying the access rights to the documents.

indexes -

Returns:

list of IProperty objects

Throws:

com.sapportals.wcm.WcmException - in case of an error

getPropertyValues

Collection getPropertyValues(IPropertyName propertyName,
                             IQueryEntryList queryEntryList,
                             ICollection searchFromHere,
                             IResourceContext context)
                             throws com.sapportals.wcm.WcmException

Returns the distinct property values of all indexes of the ISearchIndexCollection for the specified property, only considering the documents fullfilling the search restriction.

Parameters:

propertyName - the property for which the values are extracted

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHere - restricts the considered documents to those located under this collection

context - resource context, not used to filter the result applying the access rights to the documents.

Returns:

list of IProperty objects

Throws:

com.sapportals.wcm.WcmException - in case of an error

getPropertyValues

List getPropertyValues(List numberOfDocList,
                       IPropertyName propertyName,
                       IQueryEntryList queryEntryList,
                       ICollection searchFromHere,
                       IResourceContext context)
                       throws com.sapportals.wcm.WcmException

Returns the distinct property values of all indexes of the ISearchIndexCollection for the specified property, only considering the documents fullfilling the search restriction.

Parameters:

numberOfDocList - this list is filled with the number of documents for every property value.

propertyName - the property for which the values are extracted

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHere - restricts the considered documents to those located under this collection

context - resource context, not used to filter the result applying the access rights to the documents.

Returns:

list of IProperty objects

Throws:

com.sapportals.wcm.WcmException - in case of an error

getPropertyValues

List getPropertyValues(List numOfDocs,
                       IPropertyName propertyName,
                       IQueryEntryList queryEntryList,
                       ICollection searchFromHere,
                       IResourceContext context,
                       Integer maxNumberOfValues)
                       throws com.sapportals.wcm.WcmException

Returns the distinct property values of all indexes of the ISearchIndexCollection for the specified property, only considering the documents fullfilling the search restriction.

Parameters:

numOfDocs - this list is filled with the number of documents for every property value.

propertyName - the property for which the values are extracted

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHere - restricts the considered documents to those located under this collection

context - resource context, not used to filter the result applying the access rights to the documents.

maxNumberOfValues - maximal number of result values

Returns:

list of IProperty objects

Throws:

com.sapportals.wcm.WcmException - in case of an error

getPropertyValues

List getPropertyValues(List numOfDocs,
                       IPropertyName propertyName,
                       IQueryEntryList queryEntryList,
                       com.sapportals.wcm.util.uri.IRidList searchFromHereList,
                       IResourceContext context,
                       Set languages)
                       throws com.sapportals.wcm.WcmException

Returns the distinct property values of all indexes of the ISearchIndexCollection for the specified property, only considering the documents fullfilling the search restriction.

Parameters:

numOfDocs - this list is filled with the number of documents for every property value.

propertyName - the property for which the values are extracted

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHereList - restricts the considered documents to those located under these paths

context - resource context, not used to filter the result applying the access rights to the documents.

languages - restricting the considered documents to these languages

Returns:

list of IProperty objects

Throws:

com.sapportals.wcm.WcmException - in case of an error

getPropertyValues

List getPropertyValues(List numOfDocs,
                       IPropertyName propertyName,
                       IQueryEntryList queryEntryList,
                       com.sapportals.wcm.util.uri.IRidList searchFromHereList,
                       IResourceContext context,
                       Integer maxNumberOfValues,
                       Set languages)
                       throws com.sapportals.wcm.WcmException

Returns the distinct property values of all indexes of the ISearchIndexCollection for the specified property, only considering the documents fullfilling the search restriction.

Parameters:

numOfDocs - this list is filled with the number of documents for every property value.

propertyName - the property for which the values are extracted

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHereList - restricts the considered documents to those located under these paths

context - resource context, not used to filter the result applying the access rights to the documents.

maxNumberOfValues - maximal number of values returned

languages - restricting the considered documents to these languages

Returns:

list of IProperty objects

Throws:

com.sapportals.wcm.WcmException - in case of an error

getPropertyValues

Map getPropertyValues(Map numOfDocsListsMap,
                      IPropertyNameList propertyNames,
                      IQueryEntryList queryEntryList,
                      com.sapportals.wcm.util.uri.IRidList searchFromHereList,
                      IResourceContext context,
                      Set languages)
                      throws com.sapportals.wcm.WcmException

Returns the distinct property values of all indexes of the ISearchIndexCollection for the specified properties, only considering the documents fullfilling the search restriction.

Parameters:

numOfDocsListsMap - this map is filled for every specified property with a list filled with the number of documents for every property value. Every list is accessible via the property name.

propertyNames - the properties for which the values are extracted

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHereList - restricts the considered documents to those located under these paths

context - resource context, not used to filter the result applying the access rights to the documents.

languages - restricting the considered documents to these languages

Returns:

list of IProperty objects

Throws:

com.sapportals.wcm.WcmException - in case of an error

getPropertyValues

Map getPropertyValues(Map numOfDocsListsMap,
                      IPropertyNameList propertyNames,
                      IQueryEntryList queryEntryList,
                      com.sapportals.wcm.util.uri.IRidList searchFromHereList,
                      IResourceContext context,
                      boolean noEmptyValues,
                      Set languages)
                      throws com.sapportals.wcm.WcmException

Returns the distinct property values of all indexes of the ISearchIndexCollection for the specified properties, only considering the documents fullfilling the search restriction.

Parameters:

numOfDocsListsMap - this map is filled for every specified property with a list filled with the number of documents for every property value. Every list is accessible via the property name.

propertyNames - the properties for which the values are extracted

queryEntryList - restricts the considered documents to those fullfilling this expression

searchFromHereList - restricts the considered documents to those located under these paths

context - resource context, not used to filter the result applying the access rights to the documents.

noEmptyValues - if true no empty values or values with length 0 are returned

languages - restricting the considered documents to these languages

Returns:

list of IProperty objects

Throws:

com.sapportals.wcm.WcmException - in case of an error

setMaxSnippetWords

void setMaxSnippetWords(int numOfWords)

Sets the number of snippet words returned for documents in a search. If not set, a default value is used.

Parameters:

numOfWords -

getMaxSnippetWords

int getMaxSnippetWords()

Sets the number of snippet words returned for documents in a search.

Returns:

number of snippet words

setSearchWithoutCache

void setSearchWithoutCache(boolean b)

If supported by the underlying search services, search caches are disabled if set on true. By default this is set on false.

Parameters:

b -

isSearchWithoutCache

boolean isSearchWithoutCache()

If supported by the underlying search services, search caches are disabled if set on true. By default this is set on false. Returns the value set.

Parameters:

b -

getDocumentFeatures

Collection getDocumentFeatures(IQueryEntryList queryEntryList,
                               int maxNumberOfDocs,
                               int maxFeatures)
                               throws com.sapportals.wcm.WcmException

Throws:

com.sapportals.wcm.WcmException

setFetchedProperties

void setFetchedProperties(Set propNames)

If supported by the search engine, only these properties are fetched from the server.

Parameters:

propNames - Set of IPropertyNames

getFetchedProperties

Set getFetchedProperties()

Returns the properties which should be fetched for serch results from the search engine (if suported by it). If null all possible are fetched.

Returns:

Set of IPropertyNames

setRequestContentSnippets

void setRequestContentSnippets(boolean b)

Specifies if content snippets should be fetched.

Parameters:

b -

setRequestDidYouMean

void setRequestDidYouMean(boolean b)

Specifies if do you mean terms should be fetched.

Parameters:

b -

Access Rights

This class can be accessed from:

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