buri.ddmsence.util

Class DDMSReader

Object

buri.ddmsence.util.DDMSReader

public class DDMSReader
extends Object

Reader class which loads an XML file containing DDMS information and converts it into XOM elements.

This parsing performs schema validation against a local set of DDMS/ISM schemas.

Since:

0.9.b

Author:

Brian Uri!

Constructor Summary

Constructors

Constructor and Description
DDMSReader(DDMSVersion version) Constructor

Method Summary

Modifier and Type	Method and Description
void	addExternalSchemaLocation(String xmlNamespace, String schemaLocation) Add additional schema locations to those already known by this DDMSReader.
protected Resource	buildResource(nu.xom.Element xomElement) Shared helper method to build a DDMS Resource from a XOM Element
Resource	getDDMSResource(File file) Creates a DDMS resource based on the contents of a file, and also sets the DDMSVersion based on the namespace URIs in the file.
Resource	getDDMSResource(InputStream inputStream) Creates a DDMS resource based on the contents of an input stream, and also sets the DDMSVersion based on the namespace URIs in the document.
Resource	getDDMSResource(Reader reader) Creates a DDMS resource based on the contents of a reader, and also sets the DDMSVersion based on the namespace URIs in the document.
Resource	getDDMSResource(String xml) Creates a DDMS resource based on the contents of a string representation of an XML document, and also sets the DDMSVersion based on the namespace URIs in the document.
nu.xom.Element	getElement(File file) Creates a XOM element representing the root XML element in the file.
nu.xom.Element	getElement(InputStream inputStream) Creates a XOM element representing the root XML element in an input stream.
nu.xom.Element	getElement(Reader reader) Creates a XOM element representing the root XML element in a reader.
nu.xom.Element	getElement(String xml) Creates a XOM element representing the root XML element in a string representation of an XML document.
String	getExternalSchemaLocations() Returns the external schema locations.
protected String	getLocalSchemaLocation(String schemaLocation) Returns the full path to a local schema copy, based on the relative location from the properties file.
static void	validateWithSchema(DDMSVersion version, String resourceXML) Attempts to build an Element from a Resource XML string.

Methods inherited from class Object

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

Constructor Detail

DDMSReader

public DDMSReader(DDMSVersion version)
           throws org.xml.sax.SAXException

Constructor

Schemas are loaded in reverse order, so the latest, greatest copy is always first to be looked for.

Creates a DDMSReader which can process various versions of DDMS and GML

Throws:

org.xml.sax.SAXException

Method Detail

getLocalSchemaLocation

protected String getLocalSchemaLocation(String schemaLocation)

Returns the full path to a local schema copy, based on the relative location from the properties file. The full path will have spaces escaped as %20, to resolve Issue 50 in the DDMSence Issue Tracker.

Parameters:

schemaLocation - the relative schema location as specified in the properties file

Returns:

the full path to the schema (generally this is in the JAR file)

Throws:

IllegalArgumentException - if the schema could not be found.

validateWithSchema

public static void validateWithSchema(DDMSVersion version,
                                      String resourceXML)
                               throws InvalidDDMSException

Attempts to build an Element from a Resource XML string. Element-based constructors for a Resource are automatically validated against a schema when the XML parser loads it. This method allows the data-driven constructors for a Resource to do a final confirmation that none of the data breaks any schema rules.

Parameters:

version - the DDMSVersion of the resource

resourceXML - the XML of the resource to check

Throws:

InvalidDDMSException - if the resource is invalid

getElement

public nu.xom.Element getElement(File file)
                          throws IOException,
                                 InvalidDDMSException

Creates a XOM element representing the root XML element in the file.

The implementation of this method delegates to the Reader-based overloaded method.

Parameters:

file - the file containing the XML document

Returns:

a XOM element representing the root node in the document

Throws:

IOException

InvalidDDMSException

getElement

public nu.xom.Element getElement(String xml)
                          throws IOException,
                                 InvalidDDMSException

Creates a XOM element representing the root XML element in a string representation of an XML document.

The implementation of this method delegates to the Reader-based overloaded method.

Parameters:

xml - a string containing the XML document

Returns:

a XOM element representing the root node in the document

Throws:

IOException

InvalidDDMSException

getElement

public nu.xom.Element getElement(InputStream inputStream)
                          throws IOException,
                                 InvalidDDMSException

Creates a XOM element representing the root XML element in an input stream.

The implementation of this method delegates to the Reader-based overloaded method.

Parameters:

inputStream - a stream mapping to an XML document

Returns:

a XOM element representing the root node in the document

Throws:

IOException

InvalidDDMSException

getElement

public nu.xom.Element getElement(Reader reader)
                          throws IOException,
                                 InvalidDDMSException

Creates a XOM element representing the root XML element in a reader.

Parameters:

reader - a reader mapping to an XML document

Returns:

a XOM element representing the root node in the document

Throws:

IOException

InvalidDDMSException

getDDMSResource

public Resource getDDMSResource(File file)
                         throws IOException,
                                InvalidDDMSException

Creates a DDMS resource based on the contents of a file, and also sets the DDMSVersion based on the namespace URIs in the file.

Parameters:

file - the file containing the DDMS Resource.

Returns:

a DDMS Resource

Throws:

InvalidDDMSException - if the component could not be built

IOException

getDDMSResource

public Resource getDDMSResource(String xml)
                         throws IOException,
                                InvalidDDMSException

Creates a DDMS resource based on the contents of a string representation of an XML document, and also sets the DDMSVersion based on the namespace URIs in the document.

Parameters:

xml - the string representation of the XML DDMS Resource

Returns:

a DDMS Resource

Throws:

InvalidDDMSException - if the component could not be built

IOException

getDDMSResource

public Resource getDDMSResource(InputStream inputStream)
                         throws IOException,
                                InvalidDDMSException

Creates a DDMS resource based on the contents of an input stream, and also sets the DDMSVersion based on the namespace URIs in the document.

Parameters:

inputStream - the input stream wrapped around an XML DDMS Resource

Returns:

a DDMS Resource

Throws:

InvalidDDMSException - if the component could not be built

IOException

getDDMSResource

public Resource getDDMSResource(Reader reader)
                         throws IOException,
                                InvalidDDMSException

Creates a DDMS resource based on the contents of a reader, and also sets the DDMSVersion based on the namespace URIs in the document.

Parameters:

reader - the reader wrapped around an XML DDMS Resource

Returns:

a DDMS Resource

Throws:

InvalidDDMSException - if the component could not be built

IOException

buildResource

protected Resource buildResource(nu.xom.Element xomElement)
                          throws InvalidDDMSException

Shared helper method to build a DDMS Resource from a XOM Element

Parameters:

xomElement -

Returns:

a DDMS Resource

Throws:

InvalidDDMSException - if the component could not be built

getExternalSchemaLocations

public String getExternalSchemaLocations()

Returns the external schema locations. The returned string will contain a space-delimited set of XMLNamespace/SchemaLocation pairs.

Returns:

the string containing all schema locations

addExternalSchemaLocation

public void addExternalSchemaLocation(String xmlNamespace,
                                      String schemaLocation)

Add additional schema locations to those already known by this DDMSReader. This can be used to reference external schemas for validation of the Extensible Layer in DDMS 2.0 - 4.1.

Parameters:

xmlNamespace - the unique XML namespace for the schema content

schemaLocation - the accessible location of the XML Schema file to be used for validation

Throws:

IllegalArgumentException - if the DDMSReader already knows about the specified xmlNamespace