org.pageseeder.schematron

Class Validator

java.lang.Object

org.pageseeder.schematron.Validator

public final class Validator
extends java.lang.Object

An object representing a single Schematron schema, used to validate multiple XML instances.

Use the ValidatorFactory to create validators. Validators are thread-safe.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Validator.Instance A validating instance lets you reuse a validator that uses the same output options and resolver.

Method Summary

Modifier and Type	Method and Description
Validator.Instance	newInstance()
OutputOptions	options()
Validator	options(OutputOptions options) Return a new validator with the specified output options.
Validator	resolver(javax.xml.transform.URIResolver resolver) Return a new validator with the specified URI resolver.
SchematronResult	validate(java.io.File xml) Performs validation of the passed XML data.
SchematronResult	validate(java.io.File xml, java.util.Map<java.lang.String,java.lang.Object> parameters) Validates the XML data.
SchematronResult	validate(javax.xml.transform.Source xml) Performs validation of the passed XML data.
SchematronResult	validate(javax.xml.transform.Source xml, java.util.Map<java.lang.String,java.lang.Object> parameters) Validates the XML data.

Methods inherited from class java.lang.Object

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

Method Detail

options

public Validator options(OutputOptions options)

Return a new validator with the specified output options.

Parameters:

options - The output options to use for this validator.

Returns:

A new validator

options

public OutputOptions options()

resolver

public Validator resolver(javax.xml.transform.URIResolver resolver)

Return a new validator with the specified URI resolver.

Parameters:

resolver - The default resolved to use for this validator.

Returns:

A new validator

validate

public SchematronResult validate(java.io.File xml)
                          throws SchematronException

Performs validation of the passed XML data.

Returns:

the results of the validation.

Throws:

SchematronException - Should an error occur during validation.

validate

public SchematronResult validate(javax.xml.transform.Source xml)
                          throws SchematronException

Performs validation of the passed XML data.

Returns:

the results of the validation.

Throws:

SchematronException - Should an error occur during validation.

validate

public SchematronResult validate(java.io.File xml,
                                 java.util.Map<java.lang.String,java.lang.Object> parameters)
                          throws SchematronException

Validates the XML data.

Parameters:

xml - XML file to validate

parameters - The parameters to send to the schema during validation

Returns:

the results of the validation.

Throws:

SchematronException - Should an error occur during validation.

validate

public SchematronResult validate(javax.xml.transform.Source xml,
                                 java.util.Map<java.lang.String,java.lang.Object> parameters)
                          throws SchematronException

Validates the XML data.

Parameters:

xml - XML source to validate

parameters - The parameters to send to the schema during validation

Returns:

the results of the validation.

Throws:

SchematronException - Should an error occur during validation.

newInstance

public Validator.Instance newInstance()
                               throws SchematronException

Throws:

SchematronException