com.endeca.navigation
Class UrlENEQuery

java.lang.Object
  extended by com.endeca.navigation.ENEQuery
      extended by com.endeca.navigation.UrlENEQuery
All Implemented Interfaces:
Serializable

public class UrlENEQuery
extends ENEQuery
implements Serializable

An object used for formulating queries to an Endeca MDEX Engine through the use of an input URL. A direct subclass of ENEQuery, UrlENEQuery allows an application to pass in a 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, UrlENEQuery can express a request for a navigation query, a record query, an aggregated record query, a dimension search query, and/or a navigation state search.

For example a UrlENEQuery can formulate a request for a navigation and a dimension value search from the URL:

controller.jsp?N=0&D=cadillac
This example will express a query to the MDEX Engine for the root navigation, as well as a value search for a dimension value named "cadillac".

UrlENEQuery can be instantiated in two ways in a JSP usage. The first way is to use the two-argument UrlENEQuery constructor, as in this example:

<%
   ENEConnection nec = new HttpENEConnection("engine.endeca.com", 8000);
   ENEQuery usq = new UrlENEQuery(request.getQueryString(), "UTF-8");
   QueryResults = nec.query(usq);
%>
In this example, the fields of the of the ENEQuery are populated by the request query string.

The second way is to use the useBean syntax, as in this example:

<jsp:useBean id="usq" scope="request"
         class="com.endeca.navigation.UrlENEQuery"
         type="com.endeca.navigation.ENEQuery">
   <jsp:setProperty name="usq" property="*" />
</jsp:useBean>
<%
   QueryResults = nec.query(usq);
%>
In this example, the useBean action instantiated the query object with an empty constructor, but the setProperty * action actually populated the individual fields.

As seen with the useBean example, all setter methods of this class are expected to be DECODED from "x-www-form-urlencoded" form, as opposed to the contructor that takes the URL query string which is expected to be "x-www-form-urlencoded" ENCODED.

Note that the set* methods of this query class are not meant to be usually called through a direct method call, but instead automatically by the useBean JSP semantics.

The following table lists the URL parameters that can used in a request URL's query string.

Navigation Query

Parameter Parameter Value Format Example ENEQuery Setter Method
N
Either 0 (zero) for a root navigation request, or one or more dimension value IDs. N=0
N=132831+154283
setNavDescriptors
Nao A number indicating the starting index of an aggregated record list. N=0&Nao=3&Nu=ssn setNavAggrERecsOffset
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. N=132831+154283&Ne=0
N=132831+154283&Ne=134711
setNavExposedRefinements
Nf Sets a range filter with one of these formats:
key|LT+number
key|LTEQ+number
key|GT+number
key|GTEQ+number
key|BTWN+num1+num2
key|GCLT+lat,lon+number
key|GCGT+lat,lon+number
key|GCBTWN+lat,lon+num1+num2
N=101&Nf=Price|LT+25

N=0&Nf=Price|BTWN+8+15

N=0&Nf=Loc|GCLT+42.365615,-71.075647+10

setNavRangeFilters
Nk Either all or none. N=132831&Nu=P_Winery setNavKeyProperties
No A number indicating the starting index of a record list. N=132831+154283&No=20 setNavERecsOffset
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). N=0&Nu=ssn&Np=1 setNavERecsPerAggrERec
Nr The record filter for the navigation query. N=0&Nr=FILTER(MyFilter) setNavRecordFilter
Nrc The dynamic refinement configs for the navigation query.
Each dynamic refinement config is delimited by the pipe character and must have the id setting.

Settings for a dynamic refinement config are:
- id: The dimension value id.
- exposed: Whether to expose the dimension value's refinements.
Valid values are true which indicates exposed and false which indicates not exposed. Defaults to exposed.
- dynrank: Whether the dimension value has Dynamic Ranking enabled.
Valid values are enabled, disabled or default.
- dyncount: The maximum number of dimension values to return.
Valid values are integers >= 0 or default.
- dynorder: Dynamic Ranking sort order.
Valid values are static, dynamic or default.

Omission of a setting or specifying the value default results in using the setting in Developer Studio.
N=0&Nrc=id+134711+exposed+true+dynrank+enabled
+dyncount+default+dynorder+dynamic|id+132830+dyncount+7
setNavRefinementConfigs
Ndr The disabled refinements config for the navigation query.

Settings for the disabled refinements config are:
- basedimid: An id of a dimension that is to be included in the base nav state. - eqlfilterinbase: A true or false value indicating whether the eql filter is part of the base nav state. - textsearchesinbase: A true or false value indicating whether text searches are part of the base nav state. - rangefiltersinbase: A true or false value indicating whether range filters are part of the base nav state.
N=134711+135689&Ntk=All&Ntt=television&Ndr=basedimid+100000+textsearchesinbase+true+eqlfilterinbase+false+rangefiltersinbase+false setNavDisabledRefinementsConfig
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). N=132831+154283&Ns=Price|1 setNavActiveSortKeys
Ntk One or more search keys (properties or dimensions), each delimited by the pipe character. N=0132831&Ntk=WineType&Ntt=merlot+2003 setNavERecSearches
Ntpc 1 (to turn on the computed alternative phrasings feature for a record search) or 0 (to turn it off). 0 is the default. N=0&Ntk=All&Ntt=napa&Nty=1&Ntpc=1 setNavERecSearchComputeAlternativePhrasings
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. N=0&Ntk=All&Ntt=napa&Nty=1&Ntpc=1&Ntpr=1 setNavERecSearchRewriteQueryToAnAlternativePhrasing
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. N=132831&Ntk=WineType&Ntt=merlot+2003 setNavERecSearches
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. N=0&Ntk=Brand&Ntt=Nike
&Ntx=mode+matchallany+rel+MyStrategy
setNavERecSearches
Nrk A search key (property or dimension). N=0132831&Nrk=WineType&Nrt=merlot+2003 setNavRelRankERecRank
Nrt One or more terms for a relevance ranking record search. Each term is delimited by a plus sign. N=132831&Nrk=WineType&Nrt=merlot+2003 setNavRelRankERecRank
Nrr A strategy for relevance ranking record search in the navigation query. N=0&Nrk=Brand&Nrt=Nike
&Nrr=MyStrategy
setNavRelRankERecRank
Nrm A match mode for relevance ranking record search in the navigation query. N=0&Nrk=Brand&Nrt=Nike
&Nrr=MyStrategy&Nrm=matchall
setNavRelRankERecRank
Nty 1 (to turn on the "Did You Mean" feature for a record search) or 0 (to turn it off). 0 is the default. N=0&Ntk=WineType&Ntt=merlot+2003&Nty=1 setNavERecSearchDidYouMean
Nu A property or dimension to be used as a rollup key for aggregated records. N=132831&Nu=P_Winery setNavRollupKey

