|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.commerce.search.refinement.admin.PropertyRefinementConfigurationContainer atg.commerce.search.refinement.admin.KeyedRefinementConfigurationContainer
public class KeyedRefinementConfigurationContainer
An extension of the PropertyRefinementConfigurationContainer that uses a key to find the correct refinement configuration item in a map. For example, given an item descriptor "category" that has a property "categoryInfos", which is a Map whose keys are catalog ids, and whose values are items of type "category-info". "category-info" has a property called "refineConfig", which is the item that will be returned by this container. In this example, the itemDescriptor is category, the property name is "categoryInfos", the repository id is the id of the category, the key is the id of the catalog, and the mapPropertyName is "refineConfig".
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
static java.lang.String |
MAPPING_VALUE_DELIMITER
|
protected java.lang.String |
mKey
Gets the key of the mapped item to find in the map. |
protected java.lang.String |
mMapPropertyName
|
Fields inherited from class atg.commerce.search.refinement.admin.PropertyRefinementConfigurationContainer |
---|
mItemDescriptor, mLogger, mPropertyName, mRepositoryId |
Constructor Summary | |
---|---|
KeyedRefinementConfigurationContainer(RepositoryItem pItem,
java.lang.String pPropertyName,
java.lang.String pRepositoryId,
java.lang.String pKey,
java.lang.String pMapPropertyName,
int pSpecificity)
Create a new refinement configuration container whose item is a property value of an item of a map, which itself is a property value of another item. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object pOther)
Tests the equailty of another container |
java.lang.String |
getKey()
|
java.lang.String |
getMappingValue()
Returns a value in the form "itemId:key" |
java.lang.String |
getMapPropertyName()
Gets the property name of the refinement configuration item within the mapped item |
RepositoryItem |
getRefinementConfigurationItem()
Gets the refinement configuration item by first finding a map property of the given item, then looking up a subitem by key, and returning the refinement configuration property of that subitem. |
int |
hashCode()
Gets the hashCode of this container. |
java.lang.String |
toString()
Returns a string representation of this item. |
Methods inherited from class atg.commerce.search.refinement.admin.PropertyRefinementConfigurationContainer |
---|
getContainingItem, getItemDescriptor, getName, getPropertyName, getRepositoryId, getSourceItem, getSpecificity, setName, setSourceItem, setSpecificity |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
public static java.lang.String MAPPING_VALUE_DELIMITER
protected java.lang.String mMapPropertyName
protected java.lang.String mKey
Constructor Detail |
---|
public KeyedRefinementConfigurationContainer(RepositoryItem pItem, java.lang.String pPropertyName, java.lang.String pRepositoryId, java.lang.String pKey, java.lang.String pMapPropertyName, int pSpecificity)
Method Detail |
---|
public java.lang.String getMapPropertyName()
public java.lang.String getKey()
public RepositoryItem getRefinementConfigurationItem() throws RepositoryException
getRefinementConfigurationItem
in interface RefinementConfigurationContainer
getRefinementConfigurationItem
in class PropertyRefinementConfigurationContainer
RepositoryException
public java.lang.String getMappingValue()
getMappingValue
in interface RefinementConfigurationContainer
getMappingValue
in class PropertyRefinementConfigurationContainer
public boolean equals(java.lang.Object pOther)
equals
in class PropertyRefinementConfigurationContainer
public int hashCode()
hashCode
in class PropertyRefinementConfigurationContainer
public java.lang.String toString()
toString
in class PropertyRefinementConfigurationContainer
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |