Node (Oracle Commerce Assembler 11.0.0 API)

All Known Subinterfaces:

MutableNode

All Known Implementing Classes:

InternalNode
```
public interface Node
```
This Node represents a single element in a bi-directional tree with a single root node. Any Node will have a single parent, N children, and N properties.
Properties are defined on a node as any typed object. (Primitives will be boxed) This requires a knowledge of the node type that you are retrieving. It is ideal if the implementation throws a Class Cast Exception when attempting to retrieve a property of the wrong type.
Navigation of nodes can be done in either direction. Navigating down the tree is accomplished by accessing child nodes. When you reach a final node, the children will be NULL or empty. Respectively, accessing the parent node will eventually be NULL when you reach the root node.

Field Summary

Fields
Modifier and Type Field and Description

static String PATH_SEPARATOR

static String ROOT_PATH

Fields
Modifier and Type	Field and Description
`static String`	`PATH_SEPARATOR`
`static String`	`ROOT_PATH`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getName()` Returns the name of the node.
`Node`	`getNode(String relativePath)` Retrieves a node based on a relative path to the current node.
`Collection<Node>`	`getNodes()` Get all the direct child nodes.
`Node`	`getParent()` Returns the parent node.
`String`	`getPath()` Returns the path of the node.
`Map<String,Object>`	`getProperties()` Returns a Map of all the property names and their values.
`<T> T`	`getTypedProperty(String key)` Retrieve a property of this Node.
`boolean`	`hasNode(String relativePath)` Checks to see if a node exists at the current path.
`boolean`	`hasNodes()` Checks if the current node has any child nodes.
`boolean`	`hasProperty(String property)` Checks to see if the current node has a property set.

- Field Detail
  - PATH_SEPARATOR
```
static final String PATH_SEPARATOR
```
    See Also:
    Constant Field Values
  - ROOT_PATH
```
static final String ROOT_PATH
```
    See Also:
    Constant Field Values
- Method Detail
  - getName
```
String getName()
```
    Returns the name of the node. This name will be unique with respect to its path.
    
    Returns:
    The name of the node.
  - getNode
```
Node getNode(String relativePath)
             throws PathNotFoundException
```
    Retrieves a node based on a relative path to the current node. If any element of the path given is not found, an exception will be thrown. If the node itself does not exist, but the entire path is valid, the node returned will be NULL.
    Note that the paths cannot navigate upwards through the tree. For example,
    node2.getNode("node3/node4")
    is valid, whereas
    node2.getNode("../nodeX/nodeY")
    and
    node2.getNode("node3/../nodeX")
    are not. In such a situation, use the #getParent method:
    node2.getParent().getNode("nodeX/nodeY")
    
    Parameters:
    relativePath - The path to the desired node, relative to the current nodes location.
    
    Returns:
    The requested node. NULL if the node itself does not exist.
    
    Throws:
    
    PathNotFoundException - Thrown if any element of the requested relative path is not valid.
  - getNodes
```
Collection<Node> getNodes()
```
    Get all the direct child nodes. This will not retrieve the entire tree underneath the current node.
    
    Returns:
    A collection of child nodes for the current node.
  - getParent
```
Node getParent()
```
    Returns the parent node. This can be used to navigate upward through the tree structure. The root node of the data structure will return NULL when requesting the parent. No other node should return NULL.
    
    Returns:
    The parent node. NULL if the current node is the root node.
  - getPath
```
String getPath()
```
    Returns the path of the node.
    
    Returns:
    The path of the node.
  - getProperties
```
Map<String,Object> getProperties()
```
    Returns a Map of all the property names and their values. The values are all down cast to Objects for this Map.
    
    Returns:
    The map of all properties for this node.
  - getTypedProperty
```
<T> T getTypedProperty(String key)
```
    Retrieve a property of this Node. Will return NULL if the property does not exist. This method will return the requested property properly casted. If the type is not one which is expected, this method will throw a ClassCastException.
    
    Type Parameters:
    T - The type of property being retrieved.
    Parameters:
    key - The name of the property on the node.
    
    Returns:
    The value of the property on this node. NULL if the property is not set.
  - hasNode
```
boolean hasNode(String relativePath)
```
    Checks to see if a node exists at the current path. If elements of the path are invalid, or if the node itself is not found, the method will return FALSE.
    
    Parameters:
    relativePath - The path to the node relative to the current node.
    
    Returns:
    TRUE if a node is found at the relative path. FALSE is any part of the requested path does not exist.
  - hasNodes
```
boolean hasNodes()
```
    Checks if the current node has any child nodes. Returns TRUE if any child nodes exist.
    
    Returns:
    TRUE if any child nodes exist for this node.
  - hasProperty
```
boolean hasProperty(String property)
```
    Checks to see if the current node has a property set. If the key is found on the node for any property, even if that property's value is set to NULL, this will return TRUE.
    
    Parameters:
    property - The name of the property for this node.
    
    Returns:
    Returns TRUE if the property has been set on the node.

Interface Node

Field Summary

Method Summary

Field Detail

PATH_SEPARATOR

ROOT_PATH

Method Detail

getName

getNode

getNodes

getParent

getPath

getProperties

getTypedProperty

hasNode

hasNodes

hasProperty