|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.navigation.RefinementConfig
public class RefinementConfig
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 |
---|
public RefinementConfig(long dimValId)
dimValId
sets the dimension
value this dynamic refinement config is associated with.
dimValId
- Specifies what dimension value this dynamic refinement config
is associated with.Method Detail |
---|
public long getDimValId()
long
.
public boolean isDynamicRankingEnabled()
boolean
indicating if Dynamic Ranking is
enabled for the dimension value.
Defaults to FALSE
.public boolean isDynamicRankingDisabled()
boolean
indicating if Dynamic Ranking is
disabled for the dimension value.
Defaults to FALSE
.public boolean isDynamicRankingDefault()
boolean
indicating if Dynamic Ranking is
set to use default for the dimension value.
Defaults to TRUE
.public boolean isDynamicRankOrderStatic()
boolean
indicating if the dimension value is
sorted statically.
Defaults to FALSE
.public boolean isDynamicRankOrderDynamic()
boolean
indicating if the dimension value is
sorted dynamically.
Defaults to FALSE
.public boolean isDynamicRankOrderDefault()
boolean
indicating if Dynamic Ranking is
set to use default for the dimension value.
Defaults to TRUE
.public OptionalInt getDynamicRefinementCount()
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
.public boolean isExposed()
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
.public void setDynamicRankingEnabled()
public void setDynamicRankingDisabled()
public void setDynamicRankingDefault()
public void setDynamicRankOrderStatic()
public void setDynamicRankOrderDynamic()
public void setDynamicRankOrderDefault()
public void setDynamicRefinementCount(OptionalInt count)
count
- An OptionalInt
that specifies the maximum
dimension values to return.
An empty OptionalInt
indicates to use
the setting in Developer Studio.public void setExposed(boolean expose)
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
.public String toString()
toString
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |