An object used for expressing queries to an Endeca MDEX Engine.
Declaration Syntax| C# | Visual Basic | Visual C++ |
[SerializableAttribute] public class ENEQuery
<SerializableAttribute> _ Public Class ENEQuery
[SerializableAttribute] public ref class ENEQuery
Members| All Members | Constructors | Methods | Properties | Fields | |
| Icon | Member | Description |
|---|---|---|
 | ENEQueryENEQueryNew()() |
Zero argument default constructor.
|
| AddSelection(String) |
Adds the field named fieldName to the set of fields that should
be returned for each record in the result set.
|
 | AggrERec | Obsolete.
Gets or sets the Id of the aggregated record to be queried for.
|
| AggrERecNavDescriptors |
Gets or sets the navigation values which the aggregated record will
be composed in relation to.
|
| AggrERecNavRangeFilters |
Gets or sets the navigation range filters which the aggregated record
will be composed in relation to.
|
| AggrERecNavRecordFilter |
Gets or sets the record filter which the aggregated record will be
composed in relation to.
|
| AggrERecRollupKey |
Gets or sets the rollup key the aggregated record is composed by.
|
| AggrERecSpec |
Gets or sets the specification of the aggregated record to be queried for.
|
| AggrERecStructureExpr |
Gets or sets the structure expression used to filter members of
the aggregated record.
|
  | ALL_ERECS_PER_AGGR |
All records that compose a aggregated record will be returned.
|
| AnalyticsQuery |
Gets and sets the AnalyticsQuery instance that represents the
Analytics query that will be sent to the MDEX Engine. On set, if the query is
malformed, it will not be set on the HttpENEConnection and a SyntaxException
is thrown. An AnalyticsQuery instance can be built
programmatically or by calling the parseQuery(String) method.
|
| ContainsAggrERecQuery()() |
Returns if this query includes a aggregated record query.
|
| ContainsDimSearchQuery()() |
Returns if this query includes a dimension search query.
|
| ContainsERecQuery()() |
Returns if this query includes a record query.
|
| ContainsERecsQuery()() |
Returns if this query includes a query for records.
|
| ContainsNavQuery()() |
Returns whether the query includes a navigation query.
|
| ContainsQuery()() |
Returns whether the query is querying for any of a navigation,
record, dimension search, or a value set search.
|
| DIM_SEARCH_ALL_DIM_VALUES |
All matches from dimension search will be returned from each dimension.
|
| DimSearchCompound |
Gets and sets whether dimension search will include compound results.
|
| DimSearchDimension |
Gets and sets the dimension which which the dimension search can
search from.
|
| DimSearchDimensions |
Gets and sets the dimensions which which the dimension search can
search from.
|
| DimSearchNavDescriptors |
Gets and sets the navigation values that describe a navigation state
that restrict the number of values that can be searched from.
|
| DimSearchNavRangeFilters |
Gets and sets the navigation range filters that restrict the
dimension search.
|
| DimSearchNavRecordFilter |
Gets and sets the record filter that will restrict the dimension
search results.
|
| DimSearchNavRecordStructureExpr |
Gets and sets the structure expression that will restrict the dimension
search results.
|
| DimSearchNumDimValues |
Gets and sets the number of values returned from each dimension
for value search.
|
| DimSearchOpts |
Gets and sets the option set that dimension search will use.
|
| DimSearchRankResults |
Gets and sets how the dimension search will order its results.
|
| DimSearchResultsOffset |
Gets and sets the offset with which the dimension search will begin returning
results per dimension.
|
| DimSearchTerms |
Gets and sets the search terms the dimension search will use.
|
| Equals(Object) | (Inherited from Object.) |
| ERec |
Sets the Id of the record to be queried for.
|
| ERecs |
Gets or sets the Ids of the records to be queried for.
|
 | 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.) |
