public class DOMProcessor
extends java.lang.Object
Constructor and Description |
---|
DOMProcessor()
Creates a new empty DOM ready for processing.
|
DOMProcessor(org.w3c.dom.Document dom)
Wraps the given DOM in this processor allowing it to be written
as an XML file, or appended with new nodes.
|
DOMProcessor(java.io.InputStream inStream)
Reads XML from the given input stream and constructs a DOM from it.
|
DOMProcessor(java.lang.String fileName)
Reads and the given XML file and constructs a DOM from it.
|
Modifier and Type | Method and Description |
---|---|
static void |
addAttribute(java.lang.String name,
java.lang.String value,
org.w3c.dom.Node node)
Adds the given attribute to the given node.
|
void |
addComment(java.lang.String comment)
Adds the given comment to the root of the DOM.
|
void |
addComment(java.lang.String comment,
org.w3c.dom.Node node)
Adds the given comment to the given node.
|
org.w3c.dom.Node |
addElement(java.lang.String name)
Adds a new element to the root of the DOM.
|
org.w3c.dom.Node |
addElement(java.lang.String name,
org.w3c.dom.Node existingElement)
Adds a new element to the given one within the DOM.
|
org.w3c.dom.Node |
addElement(java.lang.String name,
java.lang.String text,
org.w3c.dom.Node existingElement)
Adds a new element to the given one within the DOM.
|
void |
addText(java.lang.String text,
org.w3c.dom.Node node)
Adds text as the child of the given node.
|
java.lang.String[] |
getAttributes(java.lang.String attributeName)
Searches the entire DOM for a given attribute and returns the value associated with it.
|
java.lang.String[] |
getAttributes(java.lang.String attributeName,
org.w3c.dom.Node node)
Searches the given node and its children for a given attribute and returns the value
associated with it.
|
org.w3c.dom.Node[] |
getElements(java.lang.String name)
Returns a list of the DOM elements with the given name.
|
org.w3c.dom.Node[] |
getElements(java.lang.String name,
org.w3c.dom.Node node)
Returns a list of the DOM elements with the given name that are
nested within the given node.
|
static java.lang.String |
getNodeAttribute(java.lang.String attributeName,
org.w3c.dom.Node node)
Searches the given node for a given attribute and returns the value associated with it.
|
static org.w3c.dom.Node |
getNodeElement(java.lang.String name,
org.w3c.dom.Node node)
Returns a DOM element with the given name that is the child of the
given node.
|
static org.w3c.dom.Node[] |
getNodeElements(java.lang.String name,
org.w3c.dom.Node node)
Returns the DOM elements with the given name that are the children of the
given node.
|
static java.lang.String |
getNodeText(org.w3c.dom.Node node)
Searches for a given node and returns text associated with
it.
|
java.lang.String[] |
getText(org.w3c.dom.Node node)
Returns any text associated found in the given node or its children.
|
java.lang.String[] |
getText(java.lang.String elementName)
Searches the entire DOM for a given element and returns text associated
with it.
|
java.lang.String[] |
getText(java.lang.String elementName,
org.w3c.dom.Node node)
Searches for a given element and returns text associated with it.
|
boolean |
isEmpty()
Reports whether we have an empty DOM.
|
boolean |
readXML(java.io.InputStream inStream)
Reads the XML from the given input stream and converts it into a DOM.
|
boolean |
readXML(java.lang.String fileName)
Reads the given XML file and converts it into a DOM.
|
void |
renameElement(org.w3c.dom.Node existingElement,
java.lang.String newName)
Renames the given element with the given new name.
|
boolean |
writeXML()
Displays the DOM stored within this class as an XML file with default
document settings on standard output.
|
boolean |
writeXML(java.io.OutputStream outStream)
Converts the DOM stored within this class into an XML file with default document settings.
|
boolean |
writeXML(java.io.OutputStream outStream,
java.lang.String version,
java.lang.String encoding,
java.lang.Boolean standalone)
Converts the DOM stored within this class into an XML file with the given document settings.
|
boolean |
writeXML(java.lang.String fileName)
Converts the DOM stored within this class into an XML file with default document settings.
|
boolean |
writeXML(java.lang.String version,
java.lang.String encoding,
java.lang.Boolean standalone)
Displays the DOM stored within this class as an XML file with the given document
settings on standard output.
|
boolean |
writeXML(java.lang.String fileName,
java.lang.String version,
java.lang.String encoding,
java.lang.Boolean standalone)
Converts the DOM stored within this class into an XML file with the given document settings.
|
public DOMProcessor()
public DOMProcessor(org.w3c.dom.Document dom)
dom
- Document Object Model to use in processor.public DOMProcessor(java.lang.String fileName)
fileName
- Name of XML file to read.public DOMProcessor(java.io.InputStream inStream)
inStream
- Stream from which to read XML.public boolean isEmpty()
public org.w3c.dom.Node addElement(java.lang.String name)
name
- Name of the new elementpublic org.w3c.dom.Node addElement(java.lang.String name, org.w3c.dom.Node existingElement)
name
- Name of the new elementexistingElement
- Element onto which the new element should be attached.public org.w3c.dom.Node addElement(java.lang.String name, java.lang.String text, org.w3c.dom.Node existingElement)
name
- Name of the new elementtext
- Text to attach to element or null if none required.existingElement
- Element onto which the new element should be attached.public void renameElement(org.w3c.dom.Node existingElement, java.lang.String newName)
existingElement
- Element to rename.newName
- New name to give element.public static void addAttribute(java.lang.String name, java.lang.String value, org.w3c.dom.Node node)
name
- Attribute name.value
- Attribute value.node
- Element to attach attribute.public void addComment(java.lang.String comment)
comment
- Comment text.public void addComment(java.lang.String comment, org.w3c.dom.Node node)
comment
- Comment text.node
- Element to attach comment.public void addText(java.lang.String text, org.w3c.dom.Node node)
text
- Text to add to node.node
- Element to attach text.public java.lang.String[] getText(java.lang.String elementName)
elementName
- Element to search for.public java.lang.String[] getText(org.w3c.dom.Node node)
getText(null,node)
.
If more than one element containing text exists, multiple text values
are returned.node
- Node from which to start search.public java.lang.String[] getText(java.lang.String elementName, org.w3c.dom.Node node)
elementName
- Element to search for. If elementName is null, search will be
for all text contained within the given node.node
- Node from which to start search.public static java.lang.String getNodeText(org.w3c.dom.Node node)
node
- Node to search.public java.lang.String[] getAttributes(java.lang.String attributeName)
attributeName
- Attribute to search for.public java.lang.String[] getAttributes(java.lang.String attributeName, org.w3c.dom.Node node)
attributeName
- Attribute to search for.node
- Node from which to start search.public static java.lang.String getNodeAttribute(java.lang.String attributeName, org.w3c.dom.Node node)
attributeName
- Attribute to search for.node
- Node from which to start search.public org.w3c.dom.Node[] getElements(java.lang.String name)
name
- Element name to search for.public org.w3c.dom.Node[] getElements(java.lang.String name, org.w3c.dom.Node node)
getNodeElements
and
recursively search for children of returned nodes.name
- Element name to search for.node
- Node from which to start search.public static org.w3c.dom.Node getNodeElement(java.lang.String name, org.w3c.dom.Node node)
getNodeElements()
this method only
returns the first matched child of the given node.name
- Element name to search for.node
- Node from which to examine children.public static org.w3c.dom.Node[] getNodeElements(java.lang.String name, org.w3c.dom.Node node)
name
- Element name to search for.node
- Node from which to examine children.public boolean readXML(java.lang.String fileName)
fileName
- Name of XML file to convert.public boolean readXML(java.io.InputStream inStream)
inStream
- Input stream containing XML to convert.public boolean writeXML()
public boolean writeXML(java.lang.String version, java.lang.String encoding, java.lang.Boolean standalone)
version
- XML version, or null if default ('1.0') is to be used.encoding
- XML encoding, or null if encoding is not to be specified.standalone
- XML stand-alone status of XML file or null if not to be specified.public boolean writeXML(java.lang.String fileName)
fileName
- Name of file to contain the XML.public boolean writeXML(java.io.OutputStream outStream)
outStream
- Output stream representing file to contain the XML.public boolean writeXML(java.lang.String fileName, java.lang.String version, java.lang.String encoding, java.lang.Boolean standalone)
fileName
- Name of file to contain the XML.version
- XML version, or null if default ('1.0') is to be used.encoding
- XML encoding, or null if encoding is not to be specified.standalone
- XML stand-alone status of XML file or null if not to be specified.public boolean writeXML(java.io.OutputStream outStream, java.lang.String version, java.lang.String encoding, java.lang.Boolean standalone)
outStream
- Output stream representing file to contain the XML.version
- XML version, or null if default ('1.0') is to be used.encoding
- XML encoding, or null if encoding is not to be specified.standalone
- XML stand-alone status of XML file or null if not to be specified.