public class XMLDocument extends java.lang.Object implements RevisionHandler
PI
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATT_NAME
the "name" attribute.
|
static java.lang.String |
ATT_VERSION
the "version" attribute.
|
static java.lang.String |
DTD_ANY
the ANY placeholder.
|
static java.lang.String |
DTD_AT_LEAST_ONE
the at least one marker.
|
static java.lang.String |
DTD_ATTLIST
the AttList definition.
|
static java.lang.String |
DTD_CDATA
the CDATA placeholder.
|
static java.lang.String |
DTD_DOCTYPE
the DocType definition.
|
static java.lang.String |
DTD_ELEMENT
the Element definition.
|
static java.lang.String |
DTD_IMPLIED
the #IMPLIED placeholder.
|
static java.lang.String |
DTD_OPTIONAL
the optional marker.
|
static java.lang.String |
DTD_PCDATA
the #PCDATA placeholder.
|
static java.lang.String |
DTD_REQUIRED
the #REQUIRED placeholder.
|
static java.lang.String |
DTD_SEPARATOR
the option separator.
|
static java.lang.String |
DTD_ZERO_OR_MORE
the zero or more marker.
|
static java.lang.String |
PI
the parsing instructions "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
(may not show up in Javadoc due to tags!).
|
static java.lang.String |
VAL_NO
the value "no".
|
static java.lang.String |
VAL_YES
the value "yes".
|
Constructor and Description |
---|
XMLDocument()
initializes the factory with non-validating parser.
|
XMLDocument(java.io.File file)
Creates a new instance of XMLDocument.
|
XMLDocument(java.io.InputStream stream)
Creates a new instance of XMLDocument.
|
XMLDocument(java.io.Reader reader)
Creates a new instance of XMLDocument.
|
XMLDocument(java.lang.String xml)
Creates a new instance of XMLDocument.
|
Modifier and Type | Method and Description |
---|---|
void |
clear()
sets up an empty DOM document, with the current DOCTYPE and root node.
|
java.lang.Boolean |
evalBoolean(java.lang.String xpath)
Evaluates and returns the boolean result of the XPath expression.
|
java.lang.Double |
evalDouble(java.lang.String xpath)
Evaluates and returns the double result of the XPath expression.
|
java.lang.String |
evalString(java.lang.String xpath)
Evaluates and returns the boolean result of the XPath expression.
|
org.w3c.dom.NodeList |
findNodes(java.lang.String xpath)
Returns the nodes that the given xpath expression will find in the
document.
|
javax.xml.parsers.DocumentBuilder |
getBuilder()
returns the DocumentBuilder.
|
static java.util.Vector |
getChildTags(org.w3c.dom.Node parent)
returns all non tag-children from the given node.
|
static java.util.Vector |
getChildTags(org.w3c.dom.Node parent,
java.lang.String name)
returns all non tag-children from the given node.
|
static java.lang.String |
getContent(org.w3c.dom.Element node)
returns the text between the opening and closing tag of a node
(performs a
trim() on the result). |
java.lang.String |
getDocType()
returns the current DOCTYPE, can be
null . |
org.w3c.dom.Document |
getDocument()
returns the parsed DOM document.
|
javax.xml.parsers.DocumentBuilderFactory |
getFactory()
returns the DocumentBuilderFactory.
|
org.w3c.dom.Node |
getNode(java.lang.String xpath)
Returns the node represented by the XPath expression.
|
java.lang.String |
getRevision()
Returns the revision string.
|
java.lang.String |
getRootNode()
returns the current root node.
|
boolean |
getValidating()
returns whether a validating parser is used.
|
static void |
main(java.lang.String[] args)
for testing only.
|
org.w3c.dom.Document |
newDocument(java.lang.String docType,
java.lang.String rootNode)
creates a new Document with the given information.
|
void |
print()
prints the current DOM document to standard out.
|
org.w3c.dom.Document |
read(java.io.File file)
parses the given file and returns a DOM document.
|
org.w3c.dom.Document |
read(java.io.InputStream stream)
parses the given stream and returns a DOM document.
|
org.w3c.dom.Document |
read(java.io.Reader reader)
parses the given reader and returns a DOM document.
|
org.w3c.dom.Document |
read(java.lang.String xml)
parses the given XML string (can be XML or a filename) and returns a
DOM Document.
|
void |
setDocType(java.lang.String docType)
sets the DOCTYPE-String to use in the XML output.
|
void |
setDocument(org.w3c.dom.Document newDocument)
sets the DOM document to use.
|
void |
setRootNode(java.lang.String rootNode)
sets the root node to use in the XML output.
|
void |
setValidating(boolean validating)
sets whether to use a validating parser or not.
Note: this does clear the current DOM document! |
java.lang.String |
toString()
returns the current DOM document as XML-string.
|
void |
write(java.io.File file)
writes the current DOM document into the given file.
|
void |
write(java.io.OutputStream stream)
writes the current DOM document into the given stream.
|
void |
write(java.lang.String file)
writes the current DOM document into the given file.
|
void |
write(java.io.Writer writer)
writes the current DOM document into the given writer.
|
public static final java.lang.String PI
public static final java.lang.String DTD_DOCTYPE
public static final java.lang.String DTD_ELEMENT
public static final java.lang.String DTD_ATTLIST
public static final java.lang.String DTD_OPTIONAL
public static final java.lang.String DTD_AT_LEAST_ONE
public static final java.lang.String DTD_ZERO_OR_MORE
public static final java.lang.String DTD_SEPARATOR
public static final java.lang.String DTD_CDATA
public static final java.lang.String DTD_ANY
public static final java.lang.String DTD_PCDATA
public static final java.lang.String DTD_IMPLIED
public static final java.lang.String DTD_REQUIRED
public static final java.lang.String ATT_VERSION
public static final java.lang.String ATT_NAME
public static final java.lang.String VAL_YES
public static final java.lang.String VAL_NO
public XMLDocument() throws java.lang.Exception
java.lang.Exception
- if the construction failspublic XMLDocument(java.lang.String xml) throws java.lang.Exception
xml
- the xml to parse (if "
java.lang.Exception
- if the construction of the DocumentBuilder failssetValidating(boolean)
public XMLDocument(java.io.File file) throws java.lang.Exception
file
- the XML file to parsejava.lang.Exception
- if the construction of the DocumentBuilder failssetValidating(boolean)
public XMLDocument(java.io.InputStream stream) throws java.lang.Exception
stream
- the XML stream to parsejava.lang.Exception
- if the construction of the DocumentBuilder failssetValidating(boolean)
public XMLDocument(java.io.Reader reader) throws java.lang.Exception
reader
- the XML reader to parsejava.lang.Exception
- if the construction of the DocumentBuilder failssetValidating(boolean)
public javax.xml.parsers.DocumentBuilderFactory getFactory()
public javax.xml.parsers.DocumentBuilder getBuilder()
public boolean getValidating()
public void setValidating(boolean validating) throws java.lang.Exception
validating
- whether to use a validating parserjava.lang.Exception
- if the instantiating of the DocumentBuilder failspublic org.w3c.dom.Document getDocument()
public void setDocument(org.w3c.dom.Document newDocument)
newDocument
- the DOM document to usepublic void setDocType(java.lang.String docType)
null
the DOCTYPE is omitted.docType
- the DOCTYPE definition to use in XML outputpublic java.lang.String getDocType()
null
.null
public void setRootNode(java.lang.String rootNode)
rootNode
- the root node to use in the XML outputpublic java.lang.String getRootNode()
public void clear()
setRootNode(String)
,
setDocType(String)
public org.w3c.dom.Document newDocument(java.lang.String docType, java.lang.String rootNode)
docType
- the DOCTYPE definition (no checking happens!), can be nullrootNode
- the name of the root node (must correspond to the one
given in docType
)public org.w3c.dom.Document read(java.lang.String xml) throws java.lang.Exception
xml
- the xml to parse (if "
java.lang.Exception
- if something goes wrong with the parsingpublic org.w3c.dom.Document read(java.io.File file) throws java.lang.Exception
file
- the XML file to parsejava.lang.Exception
- if something goes wrong with the parsingpublic org.w3c.dom.Document read(java.io.InputStream stream) throws java.lang.Exception
stream
- the XML stream to parsejava.lang.Exception
- if something goes wrong with the parsingpublic org.w3c.dom.Document read(java.io.Reader reader) throws java.lang.Exception
reader
- the XML reader to parsejava.lang.Exception
- if something goes wrong with the parsingpublic void write(java.lang.String file) throws java.lang.Exception
file
- the filename to write tojava.lang.Exception
- if something goes wrong with the parsingpublic void write(java.io.File file) throws java.lang.Exception
file
- the filename to write tojava.lang.Exception
- if something goes wrong with the parsingpublic void write(java.io.OutputStream stream) throws java.lang.Exception
stream
- the filename to write tojava.lang.Exception
- if something goes wrong with the parsingpublic void write(java.io.Writer writer) throws java.lang.Exception
writer
- the filename to write tojava.lang.Exception
- if something goes wrong with the parsingpublic static java.util.Vector getChildTags(org.w3c.dom.Node parent)
parent
- the node to get the children frompublic static java.util.Vector getChildTags(org.w3c.dom.Node parent, java.lang.String name)
parent
- the node to get the children fromname
- the name of the tags to return, "" for allpublic org.w3c.dom.NodeList findNodes(java.lang.String xpath)
xpath
- the XPath expression to run on the documentpublic org.w3c.dom.Node getNode(java.lang.String xpath)
xpath
- the XPath expression to run on the documentpublic java.lang.Boolean evalBoolean(java.lang.String xpath)
xpath
- the expression to evaluatepublic java.lang.Double evalDouble(java.lang.String xpath)
xpath
- the expression to evaluatepublic java.lang.String evalString(java.lang.String xpath)
xpath
- the expression to evaluatepublic static java.lang.String getContent(org.w3c.dom.Element node)
trim()
on the result).node
- the node to get the text frompublic void print()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getRevision()
getRevision
in interface RevisionHandler
public static void main(java.lang.String[] args) throws java.lang.Exception
args
- the commandline argumentsjava.lang.Exception
- if something goes wrong