Node (hybris Commerce Suite 6.3.0.0-SNAPSHOT)

java.lang.Object
- de.hybris.platform.hmc.generic.nodes.Node

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

AbstractActionNode, AbstractClassMappingNode, ActionNode, AttributeCollectionNode, AttributeTypeNode, ClassConfigNode, ClassMappingsNode, ConfigurationNode, DefaultAttributeChipsNode, ErrorNode, ExternalClassNode, ItemNode, PresetNode, ShortcutNode, TreeNode, TypeChildNode, TypeNode, TypeReferenceNode, WarningNode
```
public abstract class Node
extends Object
implements Serializable, Cloneable
```
Abstract super class representing a XML-tag of the layout configuration file.

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Node(Node parent)` Creates a new node with the given parent, an empty string as element name and no attributes.
`protected`	`Node(Node parent, Map<String,String> attributes)` Creates a new node with the given parameters and an empty string as element name.
`protected`	`Node(String elementName, Node parent, Map<String,String> attributes)` Creates a new node with the given parameters.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addAttribute(String name, String value)`
`void`	`addChild(Node child)`
`void`	`addChildren(List<Node> childs)`
`protected void`	`checkCreateConditions(Node parent, Map<String,String> attributes)` This method will automatically be called during creation of this Node.
`abstract Node`	`clone(Node newParent)` This method returns a clone of the current node whichs parent node is specified by the parameter newParent.
`Node`	`cloneAll(Node newParent)` This method returns a clone subtree beginning with the current node whichs parent node is specified by the parameter newParent, including all children as clones.
`Map<String,String>`	`getAttributes()`
`protected boolean`	`getBooleanAttribute(String attributeName)` Returns true if an xml attribute with the given name is found and contains "true" or "1".
`protected boolean`	`getBooleanAttribute(String attributeName, boolean defaultValue)` Returns true if an xml attribute with the given name is found and contains "true" or "1".
`protected <T> T`	`getCachedObject(T object)`
`protected Node`	`getChild(Class type)` Returns the first found child of the given type.
`List<Node>`	`getChildren()`
`<T> List<T>`	`getChildren(Class<T> type)` Returns a list of children which are of the given type.
`protected List<Node>`	`getChildrenInternal(boolean create)`
`EditorNode`	`getEditorNode()` Returns the parent `EditorNode` instance of this node, or `Null`, if this `Node` is not a child of an `EditorNode`.
`String`	`getElementName()`
`protected int`	`getIntegerAttribute(String attributeName)` /** Returns the value of an xml attribute of type int with the given name (the String from the xml file will be parsed for an int value).
`protected int`	`getIntegerAttribute(String attributeName, int defaultValue)` Returns the value of an xml attribute of type int with the given name (the String from the xml file will be parsed for an int value).
`Logger`	`getLogger()`
`Node`	`getParent()`
`int`	`getPosition()`
`String`	`getPositionInfo()`
`protected String`	`getStringAttribute(String attributeName)` Returns the value of an xml attribute of type String with the given name.
`protected String`	`getStringAttribute(String attributeName, String defaultValue)` Returns the value of an xml attribute of type String with the given name.
`protected Node`	`getSuperNode(Class type)`
`protected void`	`removeAttribute(String name)`
`void`	`removeChild(Node child)`
`void`	`replace(int pos)`
`void`	`replaceChild(Node oldChild, Node newChild)`
`protected void`	`setAttributes(Map<String,String> attributes)`
`void`	`setElementName(String string)` Set the name of the xml element this node represents.
`protected void`	`setParent(Node newParent)`
`void`	`setPosition(int position)`
`protected void`	`setPositionInfo(String positionInfo)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Node
```
protected Node(String elementName,
               Node parent,
               Map<String,String> attributes)
        throws NodeCreationFailedException
```
    Creates a new node with the given parameters.
    
    Parameters:
    
    elementName - the name of the xml element this node represents
    
    parent - the parent node of this node
    
    attributes - the map of xml attributes
    
    Throws:
    
    NodeCreationFailedException
  - Node
```
protected Node(Node parent,
               Map<String,String> attributes)
        throws NodeCreationFailedException
```
    Creates a new node with the given parameters and an empty string as element name.
    
    Parameters:
    
    parent - the parent node of this node
    
    attributes - the map of xml attributes
    
    Throws:
    
    NodeCreationFailedException
  - Node
```
protected Node(Node parent)
        throws NodeCreationFailedException
```
    Creates a new node with the given parent, an empty string as element name and no attributes.
    
    Parameters:
    
    parent - the parent node of this node
    
    Throws:
    
    NodeCreationFailedException
- Method Detail
  - getChildrenInternal
```
protected List<Node> getChildrenInternal(boolean create)
```
  - addChild
```
public void addChild(Node child)
```
  - addChildren
```
public void addChildren(List<Node> childs)
```
  - removeChild
```
public void removeChild(Node child)
```
  - replaceChild
```
public void replaceChild(Node oldChild,
                         Node newChild)
```
  - getChildren
```
public List<Node> getChildren()
```
  - getChildren
```
public <T> List<T> getChildren(Class<T> type)
```
    Returns a list of children which are of the given type.
  - getChild
```
protected Node getChild(Class type)
```
    Returns the first found child of the given type.
  - getSuperNode
```
protected Node getSuperNode(Class type)
```
  - getParent
```
public Node getParent()
```
  - getAttributes
```
public Map<String,String> getAttributes()
```
  - setAttributes
```
protected void setAttributes(Map<String,String> attributes)
```
  - getCachedObject
```
protected <T> T getCachedObject(T object)
```
  - getStringAttribute
```
protected String getStringAttribute(String attributeName,
                                    String defaultValue)
```
    Returns the value of an xml attribute of type String with the given name. If the attribute is not found, the given default value will be returned!
    
    Parameters:
    
    attributeName - the name of the xml attribute
    
    defaultValue - the default value if the attribute is not found
    
    Returns:
    
    the value of an xml attribute of type String with the given name. If the attribute is not found, the given default value will be returned!
  - getStringAttribute
```
protected String getStringAttribute(String attributeName)
```
    Returns the value of an xml attribute of type String with the given name. If the attribute is not found, null will be returned!
    
    Parameters:
    
    attributeName - the name of the xml attribute
    
    Returns:
    
    the value of an xml attribute of type String with the given name. If the attribute is not found, null will be returned!
  - getBooleanAttribute
```
protected boolean getBooleanAttribute(String attributeName,
                                      boolean defaultValue)
```
    Returns true if an xml attribute with the given name is found and contains "true" or "1". If the attribute is not found, the given default value will be returned.
    
    Parameters:
    
    attributeName - the name of the xml attribute
    
    defaultValue - the default value if the attribute is not found
    
    Returns:
    
    true if an xml attribute with the given name is found and contains "true" or "1". If the attribute is not found, the given default value will be returned.
  - getBooleanAttribute
```
protected boolean getBooleanAttribute(String attributeName)
```
    Returns true if an xml attribute with the given name is found and contains "true" or "1". If the attribute is not found, false will be returned!
    
    Parameters:
    
    attributeName - the name of the xml attribute
    
    Returns:
    
    true if an xml attribute with the given name is found and contains "true" or "1". If the attribute is not found, false will be returned!
  - getIntegerAttribute
```
protected int getIntegerAttribute(String attributeName,
                                  int defaultValue)
```
    Returns the value of an xml attribute of type int with the given name (the String from the xml file will be parsed for an int value). If the attribute is not found or could not be parsed, the given default value will be returned!
    
    Parameters:
    
    attributeName - the name of the xml attribute
    
    defaultValue - the default value if the attribute is not found or could not be parsed
    
    Returns:
    
    the value of an xml attribute of type int with the given name (the String from the xml file will be parsed for an int value). If the attribute is not found or could not be parsed, the given default value will be returned!
  - getIntegerAttribute
```
protected int getIntegerAttribute(String attributeName)
```
    /** Returns the value of an xml attribute of type int with the given name (the String from the xml file will be parsed for an int value). If the attribute is not found or could not be parsed, 0will be returned!
    
    Parameters:
    
    attributeName - the name of the xml attribute
    
    Returns:
    
    the value of an xml attribute of type int with the given name (the String from the xml file will be parsed for an int value). If the attribute is not found or could not be parsed, 0 will be returned!
  - removeAttribute
```
protected void removeAttribute(String name)
```
  - addAttribute
```
protected void addAttribute(String name,
                            String value)
```
  - setPositionInfo
```
protected void setPositionInfo(String positionInfo)
```
  - getPositionInfo
```
public String getPositionInfo()
```
  - checkCreateConditions
```
protected void checkCreateConditions(Node parent,
                                     Map<String,String> attributes)
                              throws NodeCreationFailedException
```
    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!
    
    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
  - getLogger
```
public Logger getLogger()
```
    Returns:
    
    Returns the logger.
  - getElementName
```
public String getElementName()
```
    Returns:
    
    the name of the xml element this node represents
  - setElementName
```
public void setElementName(String string)
```
    Set the name of the xml element this node represents.
    
    Parameters:
    
    string - the element name
  - clone
```
public abstract Node clone(Node newParent)
```
    This method returns a clone of the current node whichs parent node is specified by the parameter newParent.
    
    Parameters:
    
    newParent - The parent of the cloned node.
    
    Returns:
    
    Cloned node instance refering to the new parent.
  - cloneAll
```
public Node cloneAll(Node newParent)
```
    This method returns a clone subtree beginning with the current node whichs parent node is specified by the parameter newParent, including all children as clones.
    
    Parameters:
    
    newParent - The parent of the cloned node.
    
    Returns:
    
    Cloned node instance refering to the new parent, including all children.
  - setParent
```
protected void setParent(Node newParent)
```
    Parameters:
    
    newParent -
  - getEditorNode
```
public EditorNode getEditorNode()
```
    Returns the parent EditorNode instance of this node, or Null, if this Node is not a child of an EditorNode.
    
    Returns:
    
    Returns the parent EditorNode instance of this node, or Null, if this Node is not a child of an EditorNode
  - replace
```
public void replace(int pos)
```
  - getPosition
```
public int getPosition()
```
    Since:
    
    2.30
  - setPosition
```
public void setPosition(int position)
```
    Since:
    
    2.30

Class Node

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Node

Node

Node

Method Detail

getChildrenInternal

addChild

addChildren

removeChild

replaceChild

getChildren

getChildren

getChild

getSuperNode

getParent

getAttributes

setAttributes

getCachedObject

getStringAttribute

getStringAttribute

getBooleanAttribute

getBooleanAttribute

getIntegerAttribute

getIntegerAttribute

removeAttribute

addAttribute

setPositionInfo

getPositionInfo

checkCreateConditions

getLogger

getElementName

setElementName

clone

cloneAll

setParent

getEditorNode

replace

getPosition

setPosition