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

Direct Known Subclasses:

SchematronResourceSCH, SchematronResourceXSLT

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

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

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
protected ErrorListener	m_aCustomErrorListener
protected com.helger.commons.collection.ext.ICommonsOrderedMap<String,?>	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(com.helger.commons.io.IHasInputStream aXMLResource) Apply the Schematron validation on the passed XML resource and return an SVRL XML DOM Document.
Document	applySchematronValidation(Node aXMLResource)
Document	applySchematronValidation(Source aXMLSource) Apply the Schematron validation on the passed XML source and return an SVRL XML DOM Document.
SchematronOutputType	applySchematronValidationToSVRL(com.helger.commons.io.IHasInputStream aXMLResource) Apply the Schematron validation on the passed XML resource and return a SchematronOutputType object.
SchematronOutputType	applySchematronValidationToSVRL(Node aXMLSource)
SchematronOutputType	applySchematronValidationToSVRL(Source aXMLSource) Apply the Schematron validation on the passed XML source and return a SchematronOutputType object.
ErrorListener	getErrorListener()
com.helger.commons.collection.ext.ICommonsOrderedMap<String,?>	getParameters()
com.helger.commons.state.EValidity	getSchematronValidity(com.helger.commons.io.IHasInputStream aXMLResource) A method to check if the passed XML DOM node matches the Schematron rules or not.
com.helger.commons.state.EValidity	getSchematronValidity(Source aXMLSource) A method to check if the passed XML DOM node matches the Schematron rules or not.
URIResolver	getURIResolver()
abstract ISchematronXSLTBasedProvider	getXSLTProvider()
ISchematronXSLTValidator	getXSLTValidator()
boolean	hasParameters()
boolean	isValidSchematron()
IMPLTYPE	setErrorListener(ErrorListener aCustomErrorListener)
IMPLTYPE	setParameters(Map<String,?> aCustomParameters)
IMPLTYPE	setURIResolver(URIResolver aCustomURIResolver)
IMPLTYPE	setXSLTValidator(ISchematronXSLTValidator aXSLTValidator)
String	toString()

Methods inherited from class com.helger.schematron.AbstractSchematronResource

getID, getResource

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

getComparatorID

Field Detail

m_aCustomErrorListener

protected ErrorListener m_aCustomErrorListener

m_aCustomURIResolver

protected URIResolver m_aCustomURIResolver

m_aCustomParameters

protected com.helger.commons.collection.ext.ICommonsOrderedMap<String,?> m_aCustomParameters

Constructor Detail

AbstractSchematronXSLTBasedResource

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

Method Detail

getErrorListener

@Nullable
public ErrorListener getErrorListener()

setErrorListener

@Nonnull
public IMPLTYPE setErrorListener(@Nullable
                                           ErrorListener aCustomErrorListener)

getURIResolver

@Nullable
public URIResolver getURIResolver()

setURIResolver

@Nonnull
public IMPLTYPE setURIResolver(@Nullable
                                         URIResolver aCustomURIResolver)

hasParameters

public boolean hasParameters()

getParameters

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.ext.ICommonsOrderedMap<String,?> getParameters()

setParameters

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

getXSLTProvider

@Nullable
public abstract ISchematronXSLTBasedProvider getXSLTProvider()

Returns:

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

getXSLTValidator

@Nonnull
public ISchematronXSLTValidator getXSLTValidator()

Returns:

The XSLT validator to be used. Never null.

setXSLTValidator

@Nonnull
public IMPLTYPE setXSLTValidator(@Nonnull
                                           ISchematronXSLTValidator aXSLTValidator)

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
                                                                          com.helger.commons.io.IHasInputStream aXMLResource)
                                                                   throws Exception

Description copied from interface: ISchematronResource

A method to check if the passed XML 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:

aXMLResource - The source XML to read and validate against the Schematron. May not 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

getSchematronValidity

@Nonnull
public com.helger.commons.state.EValidity getSchematronValidity(@Nonnull
                                                                          Source aXMLSource)
                                                                   throws Exception

Description copied from interface: ISchematronResource

A method to check if the passed XML 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:

aXMLSource - The source XML to be validated against the Schematron. May not 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 Document applySchematronValidation(@Nonnull
                                                     com.helger.commons.io.IHasInputStream aXMLResource)
                                              throws Exception

Description copied from interface: ISchematronResource

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

Specified by:

applySchematronValidation in interface ISchematronResource

Parameters:

aXMLResource - The XML resource to validate via Schematron. May not be null.

Returns:

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

Throws:

Exception - In case the transformation somehow goes wrong.

See Also:

on how to convert the document into a domain object

applySchematronValidation

@Nullable
public Document applySchematronValidation(@Nonnull
                                                     Node aXMLResource)
                                              throws Exception

Throws:

Exception

applySchematronValidation

@Nullable
public final Document applySchematronValidation(@Nonnull
                                                           Source aXMLSource)
                                                    throws TransformerException

Description copied from interface: ISchematronResource

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

Specified by:

applySchematronValidation in interface ISchematronResource

Parameters:

aXMLSource - The XML source to validate via Schematron. May not be null.

Returns:

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

Throws:

TransformerException

See Also:

on how to convert the document into a domain object

applySchematronValidationToSVRL

@Nullable
public SchematronOutputType applySchematronValidationToSVRL(@Nonnull
                                                                       com.helger.commons.io.IHasInputStream aXMLResource)
                                                                throws Exception

Description copied from interface: ISchematronResource

Apply the Schematron validation on the passed XML resource and return a SchematronOutputType object.

Specified by:

applySchematronValidationToSVRL in interface ISchematronResource

Parameters:

aXMLResource - The XML resource to validate via Schematron. May not 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.

applySchematronValidationToSVRL

@Nullable
public SchematronOutputType applySchematronValidationToSVRL(@Nonnull
                                                                       Source aXMLSource)
                                                                throws Exception

Description copied from interface: ISchematronResource

Apply the Schematron validation on the passed XML source and return a SchematronOutputType object.

Specified by:

applySchematronValidationToSVRL in interface ISchematronResource

Parameters:

aXMLSource - The XML source to validate via Schematron. May not 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.

applySchematronValidationToSVRL

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

Throws:

Exception

toString

public String toString()

Overrides:

toString in class AbstractSchematronResource