com.endeca.navigation
Class DimSearchRefinementConfig

java.lang.Object
  com.endeca.navigation.RefinementConfigBase
      com.endeca.navigation.DimSearchRefinementConfig

public class DimSearchRefinementConfig
extends RefinementConfigBase

Class representing a refinement config for dimension search for a dimension value. The only option available in this class is the ability to turn counts on or off

Field Summary

Fields inherited from class com.endeca.navigation.RefinementConfigBase

id, showCounts, synonyms

Constructor Summary

DimSearchRefinementConfig(long dimValId)
Default constructor where the dimValId sets the dimension value this dimension search refinement config is associated with.

Method Summary

OptionalInt	getNumResults() Gets the maximum number of results to return for the dimension.
void	setNumResults(OptionalInt numResults_) Sets the maximum number of results to return for the dimension.
String	toString() Returns the string representation of the dimension search refinement config.

Methods inherited from class com.endeca.navigation.RefinementConfigBase

getDimValId, getShowCounts, getSynonyms, parseDimValId, parseShowCounts, parseSynonyms, setShowCounts, setSynonyms

Methods inherited from class java.lang.Object

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

Constructor Detail

DimSearchRefinementConfig

public DimSearchRefinementConfig(long dimValId)

Default constructor where the dimValId sets the dimension value this dimension search refinement config is associated with.

Parameters:

dimValId - Specifies what dimension value this dimension search refinement config is associated with.

Method Detail

setNumResults

public void setNumResults(OptionalInt numResults_)

Sets the maximum number of results to return for the dimension.

Parameters:

numResults_ - An OptionalInt that specifies the maximum number of results to return for the dimension. If the OptionalInt is empty, then, by default, all results are returned.

getNumResults

public OptionalInt getNumResults()

Gets the maximum number of results to return for the dimension.

Returns:

An OptionalInt that specifies the maximum number of results to return for the dimension. If the OptionalInt is empty, then, by default, all results are returned.

toString

public String toString()

Returns the string representation of the dimension search refinement config.

Overrides:

toString in class RefinementConfigBase

Returns:

The string representation of the dimension search refinement config.