XMLObject (axelframework 3.1.12.RELEASE API)

java.lang.Object
- org.xmlactions.common.xml.XMLObject

All Implemented Interfaces:: java.io.Serializable

public class XMLObject
extends java.lang.Object
implements java.io.Serializable

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description
`XMLObject()` Creates a new instance of XMLObject Some examples of usage // find first instance of root2 to node in path 'element_root/root1/root2' XMLObject xo1 = xo.findXMLObjectByPath("element_root/root1/root2"); // find index instance of root3 to node in path 'element_root/root1/root2/root3' xo1 = xo.findXMLObjectByPath("element_root/root1/root2/root3", 1); // get attribute value for 'index' in 'element_root/root1/root2/root3' str = xo.getAttribute("element_root/root1/root2/root3", "index"); // get attribute value for 'index' in indexed 'element_root/root1/root2/root3' str = xo.getAttribute("element_root/root1/root2/root3", 2, "index");
`XMLObject(java.lang.String elementName)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAttribute(java.lang.String key, int value)`
`void`	`addAttribute(java.lang.String key, java.lang.String value)`
`void`	`addChild(int index, XMLObject xmlObject)`
`void`	`addChild(XMLObject xmlObject)`
`void`	`addChildAfter(XMLObject before, XMLObject xo)`
`void`	`addContent(java.lang.String content)`
`XMLObject`	`addNodeWithContent(java.lang.String nodeName, java.lang.String content)` add a new node with the content as an child of this node.
`int`	`findChild(XMLObject xo)`
`XMLObject`	`findChildNode(java.lang.String nodeName)` Finds and returns a child XMLObject with nodeName or returns null if not found
`XMLObject`	`findNode(XMLObject xo, java.lang.String nodeName)` Finds and returns a XMLObject of nodeName or returns null if not found Traverses node and subsequent child node searching for the nodeName.
`XMLObject`	`findXMLObjectByPath(java.lang.String path)` Using a path such as 'root/node1/node2' will return an XMLObject for node2 if found else null.
`XMLObject`	`findXMLObjectByPath(java.lang.String path, int index)` Using a path such as 'root/node1/node2' will return the index count of node2.
`java.lang.String`	`getAttribute(java.lang.String path, int index, java.lang.String key)` Gets an attribute value as a string using path and key
`java.lang.String`	`getAttribute(java.lang.String path, java.lang.String key)` Gets an attribute value as a string using path and key
`java.lang.String`	`getAttributeAsString(int index)` Get the attribute value for this index.
`int`	`getAttributeCount()` Get the number of attribute for this element.
`java.lang.String`	`getAttributeKeyAsString(int index)` Get the attribute key for this index.
`java.util.List<XMLAttribute>`	`getAttributes()` Get the list of attributes for this element.
`java.lang.Object`	`getAttributeValue(java.lang.String key)` Get the attribute value for this key, will return null if no key exists.
`java.lang.String`	`getAttributeValueAsString(java.lang.String key)` Get the attribute value for this key as a string, will return null if no key exists.
`java.lang.Object`	`getAttributeValueNoNull(java.lang.String key)` Get the attribute value for this key as a string, will return "" if no key exists.
`XMLObject`	`getChild(int index)`
`int`	`getChildCount()`
`int`	`getChildCount(java.lang.String childElementName)` Cound the number of children this XMLObject has that match the entered childElementName (not case sensitive)
`int`	`getChildIndex(int from, java.lang.String childElementName)` Get a child element starting a from index and containing childElementName Will start at the entered from position getting each child element.
`java.util.List<XMLObject>`	`getChildren()`
`java.lang.String`	`getContent()`
`java.lang.String`	`getContent(java.lang.String path)` Gets content as a string using path to reach node.
`java.lang.String`	`getContent(java.lang.String path, int index)` Gets content as a string using path and index to reach node.
`java.lang.String`	`getElementName()`
`java.lang.String`	`getName()` returns the element name including the namespace if there is one
`java.lang.String`	`getNameSpace()`
`XMLObject`	`getNode(java.lang.String path, int index)` Gets a node and any children as a string using path and index
`XMLObject`	`getParent()`
`XMLAttribute`	`getXMLAttribute(int index)`
`XMLAttribute`	`getXMLAttribute(java.lang.String key)`
`static void`	`main(java.lang.String[] args)`
`XMLObject`	`mapXMLCharToXMLObject(java.lang.String xml)` Map an XML String to a XMLObject
`XMLObject`	`mapXMLCharToXMLObject(java.lang.String xml, char[][] nameSpaces)` Map an XML String to a XMLObject
`XMLObject`	`mapXMLCharToXMLObject(java.lang.String xml, java.lang.String nameSpace)` Map an XML String to a XMLObject
`java.lang.String`	`mapXMLObject2HTML()`
`java.lang.String`	`mapXMLObject2XML(XMLObject root)` Map an XMLObject to an XMLString
`java.lang.String`	`mapXMLObject2XML(XMLObject root, boolean lineFeed)` Map an XMLObject to an XMLString
`XMLObject`	`mapXMLToXMLObject(java.lang.String xml)` Deprecated. Please now use mapXMLCharToXMLObject()
`void`	`remove()` removes the xml object from it's parent if there is a parent.
`void`	`remove(XMLObject oldXO)` removes the xml object from it's parent if there is a parent
`void`	`removeChild(int index)`
`void`	`removeChild(XMLObject xo)`
`void`	`replace(XMLObject oldXO, XMLObject newXO)` replaces the oldXO with the newXO by first determining the parent of the oldXO and then replacing the child.
`void`	`setAttributes(java.util.List<XMLAttribute> attributes)`
`void`	`setElementName(java.lang.String elementName)`
`void`	`setNameSpace(java.lang.String nameSpace)`
`protected void`	`setup()`
`java.lang.String`	`toHTMLString()`
`java.lang.String`	`toString()`
`java.lang.String`	`toXMLString(boolean closeElement)` Converts the xml object into an XML String
`java.lang.String`	`toXMLString(int indent, boolean closeElement)` Converts the xml object into an XML String
`void`	`updateAttribute(java.lang.String key, java.lang.Object newValue)`
`void`	`updateAttribute(java.lang.String key, java.lang.String newValue)`
`void`	`xmlAllNodes(XMLObject node, XMLBuilder builder, int indent, boolean lineFeed)`

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

