public class ResourceXMLParser
extends java.lang.Object
parse()
method parses the configured File as a sequence of ResourceXMLParser.Entity
objects, one for each entry in the file. It passes these objects to any configured ResourceXMLReceiver
object. One should be set using setReceiver(ResourceXMLReceiver)
to receive parsed entities or the entire entity set.
(node|setting|package|deployment)
, but this can be set to any Xpath to limit the entities that are
parsed from the document. (e.g. "node|package
" or "node[@name='mynode']
").
Modifier and Type | Class and Description |
---|---|
static class |
ResourceXMLParser.Entity
Represents a parsed resource entity in the xml, which consists of a name property, a type property, and a set of
name/value properties.
|
static class |
ResourceXMLParser.EntitySet
Contains the set of parsed entities from the document.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_ENTITY_XPATH |
Constructor and Description |
---|
ResourceXMLParser(org.dom4j.Document doc)
Constructor for the ResourceXMLParser
|
ResourceXMLParser(java.io.File file)
Constructor for the ResourceXMLParser
|
ResourceXMLParser(java.io.InputStream input)
Constructor for the ResourceXMLParser
|
Modifier and Type | Method and Description |
---|---|
static org.xml.sax.EntityResolver |
createEntityResolver() |
ResourceXMLReceiver |
getReceiver()
Return the ResourceXMLReceiver
|
void |
parse()
Parse the document, applying the configured Receiver to the parsed entities
|
protected static java.lang.String |
reportNodeErrorLocation(org.dom4j.Node e)
Return a String describing the DOM node's location and parent type name
|
void |
setReceiver(ResourceXMLReceiver receiver)
Set the ResourceXMLReceiver to use.
|
public static final java.lang.String DEFAULT_ENTITY_XPATH
public ResourceXMLParser(java.io.File file)
file
- source filepublic ResourceXMLParser(java.io.InputStream input)
input
- source filepublic ResourceXMLParser(org.dom4j.Document doc)
doc
- source documentpublic void parse() throws ResourceXMLParserException, java.io.IOException
ResourceXMLParserException
- parse errorjava.io.IOException
- io errorpublic static org.xml.sax.EntityResolver createEntityResolver()
protected static java.lang.String reportNodeErrorLocation(org.dom4j.Node e)
e
- the nodepublic ResourceXMLReceiver getReceiver()
public void setReceiver(ResourceXMLReceiver receiver)
ResourceXMLParser.Entity
objects created during the parse()
method,
and will also receive the complete ResourceXMLParser.EntitySet
at the
end of the sequence. It can govern whether parsing should continue or not, see ResourceXMLReceiver
receiver
- the new ResourceXMLReceiver