RAPPElement (NetPhantom® 7.7 Java API Specification)

java.lang.Object
- se.entra.phantom.rapp.RAPPElement

```
public class RAPPElement
extends Object
```
This class is a helper class that should be used by classes that are stored or created from an Element.
It provides simple set/get methods for the basic attribute types such an Element can have.
This class should be used to create and manipulate the document structure instead of directly using Element, Node and Document. This is due to the Namespace usage in the XML document and also future XML schema implementation in the RAPP API.

Constructor Summary

Constructors
Constructor and Description

RAPPElement(Element element, RAPPNameSpaceItem nsItem)
Creates the RAPPElement from an existing Element.

Constructors
Constructor and Description
`RAPPElement(Element element, RAPPNameSpaceItem nsItem)` Creates the RAPPElement from an existing Element.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`appendChild(Node node)` Appends a child node to this element.
`RAPPElement`	`createAppendedChild(String name)` Creates a new instance of the RAPPElement that is already added to this instance Element as a child.
`RAPPElement`	`createAppendedChild(String name, RAPPNameSpaceItem item)` Creates a new instance of the RAPPElement that is already added to this instance Element as a child.
`Element`	`createElement(Document document, String name)` Creates the element in the specified document with the specified name.
`String`	`getAttribute(String name)` Gets a String attribute for an element.
`String`	`getAttribute(String name, String defaultValue)` Gets a String attribute for an element.
`boolean`	`getBooleanAttribute(String name)` Gets a boolean value for an attribute of an element.
`boolean`	`getBooleanAttribute(String name, boolean defaultValue)` Gets a boolean value for an attribute of an element.
`Document`	`getDocument()` Gets the document for the action, null if no document is being created or this class instance (or extending classes) is creating the document.
`Element`	`getElement()` Gets the element for the action, null if no document is being created or this class instance (or extending classes) is creating the document.
`static String`	`getElementString(Element e)` Returns a string for an Element.
`Element`	`getFirstChildElement()` Gets the first child element.
`static Element`	`getFirstChildElement(Element element)` Gets the first child element.
`static Element`	`getFirstChildElement(Element element, String tagName, RAPPNameSpaceItem nsItem)` Gets the first child element with the specified tag name and namespace.
`Element`	`getFirstChildElement(String tagName)` Gets the first child element with the specified tag name.
`int`	`getIntegerAttribute(String name)` Gets an integer value for an attribute of an element.
`int`	`getIntegerAttribute(String name, int defaultValue)` Gets an integer value for an attribute of an element.
`RAPPNameSpaceItem`	`getNameSpaceItem()` Get namespace item or null if not initiated.
`Element`	`getNextSiblingElement()` Gets the next sibling element with the specified tag name.
`static Element`	`getNextSiblingElement(Element element)` Gets the next sibling element.
`static Element`	`getNextSiblingElement(Element element, String tagName, RAPPNameSpaceItem nsItem)` Gets the next sibling element with the specified tag name and namespace.
`Element`	`getNextSiblingElement(String tagName)` Gets the next sibling element with the specified tag name.
`static String`	`getNodeAttributesString(Node n)` Returns a string with all attributes of a node.
`Element`	`getParentElement()` Gets the parent Element.
`int`	`getStarAttribute(String name)` Gets a positive integer value for an attribute of an element that can contain the value "*" (-2).
`boolean`	`hasAttribute(String name)` Checks if an attribute for the element exists.
`void`	`removeAttribute(String name)` Removes an attribute from the element.
`void`	`removeChild(Node node)` Removes the child node from this element.
`void`	`removeChild(RAPPElement child)` Removes the child node from this element.
`void`	`setAttribute(String name, boolean value)` Sets the boolean value as an attribute ("true" or "false").
`void`	`setAttribute(String name, int value)` Sets the integer value as an attribute for the action element.
`void`	`setAttribute(String name, String value)` Sets the string value as an attribute for the action element.
`void`	`setStarAttribute(String name, int value)` Sets the "star" integer value as an attribute for the action element.
`String`	`toString()` Converts this class into a string for testing purposes.

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

