com.endeca.store.configuration

Class InternalNode

java.lang.Object

com.endeca.store.configuration.InternalNode

All Implemented Interfaces:

MutableNode, Node

public class InternalNode
extends Object
implements MutableNode

The common node type used to construct configuration and content across all Endeca Actors. Simple representation of the data structure.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,InternalNode>	children
static String	PRIMARY_TYPE_PROPERTY_NAME
protected Map<String,Object>	properties

Fields inherited from interface com.endeca.store.Node

PATH_SEPARATOR, ROOT_PATH

Method Summary

Methods

Modifier and Type	Method and Description
InternalNode	addChild(String nodeName, InternalNode node)
InternalNode	addNode(String relativePath) Adds a node to the relative path.
InternalNode	addStandAloneChild(InternalNode node)
<T> void	addTypedProperty(String property, T value)
InternalNode	createPath(String relativePath) Add a new, empty node to this node.
String	getName() Returns the name of the node.
Node	getNode(String relativePath) Retrieves a node based on a relative path to the current node.
protected com.endeca.store.configuration.InternalNode.EndecaNodeInfo	getNodeInfo(String relativePath)
Collection<Node>	getNodes() Get all the direct child nodes.
Node	getParent() Returns the parent node.
String	getPath() Returns the path of the node.
String	getPrimaryType() Get the value for the property that represents the primary type of this node.
Map<String,Object>	getProperties() Returns a Map of all the property names and their values.
static Node	getStandaloneNode(String name) Get a standalone node, one that will not be added to an Store.
<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.
InternalNode	lazilyAddNodes(String relativePath) Rather than reconstructing the Jackson Protocol immediately, we'll lazily create nodes.
protected InternalNode	removeChild(String nodeName)
void	removeNode(String relativePath)
void	setPrimaryType(String primaryType) Set the primary type of this node.
void	setProperties(Map<String,Object> properties)
void	setProperty(String key, Object value) Set the value of the given property.

Methods inherited from class java.lang.Object

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

Field Detail

PRIMARY_TYPE_PROPERTY_NAME

public static String PRIMARY_TYPE_PROPERTY_NAME

properties

protected Map<String,Object> properties

children

protected Map<String,InternalNode> children

Method Detail

getStandaloneNode

public static Node getStandaloneNode(String name)

Get a standalone node, one that will not be added to an Store. This node has no parent or path, but just holds content. Useful when a node is needed but will not immediately be added to a Store.

Parameters:

name - The name of the standalone node.

Returns:

An instance of a standalone node.

addNode

public InternalNode addNode(String relativePath)
                     throws NodeExistsException,
                            PathNotFoundException

Adds a node to the relative path. Strict expectations regarding when and how to add a node.

Parameters:

relativePath - The relative path to where the node should be created.

Returns:

The newly created node.

Throws:

NodeExistsException - Thrown if the node already exists.

PathNotFoundException - If any part of the path does not exist to the node being added, this exception will be thrown.

removeNode

public void removeNode(String relativePath)
                throws PathNotFoundException

Throws:

PathNotFoundException

createPath

public InternalNode createPath(String relativePath)
                        throws BadPathException,
                               PathNotFoundException

Add a new, empty node to this node. The node is added at the given path, relative to this node. Any non-existent nodes along the path from this node to the new node will be created and will be empty.

Parameters:

relativePath - The path from this node to the newly created node.

Returns:

The newly created node, or this node if the given relative path is null, empty, or equal to '/'.

Throws:

BadPathException

PathNotFoundException

lazilyAddNodes

public InternalNode lazilyAddNodes(String relativePath)
                            throws PathNotFoundException

Rather than reconstructing the Jackson Protocol immediately, we'll lazily create nodes. This should allow minimal changes to the protocol.

Parameters:

relativePath - The relative path to where the node should be created.

Returns:

The final node created in this path. Other nodes in the path may be created silently in the path if they did not exist.

Throws:

PathNotFoundException

addTypedProperty

public <T> void addTypedProperty(String property,
                        T value)

setProperties

public void setProperties(Map<String,Object> properties)

getName

public String getName()

Description copied from interface: Node

Returns the name of the node. This name will be unique with respect to its path.

Specified by:

getName in interface Node

Returns:

The name of the node.

getNode

public Node getNode(String relativePath)
             throws PathNotFoundException

Description copied from interface: Node

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")

Specified by:

getNode in interface Node

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

public Collection<Node> getNodes()

Description copied from interface: Node

Get all the direct child nodes. This will not retrieve the entire tree underneath the current node.

Specified by:

getNodes in interface Node

Returns:

A collection of child nodes for the current node.

getParent

public Node getParent()

Description copied from interface: Node

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.

Specified by:

getParent in interface Node

Returns:

The parent node. NULL if the current node is the root node.

getPath

public String getPath()

Description copied from interface: Node

Returns the path of the node.

Specified by:

getPath in interface Node

Returns:

The path of the node.

getProperties

public Map<String,Object> getProperties()

Description copied from interface: Node

Returns a Map of all the property names and their values. The values are all down cast to Objects for this Map.

Specified by:

getProperties in interface Node

Returns:

The map of all properties for this node.

getTypedProperty

public <T> T getTypedProperty(String key)

Description copied from interface: Node

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.

Specified by:

getTypedProperty in interface Node

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.

setProperty

public void setProperty(String key,
               Object value)

Description copied from interface: MutableNode

Set the value of the given property. Supports only String values. If the given value is null, the property is removed.

Specified by:

setProperty in interface MutableNode

Parameters:

key - The key of the property.

value - The value to set.

getPrimaryType

public String getPrimaryType()

Description copied from interface: MutableNode

Get the value for the property that represents the primary type of this node. The property mapped as primary type depends on the implementation of Node. The value for this property is necessarily a String.

Specified by:

getPrimaryType in interface MutableNode

Returns:

The primary type of this node. Possibly null.

setPrimaryType

public void setPrimaryType(String primaryType)

Description copied from interface: MutableNode

Set the primary type of this node.

Specified by:

setPrimaryType in interface MutableNode

Parameters:

primaryType - The primary type.

hasNode

public boolean hasNode(String relativePath)

Description copied from interface: Node

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.

Specified by:

hasNode in interface Node

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

public boolean hasNodes()

Description copied from interface: Node

Checks if the current node has any child nodes. Returns TRUE if any child nodes exist.

Specified by:

hasNodes in interface Node

Returns:

TRUE if any child nodes exist for this node.

hasProperty

public boolean hasProperty(String property)

Description copied from interface: Node

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.

Specified by:

hasProperty in interface Node

Parameters:

property - The name of the property for this node.

Returns:

Returns TRUE if the property has been set on the node.

addChild

public InternalNode addChild(String nodeName,
                    InternalNode node)

addStandAloneChild

public InternalNode addStandAloneChild(InternalNode node)

removeChild

protected InternalNode removeChild(String nodeName)

getNodeInfo

protected com.endeca.store.configuration.InternalNode.EndecaNodeInfo getNodeInfo(String relativePath)
                                                                          throws PathNotFoundException

Throws:

PathNotFoundException