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

Interface Summary
Interface	Description
IExtendedSearchIndex	Extended interface for additional search and retrieval operations.
IFederatedSearch	Starts a search with a given query within a list of indexes, no matter what search service implementation an index is.
IPropertyDistribution	Holds information about the distribution of property values of one property.
IPropertyDistributionList	List of `IPropertyDistribution` objects
IPropertyDistributionListIterator	Iterator for the property distribution list.
IPropertyInfo	Represents important info about a property.
IPropertyRange	Holds information about the range of property values of one property.
IPropertyRangeList	List of `IPropertyRange` objects
IPropertyRangeListIterator	Iterator for the property range list.
IQueryEntry	Single entry of a complex search query.
IQueryEntryList	List of `IQueryEntry` objects Changes between major releases 7.0 and 7.X Added methods: `IQueryEntryList.addDateRangeQuery(IPropertyName, long, byte)` `IQueryEntryList.clear()` `IQueryEntryList.fromXMLString(String)` `IQueryEntryList.toXMLString()` `IQueryEntryList.toXMLStringSave()`
IQueryEntryListIterator	An iterator for the query entry list.
IRawSearchResult	A search result represented by the document key and the rank value.
IRawSearchSession	Access to a search session from the input side.
ISearchIndex	Index for search and retrieval operations.
ISearchIndexCollection	Offers search calls for more than one index.
ISearchResult	Represents a document in the search result.
ISearchResultList	List of `ISearchResult` objects
ISearchResultListIterator	Iterator for the search result list.
ISearchSession	The session object contains the search results in a raw format.
ISearchSessionProvider	The session provider is in interface to provide a stored searchsession from SearchRendererStatus
ISearchUtils	Utility methods that can be used by `ISearchIndexCollection` implementations.
ISortPropertyName	A sort property name is a combination of a resource property name and a sort direction.
ITextminingResult	Container for a list text mining result for a document.
ITextminingTerm	Result term for the text mining request `searchSimilarTerms` of interface `ISearchIndex`.

Class Summary
Class	Description
AbstractSearchIndexCollection	Collection of search indexes to perform search and other retrieval operations on them.
DefaultQueryExtender	Basic class to extend the query of particular indexes by implementing a subclass of this class.
DistributionParameter	Class to specify the strategy how to determine ranges for properties in a guided navigation call.
SearchQueryBuilderIM	The SearchQueryBuilder provides helping functions for building a search query.
SearchStringParser
SearchStringTerm
SortPropertyName	A sort property name is a combination of a resource property name and a sort direction.
TestQueryExtender	Test method for the query extender concept.

Exception Summary
Exception Description

ImParsingException
Exception thrown in case of an error when creating an internal query entry list by the class SearchQueryBuilderIM.

Exception Summary
Exception	Description
ImParsingException	Exception thrown in case of an error when creating an internal query entry list by the class `SearchQueryBuilderIM`.

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

Provides functions for searching and textmining.

Changes between major releases 7.0 and 7.X

Added classes:
DistributionParameter
SearchQueryBuilderIM
ImParsingException
Changed classes:
IFederatedSearch
IQueryEntry
IQueryEntryList
IRawSearchResult
ISearchIndexCollection
ISearchResult
AbstractSearchIndexCollection
DefaultQueryExtender
TestQueryExtender

Package Specification

Purpose

The search package contains interfaces and abstract classes, which offer search and textmining functions that are provided by indexes. The main interfaces are ISearchIndex and IFederatedSearch.