- Constructor Detail
  - RAPPElement
```
public RAPPElement(Element element,
                   RAPPNameSpaceItem nsItem)
```
    Creates the RAPPElement from an existing Element.
- Method Detail
  - getFirstChildElement
```
public static Element getFirstChildElement(Element element)
```
    Gets the first child element.
    
    Returns:
    
    Element, the first element or null if none is found.
  - getNextSiblingElement
```
public static Element getNextSiblingElement(Element element)
```
    Gets the next sibling element.
    
    Returns:
    
    Element, the next sibling element or null if none is found.
  - getFirstChildElement
```
public static Element getFirstChildElement(Element element,
                                           String tagName,
                                           RAPPNameSpaceItem nsItem)
```
    Gets the first child element with the specified tag name and namespace.
    
    Returns:
    
    Element, the first element or null if none is found.
  - getNextSiblingElement
```
public static Element getNextSiblingElement(Element element,
                                            String tagName,
                                            RAPPNameSpaceItem nsItem)
```
    Gets the next sibling element with the specified tag name and namespace.
    
    Returns:
    
    Element, the next sibling element or null if none is found.
  - createElement
```
public Element createElement(Document document,
                             String name)
```
    Creates the element in the specified document with the specified name. The Element is created in the Document with the specified name and this class is initialized with the document and the created element.
    
    Returns:
    
    Element The created Element in the document.
  - createAppendedChild
```
public RAPPElement createAppendedChild(String name)
```
    Creates a new instance of the RAPPElement that is already added to this instance Element as a child.
  - createAppendedChild
```
public RAPPElement createAppendedChild(String name,
                                       RAPPNameSpaceItem item)
```
    Creates a new instance of the RAPPElement that is already added to this instance Element as a child.
  - appendChild
```
public void appendChild(Node node)
```
    Appends a child node to this element.
  - removeChild
```
public void removeChild(Node node)
```
    Removes the child node from this element.
  - removeChild
```
public void removeChild(RAPPElement child)
```
    Removes the child node from this element.
  - getNameSpaceItem
```
public RAPPNameSpaceItem getNameSpaceItem()
```
    Get namespace item or null if not initiated.
  - getDocument
```
public Document getDocument()
```
    Gets the document for the action, null if no document is being created or this class instance (or extending classes) is creating the document.
  - getElement
```
public Element getElement()
```
    Gets the element for the action, null if no document is being created or this class instance (or extending classes) is creating the document.
  - getParentElement
```
public Element getParentElement()
```
    Gets the parent Element.
    
    Returns:
    
    null when the parent is not an Element.
  - getFirstChildElement
```
public Element getFirstChildElement()
```
    Gets the first child element.
    
    Returns:
    
    Element, the first element or null if none is found.
  - getFirstChildElement
```
public Element getFirstChildElement(String tagName)
```
    Gets the first child element with the specified tag name. It is assumed that child tag has the same namespace as this element.
    
    Returns:
    
    Element, the first element or null if none is found.
  - getNextSiblingElement
```
public Element getNextSiblingElement()
```
    Gets the next sibling element with the specified tag name.
    
    Returns:
    
    Element, the next sibling element or null if none is found.
  - getNextSiblingElement
```
public Element getNextSiblingElement(String tagName)
```
    Gets the next sibling element with the specified tag name.
    
    Returns:
    
    Element, the next sibling element or null if none is found.
  - getAttribute
```
public String getAttribute(String name)
                    throws SAXException
```
    Gets a String attribute for an element. If the attribute is not present, an SAXException will be thrown.
    
    Returns:
    
    String the attribute string (never null).
    
    Throws:
    
    SAXException - if the attribute is not found.
  - getAttribute
