org.opengis.cite.validation

Class SchematronValidator

java.lang.Object

org.opengis.cite.validation.SchematronValidator

public class SchematronValidator
extends Object

Verifies that the content of an XML resource satisfies the constraints defined in an ISO Schematron (ISO 19757-3) schema. The schema may incorporate abstract patterns and inclusions (sch:include and xi:include elements).

See Also:

ISO 19757-3:2006

Field Summary

Fields

Modifier and Type	Field and Description
static String	ISO_SCHEMATRON_SVRL_NS

Constructor Summary

Constructors

Constructor and Description
SchematronValidator(Source schema) Constructs a validator for the given Schematron schema with the default phase enabled.
SchematronValidator(Source schema, String phase) Constructs a validator for the given Schematron schema and phase (pattern set).

Method Summary

Modifier and Type	Method and Description
(package private) net.sf.saxon.s9api.XsltExecutable	compileSchema(Source schema, String phase) Creates an immutable representation of a compiled stylesheet that will generate an SVRL representation of the validation results when run against an instance document.
(package private) StreamResult	generateTextResult(Source svrlSource) Transforms a standard SVRL report to a plain text representation that only includes rule violations (positive or negative assertion failures).
int	getRuleViolationCount() Get the number of violations (failed assertions and successful reports) for the validation episode.
(package private) Document	importElement(Element elem) Creates a DOM Document with the given Element as the document element.
boolean	ruleViolationsDetected() Indicates the occurrence of any rule violations.
void	setParameters(Map<String,String> params) Sets parameters required to evaluate Schematron rules.
Result	validate(Source xmlSource) Validates the specified XML source document.
Result	validate(Source xmlSource, boolean svrlReport) Validates the specified XML source document.
ValidationErrorHandler	validateSchema(Source schema) Validates a Schematron schema against the official RELAX NG grammar (ISO 19757-3, Annex A).

Methods inherited from class java.lang.Object

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

Field Detail

ISO_SCHEMATRON_SVRL_NS

public static final String ISO_SCHEMATRON_SVRL_NS

See Also:

Constant Field Values

Constructor Detail

SchematronValidator

public SchematronValidator(Source schema)
                    throws Exception

Constructs a validator for the given Schematron schema with the default phase enabled. If no default phase is specified, then all patterns are active. The results will be represented as a standard SVRL (Schematron Validation Report Language) document.

Parameters:

schema - The Source that represents the schema.

Throws:

Exception - If any error occurs while attempting to read or preprocess the schema.

SchematronValidator

public SchematronValidator(Source schema,
                           String phase)
                    throws Exception

Constructs a validator for the given Schematron schema and phase (pattern set).

Parameters:

schema - The Source that represents the schema.

phase - The active phase; if null, the default phase is enabled (all patterns are active if no default is specified).

Throws:

Exception - If any error occurs while attempting to read or preprocess the schema.

Method Detail

validateSchema

public ValidationErrorHandler validateSchema(Source schema)
                                      throws IOException

Validates a Schematron schema against the official RELAX NG grammar (ISO 19757-3, Annex A).

Parameters:

schema - A Source to obtain the schema from.

Returns:

The ErrorHandler that received reported errors, if any.

Throws:

IOException - If an error occurs while reading the schema.

getRuleViolationCount

public int getRuleViolationCount()

Get the number of violations (failed assertions and successful reports) for the validation episode.

Returns:

An int value equal to or greater than zero.

ruleViolationsDetected

public boolean ruleViolationsDetected()

Indicates the occurrence of any rule violations.

Returns:

true if any rule violations have been detected; false otherwise.

setParameters

public void setParameters(Map<String,String> params)

Sets parameters required to evaluate Schematron rules.

Parameters:

params - A Map<String,String> object containing parameter names and values.

validate

public Result validate(Source xmlSource)

Validates the specified XML source document.

Parameters:

xmlSource - The XML resource to validate. A DOMSource must wrap a Document or an Element node.

Returns:

A Result containing the validation results as a standard SVRL report.

validate

public Result validate(Source xmlSource,
                       boolean svrlReport)

Validates the specified XML source document. The result is represented either as an SVRL (Schematron Validation Report Language) report or as plain text.

Parameters:

xmlSource - The XML resource to validate. A DOMSource must wrap a Document or an Element node.

svrlReport - Produce an SVRL (XML) report; if false, the results are in plain text.

Returns:

A Result (DOMResult or StreamResult) containing the validation results.

generateTextResult

StreamResult generateTextResult(Source svrlSource)

Transforms a standard SVRL report to a plain text representation that only includes rule violations (positive or negative assertion failures).

Parameters:

svrlSource - The source for reading the SVRL report.

Returns:

A StreamResult holding the plain text output (as a byte stream), or null if the transformation failed.

compileSchema

final net.sf.saxon.s9api.XsltExecutable compileSchema(Source schema,
                                                      String phase)
                                               throws Exception

Creates an immutable representation of a compiled stylesheet that will generate an SVRL representation of the validation results when run against an instance document.

Parameters:

schema - A Source to read a Schematron schema.

phase - The name of the active phase; if not specified, the default phase will be used (all patterns are active if no default is specified).

Returns:

A compiled stylesheet ready for execution.

Throws:

Exception - If the schema cannot be compiled for any reason.

importElement

Document importElement(Element elem)

Creates a DOM Document with the given Element as the document element. A deep copy of the element is imported--the source element is not altered.

Parameters:

elem - An Element node.

Returns:

A Document node.