Record Query

Parameter Parameter Value Format Example ENEQuery Setter Method
R One or more Endeca record specs. R=66091 setERecs

Aggregated Record Query

Parameter Parameter Value Format Example ENEQuery Setter Method
A The record specification of the Endeca aggregated record. A=7&An=123&Au=ssn setAggrERecSpec
Af One or more aggregated record navigation range filters. See the Nf parameter for the format. A=7&An=123&Au=ssn&Af=Base|GT+100000 setAggrERecNavRangeFilters
An One or more dimension value IDs. A=7&An=123&Au=ssn setAggrERecNavDescriptors
Ar The record filter for the aggregated record navigation query. A=2496&An=0&Au=sku&Ar=OR(10001,20099) setAggrERecNavRecordFilter
Ars The structure expression for the aggregated record query. A=2496&An=0&Au=sku&Ars=fn:collection()/record[fn:true()] setAggrERecStructureExpr
Au A property or dimension to be used as a rollup key for aggregated records. A=7&An=123&Au=ssn setAggrERecRollupKey
As a sort specification As=propertyA|0||propertyB|1 setAggrERecActiveSortKeys

Dimension Search Query

Parameter Parameter Value Format Example ENEQuery Setter Method
D The dimension search query terms. D=Red+White setDimSearchTerms
Df One or more dimension search range filters. See the Nf parameter for the format. D=Merlot&Df=Price|LT+11 setDimSearchNavRangeFilters
Di One or more IDs of dimensions to search against. D=Merlot&Di=11378 setDimSearchDimensions
Dk 0 means default dimension value ranking is used to order dimension search results while 1 means relevance ranking is used. D=Merlot&Dk=1 setDimSearchRankResults
Dn One or more dimension value IDs. D=Merlot&Dn=132831 setDimSearchNavDescriptors
Do A number indicating the offset with which the dimension search will begin returning results per dimension. D=Merlot&Di=11378&Dp=4&Do=3 setDimSearchResultsOffset
Dp The number of dimension value matches to return per dimension. D=Merlot&Di=11378&Dp=3 setDimSearchNumDimValues
Dr The record filter for the dimension search navigation query. D=Hawaii&Dn=0&Dr=NOT(Subject:Travel) setDimSearchNavRecordFilter
Dx The options for the dimension search operation. D=dickens&Dk=1&Dx=rel+exact,static(rank,descending) setDimSearchOpts

See Also:
Serialized Form

Field Summary
static String AGGR_EREC_NAV_DESCRIPTORS_PARAM
          Parameter name for aggregated record descriptors.
static String AGGR_EREC_NAV_RANGE_FILTERS_PARAM
          Parameter name for aggregated record navigation range filters.
static String AGGR_EREC_NAV_RECORD_FILTER_PARAM
          Parameter name for aggregated record navigation record filter.
static String AGGR_EREC_PARAM
          Parameter name for aggregated records.
static String AGGR_EREC_ROLLUP_KEY_PARAM
          Parameter name for aggregated record rollup keys.
static String AGGR_EREC_SORT_KEY_PARAM
          Parameter name for aggregated record sort key.
static String AGGR_EREC_STRUCTURE_EXPR_PARAM
          Parameter name for aggregated record structure expression.
static String ANALYTICS_PARAM
          Parameter name for Analytics query
static String DIM_SEARCH_DIMENSIONS_PARAM
          Parameter name for dimension search dimension.
static String DIM_SEARCH_NAV_DESCRIPTORS_PARAM
          Parameter name for dimension search navigation descriptors.
static String DIM_SEARCH_NAV_RANGE_FILTERS_PARAM
          Parameter name for dimension search navigation range filters.
static String DIM_SEARCH_NAV_RECORD_FILTER_PARAM
          Parameter name for dimension search navigation record filter.
static String DIM_SEARCH_NAV_RECORD_STRUCTURE_EXPR_PARAM
          Parameter name for dimension search navigation structure expressions.
static String DIM_SEARCH_NUM_DIM_VALUES_PARAM
          Parameter name for number of dimension values to return.
static String DIM_SEARCH_OPTS_PARAM
          Parameter name for dimension search options.
static String DIM_SEARCH_RANK_RESULTS_PARAM
          Parameter name for ranking dimension search results.
static String DIM_SEARCH_RESULTS_OFFSET_PARAM
          Parameter name for dimension search results offset.
static String DIM_SEARCH_TERMS_PARAM
          Parameter name for dimension search terms.
static String ERECS_PARAM
          Parameter name for records.
static String NAV_AGGR_ERECS_OFFSET_PARAM
          Parameter name for navigation aggregated record list offset.
static String NAV_DESCRIPTORS_PARAM
          Parameter name for navigation values.
static String NAV_DISABLED_REFINEMENTS_CONFIGS_PARAM
          Parameter name for disabled refinements config.
static String NAV_EREC_SEARCH_DID_YOU_MEAN_PARAM
          Parameter name for navigation record search Did You Mean.
static String NAV_EREC_SEARCH_KEYS_PARAM
          Parameter name for navigation record search keys.
static String NAV_EREC_SEARCH_OPTS_PARAM
          Parameter name for navigation record search option sets.
static String NAV_EREC_SEARCH_PHRASING_COMPUTE_PARAM
          Parameter name for navigation record search to compute alternative phrasings.
static String NAV_EREC_SEARCH_PHRASING_REWRITE_PARAM
          Parameter name for navigation record search to rewrite the query to an alternative phrasing.
static String NAV_EREC_SEARCH_TERMS_PARAM
          Parameter name for navigation record search term sets.
static String NAV_ERECS_OFFSET_PARAM
          Parameter name for navigation record list offset.