- Constructor Detail
  - XMLObject
```
public XMLObject()
```
    Creates a new instance of XMLObject Some examples of usage // find first instance of root2 to node in path 'element_root/root1/root2' XMLObject xo1 = xo.findXMLObjectByPath("element_root/root1/root2"); // find index instance of root3 to node in path 'element_root/root1/root2/root3' xo1 = xo.findXMLObjectByPath("element_root/root1/root2/root3", 1); // get attribute value for 'index' in 'element_root/root1/root2/root3' str = xo.getAttribute("element_root/root1/root2/root3", "index"); // get attribute value for 'index' in indexed 'element_root/root1/root2/root3' str = xo.getAttribute("element_root/root1/root2/root3", 2, "index");
  - XMLObject
```
public XMLObject(java.lang.String elementName)
```
- Method Detail
  - getNameSpace
```
public java.lang.String getNameSpace()
```
  - setNameSpace
```
public void setNameSpace(java.lang.String nameSpace)
```
  - setup
```
protected void setup()
```
  - setElementName
```
public void setElementName(java.lang.String elementName)
```
  - setAttributes
```
public void setAttributes(java.util.List<XMLAttribute> attributes)
```
  - addAttribute
```
public void addAttribute(java.lang.String key,
                         java.lang.String value)
```
  - addAttribute
```
public void addAttribute(java.lang.String key,
                         int value)
```
  - addContent
```
public void addContent(java.lang.String content)
```
  - addNodeWithContent
```
public XMLObject addNodeWithContent(java.lang.String nodeName,
                                    java.lang.String content)
```
    add a new node with the content as an child of this node.
  - getElementName
```
public java.lang.String getElementName()
```
  - getName
```
public java.lang.String getName()
```
    returns the element name including the namespace if there is one
  - getXMLAttribute
```
public XMLAttribute getXMLAttribute(int index)
```
  - getXMLAttribute
```
public XMLAttribute getXMLAttribute(java.lang.String key)
```
  - getAttributeValue
```
public java.lang.Object getAttributeValue(java.lang.String key)
```
    Get the attribute value for this key, will return null if no key exists.
  - getAttributeValueNoNull
```
public java.lang.Object getAttributeValueNoNull(java.lang.String key)
```
    Get the attribute value for this key as a string, will return "" if no key exists.
  - getAttributeValueAsString
```
public java.lang.String getAttributeValueAsString(java.lang.String key)
```
    Get the attribute value for this key as a string, will return null if no key exists.
  - getAttributeAsString
```
public java.lang.String getAttributeAsString(int index)
```
    Get the attribute value for this index.
  - getAttributeKeyAsString