| 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.) |
| GetNavActiveSortKeys()() |
Get the list of sort keys with which the navigation query's
records will be sorted.
|
| GetNavSortKey()() |
Gets the sort key with which the navigation query's records will be sorted.
|
| GetNavSortOrder()() |
Gets the sort order with which the navigation query's records
will be sorted.
|
| GetType()() | Gets the Type of the current instance. (Inherited from Object.) |
| KEY_PROPS_NONE |
Request that no key properties will be returned.
|
| LanguageId |
Gets and sets the ISO639 language code to be used for this query.
The language id is sent to the MDEX Engine when the query is
executed, and specifies the language of any text portion of the
query. For example: search terms.
|
| MAX_BULK_ERECS_AVAILABLE |
All the records that are associated with the current navigation
state should be returned through the bulk record iterator.
|
| MemberwiseClone()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
| NAV_SORT_ASCENDING |
Sort the navigation query's matching records in ascending order.
|
| NAV_SORT_DESCENDING |
Sort the navigation query's matching records in descending order.
|
| NavAggrERecsOffset |
Gets and sets the offset into the navigation aggregated record list for
navigation query.
|
| NavAllRefinements |
Gets and sets the query such that the navigation query will return with all
the refinements possible for all dimensions.
|
| NavDescriptors |
Gets and sets the navigation descriptor IDs describing the navigation object
to be queried for.
|
| NavERecSearchComputeAlternativePhrasings |
Gets and sets if the fulltext search should turn on the compute-autophrase feature.
|
| NavERecSearchDidYouMean |
Gets and sets if the fulltext search should turn on the did you mean feature.
|
| NavERecSearches |
Gets and sets the navigation record searches to perform on the records
of the navigation query.
|
| NavERecSearchRewriteQueryWithAnAlternativePhrasing |
Gets and sets if the fulltext search should turn on the rewrite-autophrase feature.
|
| NavERecsOffset |
Gets and sets the offset into the navigation record list for navigation query.
|
| NavERecsPerAggrERec |
Gets and sets the max number of records to be returned in each
aggregated record.
|
| NavExposedRefinements |
Gets and sets the set of refinements that should be exposed / returned
with the navigation query.
|
| NavKeyProperties |
Get and sets the number of key properties to be returned.
|
| NavMerchPreviewTime |
Gets and sets the merch preview time on this navigation query.
|
| NavMerchRuleFilter |
Gets and sets the merch rule filter on this navigation query.
|
| NavNumAggrERecs |
Gets and sets the max number of aggregated records returned for the
navigation query.
|
| NavNumBulkAggrERecs |
Gets and sets the max number of aggregated records returned
in bulk format for the navigation query.
If MAX_BULK_ERECS_AVAILABLE is passed to this method,
then all aggregated records for the navigation query will be returned.
|
| NavNumBulkERecs |
Gets and sets the max number of records returned in bulk format for the
navigation query. If MAX_BULK_ERECS_AVAILABLE is
passed to this method, then all records for the navigation query
will be returned.
|
| NavNumERecs |
Get and sets the max number of records returned for the navigation query.
|
| NavRangeFilters |
Gets and sets the navigation range filters on this navigation query.
|
| NavRecordFilter |
Gets and sets the record filters on this navigation query.
|
| NavRecordStructureExpr |
Gets and sets the structure expression on this navigation query.
|
| NavRefinementConfigs |
Gets and sets the list of dynamic refinement
configs to be used by the MDEX Engine.
|
| NavRelRankERecRank |
Gets and sets the navigation relevance ranking record search to perform on the records
of the navigation query.
|
| NavRelRankERecSearch |
Gets and sets the navigation relevance ranking record search to perform on the records
of the navigation query.
|
| NavRollupKey |
Gets and sets the rollup key with which the records of the navigation
query should be rolled up with to create aggregated records.
|
| ONE_EREC_PER_AGGR |
One of the records that compose a aggregated record will be returned.
|
| Profiles |
Gets and sets the set of profiles that describe
the application end user.
|
| QueryInfo |
Gets and sets the ENEQueryInfo object.
|
| Selection |
Gets and sets the select list for the query.
|
| SetNavActiveSortKeys(ERecSortKeyList) |
Set the list of sort keys with which the navigation query's
records will be sorted.
|
| SetNavSortKey(String) |
Sets the sort key with which the navigation query's records will be sorted.
|
| SetNavSortOrder(Int32) |
Sets the sort order with which the navigation query's records will be sorted.
|
| ToString()() | (Inherited from Object.) |
| ZERO_ERECS_PER_AGGR |
None of the records that compose a aggregated record will be returned.
|
Remarks
An ENEQuery object is used with a Query method
(of HttpENEConnection or AuthHttpENEConnection)
to query an MDEX Engine, which then returns an
ENEQueryResults object.
The ENEQuery object can contain one of each of the following: a record query, a navigation query, an aggregated record query, a dimension search query, and/or a navigation search.
While there are many query options, only a few critical setters are necessary to make basic queries:
- Basic navigation queries require a setting NavDescriptors.
- Basic record queries require a setting ERec.
- Basic aggregated record queries require setting AggrERec, AggrERecRollupKey, and AggrERecNavDescriptors.
- Basic dimension search queries require a setting DimSearchTerms.
Inheritance Hierarchy| Object | ||
 | ENEQuery | |
| UrlENEQuery | |