static String NAV_ERECS_PER_AGGR_EREC_PARAM
          Parameter name for navigation number of records per aggregated record.
static String NAV_KEY_PROPERTIES_PARAM
          Parameter name for navigation key properties.
static String NAV_MERCH_PREVIEW_TIME_PARAM
           
static String NAV_MERCH_RULE_FILTER_PARAM
           
static String NAV_RANGE_FILTERS_PARAM
          Parameter name for navigation range filters.
static String NAV_RECORD_FILTER_PARAM
          Parameter name for navigation record filters.
static String NAV_RECORD_STRUCTURE_EXPR_PARAM
          Parameter name for navigation record structure expressions.
static String NAV_REFINEMENT_CONFIGS_PARAM
          Parameter name for navigation refinement configs.
static String NAV_RELRANK_EREC_RANK_KEY_PARAM
          Parameter name for relevnace ranking record search key.
static String NAV_RELRANK_EREC_RANK_MATCHMODE_PARAM
          Parameter name for relevnace ranking record match mode.
static String NAV_RELRANK_EREC_RANK_STRATEGY_PARAM
          Parameter name for relevnace ranking record search strategy.
static String NAV_RELRANK_EREC_RANK_TERMS_PARAM
          Parameter name for relevnace ranking record search terms.
static String NAV_RELRANK_EREC_SEARCH_KEY_PARAM
          Deprecated. Later versions of the Endeca API may not support this constant.
static String NAV_RELRANK_EREC_SEARCH_STRATEGY_PARAM
          Deprecated. Later versions of the Endeca API may not support this constant.
static String NAV_RELRANK_EREC_SEARCH_TERMS_PARAM
          Deprecated. Later versions of the Endeca API may not support this constant.
static String NAV_ROLLUP_KEY_PARAM
          Parameter name for navigation rollup key.
static String NAV_SORT_KEY_PARAM
          Parameter name for navigation sort key.
static String NAV_SORT_ORDER_PARAM
          Parameter name for navigation sort order.
static String NAV_SPECIFIC_REFINEMENTS_PARAM
          Parameter name for navigation exposed refinements.
static String NAV_STRATIFIED_DIM_VALS_PARAM
          Parameter name for navigation stratified dim vals.
static String QUERY_ID_PARAM
          Deprecated. Later versions of the Endeca API may not support this constant.
static String SESSION_ID_PARAM
          Deprecated. Later versions of the Endeca API may not support this constant.
 
Fields inherited from class com.endeca.navigation.ENEQuery
ALL_ERECS_PER_AGGR, DIM_SEARCH_ALL_DIM_VALUES, KEY_PROPS_ALL, KEY_PROPS_NONE, MAX_BULK_ERECS_AVAILABLE, NAV_SORT_ASCENDING, NAV_SORT_DESCENDING, ONE_EREC_PER_AGGR, ZERO_ERECS_PER_AGGR
 
Constructor Summary
UrlENEQuery()
          Deprecated. Use the two-argument constructor with an explicit encoding of "windows-1252" and a null queryString, instead.
UrlENEQuery(String queryString)
          Deprecated. Use the two-argument constructor with an explicit encoding of "windows-1252" instead.
UrlENEQuery(String queryString, String encoding)
          Constructor where the queryString gets parsed into the individual query fields.
 
Method Summary
 void setA(String a)
          Sets the aggregated record for the query.
 void setAf(String filter)
          Sets the aggregated record navigation range filters.
 void setAn(String an)
          Sets the aggregated record navigation values for the query.
 void setAr(String filter)
          Sets the aggregated record navigation record filter.
 void setArs(String filter)
          Sets the aggregated record structure expression.
 void setAs(String keys)
          Sets the sort key for the aggregated record representative records.
 void setAu(String au)
          Sets the aggregated record rollup key with which the aggregated record is derived.
 void setD(String d)
          Sets the string dimension search query terms.
 void setDf(String filter)
          Sets the dimension search navigation range filters.
 void setDi(String d)
          Sets the dimensions with which to dimension search in.
 void setDk(String r)
          Sets the dimension search behavior to order results.
 void setDn(String n)
          Sets the navigation restriction for the dimension search.
 void setDo(String o)
          Sets the dimension search results offset.
 void setDp(String num)
          Sets the number of results to return per dimension.
 void setDr(String filter)
          Sets the dimension search navigation record filter.
 void setDrs(String structureExpr)
          Sets the structure expression for the dimension search query.
 void setDx(String opts)
          Sets the dimension search options.
 void setN(String n)
          Sets the navigation field of the query.
 void setNa(String query)
          Sets the analytics query.
 void setNao(String o)
          Sets the navigation aggregated record list offset.
 void setNdr(String config)
          Sets the Disabled Refinements config for the navigation query.
 void setNe(String e)
          Sets the exposed navigation refinements.
 void setNf(String filter)
          Sets the range filters for the navigation query.
 void setNk(String keyPropReq)
          Sets the key properties request for the navigation query.
 void setNmpt(String time)
           
 void setNmrf(String filter)
           
 void setNo(String o)
          Sets the navigation record list offset.
 void setNp(String num)
          Sets the number of records per aggregated record.
 void setNr(String filter)
          Sets the record filter for the navigation query.
 void setNrc(String configs)
          Sets the list of dynamic refinement configs for the navigation query.
 void setNrcs(String configs)
          Sets the list of stratified dim vals used by this navigation query.
 void setNrk(String key)
          Sets the key of the navigation query for record search using a specified relevance ranking strategy.
 void setNrm(String relRankMatchMode)
          Sets the relevance ranking match mode of the navigation query for the record search.
 void setNrr(String relRankStrategy)
          Sets the relevance ranking strategy of the navigation query for the record search.
 void setNrs(String structureExpr)
          Sets the structure expression for the navigation query.
 void setNrt(String terms)
          Sets the terms of the navigation query for record search using a specified relevance ranking strategy.
 void setNs(String keys)
          Sets the sort key for the record list of the navigation.
 void setNso(String order)
          Sets the sort order for the record list of the navigation.
 void setNtk(String keys)
          Sets the keys of the record search of the navigation query.
 void setNtpc(String computePhrasings)
          Sets whether the MDEX Engine should compute phrasing suggestions for the record search query.
 void setNtpr(String rewriteQuery)
          Sets whether the MDEX Engine should rewrite the record search query to an alternative phrasing.
 void setNtt(String termSets)
          Sets the terms of the record search of the navigation query.
 void setNtx(String optSets)
          Sets the options for the record search of the navigation query.
 void setNty(String dym)
          Sets whether the did you mean record search functionality is on in the query.
 void setNu(String key)
          Sets the rollup key for the navigation query.
 void setR(String r)
          Sets the records for query.
