An object used for formulating queries to an Endeca MDEX Engine
through the use of an input URL.
Namespace: Endeca.NavigationAssembly: Endeca.Navigation (in Endeca.Navigation.dll) Version: 6.2.0.0 (6.2.2.8614)
Syntax
| C# |
|---|
[SerializableAttribute] public class UrlENEQuery : ENEQuery |
| Visual Basic |
|---|
<SerializableAttribute> _ Public Class UrlENEQuery _ Inherits ENEQuery |
| Visual C++ |
|---|
[SerializableAttribute] public ref class UrlENEQuery : public ENEQuery |
Remarks
A direct subclass of ENEQuery, UrlENEQuery
allows an application to pass in an request URL's query string and
autopopulate the query fields to automatically query the MDEX
Engine objects specified in the URL. Like the ENEQuery
superclass, a UrlENEQuery can express a request
for a navigation, a record, a value search, and/or a value set search.
Navigation Query
| Parameter Name | Parameter Value Format | ENEQuery Method | |
|---|---|---|---|
| N | Either 0 (zero) for a root navigation request, or one or more dimension value IDs. | NavDescriptors | |
| Nao | A number indicating the starting index of an aggregated record list. | NavAggrERecsOffset | |
| Ne | Either 0 indicating no refinement values are returned for any dimensions, or one or more dimension value IDs indicating which dimension navigation refinements will be exposed. | NavExposedRefinements | |
| Nf |
Sets a range filter with one of these formats:
 CopyC#<i>key</i>|LT+<i>number</i><br /><i>key</i>|LTEQ+<i>number</i><br /><i>key</i>|GT+<i>number</i><br /><i>key</i>|GTEQ+<i>number</i><br /><i>key</i>|BTWN+<i>num1</i>+<i>num2</i><br /><i>key</i>|GCLT+<i>lat</i>,<i>lon</i>+<i>number</i><br /><i>key</i>|GCGT+<i>lat</i>,<i>lon</i>+<i>number</i><br /><i>key</i>|GCBTWN+<i>lat</i>,<i>lon</i>+<i>num1</i>+<i>num2</i> | NavRangeFilters | |
