XMLNode (SequenceExtractor 0.2 API)

java.lang.Object
- xmlhelpers.XMLNode

```
public class XMLNode
extends Object
```
Class that represents an XML node. This class is used as a wrapper of Node and contains useful functions for abstract parsing.

Author:

themis

Constructor Summary

Constructors
Constructor and Description

XMLNode(Node node)
Initializes this object given an XML node.

XMLNode(String name)
Initializes this object given a name.

Constructors
Constructor and Description
`XMLNode(Node node)` Initializes this object given an XML node.
`XMLNode(String name)` Initializes this object given a name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addNewChildNode(XMLNode newChildNode)` Adds a new child node to this node.
`void`	`addNewChildNodeInTheBeginning(XMLNode newChildNode)` Adds a new child node as the first child node of this node.
`void`	`addNewChildNodes(XMLNodeList newChildNodes)` Adds a list of nodes as child nodes to this node.
`XMLNode`	`getChildNodeByName(String name)` Returns the first child node of this node by name.
`XMLNodeList`	`getChildNodes()` Returns the child nodes of this node.
`XMLNodeList`	`getChildNodesByName(String name)` Returns a list of the child nodes of this node by name.
`XMLNodeList`	`getChildNodesRecursivelyByName(Set<String> names)` Returns all child nodes that have the given names resursively.
`XMLNodeList`	`getChildNodesRecursivelyByName(String... names)` Returns all child nodes that have the given names resursively.
`XMLNodeList`	`getDeepChildNodesRecursivelyByName(Set<String> names)` Returns all deep child nodes that have the given names resursively.
`XMLNodeList`	`getDeepChildNodesRecursivelyByName(String... names)` Returns all deep child nodes that have the given names resursively.
`XMLNode`	`getParentNode()` Returns the parent node of this node.
`String`	`getTextContent()` Returns the content of this node as a string.
`boolean`	`hasMoreThanOneChildren()` Checks if this node has more than one children.
`boolean`	`hasName(Set<String> names)` Checks if the name of this node is contained in the given set.
`boolean`	`hasName(String... names)` Checks if the name of this node is contained in the given strings.
`boolean`	`hasName(String name)` Checks if this node has the given name.
`void`	`insertNewParentNode(XMLNode newParentNode)` Replaces the parent node of this node with the given new parent node.
`boolean`	`isTextNode()` Checks if this node is a text node.
`XMLNode`	`removeChild(XMLNode child)` Removes and returns the given child from this node.
`void`	`removeParentNode()` Removes the parent node of this node.
`void`	`replaceChild(XMLNode newChild, XMLNode oldChild)` Replaces a child node of this node with another new child node.
`boolean`	`textContentStartsWith(String text)` Denotes whether the text content of this node starts with the given text.
`String`	`toString()` Returns a string representation of this node as a string representation of the inner node.
`String`	`toXMLString()` Returns the XML representation of this node.

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

- Constructor Detail
  - XMLNode
```
public XMLNode(Node node)
```
    Initializes this object given an XML node.
    
    Parameters:
    
    node - the inner node object.
  - XMLNode
```
public XMLNode(String name)
```
    Initializes this object given a name.
    
    Parameters:
    
    name - the name of the node object.
- Method Detail
  - getChildNodesByName
```
public XMLNodeList getChildNodesByName(String name)
```
    Returns a list of the child nodes of this node by name.
    
    Parameters:
    
    name - the name of the child nodes that are returned.
    
    Returns:
    
    a list of nodes with the given name.
  - getChildNodeByName
```
public XMLNode getChildNodeByName(String name)
```
    Returns the first child node of this node by name.
    
    Parameters:
    
    name - the name of the returned child node.
    
    Returns:
    
    the first child node with the given name.
  - getTextContent
```
public String getTextContent()
```
    Returns the content of this node as a string.
    
    Returns:
    
    the text content of this node.
  - hasMoreThanOneChildren
```
public boolean hasMoreThanOneChildren()
```
    Checks if this node has more than one children.
    
    Returns:
    
    true if this node has more than one children, or false otherwise.
  - getChildNodesRecursivelyByName
```
public XMLNodeList getChildNodesRecursivelyByName(Set<String> names)
```
    Returns all child nodes that have the given names resursively.
    
    Parameters:
    
    names - the names for which the child nodes are found.
    
    Returns:
    
    a list of nodes with the given names.
  - getChildNodesRecursivelyByName
```
public XMLNodeList getChildNodesRecursivelyByName(String... names)
```
    Returns all child nodes that have the given names resursively.
    
    Parameters:
    
    names - the names for which the child nodes are found.
    
    Returns:
    
    a list of nodes with the given names.
  - getDeepChildNodesRecursivelyByName
```
public XMLNodeList getDeepChildNodesRecursivelyByName(Set<String> names)
```
    Returns all deep child nodes that have the given names resursively.
    
    Parameters:
    
    names - the names for which the child nodes are found.
    
    Returns:
    
    a list of nodes with the given names.
  - getDeepChildNodesRecursivelyByName
```
public XMLNodeList getDeepChildNodesRecursivelyByName(String... names)
```
    Returns all deep child nodes that have the given names resursively.
    
    Parameters:
    
    names - the names for which the child nodes are found.
    
    Returns:
    
    a list of nodes with the given names.
  - hasName
```
public boolean hasName(String name)
```
    Checks if this node has the given name.
    
    Parameters:
    
    name - the name of this node to be checked.
    
    Returns:
    
    true if this node has the given name, or false otherwise.
  - hasName
```
public boolean hasName(Set<String> names)
```
    Checks if the name of this node is contained in the given set.
    
    Parameters:
    
    names - a set of names to be checked whether it contains the name of this node.
    
    Returns:
    
    true if the name of this node is contained in the given set, or false otherwise.
  - hasName
```
public boolean hasName(String... names)
```
    Checks if the name of this node is contained in the given strings.
    
    Parameters:
    
    names - a set of strings to be checked whether they include the name of this node.
    
    Returns:
    
    true if the name of this node is contained in the given strings, or false otherwise.
  - getChildNodes
```
public XMLNodeList getChildNodes()
```
    Returns the child nodes of this node.
    
    Returns:
    
    the child nodes of this node.
  - isTextNode
```
public boolean isTextNode()
```
    Checks if this node is a text node.
    
    Returns:
    
    true if this node is a text node, or false otherwise.
  - getParentNode
```
public XMLNode getParentNode()
```
    Returns the parent node of this node.
    
    Returns:
    
    the parent node of this node.
  - textContentStartsWith
```
public boolean textContentStartsWith(String text)
```
    Denotes whether the text content of this node starts with the given text.
    
    Parameters:
    
    text - the text to check if it is the start of the contents of this node.
    
    Returns:
    
    true if the the text content of this node starts with the given text, or false otherwise.
  - insertNewParentNode
```
public void insertNewParentNode(XMLNode newParentNode)
```
    Replaces the parent node of this node with the given new parent node.
    
    Parameters:
    
    newParentNode - the new parent node of this node.
  - addNewChildNode
```
public void addNewChildNode(XMLNode newChildNode)
```
    Adds a new child node to this node.
    
    Parameters:
    
    newChildNode - the node to be added as a new child node to this node.
  - addNewChildNodes
```
public void addNewChildNodes(XMLNodeList newChildNodes)
```
    Adds a list of nodes as child nodes to this node.
    
    Parameters:
    
    newChildNodes - the list of nodes to be added as new child nodes to this node.
  - removeParentNode
```
public void removeParentNode()
```
    Removes the parent node of this node. After calling this function, the parent of the parent node becomes the new parent node of this node.
  - replaceChild
```
public void replaceChild(XMLNode newChild,
                         XMLNode oldChild)
