de.hybris.platform.hmc.generic.nodes

Class AttributeNode

java.lang.Object

de.hybris.platform.hmc.generic.nodes.Node

de.hybris.platform.hmc.generic.nodes.TypeChildNode

de.hybris.platform.hmc.generic.nodes.AttributeNode

All Implemented Interfaces:

Serializable, Cloneable

public class AttributeNode
extends TypeChildNode

Defines an attribute of a SearchNode or ExplorerNode.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AttributeNode(Node parent, Map<String,String> attributes) Creates a new AttributeNode with the given parent and attributes.

Method Summary

Modifier and Type	Method and Description
protected void	checkCreateConditions(Node parent, Map attributes) This method will automatically be called during creation of this Node.
Node	clone(Node newParent) This method returns a clone of the current node whichs parent node is specified by the parameter newParent.
int	getActualColumnWidth() Returns the configured width of this attribute column as a primitive int value.
String	getAttributeQualifier() Returns the qualifier of the attribute this node is describing.
ClassConfigNode	getClassConfigNode() Returns the ClassConfigNode which is a child of this node.
Integer	getColumnWidth() Returns the width which should be used when rendering this attribute in a list.
String	getFallbackName() Returns the name of the fallback attribute if specified.
String	getJsp() Returns the name of the jsp which should render this attribute's content.
String	getTitle() Returns the title which should be used to name columns of this attribute in a list.
String	getWidth() Returns the width which should be used when rendering this attribute in a list.
boolean	isSuppressRoot()

Methods inherited from class de.hybris.platform.hmc.generic.nodes.TypeChildNode

findTypeNode, getAttributeDescriptor

Methods inherited from class de.hybris.platform.hmc.generic.nodes.Node

addAttribute, addChild, addChildren, cloneAll, getAttributes, getBooleanAttribute, getBooleanAttribute, getCachedObject, getChild, getChildren, getChildren, getChildrenInternal, getEditorNode, getElementName, getIntegerAttribute, getIntegerAttribute, getLogger, getParent, getPosition, getPositionInfo, getStringAttribute, getStringAttribute, getSuperNode, removeAttribute, removeChild, replace, replaceChild, setAttributes, setElementName, setParent, setPosition, setPositionInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttributeNode

public AttributeNode(Node parent,
                     Map<String,String> attributes)
              throws NodeCreationFailedException

Creates a new AttributeNode with the given parent and attributes.

Parameters:

parent -

attributes -

Throws:

NodeCreationFailedException

Method Detail

getAttributeQualifier

public String getAttributeQualifier()

Returns the qualifier of the attribute this node is describing. This is the 'name' attribute of the respective xml element.

Returns:

the name/qualifier of the attribute this node describes

getJsp

public String getJsp()

Returns the name of the jsp which should render this attribute's content. This is the 'jsp' attribute of the respective xml element.

Returns:

the name of the jsp which should render this attribute's content.

getTitle

public String getTitle()

Returns the title which should be used to name columns of this attribute in a list. This is the 'title' attribute of the respective xml element.

Returns:

the title which should be used to name columns of this attribute in a list.

getWidth

public String getWidth()

Returns the width which should be used when rendering this attribute in a list. This is the 'width' attribute of the respective xml element.

Returns:

the width which should be used when rendering this attribute in a list.

getColumnWidth

public Integer getColumnWidth()

Returns the width which should be used when rendering this attribute in a list. This is the 'width' attribute of the respective xml element. Unlike getWidth() this method parses the width string and returns an Integer object (or null if the string could not be parsed).

Returns:

the width which should be used when rendering this attribute in a list.

getActualColumnWidth

public int getActualColumnWidth()

Returns the configured width of this attribute column as a primitive int value. Also the value will be modified to be used correctly within a jsp.

Returns:

the width of this attribute column as a primitive int value.

Since:

2.10

getClassConfigNode

public ClassConfigNode getClassConfigNode()

Returns the ClassConfigNode which is a child of this node.

Returns:

the ClassConfigNode which is a child of this node.

isSuppressRoot

public boolean isSuppressRoot()

checkCreateConditions

protected void checkCreateConditions(Node parent,
                                     Map attributes)
                              throws NodeCreationFailedException

Description copied from class: Node

This method will automatically be called during creation of this Node. Override it to check for special conditions which have to be fulfilled to successfully create your Node implementation. Throw a NodeCreationFailedException if the creation fails. Note: At the time this method is called, getParent() and getXYZAttribute() will not work! Be sure to use the given parameters instead!

Overrides:

checkCreateConditions in class Node

Parameters:

parent - the parent node as given to the constructor

attributes - the attribute map as given to the constructor

Throws:

NodeCreationFailedException - if the creation of the node fails

clone

public Node clone(Node newParent)

Description copied from class: Node

This method returns a clone of the current node whichs parent node is specified by the parameter newParent.

Specified by:

clone in class Node

Parameters:

newParent - The parent of the cloned node.

Returns:

Cloned node instance refering to the new parent.

getFallbackName

public String getFallbackName()

Returns the name of the fallback attribute if specified.