org.opengis.cite.validation

Class RelaxNGValidator

java.lang.Object

org.opengis.cite.validation.RelaxNGValidator

public final class RelaxNGValidator
extends Object

Validates an XML resource with respect to a RELAX NG (ISO 19757-2) schema. The schema may be represented using either the XML or the compact syntax.

See Also:

ISO 19757-2:2008

Constructor Summary

Constructors

Constructor and Description
RelaxNGValidator(URL rngSchemaURL) Constructs a validator using the supplied schema reference and a default resource resolver (which will suffice for commonly used URL protocols such as the file and http schemes).
RelaxNGValidator(URL rngSchemaURL, LSResourceResolver resolver) Constructs a validator using the supplied schema reference and resource resolver.

Method Summary

Modifier and Type	Method and Description
(package private) Schema	createRelaxNGSchema(URL schemaURL, LSResourceResolver resolver) Creates a Schema object from the supplied URL reference.
ValidationErrorHandler	getErrorHandler() Returns the error handler.
(package private) boolean	isXMLStream(BufferedInputStream bufStream) A utility method that attempts to determine if the given stream contains XML content.
(package private) static StreamSource	toStreamSource(DOMSource domSource) Converts a DOMSource object to a StreamSource.
void	validate(Source source) Validates the given XML resource against the schema known to this validator.

Methods inherited from class java.lang.Object

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

Constructor Detail

RelaxNGValidator

public RelaxNGValidator(URL rngSchemaURL)
                 throws SAXException,
                        IOException

Constructs a validator using the supplied schema reference and a default resource resolver (which will suffice for commonly used URL protocols such as the file and http schemes).

Parameters:

rngSchemaURL - An absolute URL that refers to a RELAX NG grammar.

Throws:

IOException - If the schema cannot be accessed.

SAXException - If parsing of the schema fails for any reason.

RelaxNGValidator

public RelaxNGValidator(URL rngSchemaURL,
                        LSResourceResolver resolver)
                 throws SAXException,
                        IOException

Constructs a validator using the supplied schema reference and resource resolver. The resolver customizes resource resolution when parsing schemas; resolving schema references in an entity catalog is a common use case.

Parameters:

rngSchemaURL - A URL that refers to a RELAX NG grammar.

resolver - The resolver used to locate external resources (included grammars) while parsing schemas.

Throws:

SAXException - If the schema cannot be accessed (e.g. URL resolution fails).

IOException - If parsing of the schema fails for any reason (e.g. it's not a valid Relax NG grammar).

Method Detail

getErrorHandler

public ValidationErrorHandler getErrorHandler()

Returns the error handler.

Returns:

A ValidationErrorHandler that contains details about the most recent validation episode.

validate

public void validate(Source source)
              throws SAXException,
                     IOException

Validates the given XML resource against the schema known to this validator. Constraint violations are accumulated by the error handler.

Parameters:

source - The Source to be read. It must not be null.

Throws:

SAXException - if a fatal error occurs while parsing the source.

IOException - if an error occurs while reading the source.

createRelaxNGSchema

Schema createRelaxNGSchema(URL schemaURL,
                           LSResourceResolver resolver)
                    throws SAXException,
                           IOException

Creates a Schema object from the supplied URL reference. A resource resolver may be supplied if entity resolution must be customized (e.g. using an OASIS entity catalog).

Parameters:

schemaURL - A URL that specifies the location of a Relax NG grammar (XML or compact syntax).

resolver - The resolver used to locate external resources while parsing schemas.

Returns:

A Schema object, or null if one could not be constructed.

Throws:

IOException - If the grammar cannot be accessed.

SAXException - If the grammar cannot be parsed.

isXMLStream

boolean isXMLStream(BufferedInputStream bufStream)

A utility method that attempts to determine if the given stream contains XML content. The stream is always reset to the beginning so it can be reused.

Parameters:

bufStream - The BufferedInputStream to read.

Returns:

true if the stream contains XML data; false otherwise.

toStreamSource

static StreamSource toStreamSource(DOMSource domSource)

Converts a DOMSource object to a StreamSource. The underlying Jing Validator implementation doesn't support DOMSource inputs.

Parameters:

domSource - A DOMSource instance.

Returns:

A StreamSource object for reading the content of the original DOM node.