| Nk | Specify none to request that no key properties be returned. | NavNumAggrERecs | |
| No | A number indicating the starting index of a record list. | NavERecsOffset | |
| Np | Either 0 (no records are returned with each aggregated record), 1 (only a single representative record is returned with each aggregate record), or 2 (all records are returned with each aggregated record). | NavERecsPerAggrERec | |
| Nr | The record filter for the navigation query. | NavRecordFilter | |
| Nrc |
The dynamic refinement configs for the navigation query.
Each dynamic refinement config is delimited by the pipe character
and must have the CopyC#id CopyC#defalut CopyC#defaultCopyC#staticCopyC#dynamic CopyC#defaultCopyC#default | N=0&Nrc=id+134711+exposed+true+dynrank+enabled+dyncount+default+dynorder+dynamic+showcounts+true|id+132830+dyncount+7 | NavRefinementConfigs |
| Nrs | The structure expression for the navigation query. | NavRecordFilter | |
| Ns | One or more sort keys (properties or dimensions) for a Navigation object's record list. Optionally, each sort key can specify a sort order of 0 (ascending sort, the default) or 1 (descending sort). | SetNavActiveSortKeys(ERecSortKeyList) | |
| Ntk | One or more search keys (properties or dimensions), each delimited by the pipe character. | NavERecSearches | |
| Ntpc | 1 (to turn on the computed alternative phrasings feature for a record search) or 0 (to turn it off). 0 is the default. | NavERecSearchComputeAlternativePhrasings | |
| Ntpr | 1 (to use a computed alternative phrasing for a record search) or 0 (to use the end user's original query). 0 is the default. | NavERecSearchRewriteQueryWithAnAlternativePhrasing | |
| Ntt | One or more terms for a record search. Each term is delimited by a plus sign, and each set of terms is delimited by the pipe character. | NavERecSearches | |
| Nx | Options for navigation queries (other than options for record search, which are handled by Ntx). | NavOpts | |
| Ntx | One or more sets of options for record search in the navigation query. These options include search mode, relevance ranking, and the snip and nosnip operators. Each set of options is delimited by the pipe character. | NavERecSearches | |
| Nty | 1 (to turn on the "Did You Mean" feature for a record search) or 0 (to turn it off). 0 is the default. | NavERecSearchDidYouMean | |
| NrkThe search key for relevance ranking record searchNavRelRankERecRank | NrtOne or more terms for relevance ranking record search. Each term is delimited by a plus sign. NavRelRankERecRank | NrrThe relevance ranking strategy to use with relevance ranking record search. NavRelRankERecRank | NrmThe match mode to use with relevance ranking record search. NavRelRankERecRank |
| Nu | A property or dimension to be used as a rollup key for aggregated records. | NavRollupKey |
Record Query
| Parameter Name | Parameter Value Format | ENEQuery Method |
|---|---|---|
| R | One or more Endeca record IDs. | ERecs |
Aggregated Record Query
| Parameter Name | Parameter Value Format | ENEQuery Method |
|---|---|---|
| A | The record specification of the Endeca aggregated record. | AggrERecSpec |
| Af | One or more aggregated record navigation range filters. See the Nf parameter for the format. | AggrERecNavRangeFilters |
| An | One or more dimension value IDs. | AggrERecNavDescriptors |
| Ar | The record filter for the aggregated record navigation query. | AggrERecNavRecordFilter |
| Ars | The structure expression for the aggregated record query. | AggrERecStructureExpr |
| Au | A property or dimension to be used as a rollup key for aggregated records. | AggrERecRollupKey |
| As | A sort specification to be used to order representative records | AggrERecActiveSortKeys |
Dimension Search Query
| Parameter Name | Parameter Value Format | ENEQuery Method | |
|---|---|---|---|
| D | The dimension search query terms. | DimSearchTerms | |
| Df | One or more dimension search range filters. See the Nf parameter for the format. | DimSearchNavRangeFilters | |
| Di | One or more IDs of dimensions to search against. | DimSearchDimensions | |
| Dk | 0 means means default dimension value ranking is used to order dimension search results, while 1 means relevance ranking is used. | DimSearchRankResults | |
| Dn | One or more dimension value IDs. | DimSearchNavDescriptors | |
| Do | A number indicating the offset with which the dimension search will begin returning results per dimension. | DimSearchResultsOffset | |
| Dp | The number of dimension value matches to return per dimension. | DimSearchNumDimValues | |
| Dr | The record filter for the dimension search navigation query. | DimSearchNavRecordFilter | |
| Drc |
The dynamic refinement configs for the dimension search query.
Each dynamic refinement config is delimited by the pipe character
and must have the CopyC#id | D=1*&Drc=id+134711+showcounts+true|id+132830+showcounts+false | DimSearchRefinementConfigs |
| Drs | The structure expression for the dimension search navigation query. | DimSearchNavRecordFilter | |
| Du | A property or dimension to be used as a rollup key for aggregated counts. | D=Merlot&Drc=id+1000+showcounts+true&Du=P_Winery | DimSearchRollupKey |
| Dx | The options for the dimension search operation. | DimSearchOpts |
Examples
The set methods of this query class are not meant to be usually called
through a direct method call. For example a UrlENEQuery could formulate
a request for a navigation and a value search from the URL:
CopyC#
This example would express a
query to the MDEX Engine for the root navigation as well as a
value search for a value named "cadillac".
CopyC#
CopyC#controller.aspx?N=0&D=cadillacUrlENEQuery can be instantiated in a couple of ways in a ASP.NET and C# usage. For example:
CopyC#IENEConnection nec = new HttpENEConnection("engine.endeca.com", 5001); ENEQuery usq = new UrlENEQuery(Page.Request.Url.Query); QueryResults = nec.Query(usq);
