Package com.helger.schematron.api.xslt

Class AbstractSchematronXSLTBasedResource<IMPLTYPE extends AbstractSchematronXSLTBasedResource<IMPLTYPE>>

java.lang.Object

com.helger.schematron.AbstractSchematronResource

com.helger.schematron.api.xslt.AbstractSchematronXSLTBasedResource<IMPLTYPE>

Type Parameters:

IMPLTYPE - Implementation type

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, ISchematronXSLTBasedResource, ISchematronResource

@NotThreadSafe
public abstract class AbstractSchematronXSLTBasedResource<IMPLTYPE extends AbstractSchematronXSLTBasedResource<IMPLTYPE>>
extends AbstractSchematronResource
implements ISchematronXSLTBasedResource, com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>

Abstract implementation of a Schematron resource that is based on XSLT transformations.

Author:

Philip Helger

Nested Class Summary

Nested classes/interfaces inherited from class com.helger.schematron.AbstractSchematronResource

AbstractSchematronResource.NodeAndBaseURI

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_VALIDATE_SVRL
protected ErrorListener	m_aCustomErrorListener
protected final com.helger.commons.collection.impl.ICommonsOrderedMap<String,Object>	m_aCustomParameters
protected URIResolver	m_aCustomURIResolver

Fields inherited from class com.helger.schematron.AbstractSchematronResource

DEFAULT_USE_CACHE

Constructor Summary

Constructors

Constructor	Description
AbstractSchematronXSLTBasedResource(com.helger.commons.io.resource.IReadableResource aSCHResource)

Method Summary

Modifier and Type	Method	Description
final Document	applySchematronValidation(Node aXMLNode, String sBaseURI)	Apply the Schematron validation on the passed DOM node and return an SVRL XML DOM Document.
SchematronOutputType	applySchematronValidationToSVRL(Node aXMLSource, String sBaseURI)	Apply the Schematron validation on the passed DOM Node and return a SchematronOutputType object.
final ErrorListener	getErrorListener()
final ISchematronOutputValidityDeterminator	getOutputValidityDeterminator()	Note: The method was renamed in v8 from getXSLTValidator.
final com.helger.commons.state.EValidity	getSchematronValidity(Node aXMLNode, String sBaseURI)	A method to check if the passed DOM node matches the Schematron rules or not.
final URIResolver	getURIResolver()
abstract ISchematronXSLTBasedProvider	getXSLTProvider()
final boolean	isValidateSVRL()
final boolean	isValidSchematron()
final com.helger.commons.collection.impl.ICommonsOrderedMap<String,Object>	parameters()
final IMPLTYPE	setEntityResolver(EntityResolver aEntityResolver)	Set the XML entity resolver to be used when reading the XML to be validated.
final IMPLTYPE	setErrorListener(ErrorListener aCustomErrorListener)
final IMPLTYPE	setOutputValidityDeterminator(ISchematronOutputValidityDeterminator aSOVDeterminator)	Set the Schematron output validator to be used. Note: The method was renamed in v8 from setXSLTValidator.
final IMPLTYPE	setURIResolver(URIResolver aCustomURIResolver)	Set the URIResolver to be used for reading Schematron.
final IMPLTYPE	setValidateSVRL(boolean bValidateSVRL)	Enable or disable the validation of the created SVRL.
String	toString()

Methods inherited from class com.helger.schematron.AbstractSchematronResource

applySchematronValidation, applySchematronValidation, applySchematronValidationToSVRL, applySchematronValidationToSVRL, getAsNode, getAsNode, getEntityResolver, getID, getResource, getSchematronValidity, getSchematronValidity, internalCreateDOMReaderSettings, internalSetEntityResolver, isLenient, isUseCache, setLenient, setUseCache

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Methods inherited from interface com.helger.commons.id.IHasID

getID

Methods inherited from interface com.helger.schematron.ISchematronResource

applySchematronValidation, applySchematronValidation, applySchematronValidationToSVRL, applySchematronValidationToSVRL, getEntityResolver, getResource, getSchematronValidity, getSchematronValidity, isLenient, isUseCache, setLenient, setUseCache

Methods inherited from interface com.helger.schematron.api.xslt.ISchematronXSLTBasedResource

setAllowForeignElements

Field Details

DEFAULT_VALIDATE_SVRL

public static final boolean DEFAULT_VALIDATE_SVRL

See Also:

• Constant Field Values

m_aCustomErrorListener

protected ErrorListener m_aCustomErrorListener

m_aCustomURIResolver

protected URIResolver m_aCustomURIResolver

m_aCustomParameters

protected final com.helger.commons.collection.impl.ICommonsOrderedMap<String,Object> m_aCustomParameters

Constructor Details

AbstractSchematronXSLTBasedResource

public AbstractSchematronXSLTBasedResource(@Nonnull
 com.helger.commons.io.resource.IReadableResource aSCHResource)

Method Details

getErrorListener

@Nullable
public final ErrorListener getErrorListener()

Specified by:

getErrorListener in interface ISchematronXSLTBasedResource

Returns:

The error listener to be used. May be null.

setErrorListener

@Nonnull
public final IMPLTYPE setErrorListener(@Nullable
 ErrorListener aCustomErrorListener)

Specified by:

setErrorListener in interface ISchematronXSLTBasedResource

Parameters:

aCustomErrorListener - Error listener to use.

Returns:

this for chaining

getURIResolver

@Nullable
public final URIResolver getURIResolver()

Specified by:

getURIResolver in interface ISchematronXSLTBasedResource