```
public java.lang.String getAttributeKeyAsString(int index)
```
    Get the attribute key for this index.
  - getAttributeCount
```
public int getAttributeCount()
```
    Get the number of attribute for this element.
  - getAttributes
```
public java.util.List<XMLAttribute> getAttributes()
```
    Get the list of attributes for this element.
  - updateAttribute
```
public void updateAttribute(java.lang.String key,
                            java.lang.String newValue)
```
  - updateAttribute
```
public void updateAttribute(java.lang.String key,
                            java.lang.Object newValue)
```
  - getContent
```
public java.lang.String getContent()
```
  - addChild
```
public void addChild(XMLObject xmlObject)
```
  - addChild
```
public void addChild(int index,
                     XMLObject xmlObject)
```
  - getChild
```
public XMLObject getChild(int index)
```
  - getChildren
```
public java.util.List<XMLObject> getChildren()
```
  - getChildIndex
```
public int getChildIndex(int from,
                         java.lang.String childElementName)
```
    Get a child element starting a from index and containing childElementName Will start at the entered from position getting each child element. If the child element name matches the will return the index of the mathching child.
    
    Parameters:
    
    from - is the index of the child that we want to start searching from
    
    childElementName - is the element we are looking for
    
    Returns:
    
    the index of the found child or a -1 if not found.
  - removeChild
```
public void removeChild(int index)
```
  - addChildAfter
```
public void addChildAfter(XMLObject before,
                          XMLObject xo)
```
  - removeChild
```
public void removeChild(XMLObject xo)
```
  - getChildCount
```
public int getChildCount()
```
  - getChildCount
```
public int getChildCount(java.lang.String childElementName)
```
    Cound the number of children this XMLObject has that match the entered childElementName (not case sensitive)
    
    Parameters:
    
    childElementName - only count elements that match this element name
    
    Returns:
  - getParent
```
public XMLObject getParent()
```
  - findChild
```
public int findChild(XMLObject xo)
```
  - findNode
```
public XMLObject findNode(XMLObject xo,
                          java.lang.String nodeName)
```
    Finds and returns a XMLObject of nodeName or returns null if not found Traverses node and subsequent child node searching for the nodeName.
  - findChildNode
```
public XMLObject findChildNode(java.lang.String nodeName)
```
    Finds and returns a child XMLObject with nodeName or returns null if not found
  - replace
```
public void replace(XMLObject oldXO,
                    XMLObject newXO)
```
    replaces the oldXO with the newXO by first determining the parent of the oldXO and then replacing the child.
    
    Parameters:
    
    oldXO - is the XMLObject to replace
    
    newXO - is the XMLObject to replace it with.
  - remove
```
public void remove(XMLObject oldXO)
```
    removes the xml object from it's parent if there is a parent
  - remove
```
public void remove()
```
    removes the xml object from it's parent if there is a parent.
  - getAttribute
```
public java.lang.String getAttribute(java.lang.String path,
                                     java.lang.String key)
                              throws java.lang.Exception
```
    Gets an attribute value as a string using path and key
    
    Parameters:
    
    path - is the xml path to the node i.e. 'root/node1/node2'
    
    key - is the attribute value we want from the node.
    
    Returns:
    
    the value if node found or null if not found.
    
    Throws:
    
    java.lang.Exception
  - getAttribute
```
public java.lang.String getAttribute(java.lang.String path,
                                     int index,
                                     java.lang.String key)
                              throws java.lang.Exception
```
    Gets an attribute value as a string using path and key
    
    Parameters:
    
    path - is the xml path to the node i.e. 'root/node1/node2'
    
    index - is the node2 index as child of node1.
    
    key - is the attribute value we want from the node.
    
    Returns:
    
    the value if node found or null if not found.
    
    Throws:
    
    java.lang.Exception
  - getNode
```
public XMLObject getNode(java.lang.String path,
                         int index)
                  throws java.lang.Exception
```
    Gets a node and any children as a string using path and index
    
    Parameters:
    
    path - is the xml path to the node i.e. 'root/node1/node2'
    
    index - is the node2 index as child of node1.
    
    Returns:
    
    the node and children found or null if not found.
    
    Throws:
    
    java.lang.Exception
  - getContent
```
public java.lang.String getContent(java.lang.String path)
```
    Gets content as a string using path to reach node.
    
    Parameters:
    
    path - is the xml path to the node i.e. 'root/node1/node2'
    
    Returns:
    
    the value if node found or null if not found.
  - getContent