```
    Replaces a child node of this node with another new child node.
    
    Parameters:
    
    newChild - the child to replace the current child.
    
    oldChild - the child that is replaced.
  - removeChild
```
public XMLNode removeChild(XMLNode child)
```
    Removes and returns the given child from this node.
    
    Parameters:
    
    child - the child node to be removed.
    
    Returns:
    
    the removed child node.
  - addNewChildNodeInTheBeginning
```
public void addNewChildNodeInTheBeginning(XMLNode newChildNode)
```
    Adds a new child node as the first child node of this node.
    
    Parameters:
    
    newChildNode - the new child node to be added to the children of this node.
  - toXMLString
```
public String toXMLString()
```
    Returns the XML representation of this node.
    
    Returns:
    
    a string with the XML representation of this node.
  - toString
```
public String toString()
```
    Returns a string representation of this node as a string representation of the inner node.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of this node.

Class XMLNode

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XMLNode

XMLNode

Method Detail

getChildNodesByName

getChildNodeByName

getTextContent

hasMoreThanOneChildren

getChildNodesRecursivelyByName

getChildNodesRecursivelyByName

getDeepChildNodesRecursivelyByName

getDeepChildNodesRecursivelyByName

hasName

hasName

hasName

getChildNodes

isTextNode

getParentNode

textContentStartsWith

insertNewParentNode

addNewChildNode

addNewChildNodes

removeParentNode

replaceChild

removeChild

addNewChildNodeInTheBeginning

toXMLString

toString