Returns:

The URIResolver to be used for reading the Schematron. May be null.

setURIResolver

@Nonnull
public final IMPLTYPE setURIResolver(@Nullable
 URIResolver aCustomURIResolver)

Description copied from interface: ISchematronXSLTBasedResource

Set the URIResolver to be used for reading Schematron.

Specified by:

setURIResolver in interface ISchematronXSLTBasedResource

Parameters:

aCustomURIResolver - The URIResolver to use. May be null,

Returns:

this for chaining

parameters

@Nonnull
@ReturnsMutableObject
public final com.helger.commons.collection.impl.ICommonsOrderedMap<String,Object> parameters()

Specified by:

parameters in interface ISchematronXSLTBasedResource

Returns:

A mutable (=writable) copy of the parameters map. Never null.

setEntityResolver

@Nonnull
public final IMPLTYPE setEntityResolver(@Nullable
 EntityResolver aEntityResolver)

Set the XML entity resolver to be used when reading the XML to be validated.

Specified by:

setEntityResolver in interface ISchematronXSLTBasedResource

Parameters:

aEntityResolver - The entity resolver to set. May be null.

Returns:

this

Since:

4.2.3

See Also:

• ISchematronResource.getEntityResolver()

getXSLTProvider

@Nullable
public abstract ISchematronXSLTBasedProvider getXSLTProvider()

Returns:

The XSLT provider passed in the constructor. May be null.

getOutputValidityDeterminator

@Nonnull
public final ISchematronOutputValidityDeterminator getOutputValidityDeterminator()

Description copied from interface: ISchematronXSLTBasedResource

Note: The method was renamed in v8 from getXSLTValidator.

Specified by:

getOutputValidityDeterminator in interface ISchematronXSLTBasedResource

Returns:

The Schematron output validator to be used. Never null.

setOutputValidityDeterminator

@Nonnull
public final IMPLTYPE setOutputValidityDeterminator(@Nonnull
 ISchematronOutputValidityDeterminator aSOVDeterminator)

Description copied from interface: ISchematronXSLTBasedResource

Set the Schematron output validator to be used.
Note: The method was renamed in v8 from setXSLTValidator.

Specified by:

setOutputValidityDeterminator in interface ISchematronXSLTBasedResource

Parameters:

aSOVDeterminator - Validity determinator instance to use. May not be null.

Returns:

this for chaining

isValidateSVRL

public final boolean isValidateSVRL()

Specified by:

isValidateSVRL in interface ISchematronXSLTBasedResource

Returns:

true if the created SVRL should be validated or not. Defaults to true.

setValidateSVRL

@Nonnull
public final IMPLTYPE setValidateSVRL(boolean bValidateSVRL)

Description copied from interface: ISchematronXSLTBasedResource

Enable or disable the validation of the created SVRL.

Specified by:

setValidateSVRL in interface ISchematronXSLTBasedResource

Parameters:

bValidateSVRL - true to enable XSD validation, false to disable it.

Returns:

this for chaining

isValidSchematron

public final boolean isValidSchematron()

Specified by:

isValidSchematron in interface ISchematronResource

Returns:

true if this Schematron can be used to validate XML instances. If not, the Schematron is invalid and the log files must be investigated.

getSchematronValidity

@Nonnull
public final com.helger.commons.state.EValidity getSchematronValidity(@Nonnull
 Node aXMLNode,
 @Nullable
 String sBaseURI)
                                                               throws Exception

Description copied from interface: ISchematronResource

A method to check if the passed DOM node matches the Schematron rules or not. This is the quick check method, as it breaks upon the first failed assertion or the first successful report, if the implementation supports it (as e.g. the native pure Schematron version).

Specified by:

getSchematronValidity in interface ISchematronResource

Parameters:

aXMLNode - The source DOM node to validate against the Schematron. May not be null.

sBaseURI - The Base URI of the XML document to be validated. May be null.

Returns:

EValidity.VALID if the document is valid, EValidity.INVALID if it is invalid.

Throws:

Exception - in case of a sever error validating the schema

applySchematronValidation

@Nullable
public final Document applySchematronValidation(@Nonnull
 Node aXMLNode,
 @Nullable
 String sBaseURI)
                                         throws TransformerException

Description copied from interface: ISchematronResource

Apply the Schematron validation on the passed DOM node and return an SVRL XML DOM Document.

Specified by:

applySchematronValidation in interface ISchematronResource

Parameters:

aXMLNode - The DOM node to be validated via Schematron. May not be null.

sBaseURI - The Base URI of the XML document to be validated. May be null.

Returns:

null if the passed resource does not exist or the non- null SVRL document otherwise.

Throws:

TransformerException

See Also:

• on how to convert the document into a domain object

applySchematronValidationToSVRL

@Nullable
public SchematronOutputType applySchematronValidationToSVRL(@Nonnull
 Node aXMLSource,
 @Nullable
 String sBaseURI)
                                                     throws Exception

Description copied from interface: ISchematronResource

Apply the Schematron validation on the passed DOM Node and return a SchematronOutputType object.

Specified by:

applySchematronValidationToSVRL in interface ISchematronResource

Parameters:

aXMLSource - The DOM node to be validated via Schematron. May not be null.

sBaseURI - The Base URI of the XML document to be validated. May be null.

Returns:

The SVRL object containing the result. May be null when interpreting the Schematron failed.

Throws:

Exception - In case the transformation somehow goes wrong.

toString

public String toString()

Overrides:

toString in class AbstractSchematronResource