com.endeca.navigation
Class RefinementConfigBase

java.lang.Object
  extended by com.endeca.navigation.RefinementConfigBase
Direct Known Subclasses:
DimSearchRefinementConfig, RefinementConfig

public abstract class RefinementConfigBase
extends Object


Field Summary
protected  long id
           
protected  OptionalBoolean showCounts
           
 
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.
protected  void parseDimValId(String value)
           
protected  void parseShowCounts(String value)
           
 void setShowCounts(OptionalBoolean showCounts_)
          Sets whether the config will show counts.
 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
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.

Parameters:
showCounts_ - A 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 in the dgraph will be used The default is empty.

getShowCounts

public OptionalBoolean getShowCounts()
Gets whether the config will show counts.

Returns:
A 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 in the dgraph will be used The default is empty.

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


2011 Endeca Technologies, Inc.
Endeca Confidential