static String toQueryString(ENEQuery neq)
          Deprecated. Use the version that takes an encoding instead.
static String toQueryString(ENEQuery neq, String encoding)
          Takes a ENEQuery and serializes the object into URL query string format.
 String toString()
          Returns a string representation of this query.
 
Methods inherited from class com.endeca.navigation.ENEQuery
containsAggrERecQuery, containsDimSearchQuery, containsERecQuery, containsERecsQuery, containsNavQuery, containsQuery, getAggrERec, getAggrERecActiveSortKeys, getAggrERecNavDescriptors, getAggrERecNavRangeFilters, getAggrERecNavRecordFilter, getAggrERecRollupKey, getAggrERecSpec, getAggrERecStructureExpr, getAnalyticsQuery, getDimSearchCompound, getDimSearchDimension, getDimSearchDimensions, getDimSearchNavDescriptors, getDimSearchNavRangeFilters, getDimSearchNavRecordFilter, getDimSearchNavRecordStructureExpr, getDimSearchNumDimValues, getDimSearchOpts, getDimSearchRankResults, getDimSearchResultsOffset, getDimSearchTerms, getERecs, getLanguageId, getNavActiveSortKeys, getNavAggrERecsOffset, getNavAllRefinements, getNavDescriptors, getNavDisabledRefinementsConfig, getNavERecSearchComputeAlternativePhrasings, getNavERecSearchDidYouMean, getNavERecSearches, getNavERecSearchRewriteQueryWithAnAlternativePhrasing, getNavERecsOffset, getNavERecsPerAggrERec, getNavExposedRefinements, getNavKeyProperties, getNavMerchPreviewTime, getNavMerchRuleFilter, getNavNumAggrERecs, getNavNumBulkAggrERecs, getNavNumBulkERecs, getNavNumERecs, getNavRangeFilters, getNavRecordFilter, getNavRecordStructureExpr, getNavRefinementConfigs, getNavRelRankERecRank, getNavRelRankERecSearch, getNavRollupKey, getNavSortKey, getNavSortOrder, getNavStratifiedDimVals, getProfiles, getQueryInfo, getSelection, isMerchDebugOn, setAggrERec, setAggrERecActiveSortKeys, setAggrERecNavDescriptors, setAggrERecNavRangeFilters, setAggrERecNavRecordFilter, setAggrERecRollupKey, setAggrERecSpec, setAggrERecStructureExpr, setAnalyticsQuery, setDimSearchCompound, setDimSearchDimension, setDimSearchDimensions, setDimSearchNavDescriptors, setDimSearchNavRangeFilters, setDimSearchNavRecordFilter, setDimSearchNavRecordStructureExpr, setDimSearchNumDimValues, setDimSearchOpts, setDimSearchRankResults, setDimSearchResultsOffset, setDimSearchTerms, setERec, setERecs, setERecSpec, setLanguageId, setMerchDebugOn, setNavActiveSortKeys, setNavAggrERecsOffset, setNavAllRefinements, setNavDescriptors, setNavDisabledRefinementsConfig, setNavERecSearchComputeAlternativePhrasings, setNavERecSearchDidYouMean, setNavERecSearches, setNavERecSearchRewriteQueryWithAnAlternativePhrasing, setNavERecsOffset, setNavERecsPerAggrERec, setNavExposedRefinements, setNavKeyProperties, setNavMerchPreviewTime, setNavMerchRuleFilter, setNavNumAggrERecs, setNavNumBulkAggrERecs, setNavNumBulkERecs, setNavNumERecs, setNavRangeFilters, setNavRecordFilter, setNavRecordStructureExpr, setNavRefinementConfigs, setNavRelRankERecRank, setNavRelRankERecSearch, setNavRollupKey, setNavSortKey, setNavSortOrder, setNavStratifiedDimVals, setProfiles, setQueryInfo, setSelection
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NAV_DESCRIPTORS_PARAM

public static final String NAV_DESCRIPTORS_PARAM
Parameter name for navigation values.

See Also:
Constant Field Values

NAV_ERECS_OFFSET_PARAM

public static final String NAV_ERECS_OFFSET_PARAM
Parameter name for navigation record list offset.

See Also:
Constant Field Values

NAV_AGGR_ERECS_OFFSET_PARAM

public static final String NAV_AGGR_ERECS_OFFSET_PARAM
Parameter name for navigation aggregated record list offset.

See Also:
Constant Field Values

NAV_SPECIFIC_REFINEMENTS_PARAM

public static final String NAV_SPECIFIC_REFINEMENTS_PARAM
Parameter name for navigation exposed refinements.

See Also:
Constant Field Values

NAV_REFINEMENT_CONFIGS_PARAM

public static final String NAV_REFINEMENT_CONFIGS_PARAM
Parameter name for navigation refinement configs.

See Also:
Constant Field Values

NAV_STRATIFIED_DIM_VALS_PARAM

public static final String NAV_STRATIFIED_DIM_VALS_PARAM
Parameter name for navigation stratified dim vals.

See Also:
Constant Field Values

NAV_DISABLED_REFINEMENTS_CONFIGS_PARAM

public static final String NAV_DISABLED_REFINEMENTS_CONFIGS_PARAM
Parameter name for disabled refinements config.

See Also:
Constant Field Values

NAV_ERECS_PER_AGGR_EREC_PARAM

public static final String NAV_ERECS_PER_AGGR_EREC_PARAM
Parameter name for navigation number of records per aggregated record.

See Also:
Constant Field Values

NAV_MERCH_PREVIEW_TIME_PARAM

public static final String NAV_MERCH_PREVIEW_TIME_PARAM
See Also:
Constant Field Values

NAV_MERCH_RULE_FILTER_PARAM

