com.northconcepts.datapipeline.core

Class Node

java.lang.Object

com.northconcepts.datapipeline.core.Node

All Implemented Interfaces:

Session, Serializable

Direct Known Subclasses:

Field, ValueNode

public abstract class Node
extends Object
implements Session, Serializable

Node is the base class for all persistent data in Data Pipeline. It is the superclass for records, fields, arrays, and values.

See Also:

Record, Field, ArrayValue, SingleValue, ValueNode, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Node.DuplicateNodeAction DuplicateNodeAction lists all actions that can be taken automatically when a target field already exists during a record copy or lookup.
static class	Node.NodeType NodeType lists all concrete data node types used in Data Pipeline.

Nested classes/interfaces inherited from interface com.northconcepts.datapipeline.core.Session

Session.SessionImpl

Field Summary

Fields

Modifier and Type	Field and Description
protected Session.SessionImpl	session

Constructor Summary

Constructors

Constructor and Description
Node()

Method Summary

Modifier and Type	Method and Description
protected void	assertNotAncestorOf(Node parentNode)
<T> boolean	containsSessionProperty(Class<T> type)
<T> boolean	containsSessionProperty(Class<T> type, String name)
boolean	containsSessionProperty(String name)
void	copySessionPropertiesFrom(Session sourceSession)
int	getNodeDepth() Returns this node's distance from its root node.
abstract Node.NodeType	getNodeType()
Field	getParentField() Returns the closest parent record's field that this node is the child of, otherwise null if one does not exist.
abstract Node	getParentNode()
Record	getParentRecord() Returns the closest parent record that this node is the child of, otherwise null if one does not exist.
<T> T	getSessionProperty(Class<T> type)
<T> T	getSessionProperty(Class<T> type, String name)
<T> T	getSessionProperty(String name)
abstract boolean	hasChildNodes() Returns true if this node contains any sub nodes.
abstract boolean	hasChildRecords() Returns true if this node contains any descendant, record nodes.
boolean	isAncestorOf(Node node) Returns true if the supplied node is a descendant of this one.
boolean	isChildNode() Indicates if this record has a parent record (i.e.
abstract boolean	isNotNull() Returns true if this node does not contain a null value.
abstract boolean	isNull() Returns true if this node contains a null value.
boolean	isValueNode() Returns true if this node is a ValueNode (Record, ArrayValue, or SingleValue).
Set<String>	keySet()
protected abstract void	removeChildNode(Node child)
<T> void	setSessionProperty(Class<T> type, Object value)
<T> void	setSessionProperty(Class<T> type, String name, Object value)
void	setSessionProperty(String name, Object value)
abstract String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

session

protected transient Session.SessionImpl session

Constructor Detail

Node

public Node()

Method Detail

getParentNode

public abstract Node getParentNode()

removeChildNode

protected abstract void removeChildNode(Node child)

isNull

public abstract boolean isNull()

Returns true if this node contains a null value. In concrete terms, only Field and SingleValue can contain nulls while not being null themselves. Both Record and ArrayValue will return false even if they have no values or null only values.

isNotNull

public abstract boolean isNotNull()

Returns true if this node does not contain a null value. In concrete terms, only Field and SingleValue can contain nulls while not being null themselves. Both Record and ArrayValue will return true even if they have no values or null only values.

getParentField

public Field getParentField()

Returns the closest parent record's field that this node is the child of, otherwise null if one does not exist.

See Also:

getParentRecord(), isChildNode(), hasChildRecords(), getNodeDepth(), Field.getValueAsRecord(), Field.getValueAsRecord()

getParentRecord

public Record getParentRecord()

Returns the closest parent record that this node is the child of, otherwise null if one does not exist.

See Also:

getParentField(), isChildNode(), hasChildRecords(), getNodeDepth(), Field.getValueAsRecord(), Field#getValueAsRecords()

getNodeType

public abstract Node.NodeType getNodeType()

isChildNode

public boolean isChildNode()

Indicates if this record has a parent record (i.e. this record is part of a hierarchical structure). If this method returns true, getParentField() can be used to retrieve the parent record's field that this record is attached to.

See Also:

getParentField(), getParentRecord(), hasChildRecords(), #getRecordDepth(), Field.getValueAsRecord(), Field#getValueAsRecords()

hasChildNodes

public abstract boolean hasChildNodes()

Returns true if this node contains any sub nodes.

hasChildRecords

public abstract boolean hasChildRecords()

Returns true if this node contains any descendant, record nodes.

getNodeDepth

public int getNodeDepth()

Returns this node's distance from its root node. It returns 0 if it is the root node (i.e. it has no parents), 1 if it is the direct child of the root node, 2 if it is the grandchild of the root, and so on.

isAncestorOf

public boolean isAncestorOf(Node node)

Returns true if the supplied node is a descendant of this one.

assertNotAncestorOf

protected void assertNotAncestorOf(Node parentNode)

isValueNode

public boolean isValueNode()

Returns true if this node is a ValueNode (Record, ArrayValue, or SingleValue).

toString

public abstract String toString()

Overrides:

toString in class Object

keySet

public Set<String> keySet()

Specified by:

keySet in interface Session

containsSessionProperty

public <T> boolean containsSessionProperty(Class<T> type,
                                           String name)

Specified by:

containsSessionProperty in interface Session

containsSessionProperty

public <T> boolean containsSessionProperty(Class<T> type)

Specified by:

containsSessionProperty in interface Session

containsSessionProperty

public boolean containsSessionProperty(String name)

Specified by:

containsSessionProperty in interface Session

copySessionPropertiesFrom

public void copySessionPropertiesFrom(Session sourceSession)

Specified by:

copySessionPropertiesFrom in interface Session

getSessionProperty

public <T> T getSessionProperty(Class<T> type,
                                String name)

Specified by:

getSessionProperty in interface Session

getSessionProperty

public <T> T getSessionProperty(Class<T> type)

Specified by:

getSessionProperty in interface Session

getSessionProperty

public <T> T getSessionProperty(String name)

Specified by:

getSessionProperty in interface Session

setSessionProperty

public <T> void setSessionProperty(Class<T> type,
                                   String name,
                                   Object value)

Specified by:

setSessionProperty in interface Session

setSessionProperty

public <T> void setSessionProperty(Class<T> type,
                                   Object value)

Specified by:

setSessionProperty in interface Session

setSessionProperty

public void setSessionProperty(String name,
                               Object value)

Specified by:

setSessionProperty in interface Session