oracle.ecsf
Interface SearchHits

public interface SearchHits

Search hits of a given search. This is returned by the search engine upon a request of search.

Field Summary

static java.lang.String	RCS_ID
static boolean	RCS_ID_RECORDED

Method Summary

void	addDocument(IndexedDocument doc) Adds document to the hits.
int	getCount() Returns number of documents returned.
IndexedDocument	getDocument(int i) Returns ith document in the hit list
HitsMetaData	getHitsMetaData() Returns meta data for this search hits.

Field Detail

RCS_ID

static final java.lang.String RCS_ID

See Also:

Constant Field Values

RCS_ID_RECORDED

static final boolean RCS_ID_RECORDED

Method Detail

getDocument

IndexedDocument getDocument(int i)

Returns ith document in the hit list

Parameters:

i - index.

getCount

int getCount()

Returns number of documents returned. This is not the total hits of the search, rather documents per page. To obtain total hits, one can call HitsMetaData.getHits.

See Also:

for more details.

addDocument

void addDocument(IndexedDocument doc)

Adds document to the hits. This is used internally by the searcher to constuct the list.

Parameters:

doc - an indexable document constructed from information retrieved from index store.

getHitsMetaData

HitsMetaData getHitsMetaData()

Returns meta data for this search hits.

Returns:

meta data for this search.