public static final String NAV_MERCH_RULE_FILTER_PARAM
See Also:
Constant Field Values

NAV_SORT_KEY_PARAM

public static final String NAV_SORT_KEY_PARAM
Parameter name for navigation sort key.

See Also:
Constant Field Values

NAV_SORT_ORDER_PARAM

public static final String NAV_SORT_ORDER_PARAM
Parameter name for navigation sort order.

See Also:
Constant Field Values

NAV_ROLLUP_KEY_PARAM

public static final String NAV_ROLLUP_KEY_PARAM
Parameter name for navigation rollup key.

See Also:
Constant Field Values

NAV_EREC_SEARCH_KEYS_PARAM

public static final String NAV_EREC_SEARCH_KEYS_PARAM
Parameter name for navigation record search keys.

See Also:
Constant Field Values

NAV_EREC_SEARCH_TERMS_PARAM

public static final String NAV_EREC_SEARCH_TERMS_PARAM
Parameter name for navigation record search term sets.

See Also:
Constant Field Values

NAV_RELRANK_EREC_RANK_KEY_PARAM

public static final String NAV_RELRANK_EREC_RANK_KEY_PARAM
Parameter name for relevnace ranking record search key.

See Also:
Constant Field Values

NAV_RELRANK_EREC_RANK_TERMS_PARAM

public static final String NAV_RELRANK_EREC_RANK_TERMS_PARAM
Parameter name for relevnace ranking record search terms.

See Also:
Constant Field Values

NAV_RELRANK_EREC_RANK_STRATEGY_PARAM

public static final String NAV_RELRANK_EREC_RANK_STRATEGY_PARAM
Parameter name for relevnace ranking record search strategy.

See Also:
Constant Field Values

NAV_RELRANK_EREC_RANK_MATCHMODE_PARAM

public static final String NAV_RELRANK_EREC_RANK_MATCHMODE_PARAM
Parameter name for relevnace ranking record match mode.

See Also:
Constant Field Values

NAV_RELRANK_EREC_SEARCH_KEY_PARAM

public static final String NAV_RELRANK_EREC_SEARCH_KEY_PARAM
Deprecated. Later versions of the Endeca API may not support this constant.
Parameter name for relevnace ranking record search key.

See Also:
Constant Field Values

NAV_RELRANK_EREC_SEARCH_TERMS_PARAM

public static final String NAV_RELRANK_EREC_SEARCH_TERMS_PARAM
Deprecated. Later versions of the Endeca API may not support this constant.
Parameter name for relevnace ranking record search terms.

See Also:
Constant Field Values

NAV_RELRANK_EREC_SEARCH_STRATEGY_PARAM

public static final String NAV_RELRANK_EREC_SEARCH_STRATEGY_PARAM
Deprecated. Later versions of the Endeca API may not support this constant.
Parameter name for relevnace ranking record search strategy.

See Also:
Constant Field Values

NAV_EREC_SEARCH_DID_YOU_MEAN_PARAM

public static final String NAV_EREC_SEARCH_DID_YOU_MEAN_PARAM
Parameter name for navigation record search Did You Mean.

See Also:
Constant Field Values

NAV_RANGE_FILTERS_PARAM

public static final String NAV_RANGE_FILTERS_PARAM
Parameter name for navigation range filters.

See Also:
Constant Field Values

NAV_RECORD_FILTER_PARAM

public static final String NAV_RECORD_FILTER_PARAM
Parameter name for navigation record filters.

See Also:
Constant Field Values

NAV_RECORD_STRUCTURE_EXPR_PARAM

public static final String NAV_RECORD_STRUCTURE_EXPR_PARAM
Parameter name for navigation record structure expressions.

See Also:
Constant Field Values

NAV_KEY_PROPERTIES_PARAM

public static final String NAV_KEY_PROPERTIES_PARAM
Parameter name for navigation key properties.

See Also:
Constant Field Values

NAV_EREC_SEARCH_OPTS_PARAM

public static final String NAV_EREC_SEARCH_OPTS_PARAM
Parameter name for navigation record search option sets.

See Also:
Constant Field Values

NAV_EREC_SEARCH_PHRASING_COMPUTE_PARAM

public static final String NAV_EREC_SEARCH_PHRASING_COMPUTE_PARAM
Parameter name for navigation record search to compute alternative phrasings.

See Also:
Constant Field Values

NAV_EREC_SEARCH_PHRASING_REWRITE_PARAM

public static final String NAV_EREC_SEARCH_PHRASING_REWRITE_PARAM
Parameter name for navigation record search to rewrite the query to an alternative phrasing.

See Also:
Constant Field Values

ERECS_PARAM

public static final String ERECS_PARAM
Parameter name for records.

See Also:
Constant Field Values

AGGR_EREC_PARAM

public static final String AGGR_EREC_PARAM
Parameter name for aggregated records.

See Also:
Constant Field Values

AGGR_EREC_NAV_DESCRIPTORS_PARAM

public static final String AGGR_EREC_NAV_DESCRIPTORS_PARAM
Parameter name for aggregated record descriptors.

See Also:
Constant Field Values

AGGR_EREC_NAV_RANGE_FILTERS_PARAM

public static final String AGGR_EREC_NAV_RANGE_FILTERS_PARAM
Parameter name for aggregated record navigation range filters.

See Also:
Constant Field Values

AGGR_EREC_NAV_RECORD_FILTER_PARAM

public static final String AGGR_EREC_NAV_RECORD_FILTER_PARAM
Parameter name for aggregated record navigation record filter.

See Also:
Constant Field Values

AGGR_EREC_STRUCTURE_EXPR_PARAM

public static final String AGGR_EREC_STRUCTURE_EXPR_PARAM
Parameter name for aggregated record structure expression.

See Also:
Constant Field Values

AGGR_EREC_ROLLUP_KEY_PARAM

public static final String AGGR_EREC_ROLLUP_KEY_PARAM
Parameter name for aggregated record rollup keys.

See Also:
Constant Field Values

AGGR_EREC_SORT_KEY_PARAM

public static final String AGGR_EREC_SORT_KEY_PARAM
Parameter name for aggregated record sort key.

See Also:
Constant Field Values

DIM_SEARCH_TERMS_PARAM

