|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.AbstractMap<K,V> java.util.HashMap<String,Object> com.endeca.infront.assembler.BasicContentItem com.endeca.infront.cartridge.ResultsListConfig
public class ResultsListConfig
ResultsListHandler
configuration model.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class java.util.AbstractMap |
---|
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V> |
Nested classes/interfaces inherited from interface java.util.Map |
---|
Map.Entry<K,V> |
Constructor Summary | |
---|---|
ResultsListConfig()
Creates a ResultsListConfig with the following default settings: offset = 0 recordsPerPage = 10 whyMatchEnabled = false whyRankEnabled = false |
|
ResultsListConfig(String pType)
Creates a ResultsListConfig with the specified type and the following default settings: offset = 0 recordsPerPage = 10 whyMatchEnabled = false whyRankEnabled = false |
Method Summary | |
---|---|
List<CollectionFilter> |
getBoostStrata()
Returns filters which allow items to be boosted to the top of the results. |
List<CollectionFilter> |
getBuryStrata()
Returns filters which allow items to be buried at the bottom of the results. |
List<String> |
getFieldNames()
Returns the record fields that will be returned in the ContentItem . |
long |
getOffset()
Returns the record offset. |
String |
getRecordDisplayFieldName()
Returns the field that is considered to hold the name of the record |
int |
getRecordsPerPage()
Returns records displayed per page. |
String |
getRelRank()
Deprecated. use getRelRankStrategy() instead. |
String |
getRelRankKey()
Returns the relevance ranking key to be used with the relevance ranking strategy. |
MatchMode |
getRelRankMatchMode()
Returns the relevance ranking match mode. |
String |
getRelRankStrategy()
Returns the relevance ranking strategy. |
String |
getRelRankTerms()
Returns the relevance ranking terms to be used with the relevance ranking strategy. |
SortOption |
getSortOption()
Returns the sort option, may be null. |
List<String> |
getSubRecordFieldNames()
Returns the sub-record fields (of aggregate records) that will be returned in the ContentItem . |
SubRecordsPerAggregateRecord |
getSubRecordsPerAggregateRecord()
For aggregate records, the number of sub records that should be included in the results. |
boolean |
isIncludePrecomputedSorts()
|
boolean |
isWhyMatchEnabled()
Returns if why match debugging should be enabled. |
boolean |
isWhyRankEnabled()
Returns if why rank debugging should be enabled. |
void |
setBoostStrata(List<CollectionFilter> boostStrata)
Sets filters which allow items to be boosted to the top of the results. |
void |
setBuryStrata(List<CollectionFilter> buryStrata)
Sets filters which allow items to be buried at the bottom of the results. |
void |
setFieldNames(List<String> fieldNames)
Specifies which record fields will be passed through from the records to the resulting ContentItem . |
void |
setIncludePrecomputedSorts(boolean enabled)
Sets if default sorts (precomputed mdex sorts) are included in the results list model |
void |
setOffset(long offset)
Sets the record offset. |
void |
setRecordDisplayFieldName(String recordDisplayFieldName)
Sets the name of the field that stores the record's logical name |
void |
setRecordsPerPage(int recsPerPage)
Sets records displayed per page. |
void |
setRelRank(String relRank)
Deprecated. use setRelRankStrategy(String) instead. |
void |
setRelRankKey(String relRankKey)
Sets the relevance ranking key to be used with the relevance ranking strategy. |
void |
setRelRankMatchMode(MatchMode relRankMatchMode)
Sets the relevance ranking match mode. |
void |
setRelRankStrategy(String relRankStrategy)
Sets the relevance ranking strategy. |
void |
setRelRankTerms(String relRankTerms)
Sets one or more terms that will be used with the relevance ranking strategy to order the records. |
void |
setSortOption(SortOption sortOption)
Sets the sort option and also marks it as a default sort. |
void |
setSortRequestParameter(String paramValue)
Sets the requested sort as a String. |
void |
setSubRecordFieldNames(List<String> fieldNames)
Specifies which sub-record fields (of aggregate records) will be passed through to the resulting ContentItem . |
void |
setSubRecordsPerAggregateRecord(SubRecordsPerAggregateRecord numSubRecords)
For aggregate records, sets the number of sub records that should be included in the results. |
void |
setWhyMatchEnabled(boolean enabled)
Sets if why match debugging should be enabled. |
void |
setWhyRankEnabled(boolean enabled)
Sets if why rank debugging should be enabled. |
Methods inherited from class com.endeca.infront.assembler.BasicContentItem |
---|
getBooleanProperty, getIntProperty, getLongProperty, getType, getTypedProperty, setType |
Methods inherited from class java.util.HashMap |
---|
clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values |
Methods inherited from class java.util.AbstractMap |
---|
equals, hashCode, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.Map |
---|
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values |
Constructor Detail |
---|
public ResultsListConfig()
public ResultsListConfig(String pType)
pType
- a value that will be used as the typeBasicContentItem.getType()
Method Detail |
---|
public List<CollectionFilter> getBoostStrata()
public void setBoostStrata(List<CollectionFilter> boostStrata)
boostStrata
- stratification filters, may be null.public List<CollectionFilter> getBuryStrata()
public void setBuryStrata(List<CollectionFilter> buryStrata)
buryStrata
- stratification filters, may be null.public SortOption getSortOption()
public void setSortOption(SortOption sortOption)
ResultsListRequestParamMarshaller
@Deprecated public String getRelRank()
getRelRankStrategy()
instead.
setRelRank(String)
@Deprecated public void setRelRank(String relRank)
setRelRankStrategy(String)
instead.
relRank
- the relevance ranking strategy. This may be null, in which case default relevance ranking is used.
The default relevance ranking strategy is defined in MDEX based on the search key.public String getRelRankStrategy()
setRelRankStrategy(String)
public void setRelRankStrategy(String relRankStrategy)
Relevance ranking strategy strings must contain one or more relevance ranking module names.
Module names can be any of these pre-defined modules: exact,field (useful for record search only),first,freq,glom (useful for record search only),interp, maxfield (useful for record search only),nterms,numfields (useful for record search only), phrase (for details on using phrase, see the section below),proximity,spell,stem, thesaurus,static (for details on using static, see the section below),wfreq
Module names are delimited by comma (,) characters. No other stray characters (such as spaces) are allowed. Module names are listed in descending order of priority.
The following are examples of valid relevance ranking strategy strings:
relRankStrategy
- the relevance ranking strategy. This may be null, in which case default relevance ranking is used.
The default relevance ranking strategy is defined in MDEX based on the search key.public String getRelRankKey()
setRelRankKey(String)
public void setRelRankKey(String relRankKey)
This variable is optional, but if it is specified, a relevance ranking strategy setRelRankStrategy(String)
and relevance ranking terms setRelRankTerms(String)
must also be specified.
If this is null, but a relevance ranking strategy is specified setRelRankStrategy(String)
,
the search key defined in the first search filter will be used instead FilterState.getSearchFilters()
.
When using EQL filter, this cannot be null if applying a relevance ranking other than the default MDEX relevance ranking strategy.
relRankKey
- the relevance ranking key.public String getRelRankTerms()
setRelRankTerms(String)
public void setRelRankTerms(String relRankTerms)
FilterState.getSearchFilters()
This variable is optional, but if it is specified, a relevance ranking strategy setRelRankStrategy(String)
and relevance ranking key setRelRankKey(String)
must also be specified.
If this is null, but a relevance ranking strategy is specified setRelRankStrategy(String)
,
the search terms defined in the first search filter will be used instead FilterState.getSearchFilters()
.
When using EQL filter, this cannot be null if applying a relevance ranking other than the default MDEX relevance ranking strategy.
relRankTerms
- the relevance ranking terms.public MatchMode getRelRankMatchMode()
setRelRankMatchMode(com.endeca.infront.navigation.model.MatchMode)
public void setRelRankMatchMode(MatchMode relRankMatchMode)
MatchMode
This variable is optional, but if it is specified, a relevance ranking strategy setRelRankStrategy(String)
,
relevance ranking key setRelRankKey(String)
and relevance ranking terms setRelRankTerms(String)
must also be specified.
If this is null, but a relevance ranking strategy is specified setRelRankStrategy(String)
,
the match mode defined in the first search filter will be used instead FilterState.getSearchFilters()
.
When using EQL filter, this cannot be null if applying a relevance ranking other than the default MDEX relevance ranking strategy.
relRankMatchMode
- the relevance ranking match mode.public void setSubRecordsPerAggregateRecord(SubRecordsPerAggregateRecord numSubRecords)
numSubRecords
- as specified by SubRecordsPerAggregateRecord
.public SubRecordsPerAggregateRecord getSubRecordsPerAggregateRecord()
SubRecordsPerAggregateRecord
.
This method may also return null, in which case a default value of one will be assumed
by the MDEX.public int getRecordsPerPage()
10
.
public void setRecordsPerPage(int recsPerPage)
ResultsListRequestParamMarshaller
public long getOffset()
0
.
public void setOffset(long offset)
ResultsListRequestParamMarshaller
public boolean isWhyMatchEnabled()
false
.
Note: For debugging information to be returned, it is not sufficient for this method to
return true
. Debugging must also be enabled on
NavigationRequest
. To accomplish
this, specify debugEnabled=true
when instantiating
MdexRequestBroker
.
setWhyMatchEnabled(boolean)
,
MdexRequestBroker
public void setWhyMatchEnabled(boolean enabled)
Note: in order for debugging information to be returned, debugging must be enabled on
NavigationRequest
. To accomplish
this, specify debugEnabled=true
when instantiating
MdexRequestBroker
.
isWhyMatchEnabled()
,
ResultsListRequestParamMarshaller
,
MdexRequestBroker
public boolean isWhyRankEnabled()
false
.
Note: For debugging information to be returned, it is not sufficient for this method to
return true
. Debugging must also be enabled on
NavigationRequest
. To accomplish
this, specify debugEnabled=true
when instantiating
MdexRequestBroker
.
setWhyRankEnabled(boolean)
,
MdexRequestBroker
public void setWhyRankEnabled(boolean enabled)
Note: in order for debugging information to be returned, debugging must be enabled on
NavigationRequest
. To accomplish
this, specify debugEnabled=true
when instantiating
MdexRequestBroker
.
isWhyRankEnabled()
,
ResultsListRequestParamMarshaller
,
MdexRequestBroker
public void setSortRequestParameter(String paramValue)
SortOption
.
setSortOption(com.endeca.infront.navigation.model.SortOption)
,
ResultsListRequestParamMarshaller
public String getRecordDisplayFieldName()
public void setRecordDisplayFieldName(String recordDisplayFieldName)
ResultsListRequestParamMarshaller
public void setIncludePrecomputedSorts(boolean enabled)
isIncludePrecomputedSorts()
public boolean isIncludePrecomputedSorts()
false
.
setIncludePrecomputedSorts(boolean)
public void setFieldNames(List<String> fieldNames)
ContentItem
. If null, the default set of field names
configured for the MDEX (from render_config.xml
) will be returned.
If aggregation is enabled, this list is used to specify the record field names
for the aggregated records, and the subRecordFieldNames
list is used
to specify the record field names for the sub-records (child) records.
If aggregation is disabled and a subRecordFieldNames
list is also specified,
it will be combined with this list.
getFieldNames()
,
getSubRecordFieldNames()
public List<String> getFieldNames()
ContentItem
.
setFieldNames(java.util.List)
,
setSubRecordFieldNames(java.util.List)
public void setSubRecordFieldNames(List<String> fieldNames)
ContentItem
.
If aggregation is enabled and this list is null, all field names configured
for the MDEX (from render_config.xml
) will be returned on the
sub-records (child records). The field names specified by setFieldNames(java.util.List)
will be used to determine the field names returned on the aggregated records.
If aggregation is disabled and this list is non-null, its field names will be
combined with the field names specified by setFieldNames(java.util.List)
;
the combined list will be used to determine the field names that should be returned
on the non-aggregated records.
getSubRecordFieldNames()
,
getFieldNames()
public List<String> getSubRecordFieldNames()
ContentItem
. If aggregation is disabled, this
list is combined with the fieldNames.
setSubRecordFieldNames(java.util.List)
,
setFieldNames(java.util.List)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |