oracle.ecsf
Interface Searcher

public interface Searcher

Searcher is responsible for performing searches. The implementation is created by an search engine instance which is implemented for a specific search engine.

Method Summary

void	addFilter(java.lang.String filterName, java.lang.String filterValue, java.lang.String dataType, java.lang.String operator) Add field filters to the Searcher
void	addFilters(java.util.List<FieldFilter> filters) Add field filters to the Searcher
IndexedDocument	createIndexedDocument(SearchContext ctx, java.util.Map attributes) Creates an engine implementation of indexed document based on a list attribute values.
HitsMetaData	getHitsMetaData() Retruns the hit meta data per search.
SearchHits	search(SearchContext ctx, QueryMetaData queryMetaData) Returns a search hits for a given query.

Method Detail

getHitsMetaData

HitsMetaData getHitsMetaData()

Retruns the hit meta data per search.

Returns:

HitMetaData meta data of a result set.

search

SearchHits search(SearchContext ctx,
                  QueryMetaData queryMetaData)
                  throws SearchException

Returns a search hits for a given query. @see QueryMetaData

Parameters:

ctx - the runtime context.

queryMetaData - the query data

Returns:

SearchHits for the query. Returns null if fails by underline search engine.

Throws:

SearchException

createIndexedDocument

IndexedDocument createIndexedDocument(SearchContext ctx,
                                      java.util.Map attributes)

Creates an engine implementation of indexed document based on a list attribute values.

Parameters:

ctx - the runtime search context and a searchable object must be assigned to the context. If not, an IllegalStateException will be thrown.

attributes - custom attribute values hashed agaist field attribute name.

Returns:

an indexed document.

Throws:

java.lang.IllegalStateException - if ctx is not assigned with a searchable object.

addFilter

void addFilter(java.lang.String filterName,
               java.lang.String filterValue,
               java.lang.String dataType,
               java.lang.String operator)

Add field filters to the Searcher

Parameters:

filterName - name of the attribute used as filter

filterValue - filter value set for the attribute

dataType - attribute type

operator - ex: contains, greater than, less than

addFilters

void addFilters(java.util.List<FieldFilter> filters)

Add field filters to the Searcher

Parameters:

filters -