public static final String DIM_SEARCH_TERMS_PARAM
Parameter name for dimension search terms.

See Also:
Constant Field Values

DIM_SEARCH_NAV_DESCRIPTORS_PARAM

public static final String DIM_SEARCH_NAV_DESCRIPTORS_PARAM
Parameter name for dimension search navigation descriptors.

See Also:
Constant Field Values

DIM_SEARCH_NAV_RANGE_FILTERS_PARAM

public static final String DIM_SEARCH_NAV_RANGE_FILTERS_PARAM
Parameter name for dimension search navigation range filters.

See Also:
Constant Field Values

DIM_SEARCH_NAV_RECORD_FILTER_PARAM

public static final String DIM_SEARCH_NAV_RECORD_FILTER_PARAM
Parameter name for dimension search navigation record filter.

See Also:
Constant Field Values

DIM_SEARCH_NAV_RECORD_STRUCTURE_EXPR_PARAM

public static final String DIM_SEARCH_NAV_RECORD_STRUCTURE_EXPR_PARAM
Parameter name for dimension search navigation structure expressions.

See Also:
Constant Field Values

DIM_SEARCH_NUM_DIM_VALUES_PARAM

public static final String DIM_SEARCH_NUM_DIM_VALUES_PARAM
Parameter name for number of dimension values to return.

See Also:
Constant Field Values

DIM_SEARCH_DIMENSIONS_PARAM

public static final String DIM_SEARCH_DIMENSIONS_PARAM
Parameter name for dimension search dimension.

See Also:
Constant Field Values

DIM_SEARCH_RESULTS_OFFSET_PARAM

public static final String DIM_SEARCH_RESULTS_OFFSET_PARAM
Parameter name for dimension search results offset.

See Also:
Constant Field Values

DIM_SEARCH_OPTS_PARAM

public static final String DIM_SEARCH_OPTS_PARAM
Parameter name for dimension search options.

See Also:
Constant Field Values

DIM_SEARCH_RANK_RESULTS_PARAM

public static final String DIM_SEARCH_RANK_RESULTS_PARAM
Parameter name for ranking dimension search results.

See Also:
Constant Field Values

ANALYTICS_PARAM

public static final String ANALYTICS_PARAM
Parameter name for Analytics query

See Also:
Constant Field Values

SESSION_ID_PARAM

public static final String SESSION_ID_PARAM
Deprecated. Later versions of the Endeca API may not support this constant.
Parameter name for Session ID

See Also:
Constant Field Values

QUERY_ID_PARAM

public static final String QUERY_ID_PARAM
Deprecated. Later versions of the Endeca API may not support this constant.
Parameter name for Request ID

See Also:
Constant Field Values
Constructor Detail

UrlENEQuery

public UrlENEQuery()
Deprecated. Use the two-argument constructor with an explicit encoding of "windows-1252" and a null queryString, instead.

No argument constructor. Primarily called by the JSP useBean action. Individual setter methods must be called, either by JSP setProperty or explicitly else query will result in EmptyQueryException.


UrlENEQuery

public UrlENEQuery(String queryString)
            throws UrlENEQueryParseException
Deprecated. Use the two-argument constructor with an explicit encoding of "windows-1252" instead.

Constructor where the queryString gets parsed into the individual query fields. The common use for this constructor is to pass in request.getQueryString() as-is (i.e., arguments remain x-www-form-urlencoded), and this constructor parses out the arguments it is interested in. This constructor is identical to the two-argument constructor with an encoding of "windows-1252".

Parameters:
queryString - queryString form URL to be parsed into invididual query options.
Throws:
UrlENEQueryParseException - If there were any errors in parsing the queryString.

UrlENEQuery

public UrlENEQuery(String queryString,
                   String encoding)
            throws UrlENEQueryParseException
Constructor where the queryString gets parsed into the individual query fields. The common use for this constructor is to pass in request.getQueryString() as-is (i.e., arguments remain x-www-form-urlencoded), and this constructor parses out the arguments it is interested in.

Parameters:
queryString - queryString form URL to be parsed into invididual query options.
encoding - The character set that the query string is encoded in. Typically "UTF-8" or "Cp1252".
Throws:
UrlENEQueryParseException - If there were any errors in parsing the queryString.
Method Detail

setR

public void setR(String r)
Sets the records for query. setERecs().

Parameters:
r - Where r is record ids delimitted by ' '

setN

public void setN(String n)
          throws UrlENEQueryParseException
Sets the navigation field of the query. setNavDescriptors()

Parameters:
n - Where n is ' ' delimited string of dimension value ids.
Throws:
UrlENEQueryParseException - If the navigation values are not able to be parsed.

setNo

public void setNo(String o)
           throws UrlENEQueryParseException
Sets the navigation record list offset. setNavERecsOffset().

Parameters:
o - Where o is the offset into the record list.
Throws:
UrlENEQueryParseException - If the offset parameter is not able to be parsed.

setNa

public void setNa(String query)
           throws UrlENEQueryParseException
Sets the analytics query. setAnalyticsQuery().

Parameters:
query - The analytics query.
Throws:
UrlENEQueryParseException - If the query is malformed.

setNao

public void setNao(String o)
            throws UrlENEQueryParseException
Sets the navigation aggregated record list offset. setNavAggrERecsOffset().

Parameters:
o - Where o is the offset into the record list.
Throws:
UrlENEQueryParseException - If the aggregated offset parameter is not able to be parsed.

setNe

public void setNe(String e)
           throws UrlENEQueryParseException
Sets the exposed navigation refinements. setNavExposedRefinements().

Parameters:
e - Where e is ' ' delimited string of dimension value ids.
Throws:
UrlENEQueryParseException - If there is an error in parsing the exposed refinements.

setNp

public void setNp(String num)
           throws UrlENEQueryParseException
Sets the number of records per aggregated record. setNavERecsPerAggrERec()

Parameters:
num - Where num is one of the values: ENEQuery.ERECS_PER_AGGR_ALL, ENEQuery.ERECS_PER_AGGR_ONE, or ENEQuery.ERECS_PER_AGGR_NONE
Throws:
UrlENEQueryParseException - If unable to parse the number of records per aggregated record.

setNmpt

public void setNmpt(String time)

setNmrf

public void setNmrf(String filter)

