|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.navigation.ENEQuery
public class ENEQuery
An object used for expressing queries to an Endeca MDEX Engine. An
ENEQuery
object is used with a query
method
(of HttpENEConnection
or AuthHttpENEConnection
)
to query the MDEX Engine, which then returns an ENEQueryResults
object.
An ENEQuery
object can contain one of each of the following
types of queries: a record query, a navigation query, an aggregated record query,
a dimension search query, and/or a navigation search.
All setter and getter methods are named according to the type of query
they affect. The "contains" methods give quick access to determine what type
of results the ENEQuery
object will yield.
While there are many query options, only a few critical
ENEQuery
methods are necessary to make basic queries:
setNavDescriptors
.setERec
.setAggrERec
, setAggrERecRollupKey
,
and setAggrERecNavDescriptors
.setDimSearchTerms
.
Field Summary | |
---|---|
static int |
ALL_ERECS_PER_AGGR
All records that compose a aggregated record will be returned. |
static int |
DIM_SEARCH_ALL_DIM_VALUES
All matches from dimension search will be returned from each dimension. |
static String |
KEY_PROPS_ALL
Request all key properties be returned. |
static String |
KEY_PROPS_NONE
Request no key properties be returned. |
static int |
MAX_BULK_ERECS_AVAILABLE
All the records that are associated with the current navigation state should be returned through the bulk record iterator. |
static int |
NAV_SORT_ASCENDING
Sort the navigation query's matching records in ascending order. |
static int |
NAV_SORT_DESCENDING
Sort the navigation query's matching records in descending order. |
static int |
ONE_EREC_PER_AGGR
One of the records that compose a aggregated record will be returned. |
static int |
ZERO_ERECS_PER_AGGR
None of the records that compose a aggregated record will be returned. |
Constructor Summary | |
---|---|
ENEQuery()
Zero argument default constructor. |
Method Summary | |
---|---|
boolean |
containsAggrERecQuery()
Returns if this query includes a aggregated record query. |
boolean |
containsDimSearchQuery()
Returns if this query includes a dimension search query. |
boolean |
containsERecQuery()
Returns if this query includes a record query. |
boolean |
containsERecsQuery()
Returns if this query includes a query for records. |
boolean |
containsNavQuery()
Returns whether the query includes a navigation query. |
boolean |
containsQuery()
Returns whether the query is querying for any of a navigation, record, dimension search, or a value set search. |
long |
getAggrERec()
Deprecated. This method may not be supported in future versions of the MDEX Engine API - use getAggrERecSpec() instead.
Gets the ID of the aggregated record to be queried for. |
ERecSortKeyList |
getAggrERecActiveSortKeys()
Get the list of sort keys with which the aggregated records representative records will be sorted. |
DimValIdList |
getAggrERecNavDescriptors()
Gets the navigation values which the aggregated record will be composed in relation to. |
RangeFilterList |
getAggrERecNavRangeFilters()
Gets the navigation range filters which the aggregated record will be composed in relation to. |
String |
getAggrERecNavRecordFilter()
Gets the record filter which the aggregated record will be composed in relation to. |
String |
getAggrERecRollupKey()
Gets the rollup key the aggregated record is composed by. |
String |
getAggrERecSpec()
Gets the specification of the aggregated record to be queried for. |
String |
getAggrERecStructureExpr()
Gets the structure expression used to filter members of the aggregated record. |
AnalyticsQuery |
getAnalyticsQuery()
Gets the AnalyticsQuery instance (if any) at the root of the AST that
represents the Latitude Analytics query string. |
boolean |
getDimSearchCompound()
Gets whether that dimension search will include compound results. |
long |
getDimSearchDimension()
If calling getDimSearchDimensions() would return a list with a single value,
that value will be returned by this function. |
DimValIdList |
getDimSearchDimensions()
Gets the dimensions from which the dimension search can search from. |
DimValIdList |
getDimSearchNavDescriptors()
Gets the navigation values that restrict the dimension search. |
RangeFilterList |
getDimSearchNavRangeFilters()
Gets the navigation range filters that restrict the dimension search. |
String |
getDimSearchNavRecordFilter()
Gets the record filter for the current dimension search. |
String |
getDimSearchNavRecordStructureExpr()
Gets the structure expression for this dimension search. |
int |
getDimSearchNumDimValues()
Deprecated. This method may not be supported in future versions of the MDEX Engine API - use GlobalDimSearchRefinementConfig.getNumResults() instead. |
String |
getDimSearchOpts()
Gets the search options that dimension search will use. |
boolean |
getDimSearchRankResults()
Gets how the dimension search results will be sorted. |
DimSearchRefinementConfigList |
getDimSearchRefinementConfigs()
Gets the list of refinement configs for dimension search to be used by the MDEX Engine. |
long |
getDimSearchResultsOffset()
Gets the offset with which the dimension search will return values per dimension. |
String |
getDimSearchRollupKey()
Gets the rollup key that the dimension search will to generate aggregated counts. |
String |
getDimSearchTerms()
Gets the search terms the dimension search will use. |
ERecIdList |
getERecs()
Gets the IDs of the records being queried for. |
String |
getLanguageId()
Gets the ISO639 language ID to be used for this query. |
ERecSortKeyList |
getNavActiveSortKeys()
Get the list of sort keys with which the navigation query's records will be sorted. |
long |
getNavAggrERecsOffset()
Gets the offset into the navigation aggregated record list for navigation query. |
boolean |
getNavAllRefinements()
Gets whether all the navigational refinements should be returned without explictly setting them. |
DimValIdList |
getNavDescriptors()
Gets the descriptor IDs of the navigation being queried for. |
DisabledRefinementsConfig |
getNavDisabledRefinementsConfig()
Gets the disabled refinements config. |
boolean |
getNavERecSearchComputeAlternativePhrasings()
Gets whether the Endeca MDEX Engine should compute alternative phrasings for the end user's original record search query. |
boolean |
getNavERecSearchDidYouMean()
Gets whether if the "Did You Mean" feature will be returned in the supplements with the record search feature. |
ERecSearchList |
getNavERecSearches()
Gets the navigation record searches on the records of the navigation query. |
boolean |
getNavERecSearchRewriteQueryWithAnAlternativePhrasing()
Gets whether the Endeca MDEX Engine should use one of the alternative phrasings it has computed instead of the end user's original record search query. |
long |
getNavERecsOffset()
Gets the offset into the navigation record list for the navigation query. |
int |
getNavERecsPerAggrERec()
Gets the number of records returned for each aggregated record. |
DimValIdList |
getNavExposedRefinements()
Gets the set of refinement parents that indicate which refinements should be returned with the navigation query. |
String |
getNavKeyProperties()
Gets the navigation key properties request. |
String |
getNavMerchPreviewTime()
Gets the merch preview-time string. |
String |
getNavMerchRuleFilter()
Gets the merch rule filter. |
long |
getNavNumAggrERecs()
Gets the maximum number of aggregated records to be returned from a navigation query. |
long |
getNavNumBulkAggrERecs()
Gets the maximum number of aggregated records to be returned in bulk format from a navigation query. |
long |
getNavNumBulkERecs()
Gets the maximum number of records to be returned in bulk format from a navigation query. |
long |
getNavNumERecs()
Gets the maximum number of records to be returned from a navigation query. |
String |
getNavOpts()
Gets the navigation options the navigation query will use. |
RangeFilterList |
getNavRangeFilters()
Gets the range filters to be applied to this navigation query. |
String |
getNavRecordFilter()
Gets the record filter for this navigation query. |
String |
getNavRecordStructureExpr()
Gets the structure expression for this navigation query. |
RefinementConfigList |
getNavRefinementConfigs()
Gets the list of dynamic refinement configs to be used by the MDEX Engine. |
ERecRank |
getNavRelRankERecRank()
Gets the navigation record search specified with relevance ranking. |
ERecSearch |
getNavRelRankERecSearch()
Deprecated. This method may not be supported in future versions of the MDEX Engine API - use getNavRelRankERecRank() instead.
Gets the navigation record search specified with relevance
ranking. |
String |
getNavRollupKey()
Gets the rollup key the navigation will be rolled up by to generate aggregated records. |
String |
getNavSortKey()
Deprecated. This method may not be available in future versions of the MDEX Engine API. Use getNavActiveSortKeys() instead. |
int |
getNavSortOrder()
Deprecated. This method may not be available in future versions of the MDEX Engine API. Use getNavActiveSortKeys() instead. |
StratifiedDimValList |
getNavStratifiedDimVals()
Sets the list of stratified dimension values for use during refinement ranking by the MDEX engine. |
Set |
getProfiles()
Gets the profiles that describe characteristics of an application end user. |
ENEQueryInfo |
getQueryInfo()
Gets the ENEQueryInfo object. |
FieldList |
getSelection()
Gets the fields that should be returned for each record in the result set, for navigation, record, and aggregated record queries. |
protected boolean |
isMerchDebugOn()
|
void |
setAggrERec(long aggregatedRecordId)
Deprecated. This method may not be supported in future versions of the MDEX Engine API - use setAggrERecSpec(String) instead.
Sets the ID of the aggregated record to be queried for. |
void |
setAggrERecActiveSortKeys(ERecSortKeyList criteria)
Sets the list of keys that will be used to sort representative records. |
void |
setAggrERecNavDescriptors(DimValIdList descriptors)
Sets the navigation values which the aggregated record will be aggregated in relation to. |
void |
setAggrERecNavRangeFilters(RangeFilterList filters)
Sets the navigation range filters which the aggregated record will be composed in relation to. |
void |
setAggrERecNavRecordFilter(String filter)
Sets the record filter which the aggregated record will be composed in relation to. |
void |
setAggrERecRollupKey(String key)
Sets the rollup key the aggregated record is composed by. |
void |
setAggrERecSpec(String aggregatedRecordSpec)
Sets the specification of the aggregated record to be queried for. |
void |
setAggrERecStructureExpr(String filter)
Sets the structure expression used to filter members of the aggregated record. |
void |
setAnalyticsQuery(AnalyticsQuery q)
Sets the AnalyticsQuery instance that represents the
Latitude query that will be sent to the Endeca MDEX Engine. |
void |
setDimSearchCompound(boolean isCompound)
Sets whether dimension search will include compound results. |
void |
setDimSearchDimension(long dimensionId)
Sets the dimension which the dimension search can search from. |
void |
setDimSearchDimensions(DimValIdList dimensionIds)
Sets the dimensions which the dimension search can search from. |
void |
setDimSearchNavDescriptors(DimValIdList descriptors)
Sets the navigation values that describe a navigation state that restrict the number of values that can be searched from. |
void |
setDimSearchNavRangeFilters(RangeFilterList filters)
Sets the navigation range filters that restrict the dimension search. |
void |
setDimSearchNavRecordFilter(String filter)
Sets the record filter that will restrict the dimension search results. |
void |
setDimSearchNavRecordStructureExpr(String structureExpr)
Sets the structure expression on this dimension search. |
void |
setDimSearchNumDimValues(int num)
Deprecated. This method may not be supported in future versions of the MDEX Engine API - use GlobalDimSearchRefinementConfig.setNumResults(OptionalInt) instead. |
void |
setDimSearchOpts(String opts)
Sets the option set that dimension search will use. |
void |
setDimSearchRankResults(boolean rank)
Sets how the dimension search results are sorted. |
void |
setDimSearchRefinementConfigs(DimSearchRefinementConfigList refCfgList)
Sets the list of refinement configs for dimension search to be used by the MDEX Engine. |
void |
setDimSearchResultsOffset(long offset)
Sets the offset with which the dimension search will begin returning results per dimension. |
void |
setDimSearchRollupKey(String rollupKey)
Sets the rollup key which the records of the dimension search query should use to create aggregated counts. |
void |
setDimSearchTerms(String terms)
Sets the search terms the dimension search will use. |
void |
setERec(long recordId)
Deprecated. This method may not be supported in future versions of the MDEX Engine API - use setERecSpec(String) instead.
Sets the ID of the record to be queried for. This method is
shorthand for the setERecs(ERecIdList) method
used when only requesting one record. |
void |
setERecs(ERecIdList recordIds)
Sets the IDs of the records to be queried for. |
void |
setERecSpec(String recordSpec)
Sets the specification of the record to be queried for. |
void |
setLanguageId(String id)
Sets the ISO639 language code to be used for this query. |
void |
setMerchDebugOn(boolean isMerchDebugOn)
This method is for internal Endeca use only, and should never be called |
void |
setNavActiveSortKeys(ERecSortKeyList criteria)
Sets the list of keys that will be used to sort records. |
void |
setNavAggrERecsOffset(long offset)
Sets the offset into the navigation aggregated record list for navigation query. |
void |
setNavAllRefinements(boolean all)
Sets the query such that the navigation query will return with all the refinements possible for all dimensions. |
void |
setNavDescriptors(DimValIdList descriptors)
Sets the navigation descriptor IDs that describe the navigation object to be queried for. |
void |
setNavDisabledRefinementsConfig(DisabledRefinementsConfig disabledRefinementsConfig)
Sets the disabled refinements config. |
void |
setNavERecSearchComputeAlternativePhrasings(boolean computeAlternativePhrasings)
Sets whether the Endeca MDEX Engine will compute alternative phrasings for the current record search query. |
void |
setNavERecSearchDidYouMean(boolean dymOn)
Sets whether the record search should turn on the "Did You Mean" feature. |
void |
setNavERecSearches(ERecSearchList searches)
Sets the navigation record searches to perform on the records of the navigation query. |
void |
setNavERecSearchRewriteQueryWithAnAlternativePhrasing(boolean rewriteQueryWithAnAlternativePhrasing)
Sets whether the Endeca MDEX Engine will use one of the the alternative phrasings it has computed instead of the end user's original record search query when computing the set of documents to return. |
void |
setNavERecsOffset(long offset)
Sets the offset into the navigation record list for the navigation query. |
void |
setNavERecsPerAggrERec(int number)
Sets the maximum number of records to be returned in each aggregated record. |
void |
setNavExposedRefinements(DimValIdList refinementParents)
Sets the set of refinements that should be exposed/returned with the navigation query. |
void |
setNavKeyProperties(String keyPropsReq)
Set the navigation key properties request. |
void |
setNavMerchPreviewTime(String newTime)
Sets the merch preview-time string. |
void |
setNavMerchRuleFilter(String filter)
Sets the merch rule filter. |
void |
setNavNumAggrERecs(int number)
Sets the maximum number of aggregated records returned for the navigation query. |
void |
setNavNumBulkAggrERecs(int number)
Sets the maximum number of aggregated records returned in bulk format for the navigation query. |
void |
setNavNumBulkERecs(int number)
Sets the maximum number of records returned in bulk format for the navigation query. |
void |
setNavNumERecs(int number)
Sets the maximum number of records that can be returned for the navigation query. |
void |
setNavOpts(String opts)
Sets the navigation options the navigation query will use. |
void |
setNavRangeFilters(RangeFilterList filters)
Sets the navigation range filters on this navigation query. |
void |
setNavRecordFilter(String filter)
Sets the record filter on this navigation query. |
void |
setNavRecordStructureExpr(String structureExpr)
Sets the structure expression on this navigation query. |
void |
setNavRefinementConfigs(RefinementConfigList refCfgList)
Sets the list of dynamic refinement configs to be used by the MDEX Engine. |
void |
setNavRelRankERecRank(ERecRank rank)
Sets the relevance ranking record search to perform on the records of the navigation query. |
void |
setNavRelRankERecSearch(ERecSearch search)
Deprecated. This method may not be supported in future versions of the MDEX Engine API - use setNavRelRankERecRank(ERecRank) instead.
Sets the relevance ranking record search to perform on the records
of the navigation query. |
void |
setNavRollupKey(String rollupKey)
Sets the rollup key with which the records of the navigation query should be rolled up with to create aggregated records. |
void |
setNavSortKey(String key)
Deprecated. This method may not be available in future versions of the MDEX Engine API. Use setNavActiveSortKeys(ERecSortKeyList) instead. |
void |
setNavSortOrder(int order)
Deprecated. This method may not be available in future versions of the MDEX Engine API. Use setNavActiveSortKeys(ERecSortKeyList) instead. |
void |
setNavStratifiedDimVals(StratifiedDimValList stratifiedDimValList)
Sets the list of stratified dimension values for use during refinement ranking by the MDEX engine. |
void |
setProfiles(Set profiles)
Sets the profiles that describe characteristics of an application end user. |
void |
setQueryInfo(ENEQueryInfo queryInfo)
Sets the ENEQueryInfo object. |
void |
setSelection(FieldList selectFieldList)
Sets the fields that should be returned for each record in the result set of this query, for navigation, record, and aggregated record queries. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int NAV_SORT_ASCENDING
public static final int NAV_SORT_DESCENDING
public static final int ALL_ERECS_PER_AGGR
public static final int ONE_EREC_PER_AGGR
public static final int ZERO_ERECS_PER_AGGR
public static final int DIM_SEARCH_ALL_DIM_VALUES
public static final int MAX_BULK_ERECS_AVAILABLE
public static final String KEY_PROPS_NONE
public static final String KEY_PROPS_ALL
Constructor Detail |
---|
public ENEQuery()
EmptyQueryException
.
Method Detail |
---|
public void setAnalyticsQuery(AnalyticsQuery q) throws SyntaxException
AnalyticsQuery
instance that represents the
Latitude query that will be sent to the Endeca MDEX Engine.
If the query is malformed, it will not be set on the ENEQuery
and a SyntaxException
is thrown. An AnalyticsQuery
instance can be built programmatically or by
calling AnalyticsQuery.parseQuery(String)
.
q
- the AnalyticsQuery
that will be sent to
the MDEX Engine.
SyntaxException
- if the AnalyticsQuery
is malformed.public AnalyticsQuery getAnalyticsQuery()
AnalyticsQuery
instance (if any) at the root of the AST that
represents the Latitude Analytics query string.
AnalyticsQuery
object.public void setQueryInfo(ENEQueryInfo queryInfo)
ENEQueryInfo
object. This object is used to store
query-specific information (such as the session ID and query ID)
for the MDEX Engine to log.
queryInfo
- a filled ENEQueryInfo
object.public ENEQueryInfo getQueryInfo()
ENEQueryInfo
object. This object can contain
information such as the Session ID and the Query ID.
ENEQueryInfo
object.public void setNavDescriptors(DimValIdList descriptors)
descriptors
- a DimValIdList
object containing the
list of dimension value IDs describing the navigation to query for.public DimValIdList getNavDescriptors()
DimValIdList
object containing the
dimension value (descriptor) IDs of the navigation being
queried for. Returns null
if there are
no navigation descriptors.public void setNavERecsOffset(long offset)
0
if not set.
offset
- the offset into the navigation record list.public long getNavERecsOffset()
public void setNavNumERecs(int number)
10
.
number
- an integer specifying the maximum number of records
to return for the navigation query.public long getNavNumERecs()
public void setNavNumBulkERecs(int number)
MAX_BULK_ERECS_AVAILABLE
is
passed to this method, all records for the navigation query
are returned.
Defaults to 0
.
number
- an integer specifying the maximum number of records
to return in bulk format for the navigation query.public long getNavNumBulkERecs()
public void setNavExposedRefinements(DimValIdList refinementParents)
getNavAllRefinements
method returns false
,
no refinements will be returned and thus refinements must be
specified via this set method to be returned. If
getNavAllRefinements
returns true
, this
method will be ignored unless it includes non-navigable values.
refinementParents
- a DimValIdList
object containing the
IDs of parents of refinements that should be returned in the query.public DimValIdList getNavExposedRefinements()
DimValIdList
object containing the IDs of
parents of the refinements that should be returned with the
navigation query. Returns null
if none have been
specified.public void setNavRefinementConfigs(RefinementConfigList refCfgList)
refCfgList
- A RefinementConfigList
that encapsulates all
dynamic refinement configs to be used by the MDEX Engine.public RefinementConfigList getNavRefinementConfigs()
RefinementConfigList
that encapsulates all
dynamic refinement configs to be used by the MDEX Engine.public void setDimSearchRefinementConfigs(DimSearchRefinementConfigList refCfgList)
refCfgList
- A DimSearchRefinementConfigList
that
encapsulates all refinement configs for dimension search to be used by the
MDEX Engine.public DimSearchRefinementConfigList getDimSearchRefinementConfigs()
DimSearchRefinementConfigList
that encapsulates all
refinement configs for dimension search to be used by the MDEX Engine.public void setNavStratifiedDimVals(StratifiedDimValList stratifiedDimValList)
stratifiedDimValList
- A StratifiedDimValList
that
encapsulates all the strata to be used for refinement ranking in the
MDEX Engine.public StratifiedDimValList getNavStratifiedDimVals()
StratifiedDimValList
that
encapsulates all the strata to be used for refinement ranking in the
MDEX Engine.public void setNavAllRefinements(boolean all)
false
(the default), refinements must be requested
explicitly via the setNavExposedRefinements
method.
all
- true
if all of the refinements should be
returned with the navigation query, or false
if none should be returned.public boolean getNavAllRefinements()
true
if all refinements will be returned from
the navigation, or false
if they will not.public void setNavERecSearchComputeAlternativePhrasings(boolean computeAlternativePhrasings)
true
allows the application to
take advantage of the Automatic Phrasing feature.
For example, if this property is set to true
,
then given an end user's query of:
QUERY[Ann Arbor restaurants]
the Endeca MDEX Engine, if configured appropriately,
will compute:
QUERY["Ann Arbor" restaurants]
as an alternative phrasing of the end user's original record
search query. The alternative phrasings will appear in
either ESearchReport.getAutoSuggestions()
or ESearchReport.getDYMSuggestions()
depending on
how getNavERecSearchRewriteQueryWithAnAlternativePhrasing()
is set.
The default value of this property is false
.
That is, if this method is never called on an ENEQuery
object, then the Endeca MDEX Engine will NOT compute alternative
for the end user's original record search query. In addition,
a call to the corresponding accessor
method getNavERecSearchComputeAlternativePhrasings()
will return false
.
computeAlternativePhrasings
- a boolean
indicating
whether the Endeca MDEX Engine should compute alternative phrasings for
the end user's original record search query.getNavERecSearchComputeAlternativePhrasings()
,
setNavERecSearchRewriteQueryWithAnAlternativePhrasing(boolean)
,
getNavERecSearchRewriteQueryWithAnAlternativePhrasing()
,
ESearchReport.getAutoSuggestions()
,
ESearchReport.getDYMSuggestions()
public boolean getNavERecSearchComputeAlternativePhrasings()
setNavERecSearchComputeAlternativePhrasings(boolean)
for detailed information about this property.
boolean
indicating whether the Endeca MDEX Engine
will compute alternative phrasings for the end user's original record search query.setNavERecSearchComputeAlternativePhrasings(boolean)
,
setNavERecSearchRewriteQueryWithAnAlternativePhrasing(boolean)
,
getNavERecSearchRewriteQueryWithAnAlternativePhrasing()
,
ESearchReport.getAutoSuggestions()
,
ESearchReport.getDYMSuggestions()
public void setNavERecSearchRewriteQueryWithAnAlternativePhrasing(boolean rewriteQueryWithAnAlternativePhrasing)
Note that in order for this method to have any effect, the
Endeca MDEX Engine must compute alternative
phrasings for the end user's original record search
query. That is, the
setNavERecSearchComputeAlternativePhrasings(boolean)
must have been called with the value true
.
The default value of this method is false
.
That is, if this method is never called on an ENEQuery
object, the Endeca MDEX Engine will NOT use an alternative phrasing
instead of the end user's original record search query to
compute the set of matching documents to return.
In addition, a call to the corresponding accessor method
getNavERecSearchRewriteQueryWithAnAlternativePhrasing()
will return false
.
The alternative phrasing that was chosen to replace the end
user's original record search query, if the MDEX Engine
decides to make such a replacement, will be returned in a call to
the ESearchReport.getAutoSuggestions()
method. The alternative
phrasings that were computed by the Endeca MDEX Engine
but not chosen to replace the end user's original record search
query will be returned in a call to the
ESearchReport.getDYMSuggestions()
method.
rewriteQueryWithAnAlternativePhrasing
- a boolean
indicating whether the Endeca MDEX Engine should use one of
the alternative phrasings it has computed for the end user's
original query instead of the end user's original query itself.setNavERecSearchComputeAlternativePhrasings(boolean)
,
getNavERecSearchComputeAlternativePhrasings()
,
getNavERecSearchRewriteQueryWithAnAlternativePhrasing()
,
ESearchReport.getAutoSuggestions()
,
ESearchReport.getDYMSuggestions()
public boolean getNavERecSearchRewriteQueryWithAnAlternativePhrasing()
setNavERecSearchRewriteQueryWithAnAlternativePhrasing(boolean)
for detailed information about this setting.
boolean
indicating whether the Endeca
MDEX Engine should use one of the alternative phrasings it has
computed for the end user's original query
instead of the end user's original query itself.setNavERecSearchComputeAlternativePhrasings(boolean)
,
getNavERecSearchComputeAlternativePhrasings()
,
setNavERecSearchRewriteQueryWithAnAlternativePhrasing(boolean)
,
ESearchReport.getAutoSuggestions()
,
ESearchReport.getDYMSuggestions()
public void setProfiles(Set profiles)
profiles
- the set of profiles that describe
an application end user. Each profile should be a
java.lang.String
.public Set getProfiles()
java.util.Set
that was provided
with setProfiles
when it was called last.
If setProfiles
was never called before on this object,
null
is returned. Note that changing
the Set
returned will change the
set of profiles that will be sent to the Endeca MDEX Engine.public void setSelection(FieldList selectFieldList)
selectFieldList
- the list of fields that should be returned
for each record in the result set of this
query.public FieldList getSelection()
public void setNavSortKey(String key)
setNavActiveSortKeys(ERecSortKeyList)
instead.
key
- Sort key with which the navigation will sort the
matching records.public String getNavSortKey()
getNavActiveSortKeys()
instead.
null
if there is no sort key specified.
IllegalStateException
public ERecSortKeyList getNavActiveSortKeys()
public void setNavActiveSortKeys(ERecSortKeyList criteria)
criteria
- the ERecSortKeyList that contains the
desired sort keys.The order of the keys is significant. The
first key is the primary sort criterion, the second key is
the secondary sort criterion, and so on.public void setNavSortOrder(int order)
setNavActiveSortKeys(ERecSortKeyList)
instead.
NAV_SORT_ASCENDING
or
NAV_SORT_DESCENDING
. Defaults to ascending
and is only applied if the a sort key is present in query as well.
order
- Sort order of the navigation query's records.public int getNavSortOrder()
getNavActiveSortKeys()
instead.
NAV_SORT_ASCENDING
if ascending,
NAV_SORT_DESCENDING
if descending.public void setNavOpts(String opts)
opts
- Navigation query options.public String getNavOpts()
public void setNavRollupKey(String rollupKey)
AggrERec
objects)
will be returned by the navigation query instead of
Endeca records (ERec
objects).
rollupKey
- The Endeca property or dimension that will be used
to roll up the records of the navigation query in order
to create aggregated Endeca records.public String getNavRollupKey()
null
if none
is specified.public void setNavAggrERecsOffset(long offset)
0
if not
set. Only applicable when a aggregated record set is queried for.
offset
- Offset into the navigation aggregated record list.public long getNavAggrERecsOffset()
public void setNavNumAggrERecs(int number)
10
. Only applicable
for aggregated record navigation queries.
number
- Maximum number of aggregated records to return for the
navigation query.public long getNavNumAggrERecs()
public void setNavERecsPerAggrERec(int number)
ALL_ERECS_PER_AGGR
,
ONE_EREC_PER_AGGR
, or
ZERO_ERECS_PER_AGGR
.
number
- Maximum number of records to return per aggregated
record.public int getNavERecsPerAggrERec()
ALL_ERECS_PER_AGGR
,
ONE_EREC_PER_AGGR
, or
ZERO_ERECS_PER_AGGR
.public void setNavNumBulkAggrERecs(int number)
MAX_BULK_ERECS_AVAILABLE
is specified, all aggregated records for the
navigation query will be returned. Only applicable for aggregated
record navigation queries.
Defaults to 0
.
number
- Maximum number of aggregated records to return in bulk
format for the navigation query.public long getNavNumBulkAggrERecs()
public void setNavERecSearches(ERecSearchList searches)
searches
- Record searches to apply to this navigation.public ERecSearchList getNavERecSearches()
null
if none have been
previously specified.public void setNavRelRankERecRank(ERecRank rank)
rank
- Relevance Ranking to apply to this navigation.public ERecRank getNavRelRankERecRank()
null
if no relevance ranking
record search has been specified.public void setNavRelRankERecSearch(ERecSearch search)
setNavRelRankERecRank(ERecRank)
instead.
Sets the relevance ranking record search to perform on the records
of the navigation query.
search
- Relevance Ranking to apply to this navigation.public ERecSearch getNavRelRankERecSearch()
getNavRelRankERecRank()
instead.
Gets the navigation record search specified with relevance
ranking.
null
if no relevance ranking
record search has been specified.public void setNavERecSearchDidYouMean(boolean dymOn)
false
dymOn
- true
if the "Did You Mean" feature
is enabled for record search, or false
if it is not.public boolean getNavERecSearchDidYouMean()
true
if the "Did You Mean" feature is enabled,
false
if it is not.public void setNavRangeFilters(RangeFilterList filters)
filters
- Range filters of the navigation query.public RangeFilterList getNavRangeFilters()
null
if none are returned.public void setNavRecordFilter(String filter)
filter
- Record filter for the navigation query.public String getNavRecordFilter()
null
if none is set.public void setNavRecordStructureExpr(String structureExpr)
structureExpr
- Structure expression for the navigation query.public String getNavRecordStructureExpr()
null
if none is set.public void setNavKeyProperties(String keyPropsReq)
keyPropsReq
- must be one of KEY_PROPS_NONE or KEY_PROPS_ALL.public String getNavKeyProperties()
public void setERecSpec(String recordSpec)
setERecs(ERecIdList)
method
used when only requesting one record.
recordSpec
- The record specification of the record being
queried for.public void setERecs(ERecIdList recordIds)
recordIds
- The record IDs of the records being queried
for.public ERecIdList getERecs()
ERecIdList
of one element.
null
if there
were none.public void setAggrERecSpec(String aggregatedRecordSpec)
aggregatedRecordSpec
- The aggregated record specification
of the aggregated record being queried for.public String getAggrERecSpec()
public void setAggrERecNavDescriptors(DimValIdList descriptors)
descriptors
- Navigation value ids of the aggregated record is
relative to.public DimValIdList getAggrERecNavDescriptors()
null
if none are specified.public void setAggrERecNavRangeFilters(RangeFilterList filters)
filters
- Navigation range filters the aggregated record
is composed relative to.public RangeFilterList getAggrERecNavRangeFilters()
null
if none is present.public void setAggrERecNavRecordFilter(String filter)
filter
- Record filter the aggregated record is composed
relative to.public String getAggrERecNavRecordFilter()
null
if none is present.public void setAggrERecStructureExpr(String filter)
filter
- structure expression used to filter members of the
aggregated record.public String getAggrERecStructureExpr()
public void setAggrERecRollupKey(String key)
key
- Rollup key to compose the aggregated record.public String getAggrERecRollupKey()
null
if none are specified.public ERecSortKeyList getAggrERecActiveSortKeys()
public void setAggrERecActiveSortKeys(ERecSortKeyList criteria)
criteria
- the ERecSortKeyList that contains the
desired sort keys.The order of the keys is significant. The
first key is the primary sort criterion, the second key is
the secondary sort criterion, and so on.public void setDimSearchTerms(String terms)
terms
is that of the form the end user inputted, that
is decoded and untokenized.
terms
- Dimension search terms.public void setDimSearchOpts(String opts)
opts
- Dimension search options.public void setDimSearchCompound(boolean isCompound)
public String getDimSearchTerms()
public String getDimSearchOpts()
public boolean getDimSearchCompound()
public void setDimSearchNavDescriptors(DimValIdList descriptors)
descriptors
- Values that describe a navigation state
restriction on the searchable values.public DimValIdList getDimSearchNavDescriptors()
public void setDimSearchRollupKey(String rollupKey)
Dgraph.AggrBins
key of the DimVal
object's
PropertyMap
.
rollupKey
- The Endeca property or dimension that will be used
to roll up the counts of dimension search query in order
to create aggregated counts.public String getDimSearchRollupKey()
null
if none
is specified.public void setDimSearchNavRangeFilters(RangeFilterList filters)
filters
- Navigation range filters of the dimension search
query.public RangeFilterList getDimSearchNavRangeFilters()
null
if none are present.public void setDimSearchNavRecordFilter(String filter)
filter
- Record filter for the dimension search query.public String getDimSearchNavRecordFilter()
null
if none is present.public void setDimSearchNavRecordStructureExpr(String structureExpr)
structureExpr
- Structure expression for the dimension search.public String getDimSearchNavRecordStructureExpr()
null
if none is set.public void setDimSearchDimension(long dimensionId)
dimensionId
- The dimension id of the dimension that value
search can search from.public void setDimSearchDimensions(DimValIdList dimensionIds)
dimensionIds
- The dimension ids of the dimension that value
search can search from.public long getDimSearchDimension()
getDimSearchDimensions()
would return a list with a single value,
that value will be returned by this function.
Otherwise, returns -1.
public DimValIdList getDimSearchDimensions()
public void setDimSearchNumDimValues(int num)
GlobalDimSearchRefinementConfig.setNumResults(OptionalInt)
instead.
num
- Number of values to be returned in each dimension.public int getDimSearchNumDimValues()
GlobalDimSearchRefinementConfig.getNumResults()
instead.
-1
indicates all and is the default.public void setDimSearchResultsOffset(long offset)
setDimSearchNumDimValues
.
Defaults to 0
.
offset
- Offset into each dimension of results.public long getDimSearchResultsOffset()
public void setDimSearchRankResults(boolean rank)
true
means that relevance ranking is used
to sort dimension search results, while false
means that default dimension value ranking
(alpha, numeric, or manual, as set in Developer Studio) is
used to order dimension search results. The default is
false
, meaning that default dimension value
ranking is used, not relevance ranking.
rank
- true
to use relevance ranking
to sort dimension search results, or false
to use the default dimension value ranking.public boolean getDimSearchRankResults()
true
if relevance ranking is used or
false
if the default dimension value ranking
is used.public void setMerchDebugOn(boolean isMerchDebugOn)
protected boolean isMerchDebugOn()
public void setLanguageId(String id)
id
- The String representing an ISO639 language code.public String getLanguageId()
null
if a language ID has not been set.public boolean containsNavQuery()
true
if query includes a request for a
navigation object and false
if it does not.public boolean containsERecQuery()
containsERecsQuery
and is here for
completeness when requesting only one record.
true
if query includes a record query.
false
if it does not.public boolean containsERecsQuery()
true
if query includes a query for one or more
records. false
if it does not.public boolean containsAggrERecQuery()
true
if query includes a aggregated record query.
false
if it does not.public boolean containsDimSearchQuery()
true
if query includes a dimension search query.
false
if it does not.public boolean containsQuery()
false
if a navigation, record, dimension search,
value set search are specified in query.
true
if none are.public String getNavMerchPreviewTime()
public void setNavMerchPreviewTime(String newTime)
public String getNavMerchRuleFilter()
public void setNavMerchRuleFilter(String filter)
public DisabledRefinementsConfig getNavDisabledRefinementsConfig()
public void setNavDisabledRefinementsConfig(DisabledRefinementsConfig disabledRefinementsConfig)
public void setERec(long recordId)
setERecSpec(String)
instead.
Sets the ID of the record to be queried for. This method is
shorthand for the setERecs(ERecIdList)
method
used when only requesting one record.
recordId
- The record ID of the record being queried
for.public void setAggrERec(long aggregatedRecordId)
setAggrERecSpec(String)
instead.
Sets the ID of the aggregated record to be queried for.
aggregatedRecordId
- The aggregated record ID of the
aggregated record being queried for.public long getAggrERec() throws NumberFormatException
getAggrERecSpec()
instead.
Gets the ID of the aggregated record to be queried for.
NumberFormatException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |