|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.navigation.ENEQueryResults
public class ENEQueryResults
Result object returned from a query to an Endeca MDEX Engine.
The ENEQueryResults
object is returned by the query
method
of the HttpENEConnection
and AuthHttpENEConnection
classes.
The ENEQueryResults
object encapsulates these four objects:
Navigation
, ERecList
, AggrERec
,
and DimensionSearchResult
. The ENEQueryResults
object
also contains the total time (in seconds) that was spent waiting for the
MDEX Engine to respond.
Method Summary | |
---|---|
boolean |
containsAggrERec()
Indicates whether this query results object contains an Endeca aggregated record. |
boolean |
containsDimensionSearch()
Indicates whether this query results object contains a dimension search results object. |
boolean |
containsDimSearch()
Indicates whether this query results object contains a dimension search results object. |
boolean |
containsERec()
Indicates whether this query results object contains an Endeca record. |
boolean |
containsERecs()
Indicates whether this query results object contains one or more Endeca records. |
boolean |
containsNavigation()
Indicates whether this query results object contains a Navigation object. |
AggrERec |
getAggrERec()
Gets the Endeca aggregated record object result. |
DimensionSearchResult |
getDimensionSearch()
Gets the dimension search object result. |
DimSearchResult |
getDimSearch()
Deprecated. This method may not be available in future. |
ERec |
getERec()
Gets the Endeca record for the result. |
ERecList |
getERecs()
Gets the Endeca records for the result. |
Navigation |
getNavigation()
Gets the navigation object result. |
double |
getTotalNetworkAndComputeTime()
Returns the total number of seconds spent waiting for the MDEX Engine to respond to all queries. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public Navigation getNavigation()
Navigation
object or null
if none is present.public ERec getERec()
getERecs
method if more than one record was requested.
ERec
object) requested or null
if none was requested.public ERecList getERecs()
ERecList
object containing the records requested or null
if none were requested.public AggrERec getAggrERec()
AggrERec
object) requested or null
if
none was requested.public DimSearchResult getDimSearch()
DimSearchResult
object)
or null
if none is present.public DimensionSearchResult getDimensionSearch()
DimensionSearchResult
object)
or null
if none is present.public boolean containsNavigation()
true
if a Navigation
object is present,
or false
if not.public boolean containsERecs()
true
if at least one Endeca record
(ERec
object) is present, or
false
if not.public boolean containsERec()
containsERecs
method but
present for the single record request case for completeness.
true
if an Endeca record (ERec
object) is present,
or false
if not.public boolean containsAggrERec()
true
if an aggregated record (AggrERec
object) is present,
or false
if not.public boolean containsDimSearch()
true
if a dimension search results object is present,
or false
if not.public boolean containsDimensionSearch()
true
if a DimensionSearchResult
object is present,
or false
if not.public double getTotalNetworkAndComputeTime()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |