com.endeca.navigation

Class DimensionSearchResult

java.lang.Object

com.endeca.navigation.DimensionSearchResult

public class DimensionSearchResult
extends Object

Result class for a value search query. Class includes values queried for as well as other information about the query.

Method Summary

Modifier and Type	Method and Description
Object	get(int index) Gets the result group at position index.
DimensionSearchResultGroup	getDimensionSearchResultGroup(DimValIdList dimIds) Gets the dimension result group with ids in the list dimIds.
DimensionSearchResultGroup	getDimensionSearchResultGroup(long dimensionId) Gets the single-dimension result group with id dimensionId.
Map	getESearchReportsComplete() Gets the Map of Lists of ESearchReports for this dimension search result.
long	getNumResultGroups() Gets the number of result groups.
DimensionSearchResultGroupList	getResults() Gets the results grouped by dimension roots.
SupplementList	getSupplements() Gets the supplements to this navigation query result.
long	getTotalNumResults() Gets the total number of value results found even if not all of them were returned because of the parameters of the query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSupplements

public SupplementList getSupplements()

Gets the supplements to this navigation query result. Returns an empty set if there are no supplements.

Returns:

The supplements of this navigation.

getESearchReportsComplete

public Map getESearchReportsComplete()

Gets the Map of Lists of ESearchReports for this dimension search result. Returns an empty set if there are no ESearchReports.

Returns:

A Map of Lists of ESearchReport, keyed by the search term.

getResults

public DimensionSearchResultGroupList getResults()

Gets the results grouped by dimension roots. Returns an empty list if there are no results.

Returns:

The results grouped by dimension roots.

getTotalNumResults

public long getTotalNumResults()

Gets the total number of value results found even if not all of them were returned because of the parameters of the query.

Returns:

Total number of search results.

getNumResultGroups

public long getNumResultGroups()

Gets the number of result groups.

Returns:

Number of result groups.

get

public Object get(int index)

Gets the result group at position index. The object returned is of type DimensionSearchResultGroup.

Returns:

Dimension location group at index.

Throws:

IndexOutOfBoundsException - If the index is out of range.

getDimensionSearchResultGroup

public DimensionSearchResultGroup getDimensionSearchResultGroup(long dimensionId)

Gets the single-dimension result group with id dimensionId. Returns null if no group can be found with this dimension id.

Returns:

DimensionSearchResultGroup with a dimension id of dimensionId. Returns null if none can be found.

getDimensionSearchResultGroup

public DimensionSearchResultGroup getDimensionSearchResultGroup(DimValIdList dimIds)

Gets the dimension result group with ids in the list dimIds. Returns null if no group can be found with this dimension id.

Returns:

DimensionSearchResultGroup with dimension ids dimIds. Returns null if none can be found.