```
public java.lang.String getContent(java.lang.String path,
                                   int index)
```
    Gets content as a string using path and index to reach node.
    
    Parameters:
    
    path - is the xml path to the node i.e. 'root/node1/node2'
    
    index - is the node2 index as child of node1.
    
    Returns:
    
    the value if node found or null if not found.
  - findXMLObjectByPath
```
public XMLObject findXMLObjectByPath(java.lang.String path)
```
    Using a path such as 'root/node1/node2' will return an XMLObject for node2 if found else null.
    
    Parameters:
    
    path - is the xml path such as 'root/node1/node2'
    
    Returns:
    
    the XMLObject if found or null if not.
  - findXMLObjectByPath
```
public XMLObject findXMLObjectByPath(java.lang.String path,
                                     int index)
```
    Using a path such as 'root/node1/node2' will return the index count of node2. if index = 1 will return the first instance of node2 if index is 2 will return the second instance of node2
    
    Parameters:
    
    path - is the xml path such as 'root/node1/node2'
    
    index - is the index into last node name of path
    
    Returns:
    
    the XMLObject if found or null if not.
  - mapXMLToXMLObject
```
public XMLObject mapXMLToXMLObject(java.lang.String xml)
                            throws java.lang.Exception
```
    Deprecated. Please now use mapXMLCharToXMLObject()
    
    Map an XML String to a XMLObject
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    "mapXMLCharToXMLObject()"
  - mapXMLCharToXMLObject
```
public XMLObject mapXMLCharToXMLObject(java.lang.String xml)
```
    Map an XML String to a XMLObject
  - mapXMLCharToXMLObject
```
public XMLObject mapXMLCharToXMLObject(java.lang.String xml,
                                       java.lang.String nameSpace)
```
    Map an XML String to a XMLObject
    
    Parameters:
    
    xml - is the xml to map
    
    nameSpace - will only map elements with this namespace
  - mapXMLCharToXMLObject
```
public XMLObject mapXMLCharToXMLObject(java.lang.String xml,
                                       char[][] nameSpaces)
```
    Map an XML String to a XMLObject
    
    Parameters:
    
    xml - is the xml to map
    
    nameSpaces - will only map elements with these namespaces
  - mapXMLObject2XML
```
public java.lang.String mapXMLObject2XML(XMLObject root)
```
    Map an XMLObject to an XMLString
  - mapXMLObject2XML
```
public java.lang.String mapXMLObject2XML(XMLObject root,
                                         boolean lineFeed)
```
    Map an XMLObject to an XMLString
  - xmlAllNodes
```
public void xmlAllNodes(XMLObject node,
                        XMLBuilder builder,
                        int indent,
                        boolean lineFeed)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toHTMLString
```
public java.lang.String toHTMLString()
```
  - mapXMLObject2HTML
```
public java.lang.String mapXMLObject2HTML()
```
  - toXMLString
```
public java.lang.String toXMLString(boolean closeElement)
```
    Converts the xml object into an XML String
    
    Parameters:
    
    closeElement - if set true will terminate the node using either '/>' or '</elementName>'. if set false will close the node with '>' provided no content has been added.
  - toXMLString
```
public java.lang.String toXMLString(int indent,
                                    boolean closeElement)
```
    Converts the xml object into an XML String
    
    Parameters:
    
    indent - is the indenting spaces to add at the beginning of the xml
    
    closeElement - if set true will terminate the node using either '/>' or '</elementName>'. if set false will close the node with '>' provided no content has been added.
  - main
```
public static void main(java.lang.String[] args)
                 throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception

Class XMLObject

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XMLObject

XMLObject

Method Detail

getNameSpace

setNameSpace

setup

setElementName

setAttributes

addAttribute

addAttribute

addContent

addNodeWithContent

getElementName

getName

getXMLAttribute

getXMLAttribute

getAttributeValue

getAttributeValueNoNull

getAttributeValueAsString

getAttributeAsString

getAttributeKeyAsString

getAttributeCount

getAttributes

updateAttribute

updateAttribute

getContent

addChild

addChild

getChild

getChildren

getChildIndex

removeChild

addChildAfter

removeChild

getChildCount

getChildCount

getParent

findChild

findNode

findChildNode

replace

remove

remove

getAttribute

getAttribute

getNode

getContent

getContent

findXMLObjectByPath

findXMLObjectByPath

mapXMLToXMLObject

mapXMLCharToXMLObject

mapXMLCharToXMLObject

mapXMLCharToXMLObject

mapXMLObject2XML

mapXMLObject2XML

xmlAllNodes

toString

toHTMLString

mapXMLObject2HTML

toXMLString

toXMLString

main