setNs

public void setNs(String keys)
Sets the sort key for the record list of the navigation. setNavActiveSortKeys().

Parameters:
keys - Sort key of the navigation.

setNso

public void setNso(String order)
            throws UrlENEQueryParseException
Sets the sort order for the record list of the navigation. setNavSortOrder().

Parameters:
order - Sort order of the navigation where order is one of: ENEQuery.NAV_SORT_ASCENDING, or ENEQuery.NAV_SORT_DESCENDING.
Throws:
UrlENEQueryParseException - If unable to parse the sort order.

setNrcs

public void setNrcs(String configs)
             throws UrlENEQueryParseException
Sets the list of stratified dim vals used by this navigation query. Stratified dim vals are delimited by ';' and are in the form [strata],[dimvalid].

Parameters:
configs - A urldecoded ';' delimited sequence of stratified dim vals
Throws:
UrlENEQueryParseException - Thrown if problem parsing the pairs.

setNrc

public void setNrc(String configs)
            throws UrlENEQueryParseException
Sets the list of dynamic refinement configs for the navigation query. Dynamic refinement configs are delimited by '|'.

Parameters:
configs - A urldecoded '|' delimited sequence of refinement configs.
Throws:
UrlENEQueryParseException - Thrown if problem parsing or pairing up key+value pairs.

setNdr

public void setNdr(String config)
            throws UrlENEQueryParseException
Sets the Disabled Refinements config for the navigation query.

Parameters:
config - A urldecoded disabled-refinements config.
Throws:
UrlENEQueryParseException - Thrown if problem parsing disabled-refinements configuration.

setNu

public void setNu(String key)
Sets the rollup key for the navigation query. setNavRollupKey()

Parameters:
key - Rollup the navigation with this key.

setNrk

public void setNrk(String key)
            throws UrlENEQueryParseException
Sets the key of the navigation query for record search using a specified relevance ranking strategy. The Nrt and Nrr parameters MUST be used with the Nrk parameter indicating the search terms and the relevance ranking strategy to be used. The Nrk parameter does not support multiple keys. The use of '|' in the key is not allowed.

Parameters:
key - The key to be used for record search. key should not contain any '|' characters.
Throws:
UrlENEQueryParseException - Thrown if problem parsing or pairing up with search terms.

setNrt

public void setNrt(String terms)
            throws UrlENEQueryParseException
Sets the terms of the navigation query for record search using a specified relevance ranking strategy. The Nrk and Nrr parameters MUST be used with the Nrt parameter indicating the searchinterface and the relevance ranking strategy to be used. The Nrt parameter does not support multiple sets of search terms. The use of '|' in the terms is not allowed.

Parameters:
terms - The terms to be used for record search. terms should not contain any '|' characters.
Throws:
UrlENEQueryParseException - Thrown if problem parsing or pairing up with search terms.

setNrr

public void setNrr(String relRankStrategy)
            throws UrlENEQueryParseException
Sets the relevance ranking strategy of the navigation query for the record search. The Nrk and Nrt parameters MUST be used with the Nrr parameter indicating the searchinterface and search terms. The Nrr parameter does not support multiple relevance ranking strategies. The use of '|' in the strategy is not allowed.

Parameters:
relRankStrategy - The relevance ranking strategy to be used to rank the results of the record search. relRankStrategy should not contain any '|' characters.
Throws:
UrlENEQueryParseException - Thrown if problem parsing or pairing up with search terms.

setNrm

public void setNrm(String relRankMatchMode)
            throws UrlENEQueryParseException
Sets the relevance ranking match mode of the navigation query for the record search. The Nrk, Nrt and Nrr parameters MUST be used with the Nrm parameter. The Nrm parameter does not support multiple relevance ranking strategies. The use of '|' in the strategy is not allowed.

Parameters:
relRankMatchMode - The relevance ranking match mode to be used to select records to rank. relRankMatchMode should not contain any '|' characters.
Throws:
UrlENEQueryParseException - Thrown if problem parsing or pairing up with search terms.

setNtk

public void setNtk(String keys)
            throws UrlENEQueryParseException
Sets the keys of the record search of the navigation query. The keys are delimited by '|'. The Ntt parameter MUST be used with the Ntk parameter indicating the search terms for each key. In addition Ntt should have the same number of term sets as Ntk has keys. setNavSearches().

Parameters:
keys - A urldecoded '|' delimited sequence of record search keys.
Throws:
UrlENEQueryParseException - Thrown if problem parsing or pairing up with search terms.

setNtt

public void setNtt(String termSets)
            throws UrlENEQueryParseException
Sets the terms of the record search of the navigation query. Each set of terms are delimited by '|'. The Ntt parameter MUST be used with the Ntk parameter indicating which keys of the records to search. In addition Ntt should have the same number of term sets as Ntk has keys. setNavSearches().

Parameters:
termSets - A urldecoded '|' delimited sequence of record search term sets.
Throws:
UrlENEQueryParseException - Thrown if problem parsing or pairing up with search keys.

setNtx

public void setNtx(String optSets)
            throws UrlENEQueryParseException
Sets the options for the record search of the navigation query. Each set of options is delimited by '|'. The Ntx parameter MUST be used with the Ntt and Ntk parameters, and should have the same number of values as these parameters. setNavSearches().

Parameters:
optSets - A urldecoded '|' delimited sequence of record search option sets.
Throws:
UrlENEQueryParseException - Thrown if problem parsing or pairing up with search keys.

setNty

public void setNty(String dym)
            throws UrlENEQueryParseException
Sets whether the did you mean record search functionality is on in the query. ENEQuery.setNavERecSearchDidYouMean()

Parameters:
dym - 0 for off. 1 for on.
Throws:
UrlENEQueryParseException

setNtpc

public void setNtpc(String computePhrasings)
             throws UrlENEQueryParseException
Sets whether the MDEX Engine should compute phrasing suggestions for the record search query. setNavERecSearchComputeAlternativePhrasings()

Throws:
UrlENEQueryParseException

setNtpr

public void setNtpr(String rewriteQuery)
             throws UrlENEQueryParseException
Sets whether the MDEX Engine should rewrite the record search query to an alternative phrasing. setNavERecSearchRewriteQueryWithAnAlternativePhrasing()

