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 results are presented in an SVRL report. 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, String phase) Construct a validator for the given Schematron schema and phase (pattern set).

Method Summary

Methods

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.
int	getRuleViolationCount() Get the number of violations (failed assertions and successful reports) for the validation episode.
boolean	ruleViolationsDetected() Indicates the occurrence of any rule violations.
void	setParameters(Map<String,String> params) Sets parameters required to evaluate Schematron rules.
DOMResult	validate(Source xmlSource) Validates the specified source XML document and returns the results in an SVRL report.
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,
                   String phase)
                    throws Exception

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

Parameters:

schema - The ISO Schematron schema to use for validation.

phase - The active phase (rule subset). If null the default phase is used.

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 DOMResult validate(Source xmlSource)

Validates the specified source XML document and returns the results in an SVRL report.

Parameters:

xmlSource - The XML resource to validate.

Returns:

A DOMResult object containing the validation results.

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 phase (patterns sets) to check.

Returns:

A compiled stylesheet ready for execution.

Throws:

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