|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.AbstractMap<K,V> java.util.HashMap<String,Object> com.endeca.infront.assembler.BasicContentItem com.endeca.infront.cartridge.RefinementMenuConfig
public class RefinementMenuConfig
RefinementMenuHandler
configuration model.
Nested Class Summary | |
---|---|
static class |
RefinementMenuConfig.RefinementsShown
An enumeration of valid values for getRefinementsShown() |
Nested classes/interfaces inherited from class java.util.AbstractMap |
---|
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V> |
Nested classes/interfaces inherited from interface java.util.Map |
---|
Map.Entry<K,V> |
Constructor Summary | |
---|---|
RefinementMenuConfig()
Creates a ResultsListConfig with the following default settings: showMoreLink = false numRefinements = 10 maxNumRefinements = 1000 showMore = false whyPrecedenceRuleFired = false |
|
RefinementMenuConfig(ContentItem pContentItem)
Creates a ResultsListConfig with the following default settings: showMoreLink = false numRefinements = 10 maxNumRefinements = 1000 showMore = false whyPrecedenceRuleFired = false |
|
RefinementMenuConfig(String pType)
Creates a ResultsListConfig with the following default settings: showMoreLink = false numRefinements = 10 maxNumRefinements = 1000 showMore = false whyPrecedenceRuleFired = false |
Method Summary | |
---|---|
List<DvalSpec> |
getBoostRefinements()
Returns a list of DVal Specs. |
List<DvalSpec> |
getBuryRefinements()
Returns a list of DVal Specs. |
String |
getDimensionId()
Returns the Dimension ID which identifies the Endeca Dimension to be used for this RefinementMenu. |
String |
getLessLinkText()
When showMoreLink and isShowMore() is true, this text is used in the creation of the 'less' link. |
int |
getLimit()
A helper method for resolving the number of refinements to include. |
int |
getMaxNumRefinements()
The maximum number of refinements which will be shown when showMore has a value of "true". |
String |
getMoreLinkText()
When showMoreLink is true, and more refinements are available than are included in the RefinementMenu, this text is used in the link creation. |
int |
getNumRefinements()
The maximum number of refinements which will be shown when showMore has a value of "false" |
String |
getRefinementsShown()
Returns the amount of refinements to show. |
String |
getSort()
Returns the specification of sort type which governs how the returned refinements will be ordered in the RefinementMenu . |
boolean |
getUseShowMoreIdsParam()
Deprecated. As of release 3.1.1. Returns true if the show more and less actions should use the deprecated showMoreIds parameter. The default value of this property is true. |
boolean |
isShowMore()
Deprecated. As of release 3.1.1, replaced by getRefinementsShown() . When this value is false, the number of menu items generated is limited by numRefinements, and a more link will be generated. This value is intended to be overridden by request parameters when a "true" value is required in the link generation for the link generated when showMoreLink is "true". The default value for this property is false . |
boolean |
isShowMoreLink()
Enables the generation of a "More..." link as part of the refinement menu if there are more refinements available than the numRefinements variable and isShowMore() is true. |
boolean |
isWhyPrecedenceRuleFired()
When true, enables the reporting of 'why precedence rule fired' debug information. |
void |
setBoostRefinements(List<DvalSpec> boostRefinements)
Sets the list of DVal Specs to boost. |
void |
setBuryRefinements(List<DvalSpec> buryRefinements)
Sets the list of DVal Specs to bury. |
void |
setDimensionId(String dimensionId)
Specifies the Dimension ID which identifies the Endeca Dimension to be used for this RefinementMenu . |
void |
setLessLinkText(String lessLinkText)
When showMoreLink and isShowMore() is true, this text is used in the creation of the 'less' link. |
void |
setMaxNumRefinements(int maxNumRefinements)
The maximum number of refinements which will be shown when showMore has a value of "true". |
void |
setMoreLinkText(String moreLinkText)
When showMoreLink is true, and more refinements are available than are included in the RefinementMenu, this text is used in the link creation. |
void |
setNumRefinements(int numRefinements)
Sets the maximum number of refinements which will be shown when showMore has a value of "false". |
void |
setRefinementsShown(String refinementsShown)
Sets the amount of refinements to show. |
void |
setShowMore(boolean showMore)
Deprecated. As of release 3.1.1, replaced by getRefinementsShown() . Sets whether to "show more" refinements. When this value is false, the number of menu items generated is limited by numRefinements, and a more link will be generated. This value is intended to be overridden by request parameters when a "true" value is required in the link generation for the link generated when showMoreLink is "true". |
void |
setShowMoreLink(boolean showMoreLink)
Enables the generation of a "More..." link as part of the refinement menu if there are more refinements available than the numRefinements variable and isShowMore() is true. |
void |
setSort(String sort)
Sets the sort type which governs how the returned refinements will be ordered in the RefinementMenu . |
void |
setUseShowMoreIdsParam(boolean useShowMoreIdsParam)
Deprecated. As of release 3.1.1. Sets whether the deprecated showMoreIds or the navigation refinement menu config parameter should be used. If false, the showMoreIds will be ignored and the expand and collapse action will appear in the RefinementMenu . |
void |
setWhyPrecedenceRuleFired(boolean whyPrecedenceRuleFired)
Sets if 'why precedence rule fired' debug information should be enabled. |
Methods inherited from class com.endeca.infront.assembler.BasicContentItem |
---|
getBooleanProperty, getIntProperty, getLongProperty, getType, getTypedProperty, setType |
Methods inherited from class java.util.HashMap |
---|
clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values |
Methods inherited from class java.util.AbstractMap |
---|
equals, hashCode, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.Map |
---|
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values |
Constructor Detail |
---|
public RefinementMenuConfig()
public RefinementMenuConfig(String pType)
public RefinementMenuConfig(ContentItem pContentItem)
Method Detail |
---|
public String getDimensionId()
RefinementMenuHandler.preprocess(com.endeca.infront.cartridge.RefinementMenuConfig)
is called,
a CartridgeHandlerException will be thrown.
RefinementMenu
is to be configured.public void setDimensionId(String dimensionId)
RefinementMenu
.
If no dimension id is present by the time RefinementMenuHandler.preprocess(com.endeca.infront.cartridge.RefinementMenuConfig)
is called,
a CartridgeHandlerException will be thrown.
dimensionId
- for which this RefinementMenu is to be configured.public String getSort()
RefinementMenu
.
Valid values of this String are "default", "static", and "dynRank".
If the value of this property is null, "default" will be assumed by RefinementMenuHandler
.
If the value of this property is non-null, but not an expected String, a CartridgeHandlerException
will be thrown by RefinementMenuHandler.
RefinementMenu
.public void setSort(String sort)
RefinementMenu
.
Valid values of this String are "default", "static", and "dynRank".
If the value of this property is null, "default" will be assumed by RefinementMenuHandler
.
If the value of this property is non-null, but not an expected String, a CartridgeHandlerException
will be thrown by RefinementMenuHandler.
public boolean isShowMoreLink()
false
.
public void setShowMoreLink(boolean showMoreLink)
showMoreLink
- Whether to enable more link generation.public String getMoreLinkText()
public void setMoreLinkText(String moreLinkText)
moreLinkText
- The display text to be used for the more link.public String getLessLinkText()
public void setLessLinkText(String lessLinkText)
lessLinkText
- The display text to be used for the less link.public int getNumRefinements()
10
if unspecified.public void setNumRefinements(int numRefinements)
numRefinements
- the number of refinements to show before expanding. Defaults to 10
if unspecified.public int getMaxNumRefinements()
1000
.public void setMaxNumRefinements(int maxNumRefinements)
maxNumRefinements
- the maximum number of refinements to show even when refinement is expanded. Defaults to 1000
.public List<DvalSpec> getBoostRefinements()
public void setBoostRefinements(List<DvalSpec> boostRefinements)
boostRefinements
- list of Dval Specs to be boosted.public List<DvalSpec> getBuryRefinements()
public void setBuryRefinements(List<DvalSpec> buryRefinements)
buryRefinements
- list of Dval Specs to be buried.@Deprecated public boolean isShowMore()
getRefinementsShown()
. false
.
@Deprecated public void setShowMore(boolean showMore)
getRefinementsShown()
.
showMore
- specifies whether more refinements should be shown.public boolean isWhyPrecedenceRuleFired()
false
.
Note: in order for debugging information to be returned, debugging must be enabled on
NavigationRequest
. To accomplish
this, specify debugEnabled=true
when instantiating
MdexRequestBroker
.
setWhyPrecedenceRuleFired(boolean)
,
MdexRequestBroker
public void setWhyPrecedenceRuleFired(boolean whyPrecedenceRuleFired)
false
.
Note: in order for debugging information to be returned, debugging must be enabled on
NavigationRequest
. To accomplish
this, specify debugEnabled=true
when instantiating
MdexRequestBroker
.
whyPrecedenceRuleFired
- true to enable 'why precedence rule fired' debug infoisWhyPrecedenceRuleFired()
,
RefinementMenuRequestParamMarshaller
,
MdexRequestBroker
public String getRefinementsShown()
public void setRefinementsShown(String refinementsShown)
getNumRefinements()
refinements. getMaxNumRefinements()
()} refinements.
refinementsShown
- either "none", "some" or "all".@Deprecated public boolean getUseShowMoreIdsParam()
@Deprecated public void setUseShowMoreIdsParam(boolean useShowMoreIdsParam)
RefinementMenu
.
useShowMoreIdsParam
- whether to use the showMoreIds parameter or not.public int getLimit()
getRefinementsShown()
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |