|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.navigation.Navigation
public class Navigation
Top level object returned from an Endeca MDEX Engine. The Navigation
object
serves as a container for several components (such as navigation descriptors,
record set, etc.) that together compose a navigation,
A Navigation
object is defined by the set of dimension values that
were used to query an MDEX Engine to obtain the Navigation
object.
Those values are in the context of a Navigation
object defined as
descriptors, the values that describe the navigation query.
In addition, several other objects compose to make a dimension. The records which are the records that meet the query descriptor criteria. The aggregated records which are the same records but rolled up by a certain criteria. The various keys which describe options and operations available on the records. The refinements which are the navigational options that are available to refine the query.
The refinements and the descriptors are broken up by their individual
dimensions. There is a third set of dimensions called the integrated
dimensions which are the union of the refinment and descriptor
dimensions. Lastly all three sets of dimensions are available
consolidated by their dimensions groups via the
getRefinementDimGroups
,
getDescriptorDimGroups
, and
getIntegratedDimGroups
methods.
Method Summary | |
---|---|
ERecSortKeyList |
getActiveSortKeys()
Gets the sort keys in use for this navigation. |
AggrERecList |
getAggrERecs()
Gets the composite records associated with this navigation query, which come from the original records consolidated by a rollup key. |
long |
getAggrERecsOffset()
Gets the offset of the first aggregated record in the aggregated record list with respect to the total number of aggregated records in the dataset that match this navigation query. |
String |
getAnalyticsQueryError()
Gets the error message, if any, associated with the evaluation of the Analytics portion of the query results. |
SortedSet |
getAnalyticsStatementNames()
Get the set of statement names included in the Analytics results associated with this Navigation . |
AnalyticsStatementResult |
getAnalyticsStatementResult(String name)
Gets an AnalyticsStatementResult that provides access to the data
associated with the named Analytics query. |
Iterator |
getBulkAggrERecIter()
Gets an Iterator that provides access to the bulk composite records associated with this navigation query, which come from the original records consolidated by a rollup key. |
Iterator |
getBulkERecIter()
Gets an Iterator that provides access to the bulk
records associated with this navigation query. |
DimensionList |
getCompleteDimensions()
Gets the complete dimensions integrated from the refinement dimensions, the descriptor dimensions, and those that are completely implicit. |
DimGroupList |
getCompleteDimGroups()
Gets the dimension groups of the complete dimensions integrated from the refinement dimensions, the descriptor dimensions, and those that are completely implicit. |
DimensionList |
getDescriptorDimensions()
Gets the dimensions for the descriptors for this navigation. |
DimGroupList |
getDescriptorDimGroups()
Gets the dimension groups of the dimensions for the descriptors for this navigation. |
ERecCompoundSearchKeyList |
getERecCompoundSearchKeys()
Gets the text search group keys applicable for this navigation. |
ERecList |
getERecs()
Gets the records associated with this navigation query. |
ERecSearchKeyList |
getERecSearchKeys()
Gets the text search keys applicable for this navigation. |
long |
getERecsOffset()
Gets the offset of the first record in the endeca record list with respect to the total number of records in the dataset that match this navigation query. |
Map |
getESearchReports()
Gets the Map of ESearchReports for this
navigation query result. |
Map |
getESearchReportsComplete()
Gets the Map of List s of ESearchReports for this
navigation query result. |
DimensionList |
getIntegratedDimensions()
Gets the dimensions integrated from the refinement dimensions and the descriptor dimensions. |
DimGroupList |
getIntegratedDimGroups()
Gets the dimension groups of the dimensions integrated from the refinement and descriptor dimensions. |
Map |
getKeyProperties()
Gets the Map of KeyProperties for this
navigation query result. |
RangeFilterList |
getRangeFilters()
Gets the range filters applied to this navigation query result. |
DimensionList |
getRefinementDimensions()
Gets the dimensions of that still have refinements available with respect to this query. |
DimGroupList |
getRefinementDimGroups()
Gets the dimension groups of the dimensions that still have refinements available with respect to this navigation query. |
ERecRollupKeyList |
getRollupKeys()
Gets the rollup keys applicable for this navigation. |
ERecSortKeyList |
getSortKeys()
Gets the sort keys applicable for this navigation. |
SupplementList |
getSupplements()
Gets the supplements to this navigation query result. |
long |
getTotalNumAggrERecs()
Gets the total number of aggregated records matching navigation query. |
long |
getTotalNumERecs()
Gets the total number of records matching navigation query. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public ERecList getERecs()
ERecList
is
still returned.public Iterator getBulkAggrERecIter()
Iterator
is returned.public Iterator getBulkERecIter()
Iterator
that provides access to the bulk
records associated with this navigation query.
Iterator
interface. If no bulk records have been
requested (i.e. if setNavNumBulkERecs
has not been
called with a non-zero argument), a null Iterator
is
returned.public SortedSet getAnalyticsStatementNames()
Navigation
.
Set
containing the String
names
of Analytics results associated with this Navigation
,
in alphabetical order.
If no Analytics results are available, an empty Set is returned.public String getAnalyticsQueryError()
String
error message, or null if no
error was encountered.public AnalyticsStatementResult getAnalyticsStatementResult(String name)
AnalyticsStatementResult
that provides access to the data
associated with the named Analytics query.
public AggrERecList getAggrERecs()
AggrERecList
is returned.public long getERecsOffset()
0
if no records are in result.public long getAggrERecsOffset()
0
if no aggregated records are in
result.public long getTotalNumERecs()
public long getTotalNumAggrERecs()
public ERecSortKeyList getSortKeys()
ERecSortKeyList
will
be returned.public ERecSortKeyList getActiveSortKeys()
getSortKeys()
because this method returns
only those sort keys that were actually used for sorting
the records returned in this naviagation, while getSortKeys()
returns all keys marked as sortable in
the Endeca Developer Studio.
public ERecRollupKeyList getRollupKeys()
ERecRollupKeyList
will
be returned.public ERecSearchKeyList getERecSearchKeys()
ERecSearchKeyList
will
be returned.public ERecCompoundSearchKeyList getERecCompoundSearchKeys()
ERecCompoundSearchKeyList
will be returned.public RangeFilterList getRangeFilters()
RangeFilterList
,
but the list may be empty if no range filters were applied.
RangeFilterList
will always be returned.public DimensionList getDescriptorDimensions()
ENEQueryToolkit.selectRefinement
which places the
descriptors in selection order, that is the order with which the
user made their selections.
public DimGroupList getDescriptorDimGroups()
getDescriptorDimensions()
except that the dimensions
are grouped by their dimension groups. Returns an empty
dimension group list if there are no descriptors. Unlike the
descriptor dimensions, these dim groups are presented in
MDEX Engine determined dimension order as opposed to the
query specified descriptor order.
public DimensionList getRefinementDimensions()
public DimGroupList getRefinementDimGroups()
getRefinementDimensions
except that they are grouped by their dimension groups.
Returns an empty dimension group list if there are no more
refinements available. The dimension groups are in MDEX
Engine determined order where the group with the highest
ranking dimension is persented first and so on.
public DimensionList getIntegratedDimensions()
public DimGroupList getIntegratedDimGroups()
getIntegratedDimensions
except that the dimensions are
consolidated by DimGroup
. Returns an empty set
if there are neither refinement nor descriptor dimensions. The
dimension groups are in dimension group order determined by the
MDEX Engine where the dimension group with the highest ranking
dimension is placed first and so on.
public DimensionList getCompleteDimensions()
public DimGroupList getCompleteDimGroups()
getCompleteDimensions
except that the dimensions are
consolidated by DimGroup
.
That is, complete dimensions are the
dimensions that either have descriptors, still have refinement
values relative to the navigation query, or only contain implicits.
The integrated dimensions are in dimension order specified by
the MDEX Engine.
public SupplementList getSupplements()
public Map getESearchReports()
Map
of ESearchReports
for this
navigation query 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
navigation query result. Returns an empty set if there are no
ESearchReports
.
Map
of List
s of ESearchReport
, keyed
by the search term.public Map getKeyProperties()
Map
of KeyProperties
for this
navigation query result. Returns null if KeyProperties were not
requested.
Map
of KeyProperties
objects,
keyed by the String
name for the key.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |