sirius.kernel.xml

Class StructuredNode

java.lang.Object

sirius.kernel.xml.StructuredNode

public class StructuredNode
extends Object

Represents a structured node, which is part of a StructuredInput.

This is basically a XML node which can be queried using xpath.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StructuredNode(Node root) Wraps the given node

Method Summary

Modifier and Type	Method and Description
<N extends Node> N	as(Class<N> type) Returns the underlying node casted to the given type.
List<StructuredNode>	getChildren() Returns a list of all children of this DOM node.
Node	getNode() Returns the underlying W3C Node.
String	getNodeName() Returns the current nodes name.
<N extends Node> boolean	is(Class<N> type) Determines if the underlying node is actually an instance of the given class.
boolean	isEmpty(String path) Checks whether a node is not reachable or has empty content via the given XPath.
boolean	isFilled(String path) Checks whether a node or non-empty content is reachable via the given XPath.
static StructuredNode	of(Node node) Wraps the given W3C node into a structured node.
StructuredNode	queryNode(String xpath) Returns a given node at the relative path.
List<StructuredNode>	queryNodeList(String xpath) Returns a list of nodes at the relative path.
String	queryString(String path) Returns the property at the given relative path as string.
Value	queryValue(String path) Queries a Value by evaluating the given xpath.
String	queryXMLString(String path) Queries a string via the given XPath.
String	toString()
void	visit(Consumer<StructuredNode> nodeHandler, Consumer<Node> textNodeHandler) Iterates through the sub-tree and invokes the appropriate handler for each child node.
void	visitNodes(Consumer<StructuredNode> nodeHandler) Iterates through the sub-tree and invokes the given handler for each child node.
void	visitTexts(Consumer<Node> textNodeHandler) Iterates through the sub-tree and invokes the given handler for each text node.

Methods inherited from class java.lang.Object

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

Constructor Detail

StructuredNode

protected StructuredNode(Node root)

Wraps the given node

Parameters:

root - the node to wrap

Method Detail

of

@Nonnull
public static StructuredNode of(@Nonnull
                                         Node node)

Wraps the given W3C node into a structured node.

Parameters:

node - the node to wrap

Returns:

a wrapped instance of the given node

getNodeName

@Nonnull
public String getNodeName()

Returns the current nodes name.

Returns:

returns the name of the node represented by this object

getNode

@Nonnull
public Node getNode()

Returns the underlying W3C Node.

Returns:

the underlying node

is

public <N extends Node> boolean is(Class<N> type)

Determines if the underlying node is actually an instance of the given class.

Type Parameters:

N - the node type to check for

Parameters:

type - the class to check for

Returns:

true if the underlying node is an instance of the given class, false otherwise

as

public <N extends Node> N as(Class<N> type)

Returns the underlying node casted to the given type.

Used is(Class) to check if the node actually is an instance of the target class. Otherwise a ClassCastException will be thrown.

Type Parameters:

N - the node type to cast to

Parameters:

type - the target class for the cast

Returns:

the underlying node casted to the target type.

Throws:

ClassCastException - if the underlying node isn't an instance of the given class.

getChildren

@Nonnull
public List<StructuredNode> getChildren()

Returns a list of all children of this DOM node.

Returns:

a list containing all children of this node. If no children exist, an empty list will be returned.

queryNode

@Nullable
public StructuredNode queryNode(String xpath)

Returns a given node at the relative path.

Parameters:

xpath - the xpath used to retrieve the resulting node

Returns:

the node returned by the given xpath expression

Throws:

IllegalArgumentException - if an invalid xpath was given

queryNodeList

@Nonnull
public List<StructuredNode> queryNodeList(String xpath)

Returns a list of nodes at the relative path.

Parameters:

xpath - the xpath used to retrieve the resulting nodes

Returns:

the list of nodes returned by the given xpath expression

Throws:

IllegalArgumentException - if an invalid xpath was given

queryString

@Nullable
public String queryString(String path)

Returns the property at the given relative path as string.

Parameters:

path - the xpath used to retrieve property

Returns:

a string representation of the value returned by the given xpath expression

Throws:

IllegalArgumentException - if an invalid xpath was given

queryValue

@Nonnull
public Value queryValue(String path)

Queries a Value by evaluating the given xpath.

Parameters:

path - the xpath used to retrieve property

Returns:

a Value wrapping the value returned by the given xpath expression

Throws:

IllegalArgumentException - if an invalid xpath was given

queryXMLString

@Nullable
public String queryXMLString(String path)

Queries a string via the given XPath. All contained XML is converted to a string.

Parameters:

path - the xpath used to retrieve the xml sub tree

Returns:

a string representing the xml sub-tree returned by the given xpath expression

Throws:

IllegalArgumentException - if an invalid xpath was given

isFilled

public boolean isFilled(String path)

Checks whether a node or non-empty content is reachable via the given XPath.

Parameters:

path - the xpath to be checked

Returns:

true if a node or non empty property was found, false otherwise

Throws:

IllegalArgumentException - if an invalid xpath was given

isEmpty

public boolean isEmpty(String path)

Checks whether a node is not reachable or has empty content via the given XPath.

Parameters:

path - the xpath to be checked

Returns:

true if no node or a empty property was found, false otherwise

Throws:

IllegalArgumentException - if an invalid xpath was given

visitNodes

public void visitNodes(Consumer<StructuredNode> nodeHandler)

Iterates through the sub-tree and invokes the given handler for each child node.

Parameters:

nodeHandler - the handler invoked for each child element

visitTexts

public void visitTexts(Consumer<Node> textNodeHandler)

Iterates through the sub-tree and invokes the given handler for each text node.

Parameters:

textNodeHandler - the handler invoked for each text node

visit

public void visit(@Nullable
                  Consumer<StructuredNode> nodeHandler,
                  @Nullable
                  Consumer<Node> textNodeHandler)

Iterates through the sub-tree and invokes the appropriate handler for each child node.

Parameters:

nodeHandler - the handler invoked for each element node

textNodeHandler - the handler invoked for each text node

toString

public String toString()

Overrides:

toString in class Object