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.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class Navigation
Public Class Navigation
public ref class Navigation
Members| All Members | Methods | Properties | |||
| Icon | Member | Description |
|---|---|---|
 | AggrERecs |
Gets the aggregated records associated with this navigation query,
which come from the original records consolidated by a rollup key.
|
| AggrERecsOffset |
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.
|
| AnalyticsQueryError |
Gets or sets the error message, if any, associated with the evaluation of
the analytics portion of the query results. This method reports
any errors that span multiple statements; it does NOT report errors
relating to an individual statement.
|
| AnalyticsStatementNames |
Gets the set of statement names included in the analytics results
associated with this Navigation.
|
| BulkAggrERecEnumerator |
Gets an Enumerator that provides access to the bulk aggregated
records associated with this navigation query.
|
| BulkERecEnumerator |
Gets an Enumerator that provides access to the bulk records associated
with this navigation query.
|
| CompleteDimensions |
Gets the complete dimensions integrated from the refinement
dimensions, the descriptor dimensions, and those that are
completely implicit.
|
| CompleteDimGroups |
Gets the dimension groups of the complete dimensions integrated
from the refinement
dimensions, the descriptor dimensions, and those that are
completely implicit.
|
| DescriptorDimensions |
Gets the dimensions for the descriptors for this navigation.
|
| DescriptorDimGroups |
Gets the dimension groups of the dimensions for the descriptors
for this navigation.
|
 | Equals(Object) | (Inherited from Object.) |
| ERecCompoundSearchKeys |
Gets the text search group keys applicable for this navigation.
|
| ERecs |
Gets the records associated with this navigation query.
|
| ERecSearchKeys |
Gets the text search keys applicable for this navigation.
|
| ERecsOffset |
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.
|
| ESearchReports |
Gets the IDictionary of ESearchReports for this
navigation query result. Returns an empty set if there are no
ESearchReports |
| ESearchReportsComplete |
Gets the IDictionary of IList of ESearchReportfor this
navigation query result. Returns an empty set if there are no
ESearchReports |
 | Finalize()() | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetActiveSortKeys()() |
Gets the active sort keys applicable for this navigation.
|
| GetAnalyticsStatementResult(String) |
Returns the AnalyticsStatementResult for the named query.
If results for the named analytics query does not exist,
null is returned.
|
| GetHashCode()() | Serves as a hash function for a particular type. GetHashCode()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) |
| GetType()() | Gets the Type of the current instance. (Inherited from Object.) |
| IntegratedDimensions |
Gets the dimensions integrated from the refinement dimensions and
the descriptor dimensions.
|
| IntegratedDimGroups |
Gets the dimension groups of the dimensions integrated from the
refinement and descriptor dimensions.
|
| KeyProperties |
Gets or Sets the key properties request for the navigation query.
|
| MemberwiseClone()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
| RangeFilters |
Gets the range filters applied to this navigation query result.
|
| RefinementDimensions |
Gets the dimensions of that still have refinements available with
respect to this query.
|
| RefinementDimGroups |
Gets the dimension groups of the dimensions that still have
refinements available with respect to this navigation query.
|
| RollupKeys |
Gets the rollup keys applicable for this navigation.
|
| SortKeys |
Gets the sort keys applicable for this navigation.
|
| Supplements |
Gets the supplements to this navigation query result.
|
| ToString()() | (Inherited from Object.) |
| TotalNumAggrERecs |
Gets the total number of aggregated records matching navigation query.
|
| TotalNumERecs |
Gets the total number of records matching navigation query.
|
Remarks
A Navigation object is defined by the set of dimension values that
were used to query the 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 refinement and descriptor dimensions. Lastly all three sets of dimensions are available consolidated by their dimensions groups via the RefinementDimGroups, DescriptorDimGroups, and IntegratedDimGroups properties.
Inheritance Hierarchy| Object | |
 | Navigation |