|
||||||||||
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.DimensionSearchResultsConfig
public class DimensionSearchResultsConfig
DimensionSearchResultsHandler
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 | |
---|---|
DimensionSearchResultsConfig()
Creates a DimensionSearchResultsConfig with the following default settings: enabled = false
showCountsEnabled = false
relRankEnabled = false
maxResults = 100
maxResultsPerDimension = 10
dimensionList = null
|
|
DimensionSearchResultsConfig(ContentItem pContentItem)
Creates a DimensionSearchResultsConfig with the following default settings: enabled = false
showCountsEnabled = false
relRankEnabled = false
maxResults = 100
maxResultsPerDimension = 10
dimensionList = null
|
|
DimensionSearchResultsConfig(String pType)
Creates a DimensionSearchResultsConfig with the following default settings: enabled = false
showCountsEnabled = false
relRankEnabled = false
maxResults = 100
maxResultsPerDimension = 10
dimensionList = null
|
Method Summary | |
---|---|
List<String> |
getDimensionList()
Returns the dimensions that will be used for dimension search. |
int |
getMaxResults()
Returns the maximum total number of dimension search results. |
int |
getMaxResultsPerDimension()
Returns the maximum number of dimension search results returned for each dimension. |
String |
getRelRank()
Deprecated. use getRelRankStrategy() instead. |
String |
getRelRankStrategy()
Returns the relevance ranking strategy. |
boolean |
isEnabled()
Returns whether or not the dimension search cartridge is enabled. |
boolean |
isShowCountsEnabled()
Returns whether or not record counts are calculated for each result item. |
void |
setDimensionList(List<String> dimensionList)
Sets the dimensions to be used for dimension search. |
void |
setEnabled(boolean enabled)
Enables or disables the dimension search cartridge. |
void |
setMaxResults(int maxResults)
Sets the maximum total number of dimension search results. |
void |
setMaxResultsPerDimension(int maxResultsPerDimension)
Sets the maximum number of dimension search results returned for each dimension. |
void |
setRelRank(String relRank)
Deprecated. use setRelRankStrategy(String) instead. |
void |
setRelRankStrategy(String relRankStrategy)
Sets the relevance ranking strategy. |
void |
setShowCountsEnabled(boolean enabled)
Enables or disable the calculation of record counts. |
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 DimensionSearchResultsConfig()
false
false
false
100
10
null
public DimensionSearchResultsConfig(String pType)
false
false
false
100
10
null
public DimensionSearchResultsConfig(ContentItem pContentItem)
false
false
false
100
10
null
Method Detail |
---|
public boolean isEnabled()
false
, the cartridge handler returns null
for its output model.
The default value is false
.
setEnabled(boolean)
public void setEnabled(boolean enabled)
enabled
- true if dimensions search cartridge should be enabled.isEnabled()
public List<String> getDimensionList()
null
or empty
,
then the dimension search will apply across all dimensions.
The default value is null
.
setDimensionList(java.util.List)
public void setDimensionList(List<String> dimensionList)
null
or empty
,
then the dimension search will apply across all dimensions.
dimensionList
- a list of Strings representing dimension value IDs. May
be null or empty.getDimensionList()
public int getMaxResultsPerDimension()
10
.
setMaxResultsPerDimension(int)
public void setMaxResultsPerDimension(int maxResultsPerDimension)
maxResultsPerDimension
- number of maximum results per dimensiongetMaxResultsPerDimension()
public int getMaxResults()
100
.
setMaxResults(int)
public void setMaxResults(int maxResults)
maxResults
- total number of dimension search results.getMaxResults()
public boolean isShowCountsEnabled()
false
.
setShowCountsEnabled(boolean)
public void setShowCountsEnabled(boolean enabled)
enabled
- true if record counts should be returned.isShowCountsEnabled()
@Deprecated public String getRelRank()
getRelRankStrategy()
instead.
setRelRank(String)
@Deprecated public void setRelRank(String relRank)
setRelRankStrategy(String)
instead.
Defaults to null.
relRank
- a relrank string, such as "first,static(nbins,desc)" or "exact", or "exact,first"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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |