com.endeca.navigation
Class ENEQueryResults

java.lang.Object
  com.endeca.navigation.ENEQueryResults

public class ENEQueryResults
extends Object

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

getNavigation

public Navigation getNavigation()

Gets the navigation object result.

Returns:

Navigation object or null if none is present.

getERec

public ERec getERec()

Gets the Endeca record for the result. If more than one record was requested, this method returns the first one. Use the getERecs method if more than one record was requested.

Returns:

The record (ERec object) requested or null if none was requested.

getERecs

public ERecList getERecs()

Gets the Endeca records for the result. If one or more records were requested, this method returns a record list containing all the records.

Returns:

ERecList object containing the records requested or null if none were requested.

getAggrERec

public AggrERec getAggrERec()

Gets the Endeca aggregated record object result.

Returns:

The aggregated record (AggrERec object) requested or null if none was requested.

getDimSearch

public DimSearchResult getDimSearch()

Deprecated. This method may not be available in future.

Gets the dimension search object result.

Returns:

Dimension search result (DimSearchResult object) or null if none is present.

getDimensionSearch

public DimensionSearchResult getDimensionSearch()

Gets the dimension search object result.

Returns:

Dimension search result (DimensionSearchResult object) or null if none is present.

containsNavigation

public boolean containsNavigation()

Indicates whether this query results object contains a Navigation object.

Returns:

true if a Navigation object is present, or false if not.

containsERecs

public boolean containsERecs()

Indicates whether this query results object contains one or more Endeca records.

Returns:

true if at least one Endeca record (ERec object) is present, or false if not.

containsERec

public boolean containsERec()

Indicates whether this query results object contains an Endeca record. Same as the containsERecs method but present for the single record request case for completeness.

Returns:

true if an Endeca record (ERec object) is present, or false if not.

containsAggrERec

public boolean containsAggrERec()

Indicates whether this query results object contains an Endeca aggregated record.

Returns:

true if an aggregated record (AggrERec object) is present, or false if not.

containsDimSearch

public boolean containsDimSearch()

Indicates whether this query results object contains a dimension search results object.

Returns:

true if a dimension search results object is present, or false if not.

containsDimensionSearch

public boolean containsDimensionSearch()

Indicates whether this query results object contains a dimension search results object.

Returns:

true if a DimensionSearchResult object is present, or false if not.

getTotalNetworkAndComputeTime

public double getTotalNetworkAndComputeTime()

Returns the total number of seconds spent waiting for the MDEX Engine to respond to all queries. The total time includes network communication time and computation time, plus the time spent waiting in the MDEX Engine's queue.

Returns:

The total time, in seconds, spent waiting for the MDEX Engine.