com.helger.schematron.xslt

Class AbstractSchematronXSLTResource

java.lang.Object

com.helger.schematron.AbstractSchematronResource

com.helger.schematron.xslt.AbstractSchematronXSLTResource

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, ISchematronResource

Direct Known Subclasses:

SchematronResourceSCH, SchematronResourceXSLT

@NotThreadSafe
public abstract class AbstractSchematronXSLTResource
extends AbstractSchematronResource

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

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
AbstractSchematronXSLTResource(com.helger.commons.io.IReadableResource aSCHResource, ErrorListener aCustomErrorListener, URIResolver aCustomURIResolver, ISchematronXSLTProvider aXSLTProvider)
AbstractSchematronXSLTResource(com.helger.commons.io.IReadableResource aSCHResource, ErrorListener aCustomErrorListener, URIResolver aCustomURIResolver, ISchematronXSLTProvider aXSLTProvider, ISchematronXSLTValidator aXSLTValidator)

Method Summary

Methods

Modifier and Type	Method and Description
Document	applySchematronValidation(com.helger.commons.io.IInputStreamProvider aXMLResource) Apply the Schematron validation on the passed XML resource and return an SVRL XML DOM Document.
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.IInputStreamProvider aXMLResource) Apply the Schematron validation on the passed XML resource and return a SchematronOutputType object.
SchematronOutputType	applySchematronValidationToSVRL(Source aXMLSource) Apply the Schematron validation on the passed XML source and return a SchematronOutputType object.
ErrorListener	getCustomErrorListener()
URIResolver	getCustomURIResolver()
com.helger.commons.state.EValidity	getSchematronValidity(com.helger.commons.io.IInputStreamProvider 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.
ISchematronXSLTProvider	getXSLTProvider()
ISchematronXSLTValidator	getXSLTValidator()
boolean	isValidSchematron()
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

Constructor Detail

AbstractSchematronXSLTResource

public AbstractSchematronXSLTResource(@Nonnull
                              com.helger.commons.io.IReadableResource aSCHResource,
                              @Nullable
                              ErrorListener aCustomErrorListener,
                              @Nullable
                              URIResolver aCustomURIResolver,
                              @Nullable
                              ISchematronXSLTProvider aXSLTProvider)

AbstractSchematronXSLTResource

public AbstractSchematronXSLTResource(@Nonnull
                              com.helger.commons.io.IReadableResource aSCHResource,
                              @Nullable
                              ErrorListener aCustomErrorListener,
                              @Nullable
                              URIResolver aCustomURIResolver,
                              @Nullable
                              ISchematronXSLTProvider aXSLTProvider,
                              @Nonnull
                              ISchematronXSLTValidator aXSLTValidator)

Method Detail

getCustomErrorListener

@Nullable
public ErrorListener getCustomErrorListener()

Returns:

The error listener passed in the constructor. May be null.

getCustomURIResolver

@Nullable
public URIResolver getCustomURIResolver()

Returns:

The URI resolver passed in the constructor. May be null.

getXSLTProvider

@Nullable
public ISchematronXSLTProvider getXSLTProvider()

Returns:

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

getXSLTValidator

@Nonnull
public ISchematronXSLTValidator getXSLTValidator()

Returns:

The XSLT validator passed in the constructor. Never null.

isValidSchematron

public final boolean isValidSchematron()

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.IInputStreamProvider 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).

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

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.IInputStreamProvider aXMLResource)
                                   throws Exception

Description copied from interface: ISchematronResource

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

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 final Document applySchematronValidation(@Nonnull
                                          Source aXMLSource)
                                         throws Exception

Description copied from interface: ISchematronResource

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

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:

Exception - In case the transformation somehow goes wrong.

See Also:

on how to convert the document into a domain object

applySchematronValidationToSVRL

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

Description copied from interface: ISchematronResource

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

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.

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.

toString

public String toString()

Overrides:

toString in class AbstractSchematronResource