|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.navigation.DimensionSearchResult
public class DimensionSearchResult
Result class for a value search query. Class includes values queried for as well as other information about the query.
Method Summary | |
---|---|
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 |
getESearchReports()
Gets the Map of ESearchReports for this
dimension search result. |
Map |
getESearchReportsComplete()
Gets the Map of List s 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 |
---|
public SupplementList getSupplements()
public Map getESearchReports()
Map
of ESearchReports
for this
dimension search result. Returns an empty set if there are no
ESearchReports
.
Map
of ESearchReport
, keyed
by the search term.public Map getESearchReportsComplete()
Map
of List
s of ESearchReports
for this
dimension search result. Returns an empty set if there are no
ESearchReports
.
Map
of List
s of ESearchReport
, keyed
by the search term.public DimensionSearchResultGroupList getResults()
public long getTotalNumResults()
public long getNumResultGroups()
public Object get(int index)
index
.
The object returned is of type DimensionSearchResultGroup
.
index
.
IndexOutOfBoundsException
- If the index is out of range.public DimensionSearchResultGroup getDimensionSearchResultGroup(long dimensionId)
dimensionId
. Returns null
if no group can be found with this dimension id.
dimensionId
. Returns null
if none
can be found.public DimensionSearchResultGroup getDimensionSearchResultGroup(DimValIdList dimIds)
dimIds
. Returns null
if no group
can be found with this dimension id.
dimIds
. Returns null
if none
can be found.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |