public abstract class AbstractSearchIndexCollection extends AbstractIndexCollection implements ISearchIndexCollection
getDocumentFeatures(IQueryEntryList, int, int)
Modifier and Type | Class and Description |
---|---|
class |
AbstractSearchIndexCollection.PropertyInput |
m_indexes
DEFAULT_INIT_MAX_RAW_RESULTS
Constructor and Description |
---|
AbstractSearchIndexCollection(Collection indexes) |
Modifier and Type | Method and Description |
---|---|
protected IProperty |
createInitialProperty(IPropertyName propName)
Creates a property with initial value for a property name.
|
static ISearchResult |
createNewSearchResultObject(IResource resource,
float rankValue)
Creates a new search result object containing the resource and rank values of the parameters.
|
protected ISearchResult |
createSearchResultObject(IResource resource,
float rankValue)
Gets a search result object initialized with the given resource and rank value.
|
abstract ISearchResultList |
executeQuery(IQueryEntryList queryEntryList,
IResourceContext context,
int maxResults)
Executes the search
|
abstract ISearchResultList |
executeQuery(IQueryEntryList queryEntryList,
IResourceContext context,
int maxResults,
ICollection searchFromHere)
Executes the search
|
abstract ISearchResultList |
executeQuery(IQueryEntryList queryEntryList,
IResourceContext context,
int maxResults,
ICollection searchFromHere,
Set languages)
Executes the search
|
abstract ISearchSession |
executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context)
Executes the search
|
abstract ISearchSession |
executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context,
ICollection searchFromHere)
Executes the search
|
abstract ISearchSession |
executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context,
int initNumberMaxRawResults)
Executes the search
|
abstract ISearchSession |
executeQueryWithSession(IQueryEntryList queryEntryList,
IResourceContext context,
int initNumberMaxRawResults,
ICollection searchFromHere)
Executes the search
|
abstract 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,
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 search results from the search engine
(if supported by it).
|
int |
getMaxSnippetWords()
Sets the number of snippet words returned for documents in a search.
|
IQueryEntry |
getNewQueryEntry() |
IQueryEntryList |
getNewQueryEntryList() |
protected ISearchSession |
getNewSearchSession(IQueryEntryList queryEntries,
IRidList searchFromHereList,
ISearchIndexCollection searchIndexCollection,
IResourceContext context,
int initMaxRawResults,
ISortPropertyName sortProperty)
Gets a new search session instance
|
protected ISearchSession |
getNewSearchSession(IResourceList similarDocsInput,
ISearchIndexCollection searchIndexCollection,
IResourceContext context,
int initMaxRawResults,
ISortPropertyName sortProperty)
Gets a new search session instance
|
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 fulfilling 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 fulfilling 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 fulfilling 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 fulfilling 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 fulfilling the search restriction.
|
IPropertyDistributionList |
getPropertyDistributionOverview(IQueryEntryList queryEntryList,
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 fulfilling the search
restriction.
|
IPropertyDistributionList |
getPropertyDistributionOverview(IQueryEntryList queryEntryList,
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 fulfilling 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 fulfilling 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 fulfilling 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 fulfilling 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 fulfilling the search restriction.
|
IPropertyRangeList |
getPropertyRanges(IPropertyName propertyName,
IQueryEntryList queryEntryList,
IRidList searchFromHereList,
IResourceContext context,
DistributionParameter parameters,
Set languages)
Returns the ranges of the properties of the indexes of the ISearchIndexCollection,
only considering the documents fulfilling the search restriction.
|
protected PropertyType |
getPropertyType(IPropertyName propName)
Determines the property type using the property config service.
|
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 fulfilling 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 fulfilling 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 fulfilling 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 fulfilling 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 fulfilling the search
restriction.
|
List |
getPropertyValues(List numOfDocs,
IPropertyName propertyName,
IQueryEntryList queryEntryList,
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 fulfilling the search
restriction.
|
List |
getPropertyValues(List numOfDocs,
IPropertyName propertyName,
IQueryEntryList queryEntryList,
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 fulfilling the search
restriction.
|
Map |
getPropertyValues(Map numOfDocsListsMap,
IPropertyNameList propertyNames,
IQueryEntryList queryEntryList,
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 fulfilling the search
restriction.
|
Map |
getPropertyValues(Map numOfDocsListsMap,
IPropertyNameList propertyNames,
IQueryEntryList queryEntryList,
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 fulfilling the search
restriction.
|
String |
getQueryAsString()
Deprecated.
as of NW04.
|
abstract 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.
|
abstract ISearchResultList |
searchSimilarDocuments(IResourceList searchDocuments,
int maxResults)
searches similar documents
|
abstract ISearchSession |
searchSimilarDocumentsWithSession(IResourceList searchDocuments)
searches similar documents
|
abstract ISearchSession |
searchSimilarDocumentsWithSession(IResourceList searchDocuments,
int initNumberMaxRawResults)
searches similar documents
|
abstract 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 |
setRequestAttributes(boolean b)
Specifies if the indexed attributes should be send together with the search results.
|
void |
setRequestContentSnippets(boolean b)
Specifies if content snippets should be send together with the search results.
|
void |
setRequestDidYouMean(boolean b)
Specifies if do you mean terms should be send together with the search results.
|
void |
setSearchWithoutCache(boolean b)
If supported by the underlying search services, search caches are disabled if set on true.
|
addIndex, getIndex, iterator, size
add, addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
addIndex, searchSimilarDocumentsWithSession
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray
public AbstractSearchIndexCollection(Collection indexes)
indexes
- indexespublic abstract ISearchResultList executeQuery(IQueryEntryList queryEntryList, IResourceContext context, int maxResults) throws WcmException
ISearchIndexCollection
executeQuery
in interface ISearchIndexCollection
queryEntryList
- - list of query entries for the searchcontext
- - user contextmaxResults
- - maximum number of search resultsWcmException
- WcmExceptionpublic abstract ISearchResultList executeQuery(IQueryEntryList queryEntryList, IResourceContext context, int maxResults, ICollection searchFromHere) throws WcmException
ISearchIndexCollection
executeQuery
in interface ISearchIndexCollection
queryEntryList
- - list of query entries for the searchcontext
- - user contextmaxResults
- - maximum number of search resultssearchFromHere
- - folder from where search results must be direct or indirect childrenWcmException
- WcmExceptionpublic abstract ISearchResultList executeQuery(IQueryEntryList queryEntryList, IResourceContext context, int maxResults, ICollection searchFromHere, Set languages) throws WcmException
ISearchIndexCollection
executeQuery
in interface ISearchIndexCollection
queryEntryList
- - list of query entries for the searchcontext
- - user contextmaxResults
- - maximum number of search resultssearchFromHere
- - folder from where search results must be direct or indirect childrenlanguages
- - set of strings, representing languages on which the search is restrictedWcmException
- WcmExceptionpublic abstract ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context) throws WcmException
ISearchIndexCollection
executeQueryWithSession
in interface ISearchIndexCollection
queryEntryList
- - list of query entries for the searchcontext
- - user contextWcmException
- WcmExceptionpublic abstract ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, ICollection searchFromHere) throws WcmException
ISearchIndexCollection
executeQueryWithSession
in interface ISearchIndexCollection
queryEntryList
- - list of query entries for the searchcontext
- - user contextsearchFromHere
- - folder from where search results must be direct or indirect childrenWcmException
- WcmExceptionpublic abstract ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, int initNumberMaxRawResults) throws WcmException
ISearchIndexCollection
executeQueryWithSession
in interface ISearchIndexCollection
queryEntryList
- - list of query entries for the searchcontext
- - user contextinitNumberMaxRawResults
- initial maximum number of raw results.
The number is increased automatically when the result session requests more raw results.WcmException
- WcmExceptionpublic abstract ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, int initNumberMaxRawResults, ICollection searchFromHere) throws WcmException
ISearchIndexCollection
executeQueryWithSession
in interface ISearchIndexCollection
queryEntryList
- - list of query entries for the searchcontext
- - user contextinitNumberMaxRawResults
- 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 childrenWcmException
- WcmExceptionpublic abstract ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, int initNumberMaxRawResults, ICollection searchFromHere, ISortPropertyName sortProperty) throws WcmException
ISearchIndexCollection
executeQueryWithSession
in interface ISearchIndexCollection
queryEntryList
- - list of query entries for the searchcontext
- - user contextinitNumberMaxRawResults
- 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 childrensortProperty
- property name for sorting the resultsWcmException
- WcmExceptionpublic ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, int initNumberMaxRawResults, ICollection searchFromHere, ISortPropertyName sortProperty, Set languages) throws WcmException
ISearchIndexCollection
executeQueryWithSession
in interface ISearchIndexCollection
queryEntryList
- - list of query entries for the searchcontext
- - user contextinitNumberMaxRawResults
- 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 childrensortProperty
- property name for sorting the resultslanguages
- - restricts the search on the languages contained (as strings)WcmException
- WcmExceptionpublic ISearchSession executeQueryWithSession(IQueryEntryList queryEntryList, IResourceContext context, int initNumberMaxRawResults, IRidList searchFromHereList, ISortPropertyName sortProperty, Set languages) throws WcmException
ISearchIndexCollection
executeQueryWithSession
in interface ISearchIndexCollection
queryEntryList
- - list of query entries for the searchcontext
- - user contextinitNumberMaxRawResults
- 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 childrensortProperty
- property name for sorting the resultslanguages
- - restricts the search on the languages contained (as strings)WcmException
- WcmExceptionpublic abstract ISearchResultList searchSimilarDocuments(IResourceList searchDocuments, int maxResults) throws WcmException
ISearchIndexCollection
searchSimilarDocuments
in interface ISearchIndexCollection
searchDocuments
- - list of documents for that similar documents have to be foundmaxResults
- - maximum number of similar documentsWcmException
- WcmExceptionpublic abstract ISearchSession searchSimilarDocumentsWithSession(IResourceList searchDocuments) throws WcmException
ISearchIndexCollection
searchSimilarDocumentsWithSession
in interface ISearchIndexCollection
searchDocuments
- - list of documents for that similar documents have to be foundWcmException
- WcmExceptionpublic abstract ISearchSession searchSimilarDocumentsWithSession(IResourceList searchDocuments, int initNumberMaxRawResults) throws WcmException
ISearchIndexCollection
searchSimilarDocumentsWithSession
in interface ISearchIndexCollection
searchDocuments
- - list of documents for that similar documents have to be foundinitNumberMaxRawResults
- initial maximum number of raw results.
The number is increased automatically when the result session requests more raw results.WcmException
- WcmExceptionpublic abstract Collection searchSimilarTerms(Collection terms, int maxTerms) throws WcmException
ISearchIndexCollection
searchSimilarTerms
in interface ISearchIndexCollection
terms
- Collection of terms (Strings)maxTerms
- - maximum number of returned similar termsWcmException
- WcmExceptionpublic void setMaxSnippetWords(int numOfWords)
setMaxSnippetWords
in interface ISearchIndexCollection
numOfWords
- numOfWordspublic int getMaxSnippetWords()
getMaxSnippetWords
in interface ISearchIndexCollection
public String getQueryAsString() throws WcmException
getQueryAsString
in interface ISearchIndexCollection
WcmException
- WcmException
Returns the momentary query as a string, ready to be saved as a .properties filepublic void loadQuery(Properties props) throws WcmException
loadQuery
in interface ISearchIndexCollection
props
- propsWcmException
- WcmException
loads a complete Query from the given properties object.public IQueryEntry getNewQueryEntry()
getNewQueryEntry
in interface ISearchIndexCollection
public IQueryEntryList getNewQueryEntryList()
getNewQueryEntryList
in interface ISearchIndexCollection
public abstract ISearchResultList getSearchResults(List rawSearchResults, IResourceContext context) throws ResourceException
getSearchResults
in interface ISearchIndexCollection
rawSearchResults
- list of IRawSearchResultcontext
- contextResourceException
- ResourceExceptionpublic IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, ISearchIndex index) throws WcmException
ISearchIndexCollection
getPropertyDistributionOverview
in interface ISearchIndexCollection
queryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHere
- restricts the considered documents to those located under
this collectioncontext
- resource context, not used to filter the result applying the
access rights to the documents.index
- indexWcmException
- in case of an errorISearchIndexCollection
public IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList, IRidList searchFromHereList, IResourceContext context, Set languages) throws WcmException
ISearchIndexCollection
getPropertyDistributionOverview
in interface ISearchIndexCollection
queryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHereList
- restricts the considered documents to those located under
the specified pathscontext
- 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.WcmException
- in case of an errorISearchIndexCollection
public IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList, IRidList searchFromHereList, IResourceContext context, IPropertyNameList propNameList, Set languages) throws WcmException
ISearchIndexCollection
getPropertyDistributionOverview
in interface ISearchIndexCollection
queryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHereList
- restricts the considered documents to those located under
the specified pathscontext
- 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 returnedlanguages
- list of languages specifying that only documents in such language specific
sub indexes are considered.WcmException
- in case of an errorISearchIndexCollection
public IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, Collection indexList) throws WcmException
ISearchIndexCollection
getPropertyDistributionOverview
in interface ISearchIndexCollection
queryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHere
- restricts the considered documents to those located under
this collectioncontext
- resource context, not used to filter the result applying the
access rights to the documents.indexList
- list of ISearchIndex of one type, e.g. AbstractTrexSearchIndexWcmException
- in case of an errorISearchIndexCollection
public IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context) throws WcmException
ISearchIndexCollection
getPropertyDistributionOverview
in interface ISearchIndexCollection
queryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHere
- restricts the considered documents to those located under
this collectioncontext
- resource context, not used to filter the result applying the
access rights to the documents.WcmException
- in case of an errorISearchIndexCollection
public IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, Collection indexList, IPropertyNameList propertyNameList) throws WcmException
ISearchIndexCollection
getPropertyDistributionOverview
in interface ISearchIndexCollection
queryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHere
- restricts the considered documents to those located under
this collectioncontext
- resource context, not used to filter the result applying the
access rights to the documents.indexList
- indexListpropertyNameList
- specifies the properties for which an overview is computed. If null
an overview for all attributes is computed.WcmException
- in case of an errorISearchIndexCollection
public IPropertyDistributionList getPropertyDistributionOverview(IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, IPropertyNameList propertyNameList) throws WcmException
ISearchIndexCollection
getPropertyDistributionOverview
in interface ISearchIndexCollection
queryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHere
- restricts the considered documents to those located under
this collectioncontext
- 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.WcmException
- in case of an errorISearchIndexCollection
public IPropertyRangeList getPropertyRanges(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, ISearchIndex index) throws WcmException
ISearchIndexCollection
getPropertyRanges
in interface ISearchIndexCollection
propertyName
- the property for which the ranges are extractedqueryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHere
- restricts the considered documents to those located under
this collectioncontext
- resource context, not used to filter the result applying the
access rights to the documents.index
- indexWcmException
- in case of an errorISearchIndexCollection
public IPropertyRangeList getPropertyRanges(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, Collection indexList) throws WcmException
ISearchIndexCollection
getPropertyRanges
in interface ISearchIndexCollection
propertyName
- the property for which the ranges are extractedqueryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHere
- restricts the considered documents to those located under
this collectioncontext
- resource context, not used to filter the result applying the
access rights to the documents.indexList
- indexListWcmException
- in case of an errorISearchIndexCollection
public IPropertyRangeList getPropertyRanges(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context) throws WcmException
ISearchIndexCollection
getPropertyRanges
in interface ISearchIndexCollection
propertyName
- the property for which the ranges are extractedqueryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHere
- restricts the considered documents to those located under
this collectioncontext
- resource context, not used to filter the result applying the
access rights to the documents.WcmException
- in case of an errorISearchIndexCollection
public IPropertyRangeList getPropertyRanges(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, DistributionParameter parameters) throws WcmException
ISearchIndexCollection
getPropertyRanges
in interface ISearchIndexCollection
propertyName
- the property for which the ranges are extractedqueryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHere
- restricts the considered documents to those located under
this collectioncontext
- 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.WcmException
- in case of an errorISearchIndexCollection
public IPropertyRangeList getPropertyRanges(IPropertyName propertyName, IQueryEntryList queryEntryList, IRidList searchFromHereList, IResourceContext context, DistributionParameter parameters, Set languages) throws WcmException
ISearchIndexCollection
getPropertyRanges
in interface ISearchIndexCollection
propertyName
- the property for which the ranges are extractedqueryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHereList
- restricts the considered documents to those located under
the specified pathscontext
- 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.WcmException
- in case of an errorISearchIndexCollection
public Collection getPropertyValues(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, ISearchIndex index) throws WcmException
ISearchIndexCollection
getPropertyValues
in interface ISearchIndexCollection
propertyName
- the property for which the values are extractedqueryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHere
- restricts the considered documents to those located under
this collectioncontext
- resource context, not used to filter the result applying the
access rights to the documents.index
- indexWcmException
- in case of an errorISearchIndexCollection
public Collection getPropertyValues(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, Collection indexes) throws WcmException
ISearchIndexCollection
getPropertyValues
in interface ISearchIndexCollection
propertyName
- the property for which the values are extractedqueryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHere
- restricts the considered documents to those located under
this collectioncontext
- resource context, not used to filter the result applying the
access rights to the documents.indexes
- indexesWcmException
- in case of an errorISearchIndexCollection
public Collection getPropertyValues(IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context) throws WcmException
ISearchIndexCollection
getPropertyValues
in interface ISearchIndexCollection
propertyName
- the property for which the values are extractedqueryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHere
- restricts the considered documents to those located under
this collectioncontext
- resource context, not used to filter the result applying the
access rights to the documents.WcmException
- in case of an errorISearchIndexCollection
public List getPropertyValues(List numberOfDocList, IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context) throws WcmException
ISearchIndexCollection
getPropertyValues
in interface ISearchIndexCollection
numberOfDocList
- this list is filled with the number of documents for every property value.propertyName
- the property for which the values are extractedqueryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHere
- restricts the considered documents to those located under
this collectioncontext
- resource context, not used to filter the result applying the
access rights to the documents.WcmException
- in case of an errorISearchIndexCollection
public List getPropertyValues(List numOfDocs, IPropertyName propertyName, IQueryEntryList queryEntryList, ICollection searchFromHere, IResourceContext context, Integer maxNumberOfValues) throws WcmException
ISearchIndexCollection
getPropertyValues
in interface ISearchIndexCollection
numOfDocs
- this list is filled with the number of documents for every property value.propertyName
- the property for which the values are extractedqueryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHere
- restricts the considered documents to those located under
this collectioncontext
- resource context, not used to filter the result applying the
access rights to the documents.maxNumberOfValues
- maximal number of result valuesWcmException
- in case of an errorISearchIndexCollection
public List getPropertyValues(List numOfDocs, IPropertyName propertyName, IQueryEntryList queryEntryList, IRidList searchFromHereList, IResourceContext context, Set languages) throws WcmException
ISearchIndexCollection
getPropertyValues
in interface ISearchIndexCollection
numOfDocs
- this list is filled with the number of documents for every property value.propertyName
- the property for which the values are extractedqueryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHereList
- restricts the considered documents to those located under
these pathscontext
- resource context, not used to filter the result applying the
access rights to the documents.languages
- restricting the considered documents to these languagesWcmException
- in case of an errorISearchIndexCollection
public Map getPropertyValues(Map numOfDocsListsMap, IPropertyNameList propertyNames, IQueryEntryList queryEntryList, IRidList searchFromHereList, IResourceContext context, Set languages) throws WcmException
ISearchIndexCollection
getPropertyValues
in interface ISearchIndexCollection
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 extractedqueryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHereList
- restricts the considered documents to those located under
these pathscontext
- resource context, not used to filter the result applying the
access rights to the documents.languages
- restricting the considered documents to these languagesWcmException
- in case of an errorISearchIndexCollection
public Map getPropertyValues(Map numOfDocsListsMap, IPropertyNameList propertyNames, IQueryEntryList queryEntryList, IRidList searchFromHereList, IResourceContext context, boolean noEmptyValues, Set languages) throws WcmException
ISearchIndexCollection
getPropertyValues
in interface ISearchIndexCollection
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 extractedqueryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHereList
- restricts the considered documents to those located under
these pathscontext
- 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 returnedlanguages
- restricting the considered documents to these languagesWcmException
- in case of an errorISearchIndexCollection
public List getPropertyValues(List numOfDocs, IPropertyName propertyName, IQueryEntryList queryEntryList, IRidList searchFromHereList, IResourceContext context, Integer maxNumberOfValues, Set languages) throws WcmException
ISearchIndexCollection
getPropertyValues
in interface ISearchIndexCollection
numOfDocs
- this list is filled with the number of documents for every property value.propertyName
- the property for which the values are extractedqueryEntryList
- restricts the considered documents to those fulfilling this
expressionsearchFromHereList
- restricts the considered documents to those located under
these pathscontext
- resource context, not used to filter the result applying the
access rights to the documents.maxNumberOfValues
- maximal number of values returnedlanguages
- restricting the considered documents to these languagesWcmException
- in case of an errorISearchIndexCollection
protected ISearchSession getNewSearchSession(IQueryEntryList queryEntries, IRidList searchFromHereList, ISearchIndexCollection searchIndexCollection, IResourceContext context, int initMaxRawResults, ISortPropertyName sortProperty) throws WcmException
queryEntries
- the query entry list of the querysearchFromHereList
- collection to search from here (can be null)searchIndexCollection
- the search index collection to address for researchingcontext
- the user contextinitMaxRawResults
- initial maximum number of raw resultssortProperty
- property name for sorting the resultsWcmException
- WcmExceptionprotected ISearchResult createSearchResultObject(IResource resource, float rankValue) throws WcmException
resource
- search result resourcerankValue
- rankValueWcmException
- WcmExceptionpublic static ISearchResult createNewSearchResultObject(IResource resource, float rankValue) throws WcmException
resource
- contained in the search resultrankValue
- contained in the search resultWcmException
- in case of a failureprotected ISearchSession getNewSearchSession(IResourceList similarDocsInput, ISearchIndexCollection searchIndexCollection, IResourceContext context, int initMaxRawResults, ISortPropertyName sortProperty) throws WcmException
similarDocsInput
- the basis for similar document searchsearchIndexCollection
- the search index collection to address for researchingcontext
- the user contextinitMaxRawResults
- initial maximum number of raw resultssortProperty
- property name for sorting the resultsWcmException
- WcmExceptionprotected IProperty createInitialProperty(IPropertyName propName) throws ResourceException
propName
- name of the propertyResourceException
- ResourceExceptionprotected PropertyType getPropertyType(IPropertyName propName) throws ResourceException
propName
- name of the propertyResourceException
- ResourceExceptionpublic Collection getDocumentFeatures(IQueryEntryList queryEntryList, int maxNumberOfDocs, int maxFeatures) throws WcmException
getDocumentFeatures
in interface ISearchIndexCollection
queryEntryList
- queryEntryListmaxNumberOfDocs
- maxNumberOfDocsmaxFeatures
- maxFeaturesWcmException
- WcmExceptionISearchIndexCollection
public boolean isSearchWithoutCache()
isSearchWithoutCache
in interface ISearchIndexCollection
public void setSearchWithoutCache(boolean b)
setSearchWithoutCache
in interface ISearchIndexCollection
b
- bpublic void setRequestAttributes(boolean b)
b
- bpublic void setRequestContentSnippets(boolean b)
setRequestContentSnippets
in interface ISearchIndexCollection
b
- bpublic void setRequestDidYouMean(boolean b)
setRequestDidYouMean
in interface ISearchIndexCollection
b
- bpublic void setFetchedProperties(Set propNames)
ISearchIndexCollection
setFetchedProperties
in interface ISearchIndexCollection
propNames
- Set of IPropertyNamesISearchIndexCollection
public Set getFetchedProperties()
ISearchIndexCollection
getFetchedProperties
in interface ISearchIndexCollection
ISearchIndexCollection
Access 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