com.endeca.navigation
Class RefinementConfig

java.lang.Object
  extended by com.endeca.navigation.RefinementConfig

public class RefinementConfig
extends Object

Class representing a dynamic refinement config for a dimension value. This will determine how refinements are computed under this dimension value. Use of a dynamic refinement config will suppress generation of a "More..." child dimension value. You can determine whether there are more refinements than the ones shown by looking at the "DGraph.More" property on the refinements' parent dimension value. Any of the settings in this class can be set explicitly or defaulted to use the corresponding dimension's settings in developer studio.


Constructor Summary
RefinementConfig(long dimValId)
          Default constructor where the dimValId sets the dimension value this dynamic refinement config is associated with.
 
Method Summary
 long getDimValId()
          Gets the dimension value ID.
 OptionalInt getDynamicRefinementCount()
          Gets the maximum number of dimension values to return.
 boolean isDynamicRankingDefault()
          Gets whether the dimension value has Dynamic Ranking set to use default.
 boolean isDynamicRankingDisabled()
          Gets whether the dimension value has Dynamic Ranking disabled.
 boolean isDynamicRankingEnabled()
          Gets whether the dimension value has Dynamic Ranking enabled.
 boolean isDynamicRankOrderDefault()
          Gets whether the dimension value is sorted using the default.
 boolean isDynamicRankOrderDynamic()
          Gets whether the dimension value is sorted dynamically (ordered by refinement count).
 boolean isDynamicRankOrderStatic()
          Gets whether the dimension value is sorted statically (ordered by refinement sort order).
 boolean isExposed()
          Gets whether the dimension value is exposed.
 void setDynamicRankingDefault()
          Sets Dynamic Ranking to be enabled or disabled depending on the dimension's setting in Developer Studio.
 void setDynamicRankingDisabled()
          Disables Dynamic Ranking for the dimension value.
 void setDynamicRankingEnabled()
          Enables Dynamic Ranking for the dimension value.
 void setDynamicRankOrderDefault()
          Sets the dimension value to be sorted statically or dynamically depending on the dimension's setting in Developer Studio.
 void setDynamicRankOrderDynamic()
          Sets the dimension value to be sorted dynamically (ordered by refinement count).
 void setDynamicRankOrderStatic()
          Sets the dimension value to be sorted statically (ordered by refinement sort order).
 void setDynamicRefinementCount(OptionalInt count)
          Sets the maximum dimension values to return.
 void setExposed(boolean expose)
          Sets whether the dimension value is exposed.
 String toString()
          Returns the string representation of the dynamic refinement config.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RefinementConfig

public RefinementConfig(long dimValId)
Default constructor where the dimValId sets the dimension value this dynamic refinement config is associated with.

Parameters:
dimValId - Specifies what dimension value this dynamic refinement config 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.

isDynamicRankingEnabled

public boolean isDynamicRankingEnabled()
Gets whether the dimension value has Dynamic Ranking enabled.

Returns:
A boolean indicating if Dynamic Ranking is enabled for the dimension value. Defaults to FALSE.

isDynamicRankingDisabled

public boolean isDynamicRankingDisabled()
Gets whether the dimension value has Dynamic Ranking disabled.

Returns:
A boolean indicating if Dynamic Ranking is disabled for the dimension value. Defaults to FALSE.

isDynamicRankingDefault

public boolean isDynamicRankingDefault()
Gets whether the dimension value has Dynamic Ranking set to use default. If Dynamic Ranking is set to use default then Dynamic Ranking will be enabled or disabled depending on the dimension's setting in Developer Studio.

Returns:
A boolean indicating if Dynamic Ranking is set to use default for the dimension value. Defaults to TRUE.

isDynamicRankOrderStatic

public boolean isDynamicRankOrderStatic()
Gets whether the dimension value is sorted statically (ordered by refinement sort order). This is only used if the dimension value has Dynamic Ranking enabled.

Returns:
A boolean indicating if the dimension value is sorted statically. Defaults to FALSE.

isDynamicRankOrderDynamic

public boolean isDynamicRankOrderDynamic()
Gets whether the dimension value is sorted dynamically (ordered by refinement count). This is only used if the dimension value has Dynamic Ranking enabled.

Returns:
A boolean indicating if the dimension value is sorted dynamically. Defaults to FALSE.

isDynamicRankOrderDefault

public boolean isDynamicRankOrderDefault()
Gets whether the dimension value is sorted using the default. If set to use default then the dimension value will be sorted statically or dynamically depending on the dimension's setting in Developer Studio. This is only used if the dimension value has Dynamic Ranking enabled.

Returns:
A boolean indicating if Dynamic Ranking is set to use default for the dimension value. Defaults to TRUE.

getDynamicRefinementCount

public OptionalInt getDynamicRefinementCount()
Gets the maximum number of dimension values to return. This is only used if the dimension value has Dynamic Ranking enabled.

Returns:
An OptionalInt specifying the maximum number of dimension values to return. An empty OptionalInt indicates to use the setting in Developer Studio. Defaults to an empy OptionalInt.

isExposed

public boolean isExposed()
Gets whether the dimension value is exposed.

Returns:
A boolean indicating whether to expose the dimension value. Returned boolean is either TRUE (dimension value is exposed) or FALSE (dimension value is not exposed). Defaults to TRUE.

setDynamicRankingEnabled

public void setDynamicRankingEnabled()
Enables Dynamic Ranking for the dimension value.


setDynamicRankingDisabled

public void setDynamicRankingDisabled()
Disables Dynamic Ranking for the dimension value.


setDynamicRankingDefault

public void setDynamicRankingDefault()
Sets Dynamic Ranking to be enabled or disabled depending on the dimension's setting in Developer Studio.


setDynamicRankOrderStatic

public void setDynamicRankOrderStatic()
Sets the dimension value to be sorted statically (ordered by refinement sort order). This is only used if the dimension value has Dynamic Ranking enabled.


setDynamicRankOrderDynamic

public void setDynamicRankOrderDynamic()
Sets the dimension value to be sorted dynamically (ordered by refinement count). This is only used if the dimension value has Dynamic Ranking enabled.


setDynamicRankOrderDefault

public void setDynamicRankOrderDefault()
Sets the dimension value to be sorted statically or dynamically depending on the dimension's setting in Developer Studio. This is only used if the dimension value has Dynamic Ranking enabled.


setDynamicRefinementCount

public void setDynamicRefinementCount(OptionalInt count)
Sets the maximum dimension values to return. This is only used if the dimension value has Dynamic Ranking enabled.

Parameters:
count - An OptionalInt that specifies the maximum dimension values to return. An empty OptionalInt indicates to use the setting in Developer Studio.

setExposed

public void setExposed(boolean expose)
Sets whether the dimension value is exposed.

Parameters:
expose - A boolean that specifies whether the dimension value is exposed. TRUE indicates the dimension value is exposed and FALSE indicates the dimension value is not exposed. Defaults to TRUE.

toString

public String toString()
Returns the string representation of the dynamic refinement config.

Overrides:
toString in class Object
Returns:
The string representation of the dynamic refinement config.


2010 Endeca Technologies, Inc.
Endeca Confidential