com.endeca.navigation
Class RefinementConfigBase

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

Direct Known Subclasses:

DimSearchRefinementConfig, RefinementConfig

public abstract class RefinementConfigBase
extends Object

Field Summary

protected long	id
protected OptionalBoolean	showCounts
protected OptionalBoolean	synonyms

Constructor Summary

RefinementConfigBase(long dimValId)
Default constructor where the dimValId sets the dimension value this configuration is associated with.

Method Summary

long	getDimValId() Gets the dimension value ID.
OptionalBoolean	getShowCounts() Gets whether the config will show counts.
OptionalBoolean	getSynonyms() Gets whether the synonyms will be returned for the dimension value.
protected void	parseDimValId(String value)
protected void	parseShowCounts(String value)
protected void	parseSynonyms(String value)
void	setShowCounts(OptionalBoolean showCounts_) Sets whether the config will show counts.
void	setSynonyms(OptionalBoolean synonyms_) Sets whether the synonyms will be returned for the dimension value.
String	toString() Returns the string representation of the config

Methods inherited from class java.lang.Object

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

Field Detail

id

protected long id

showCounts

protected OptionalBoolean showCounts

synonyms

protected OptionalBoolean synonyms

Constructor Detail

RefinementConfigBase

public RefinementConfigBase(long dimValId)

Default constructor where the dimValId sets the dimension value this configuration is associated with.

Parameters:

dimValId - Specifies what dimension value this configuration is associated with.

Method Detail

getDimValId

public long getDimValId()

Gets the dimension value ID. Returned object is of type long.

Returns:

ID of the dimension value.

setShowCounts

public void setShowCounts(OptionalBoolean showCounts_)

Sets whether the config will show counts. This setting overrides the global setting for the dimension.

Parameters:

showCounts_ - An OptionalBoolean that specifies whether the dimension value 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 config will show counts.

Returns:

An OptionalBoolean that specifies whether the dimension value 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.

setSynonyms

public void setSynonyms(OptionalBoolean synonyms_)

Sets whether the synonyms will be returned for the dimension value. This setting overrides the global setting for the dimension.

Parameters:

synonyms_ - An OptionalBoolean that specifies whether the synonyms for the dimension value 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 the dimension value.

Returns:

An OptionalBoolean that specifies whether the synonyms for the dimension value 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.

toString

public String toString()

Returns the string representation of the config

Overrides:

toString in class Object

Returns:

The string representation of the config

parseDimValId

protected void parseDimValId(String value)
                      throws UrlENEQueryParseException

Throws:

UrlENEQueryParseException

parseShowCounts

protected void parseShowCounts(String value)
                        throws UrlENEQueryParseException

Throws:

UrlENEQueryParseException

parseSynonyms

protected void parseSynonyms(String value)
                      throws UrlENEQueryParseException

Throws:

UrlENEQueryParseException