oracle.ecsf
Interface HitsMetaData

public interface HitsMetaData

Since:

11.gr2

Version:

$Header: fxtn/modules/ecsf/src/java/oracle/ecsf/HitsMetaData.java /main/5 2010/05/19 10:15:15 sraffane Exp $ HitsMetaData defines meta data of a search query. The instance can be created and passed to a search engine, where user can specify filters, hits per page etc. On return, the instance contains information such as number of hits, time spent, and other meta data of the search results, including spelling, error message etc.

Field Summary

static java.lang.String	RCS_ID
static boolean	RCS_ID_RECORDED

Method Summary

java.lang.String	getAltKeywords() Returns comma delimited alternate keywords for the query string used
java.lang.String	getErrorMessage() Returns the error message for this search
Facet[]	getFacets() Returns the facets applicable to the searchable object
java.util.List	getFilters() Returns the filters used for the query
int	getHits() Returns the estimated total number of hits for the query performed This is not the number of hits returned to the user
int	getHitsPerPage() Returns the number of entries per page
int	getPage() Returns the page number of the current hits
int	getPages() Returns the number of pages
java.lang.String	getQuery() Returns the query string for the search
QueryMetaData	getQueryMetaData() Returns the query metadata for the search
SearchableGroup[]	getSearchableGroups() Returns the searchable groups for this search
long	getTimeSpent() Returns the time spent in ms for a given search
boolean	isError() Returns the error status for the search
void	setError(boolean error) Flags that the search resulted in error
void	setErrorMessage(java.lang.String errorMessage) Sets the error message for this search, used by the searcher.

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

getHitsPerPage

int getHitsPerPage()

Returns the number of entries per page

Returns:

int - entries per page

getHits

int getHits()

Returns the estimated total number of hits for the query performed This is not the number of hits returned to the user

Returns:

int - number of hits.

getPages

int getPages()

Returns the number of pages

Returns:

int - number of pages

getTimeSpent

long getTimeSpent()

Returns the time spent in ms for a given search

Returns:

long - time spent

getPage

int getPage()

Returns the page number of the current hits

Returns:

int - page number

getFilters

java.util.List getFilters()

Returns the filters used for the query

Returns:

List - filters

getQuery

java.lang.String getQuery()

Returns the query string for the search

Returns:

String - query string

getQueryMetaData

QueryMetaData getQueryMetaData()

Returns the query metadata for the search

Returns:

QueryMetaData - query metadata object

setError

void setError(boolean error)

Flags that the search resulted in error

Parameters:

error -

isError

boolean isError()

Returns the error status for the search

Returns:

boolean - whether the search resulted in an error

setErrorMessage

void setErrorMessage(java.lang.String errorMessage)

Sets the error message for this search, used by the searcher. Internal use only.

Parameters:

errorMessage -

getErrorMessage

java.lang.String getErrorMessage()

Returns the error message for this search

Returns:

String - error message if any

getSearchableGroups

SearchableGroup[] getSearchableGroups()

Returns the searchable groups for this search

Returns:

SearchableGroup[] searchable groups

getAltKeywords

java.lang.String getAltKeywords()

Returns comma delimited alternate keywords for the query string used

Returns:

String alternate keywords

getFacets

Facet[] getFacets()

Returns the facets applicable to the searchable object

Returns:

Facets[]