net.sf.practicalxml

Class SchemaUtil

java.lang.Object

net.sf.practicalxml.SchemaUtil

public class SchemaUtil
extends Object

A collection of static utility methods for working with XML Schema documents. Since javax.xml.validation.Schema is an opaque object, most of these actually work with DOM documents that contain an XSD.

Constructor Summary

Constructors

Constructor and Description
SchemaUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static Document[]	combineSchemas(InputSource... sources) Parses and combines one or more input sources to produce an array of DOM documents containing schema components.
static SchemaFactory	newFactory(ErrorHandler errHandler) Creates a new javax.xml.validation.SchemaFactory instance for validation with XML Schema, which reports errors via the specified error handler.
static Schema	newSchema(InputSource... sources) Parses one or more input sources to produce a Schema object.
static Schema	newSchema(SchemaFactory factory, Document... sources) Compiles one or more DOM documents to produce a Schema object from the passed factory.
static Schema	newSchema(SchemaFactory factory, InputSource... sources) Parses one or more input sources to produce a Schema object from the passed factory.
static Document[]	parseSources(InputSource[] sources) Parses an array of org.xml.sax.InputSource objects, and performs some (minimal) level of validation on them.

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaUtil

public SchemaUtil()

Method Detail

newFactory

public static SchemaFactory newFactory(ErrorHandler errHandler)

Creates a new javax.xml.validation.SchemaFactory instance for validation with XML Schema, which reports errors via the specified error handler.

newSchema

public static Schema newSchema(InputSource... sources)

Parses one or more input sources to produce a Schema object. Validators produced from this schema will throw an XmlException on any error.

The caller is responsible for ordering the sources so that imported schemas appear first. This method is unable to combine sources from the same target namespace; see combineSchemas() for explanation.

Parameters:

sources - The source schema documents. Note that these are org.xml.sax.InputSource objects for consistency with other classes in this library; not the javax.xml.transform.Source objects used by SchemaFactory.

Throws:

IllegalArgumentException - if invoked without any sources.

XmlException - if unable to create the schema object.

newSchema

public static Schema newSchema(SchemaFactory factory,
               InputSource... sources)

Parses one or more input sources to produce a Schema object from the passed factory. This call is synchronized on the factory, which the JDK 1.5 docs describe as not threadsafe.

The caller is responsible for ordering the sources so that imported schemas appear first. This method is unable to combine sources from the same target namespace; see combineSchemas() for explanation.

Parameters:

factory - Used to create the schema object.

sources - The source schema documents. Note that these are org.xml.sax.InputSource objects for consistency with other classes in this library; not the javax.xml.transform.Source objects used by SchemaFactory.

Throws:

IllegalArgumentException - if invoked without any sources.

XmlException - if unable to parse a source or compile the schema.

newSchema

public static Schema newSchema(SchemaFactory factory,
               Document... sources)

Compiles one or more DOM documents to produce a Schema object from the passed factory. This call is synchronized on the factory, which the JDK 1.5 docs describe as not threadsafe.

The caller is responsible for ordering the documents so that imported schemas appear first. This method is unable to combine sources from the same target namespace; see combineSchemas() for explanation.

Parameters:

factory - Used to create the schema object.

sources - The source schema documents.

Throws:

IllegalArgumentException - if invoked without any sources.

XmlException - if unable to compile the schema.

combineSchemas

public static Document[] combineSchemas(InputSource... sources)

Parses and combines one or more input sources to produce an array of DOM documents containing schema components. Will properly order the output documents based on dependencies, remove any location references from imports that are satisfied by the sources, and provides a workaround for the JDK 1.5 bug that prevents combination of source documents with the same namespace.

When combining schema documents with the same namespace, all top-level attributes (eg, elementFormDefault) come from the first source specified for the namespace. The <xsd:schema> element, and its attributes, are ignored for subsequent sources for that namespace.

Sources must contain <xsd:import> elements for any referenced schemas. If the sources contain a schema for the specified target namespace, any schemaLocation specification will be ignored.

Parameters:

sources - The source schema documents. Note that these are org.xml.sax.InputSource objects for consistency with other classes in this library; not the javax.xml.transform.Source objects used by SchemaFactory.

Throws:

IllegalArgumentException - if invoked without any sources, or if a source does not appear to be an XML Schema document (current checking is minimal, but that may change).

XmlException - on any parse error, or if the sources do not appear to be valid XSD documents.

parseSources

public static Document[] parseSources(InputSource[] sources)

Parses an array of org.xml.sax.InputSource objects, and performs some (minimal) level of validation on them. This method is called by newSchema() and combineSchema(), and will identify the source that wasn't valid.

Throws:

IllegalArgumentException - if no sources specified (this is a common check for callers).