Throws:
UrlENEQueryParseException

setNf

public void setNf(String filter)
           throws UrlENEQueryParseException
Sets the range filters for the navigation query. ENEQuery.setNavRangeFilters(). Multiple filters are specified by '|' delimiting each filter as described in the ENEQuery method.

Parameters:
filter - The range filters for navigation query.
Throws:
UrlENEQueryParseException

setNr

public void setNr(String filter)
           throws UrlENEQueryParseException
Sets the record filter for the navigation query. ENEQuery.setNavRecordFilter().

Parameters:
filter - The record filter for navigation query.
Throws:
UrlENEQueryParseException

setNrs

public void setNrs(String structureExpr)
            throws UrlENEQueryParseException
Sets the structure expression for the navigation query. ENEQuery.setNavStructureExpr().

Parameters:
structureExpr - The structure expression for navigation query.
Throws:
UrlENEQueryParseException

setNk

public void setNk(String keyPropReq)
           throws UrlENEQueryParseException
Sets the key properties request for the navigation query. ENEQuery.setKeyProperties().

Parameters:
keyPropReq - The key properties request (all or none) for the navigation query.
Throws:
UrlENEQueryParseException

setA

public void setA(String a)
Sets the aggregated record for the query. setAggrERecSpec().

Parameters:
a - the record specification of the aggregated record being queried for.

setAn

public void setAn(String an)
           throws UrlENEQueryParseException
Sets the aggregated record navigation values for the query. setAggrERecNavDescriptors().

Parameters:
an - Values with which to retrieve the aggregated records in relation to.
Throws:
UrlENEQueryParseException

setAf

public void setAf(String filter)
           throws UrlENEQueryParseException
Sets the aggregated record navigation range filters. ENEQuery.setAggrERecNavRangeFilters(). Multiple filters are specified by '|' delimiting each filter as described in the ENEQuery method.

Parameters:
filter - The navigation range filters for aggregated record query.
Throws:
UrlENEQueryParseException

setAr

public void setAr(String filter)
           throws UrlENEQueryParseException
Sets the aggregated record navigation record filter. ENEQuery.setAggrERecNavRecordFilter().

Parameters:
filter - The record filter for the aggregated record query.
Throws:
UrlENEQueryParseException

setArs

public void setArs(String filter)
            throws UrlENEQueryParseException
Sets the aggregated record structure expression. ENEQuery.setAggrERecStructureExpr().

Parameters:
filter - The structure expression for the aggregated record query.
Throws:
UrlENEQueryParseException

setAu

public void setAu(String au)
Sets the aggregated record rollup key with which the aggregated record is derived. setAggrERecRollupKey.

Parameters:
au - Rollup key with which the aggregated record is derived.

setAs

public void setAs(String keys)
Sets the sort key for the aggregated record representative records. setAggrERecActiveSortKeys().

Parameters:
keys - Sort key

setD

public void setD(String d)
Sets the string dimension search query terms. setDimSearchTerms().

Parameters:
d - Dimension search query terms.

setDn

public void setDn(String n)
           throws UrlENEQueryParseException
Sets the navigation restriction for the dimension search. setDimSearchNavDescriptors()

Parameters:
n - Where n is ' ' delimited string of dimension value ids.
Throws:
UrlENEQueryParseException - If unable to parse the navigation restrictions.

setDf

public void setDf(String filter)
           throws UrlENEQueryParseException
Sets the dimension search navigation range filters. ENEQuery.setDimSearchNavRangeFilters(). Multiple filters are specified by '|' delimiting each filter as described in the ENEQuery method.

Parameters:
filter - The navigation range filters for dimension search query.
Throws:
UrlENEQueryParseException

setDr

public void setDr(String filter)
           throws UrlENEQueryParseException
Sets the dimension search navigation record filter. ENEQuery.setDimSearchNavRangeFilters().

Parameters:
filter - The record filter for the dimension search query.
Throws:
UrlENEQueryParseException

setDrs

public void setDrs(String structureExpr)
            throws UrlENEQueryParseException
Sets the structure expression for the dimension search query. ENEQuery.setDimSearchNavRecordStructureExpr().

Parameters:
structureExpr - The structure expression for dimension search query.
Throws:
UrlENEQueryParseException

setDp

public void setDp(String num)
           throws UrlENEQueryParseException
Sets the number of results to return per dimension. setDimSearchNumDimValues()

Parameters:
num - Sets the number of values per dimension.
Throws:
UrlENEQueryParseException - If unable to parse the number of results per dimension.

setDi

public void setDi(String d)
           throws UrlENEQueryParseException
Sets the dimensions with which to dimension search in. setDimSearchDimensions.

Parameters:
d - Where d is dimension or dimension list to search within.
Throws:
UrlENEQueryParseException - If unable to parse the the dimension id(s).

setDo

public void setDo(String o)
           throws UrlENEQueryParseException
Sets the dimension search results offset. setDimSearchResultsOffset().

Parameters:
o - Where o is the offset into the results.
Throws:
UrlENEQueryParseException - If unable to parse the offset.

setDx

public void setDx(String opts)
Sets the dimension search options. setDimSearchOpts().

Parameters:
opts - The options for the dimension search operation.

setDk

public void setDk(String r)
           throws UrlENEQueryParseException
Sets the dimension search behavior to order results. setDimSearchRankResults().

Parameters:
r - either 0 (the default) to use the default dimension value ranking to order dimension search results or 1 to use relevance ranking.
Throws:
UrlENEQueryParseException - If unable to parse how dimension search results should be ordered.

toString

public String toString()
Returns a string representation of this query. The output format is of URL query string format. The same format as the input to the one argument constructor UrlENEQuery(String).

Overrides:
toString in class Object
Returns:
a URL query string representation.

toQueryString

public static String toQueryString(ENEQuery neq)
Deprecated. Use the version that takes an encoding instead.


toQueryString

public static String toQueryString(ENEQuery neq,
                                   String encoding)
Takes a ENEQuery and serializes the object into URL query string format. Parameters are x-www-form-urlencoded.

Parameters:
neq - ENEQuery to be serialized into URL query string format.
Returns:
a URL query string form of the neq.


2010 Endeca Technologies, Inc.
Endeca Confidential