com.dtolabs.shared.resources

Class ResourceXMLParser

java.lang.Object

com.dtolabs.shared.resources.ResourceXMLParser

public class ResourceXMLParser
extends java.lang.Object

ResourceXMLParser parses a resources.xml formatted file, and provides several interfaces for using the result data.
The 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.
The default entityXpath property value is set to match all entity types in the resource xml (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']").

Nested Class Summary

Nested Classes

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.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ENTITY_XPATH

Constructor Summary

Constructors

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

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ENTITY_XPATH

public static final java.lang.String DEFAULT_ENTITY_XPATH

See Also:

Constant Field Values

Constructor Detail

ResourceXMLParser

public ResourceXMLParser(java.io.File file)

Constructor for the ResourceXMLParser

Parameters:

file - source file

ResourceXMLParser

public ResourceXMLParser(java.io.InputStream input)

Constructor for the ResourceXMLParser

Parameters:

input - source file

ResourceXMLParser

public ResourceXMLParser(org.dom4j.Document doc)

Constructor for the ResourceXMLParser

Parameters:

doc - source document

Method Detail

parse

public void parse()
           throws ResourceXMLParserException,
                  java.io.IOException

Parse the document, applying the configured Receiver to the parsed entities

Throws:

ResourceXMLParserException - parse error

java.io.IOException - io error

createEntityResolver

public static org.xml.sax.EntityResolver createEntityResolver()

reportNodeErrorLocation

protected static java.lang.String reportNodeErrorLocation(org.dom4j.Node e)

Return a String describing the DOM node's location and parent type name

Parameters:

e - the node

Returns:

string describing xpath location and parent "type" element name

getReceiver

public ResourceXMLReceiver getReceiver()

Return the ResourceXMLReceiver

Returns:

the ResourceXMLReceiver

setReceiver

public void setReceiver(ResourceXMLReceiver receiver)

Set the ResourceXMLReceiver to use. It will be invoked to receive the 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

Parameters:

receiver - the new ResourceXMLReceiver