com.helger.schematron.xslt

Class AbstractSchematronXSLTBasedResource<IMPLTYPE extends AbstractSchematronXSLTBasedResource<IMPLTYPE>>

java.lang.Object

com.helger.schematron.AbstractSchematronResource

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

Type Parameters:

IMPLTYPE - Implementation type

All Implemented Interfaces:

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

Direct Known Subclasses:

SchematronResourceSCH, SchematronResourceXSLT

@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 and Description
protected ErrorListener	m_aCustomErrorListener
protected com.helger.commons.collection.impl.ICommonsOrderedMap<String,Object>	m_aCustomParameters
protected URIResolver	m_aCustomURIResolver

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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.
ErrorListener	getErrorListener()
com.helger.commons.collection.impl.ICommonsOrderedMap<String,Object>	getParameters() Deprecated.
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.
URIResolver	getURIResolver()
abstract ISchematronXSLTBasedProvider	getXSLTProvider()
ISchematronXSLTValidator	getXSLTValidator()
boolean	hasParameters() Deprecated.
boolean	isValidSchematron()
com.helger.commons.collection.impl.ICommonsOrderedMap<String,Object>	parameters()
IMPLTYPE	setEntityResolver(EntityResolver aEntityResolver) Set the XML entity resolver to be used when reading the XML to be validated.
IMPLTYPE	setErrorListener(ErrorListener aCustomErrorListener)
IMPLTYPE	setParameters(Map<String,?> aCustomParameters) Deprecated.
IMPLTYPE	setURIResolver(URIResolver aCustomURIResolver) Set the URIResolver to be used for reading Schematron.
IMPLTYPE	setXSLTValidator(ISchematronXSLTValidator aXSLTValidator) Set the XSLT validator to be used.
String	toString()

Methods inherited from class com.helger.schematron.AbstractSchematronResource

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

Methods inherited from class java.lang.Object

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

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

setAllowForeignElements

Methods inherited from interface com.helger.schematron.ISchematronResource

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

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

getComparatorID, getID

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

thisAsT

Field Detail

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 Detail

AbstractSchematronXSLTBasedResource

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

Method Detail

getErrorListener

@Nullable
public 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 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.

hasParameters

@Deprecated
public boolean hasParameters()

Deprecated.

getParameters

@Nonnull
 @ReturnsMutableCopy
 @Deprecated
public com.helger.commons.collection.impl.ICommonsOrderedMap<String,Object> getParameters()

Deprecated.

setParameters

@Nonnull
 @Deprecated
public IMPLTYPE setParameters(@Nullable
                                                      Map<String,?> aCustomParameters)

Deprecated.

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

getXSLTProvider

@Nullable
public abstract ISchematronXSLTBasedProvider getXSLTProvider()

Returns:

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

getXSLTValidator

@Nonnull
public ISchematronXSLTValidator getXSLTValidator()

Specified by:

getXSLTValidator in interface ISchematronXSLTBasedResource

Returns:

The XSLT validator to be used. Never null.

setXSLTValidator

@Nonnull
public final IMPLTYPE setXSLTValidator(@Nonnull
                                                 ISchematronXSLTValidator aXSLTValidator)

Description copied from interface: ISchematronXSLTBasedResource

Set the XSLT validator to be used.

Specified by:

setXSLTValidator in interface ISchematronXSLTBasedResource

Parameters:

aXSLTValidator - Validator instance to use. May not be null.

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 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