org.pageseeder.schematron

Class ValidatorFactory

java.lang.Object

org.pageseeder.schematron.ValidatorFactory

public final class ValidatorFactory
extends java.lang.Object

A ValidatorFactory instance can be used to create a Validator object.

This class uses a fluent style API.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
ValidatorFactory() Constructs a new factory.
ValidatorFactory(CompileOptions options) Constructs a new factory with the specified compile options.

Method Summary

Modifier and Type	Method and Description
ValidatorFactory	debug(DebugOutput debug) Enable debug mode to save a copy of the generated stylesheet when it is generated.
ValidatorFactory	disableDebug() Disable debug mode.
ValidatorFactory	enableDebug() Enable debug mode to save a copy of the generated stylesheet to a file for debugging.
ValidatorFactory	errorListener(javax.xml.transform.ErrorListener listener) Set the error event listener for the ValidatorFactory, which is used for the processing of the Schematron schema, not for the Schematron validation itself.
javax.xml.transform.ErrorListener	getErrorListener() Get the error event handler for this factory.
CompileOptions	getOptions() Deprecated.
Validator	newValidator(java.io.File schema) Process the specified schema into a Validator object.
Validator	newValidator(java.io.File schema, java.lang.String phase) Process the specified schema into a Validator object.
Validator	newValidator(javax.xml.transform.Source schema) Process the specified schema into a Validator object.
Validator	newValidator(javax.xml.transform.Source schema, java.lang.String phase) Process the specified schema into a Validator object.
CompileOptions	options()
ValidatorFactory	options(CompileOptions options)
ValidatorFactory	resolver(java.lang.Class<javax.xml.transform.URIResolver> resolver) Set the class name of the resolver to use, overriding built-in Apache resolver

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidatorFactory

public ValidatorFactory()

Constructs a new factory.

ValidatorFactory

public ValidatorFactory(CompileOptions options)

Constructs a new factory with the specified compile options.

Method Detail

options

public ValidatorFactory options(CompileOptions options)

getOptions

@Deprecated
public CompileOptions getOptions()

Deprecated.

options

public CompileOptions options()

errorListener

public ValidatorFactory errorListener(javax.xml.transform.ErrorListener listener)

Set the error event listener for the ValidatorFactory, which is used for the processing of the Schematron schema, not for the Schematron validation itself.

Parameters:

listener - The error listener.

getErrorListener

public javax.xml.transform.ErrorListener getErrorListener()

Get the error event handler for this factory.

Returns:

The current error handler, which should never be null.

enableDebug

public ValidatorFactory enableDebug()

Enable debug mode to save a copy of the generated stylesheet to a file for debugging.

This method assigned a default DebugOutput implementation. To specify your own use the debug(DebugOutput) method.

Returns:

A new factory if debug is not already enabled.

disableDebug

public ValidatorFactory disableDebug()

Disable debug mode.

Returns:

A new factory if debug is not already disabled.

debug

public ValidatorFactory debug(DebugOutput debug)

Enable debug mode to save a copy of the generated stylesheet when it is generated.

Returns:

A new factory if debug is not already enabled.

resolver

public ValidatorFactory resolver(java.lang.Class<javax.xml.transform.URIResolver> resolver)

Set the class name of the resolver to use, overriding built-in Apache resolver

newValidator

public Validator newValidator(java.io.File schema)
                       throws SchematronException

Process the specified schema into a Validator object.

Parameters:

schema - The Schematron schema to use.

Returns:

A Validator instance for the specified schema.

Throws:

SchematronException

newValidator

public Validator newValidator(java.io.File schema,
                              java.lang.String phase)
                       throws SchematronException

Process the specified schema into a Validator object.

Parameters:

schema - The Schematron schema to use.

Returns:

A Validator instance for the specified schema.

Throws:

SchematronException

newValidator

public Validator newValidator(javax.xml.transform.Source schema)
                       throws SchematronException

Process the specified schema into a Validator object.

Parameters:

schema - The Schematron schema to use.

Returns:

A Validator instance for the specified schema.

Throws:

SchematronException - Will wrap any exception occurring while attempting to instantiate a validator.

newValidator

public Validator newValidator(javax.xml.transform.Source schema,
                              java.lang.String phase)
                       throws SchematronException

Process the specified schema into a Validator object.

Parameters:

schema - The Schematron schema to use.

phase - The phase for this schema.

Returns:

A Validator instance for the specified schema.

Throws:

SchematronException - Will wrap any exception occurring while attempting to instantiate a validator.