com.endeca.infront.cartridge
Class DimensionSearchResultsConfig

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap<String,Object>
          com.endeca.infront.assembler.BasicContentItem
              com.endeca.infront.cartridge.DimensionSearchResultsConfig

All Implemented Interfaces:

ContentItem, Serializable, Cloneable, Map<String,Object>

public class DimensionSearchResultsConfig
extends BasicContentItem

DimensionSearchResultsHandler configuration model.

See Also:

Serialized Form

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

DimensionSearchResultsConfig

public DimensionSearchResultsConfig()

Creates a DimensionSearchResultsConfig with the following default settings:

• enabled = false
• showCountsEnabled = false
• relRankEnabled = false
• maxResults = 100
• maxResultsPerDimension = 10
• dimensionList = null

DimensionSearchResultsConfig

public DimensionSearchResultsConfig(String pType)

Creates a DimensionSearchResultsConfig with the following default settings:

• enabled = false
• showCountsEnabled = false
• relRankEnabled = false
• maxResults = 100
• maxResultsPerDimension = 10
• dimensionList = null

DimensionSearchResultsConfig

public DimensionSearchResultsConfig(ContentItem pContentItem)

Creates a DimensionSearchResultsConfig with the following default settings:

• enabled = false
• showCountsEnabled = false
• relRankEnabled = false
• maxResults = 100
• maxResultsPerDimension = 10
• dimensionList = null

Method Detail

isEnabled

public boolean isEnabled()

Returns whether or not the dimension search cartridge is enabled. If false, the cartridge handler returns null for its output model.

The default value is false.

See Also:

setEnabled(boolean)

setEnabled

public void setEnabled(boolean enabled)

Enables or disables the dimension search cartridge.

Parameters:

enabled - true if dimensions search cartridge should be enabled.

See Also:

isEnabled()

getDimensionList

public List<String> getDimensionList()

Returns the dimensions that will be used for dimension search. This is a list of root dimension value IDs. If null or empty, then the dimension search will apply across all dimensions.

The default value is null.

See Also:

setDimensionList(java.util.List)

setDimensionList

public void setDimensionList(List<String> dimensionList)

Sets the dimensions to be used for dimension search. This is a list of root dimension value IDs. If null or empty, then the dimension search will apply across all dimensions.

Parameters:

dimensionList - a list of Strings representing dimension value IDs. May be null or empty.

See Also:

getDimensionList()

getMaxResultsPerDimension

public int getMaxResultsPerDimension()

Returns the maximum number of dimension search results returned for each dimension.

The default value is 10.

Returns:

the number of maximum results per dimension

See Also:

setMaxResultsPerDimension(int)

setMaxResultsPerDimension

public void setMaxResultsPerDimension(int maxResultsPerDimension)

Sets the maximum number of dimension search results returned for each dimension.

Parameters:

maxResultsPerDimension - number of maximum results per dimension

See Also:

getMaxResultsPerDimension()

getMaxResults

public int getMaxResults()

Returns the maximum total number of dimension search results.

The default value is 100.

Returns:

maximum total number of dimension search results.

See Also:

setMaxResults(int)

setMaxResults

public void setMaxResults(int maxResults)

Sets the maximum total number of dimension search results.

Parameters:

maxResults - total number of dimension search results.

See Also:

getMaxResults()

isShowCountsEnabled

public boolean isShowCountsEnabled()

Returns whether or not record counts are calculated for each result item.

The default value is false.

See Also:

setShowCountsEnabled(boolean)

setShowCountsEnabled

public void setShowCountsEnabled(boolean enabled)

Enables or disable the calculation of record counts.

Parameters:

enabled - true if record counts should be returned.

See Also:

isShowCountsEnabled()

getRelRank

@Deprecated
public String getRelRank()

Deprecated. use getRelRankStrategy() instead.

Returns the relevancy ranking strategy for sorting dimension search results.

Returns:

relevancy ranking strategy. This may be null or an empty string.

See Also:

setRelRank(String)

setRelRank

@Deprecated
public void setRelRank(String relRank)

Deprecated. use setRelRankStrategy(String) instead.

Sets the relevancy ranking strategy to use for sorting dimension search results. Set to null or an empty string to use the default default dimension value ranking (alpha, numeric, or manual, as set in Developer Studio).

Defaults to null.

Parameters:

relRank - a relrank string, such as "first,static(nbins,desc)" or "exact", or "exact,first"

getRelRankStrategy

public String getRelRankStrategy()

Returns the relevance ranking strategy. This is ignored if the user has selected a specific sort.

Returns:

the relevance ranking strategy.

See Also:

setRelRankStrategy(String)

setRelRankStrategy

public void setRelRankStrategy(String relRankStrategy)

Sets the relevance ranking strategy. This is ignored if the user has selected a specific sort. This may be null, in which case default relevance ranking in MDEX is used. The default relevance ranking strategy is defined in MDEX based on the search key.

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:

• exact
• exact(considerFieldRanks)
• field,phrase,interp
• static(Price,ascending)
• static(Availability,descending),exact,static(Price,ascending)
• phrase(approximate,subphrase)

For more details on the behavior of relevance rank modules, see the Endeca MDEX Engine Advanced Development Guide.

Parameters:

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.