com.endeca.navigation
Class GlobalDimSearchRefinementConfig

java.lang.Object
  com.endeca.navigation.GlobalDimSearchRefinementConfig

public class GlobalDimSearchRefinementConfig
extends Object

Class representing a global refinement config for dimension search. The options currently available in this class are the ability to turn counts on or off, the ability to specify the number of results to return, and the ability to specify whether the synonyms should be returned.

Constructor Summary

GlobalDimSearchRefinementConfig()
No argument default constructor.

Method Summary

OptionalBoolean	getIncludeInert() Gets whether inert dimension values will be returned for all dimensions.
OptionalInt	getMaxDepth() Gets the maximum depth of dimension values which will be returned for all dimensions.
OptionalInt	getNumResults() Gets the number of results to return per dimension for all dimensions.
OptionalBoolean	getShowCounts() Gets whether the global config will show counts.
OptionalBoolean	getSynonyms() Gets whether the synonyms will be returned for all dimension values.
void	setIncludeInert(OptionalBoolean includeInert_) Sets whether inert dimension values will be returned for all dimensions.
void	setMaxDepth(OptionalInt maxDepth_) Sets the maximum depth of dimension values for all dimensions.
void	setNumResults(OptionalInt numResults_) Sets the number of results to return per dimension for all dimensions.
void	setShowCounts(OptionalBoolean showCounts_) Sets whether the global config will show counts.
void	setSynonyms(OptionalBoolean synonyms_) Sets whether the synonyms will be returned for all dimensions.
String	toString() Returns the string representation of the global config

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GlobalDimSearchRefinementConfig

public GlobalDimSearchRefinementConfig()

No argument default constructor.

Method Detail

setShowCounts

public void setShowCounts(OptionalBoolean showCounts_)

Sets whether the global config will show counts. The per-dimension setting overrides the global setting for that dimension.

Parameters:

showCounts_ - An OptionalBoolean that specifies whether all dimension values will show counts. TRUE indicates the dimension value will display counts and FALSE indicates the dimension value will not. If the OptionalBoolean is empty, then the default value is FALSE.

getShowCounts

public OptionalBoolean getShowCounts()

Gets whether the global config will show counts.

Returns:

An OptionalBoolean that specifies whether all dimension values will show counts. TRUE indicates the dimension value will display counts and FALSE indicates the dimension value is will not. If the OptionalBoolean is empty, then the default value is FALSE.

setNumResults

public void setNumResults(OptionalInt numResults_)

Sets the number of results to return per dimension for all dimensions. The per-dimension setting overrides the global setting for that dimension.

Parameters:

numResults_ - An OptionalInt that specifies the number of values to return per dimension for all dimensions.

getNumResults

public OptionalInt getNumResults()

Gets the number of results to return per dimension for all dimensions.

Returns:

An OptionalInt that specifies the number of results to return per dimension for all dimensions.

setSynonyms

public void setSynonyms(OptionalBoolean synonyms_)

Sets whether the synonyms will be returned for all dimensions. The per-dimension setting overrides the global setting for that dimension.

Parameters:

synonyms_ - An OptionalBoolean that specifies whether the synonyms for all dimension values will be returned. TRUE indicates that the synonyms will be returned and FALSE indicates that the synonyms will not be returned. If the OptionalBoolean is empty, then the default value is FALSE.

getSynonyms

public OptionalBoolean getSynonyms()

Gets whether the synonyms will be returned for all dimension values.

Returns:

An OptionalBoolean that specifies whether the synonyms for all dimension values will be returned. TRUE indicates that the synonyms will be returned and FALSE indicates that the synonyms will not be returned. If the OptionalBoolean is empty, then the default value is FALSE.

setMaxDepth

public void setMaxDepth(OptionalInt maxDepth_)

Sets the maximum depth of dimension values for all dimensions. There is no per-dimension setting.

Parameters:

maxDepth_ - An OptionalInt that specifies the maximum depth of dimension values for all dimensions.

getMaxDepth

public OptionalInt getMaxDepth()

Gets the maximum depth of dimension values which will be returned for all dimensions. There is no per-dimension value.

Returns:

An OptionalInt that specifies the maximum depth of returned dimension values for all dimensions.

setIncludeInert

public void setIncludeInert(OptionalBoolean includeInert_)

Sets whether inert dimension values will be returned for all dimensions.

Parameters:

includeInert_ - An OptionalBoolean that specifies whether inert dimension dimension values will be returned. TRUE indicates inert values will be returned and FALSE indicates that inert values will not be returned. If the OptionalBoolean is empty, then the default value is FALSE.

getIncludeInert

public OptionalBoolean getIncludeInert()

Gets whether inert dimension values will be returned for all dimensions. There is no per-dimension flag.

Returns:

An OptionalBoolean that specifies whether inert dimension values will be returned. TRUE indicates that inert values will be returned and FALSE indicates that inert values will not be returned. If the OptionalBoolean is empty, then the default value is FALSE.

toString

public String toString()

Returns the string representation of the global config

Overrides:

toString in class Object

Returns:

The string representation of the global config