```
public String getAttribute(String name,
                           String defaultValue)
```
    Gets a String attribute for an element. If the attribute is not present, the default value is returned.
    
    Returns:
    
    String the attribute string (never null).
  - getIntegerAttribute
```
public int getIntegerAttribute(String name)
                        throws SAXException
```
    Gets an integer value for an attribute of an element. If the attribute is not present or the value is not found or the value is not a valid integer, an SAXException will be thrown.
    
    Returns:
    
    int the attribute integer.
    
    Throws:
    
    SAXException - if the attribute is not found.
  - getIntegerAttribute
```
public int getIntegerAttribute(String name,
                               int defaultValue)
```
    Gets an integer value for an attribute of an element. If the attribute is not present or the value is not found or the value is not a valid integer, the default value is returned.
    
    Returns:
    
    int the integer attribute.
  - getStarAttribute
```
public int getStarAttribute(String name)
                     throws SAXException
```
    Gets a positive integer value for an attribute of an element that can contain the value "*" (-2).
    If the attribute is not present or the value is not found, -1 is returned.
    If the attribute is the special value "*", -2 is returned.
    If the value is negative or invalid, a SAXException is trown.
    
    Throws:
    
    SAXException - if the attribute is not found.
  - getBooleanAttribute
```
public boolean getBooleanAttribute(String name)
                            throws SAXException
```
    Gets a boolean value for an attribute of an element. If the attribute is not present or the value is not found or the value is not a valid boolean, an SAXException will be thrown.
    Valid boolean values are "true", "false", "1", "0" (case insensitive).
    
    Returns:
    
    boolean the attribute boolean.
    
    Throws:
    
    SAXException - if the attribute is not found.
  - getBooleanAttribute
```
public boolean getBooleanAttribute(String name,
                                   boolean defaultValue)
```
    Gets a boolean value for an attribute of an element. If the attribute is not present or the value is not found or the value is not a valid boolean, the default value is returned.
    Valid boolean values are "true", "false", "1", "0" (case insensitive).
    
    Returns:
    
    boolean the attribute boolean.
  - setAttribute
```
public void setAttribute(String name,
                         String value)
```
    Sets the string value as an attribute for the action element. If the value is null, the attribute is removed.
  - setAttribute
```
public void setAttribute(String name,
                         int value)
```
    Sets the integer value as an attribute for the action element.
  - setStarAttribute
```
public void setStarAttribute(String name,
                             int value)
```
    Sets the "star" integer value as an attribute for the action element. If the value is -2, a "*" is set as the value, otherwise the value. If -1, the attribute is removed.
  - setAttribute
```
public void setAttribute(String name,
                         boolean value)
```
    Sets the boolean value as an attribute ("true" or "false").
  - hasAttribute
```
public boolean hasAttribute(String name)
```
    Checks if an attribute for the element exists.
  - removeAttribute
```
public void removeAttribute(String name)
```
    Removes an attribute from the element.
  - toString
```
public String toString()
```
    Converts this class into a string for testing purposes.
    
    Overrides:
    
    toString in class Object
  - getElementString
```
public static String getElementString(Element e)
```
    Returns a string for an Element. The element name, attributes and child nodes are also added.
  - getNodeAttributesString
```
public static String getNodeAttributesString(Node n)
```
    Returns a string with all attributes of a node. The string returned is empty if no attributes are found.

Class RAPPElement

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RAPPElement

Method Detail

getFirstChildElement

getNextSiblingElement

getFirstChildElement

getNextSiblingElement

createElement

createAppendedChild

createAppendedChild

appendChild

removeChild

removeChild

getNameSpaceItem

getDocument

getElement

getParentElement

getFirstChildElement

getFirstChildElement

getNextSiblingElement

getNextSiblingElement

getAttribute

getAttribute

getIntegerAttribute

getIntegerAttribute

getStarAttribute

getBooleanAttribute

getBooleanAttribute

setAttribute

setAttribute

setStarAttribute

setAttribute

hasAttribute

removeAttribute

toString

getElementString

getNodeAttributesString