com.helger.schematron.pure

Class SchematronResourcePure

java.lang.Object

com.helger.schematron.AbstractSchematronResource

com.helger.schematron.pure.SchematronResourcePure

All Implemented Interfaces:

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

@NotThreadSafe
public class SchematronResourcePure
extends AbstractSchematronResource

A Schematron resource that is not XSLT based but using the pure (native Java) implementation. This class itself is not thread safe, but the underlying cache is thread safe. So once you configured this object fully (with all the setter), it can be considered thread safe.
Important: This class can only handle XPath expressions but no XSLT functions in Schematron asserts and reports!

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
SchematronResourcePure(com.helger.commons.io.resource.IReadableResource aResource)
SchematronResourcePure(com.helger.commons.io.resource.IReadableResource aResource, String sPhase, IPSErrorHandler aErrorHandler)

Method Summary

Methods

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(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 aXMLNode) The main method to convert a node to an SVRL document.
SchematronOutputType	applySchematronValidationToSVRL(Source aXMLSource) Apply the Schematron validation on the passed XML source and return a SchematronOutputType object.
protected IPSBoundSchema	createBoundSchema()
static SchematronResourcePure	fromByteArray(byte[] aSchematron) Create a new SchematronResourcePure from Schematron rules provided by an arbitrary byte array.
static SchematronResourcePure	fromClassPath(String sSCHPath) Create a new SchematronResourcePure from a Classpath Schematron rules
static SchematronResourcePure	fromFile(File aSCHFile) Create a new SchematronResourcePure from file system Schematron rules
static SchematronResourcePure	fromFile(String sSCHPath) Create a new SchematronResourcePure from file system Schematron rules
static SchematronResourcePure	fromInputStream(InputStream aSchematronIS) Create a new SchematronResourcePure from Schematron rules provided by an arbitrary InputStream.
static SchematronResourcePure	fromSchema(PSSchema aSchematron) Create a new SchematronResourcePure from Schematron rules provided by a domain model.
static SchematronResourcePure	fromString(String sSchematron, Charset aCharset) Create a new SchematronResourcePure from Schematron rules provided by an arbitrary String.
static SchematronResourcePure	fromURL(String sSCHURL) Create a new SchematronResourcePure from Schematron rules provided at a URL
static SchematronResourcePure	fromURL(URL aSCHURL) Create a new SchematronResourcePure from Schematron rules provided at a URL
IPSErrorHandler	getErrorHandler()
XPathFunctionResolver	getFunctionResolver()
protected IPSBoundSchema	getOrCreateBoundSchema()
String	getPhase()
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.
XPathVariableResolver	getVariableResolver()
boolean	isValidSchematron()
SchematronResourcePure	setErrorHandler(IPSErrorHandler aErrorHandler) Set the error handler to be used during binding.
SchematronResourcePure	setFunctionResolver(XPathFunctionResolver aFunctionResolver) Set the function resolver to be used in the XPath statements.
SchematronResourcePure	setPhase(String sPhase) Set the Schematron phase to be evaluated.
SchematronResourcePure	setVariableResolver(XPathVariableResolver aVariableResolver) Set the variable resolver to be used in the XPath statements.
void	validateCompletely() Use the internal error handler to validate all elements in the schematron.
void	validateCompletely(IPSErrorHandler aErrorHandler) Use the provided error handler to validate all elements in the schematron.

Methods inherited from class com.helger.schematron.AbstractSchematronResource

getID, getResource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SchematronResourcePure

public SchematronResourcePure(@Nonnull
                      com.helger.commons.io.resource.IReadableResource aResource)

SchematronResourcePure

public SchematronResourcePure(@Nonnull
                      com.helger.commons.io.resource.IReadableResource aResource,
                      @Nullable
                      String sPhase,
                      @Nullable
                      IPSErrorHandler aErrorHandler)

Method Detail

getPhase

@Nullable
public String getPhase()

Returns:

The phase to be used. May be null.

setPhase

@Nonnull
public SchematronResourcePure setPhase(@Nullable
                                      String sPhase)

Set the Schematron phase to be evaluated. Changing the phase will result in a newly bound schema!

Parameters:

sPhase - The name of the phase to use. May be null which means all phases.

Returns:

this

getErrorHandler

@Nullable
public IPSErrorHandler getErrorHandler()

Returns:

The error handler to be used to bind the schema. May be null.

setErrorHandler

@Nonnull
public SchematronResourcePure setErrorHandler(@Nullable
                                             IPSErrorHandler aErrorHandler)

Set the error handler to be used during binding.

Parameters:

aErrorHandler - The error handler. May be null.

Returns:

this

getVariableResolver

@Nullable
public XPathVariableResolver getVariableResolver()

Returns:

The variable resolver to be used. May be null.

setVariableResolver

@Nonnull
public SchematronResourcePure setVariableResolver(@Nullable
                                                 XPathVariableResolver aVariableResolver)

Set the variable resolver to be used in the XPath statements. This can only be set before the Schematron is bound. If it is already bound an exception is thrown to indicate the unnecessity of the call.

Parameters:

aVariableResolver - The variable resolver to set. May be null.

Returns:

this

getFunctionResolver

@Nullable
public XPathFunctionResolver getFunctionResolver()

Returns:

The function resolver to be used. May be null.

setFunctionResolver

@Nonnull
public SchematronResourcePure setFunctionResolver(@Nullable
                                                 XPathFunctionResolver aFunctionResolver)

Set the function resolver to be used in the XPath statements. This can only be set before the Schematron is bound. If it is already bound an exception is thrown to indicate the unnecessity of the call.

Parameters:

aFunctionResolver - The function resolver to set. May be null.

Returns:

this

createBoundSchema

@Nonnull
protected IPSBoundSchema createBoundSchema()

getOrCreateBoundSchema

@Nonnull
protected IPSBoundSchema getOrCreateBoundSchema()

isValidSchematron

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

validateCompletely

public void validateCompletely()

Use the internal error handler to validate all elements in the schematron. It tries to catch as many errors as possible.

validateCompletely

public void validateCompletely(@Nonnull
                      IPSErrorHandler aErrorHandler)

Use the provided error handler to validate all elements in the schematron. It tries to catch as many errors as possible.

Parameters:

aErrorHandler - The error handler to use. May not be null.

applySchematronValidationToSVRL

@Nonnull
public SchematronOutputType applySchematronValidationToSVRL(@Nonnull
                                                           Node aXMLNode)
                                                     throws SchematronException

The main method to convert a node to an SVRL document.

Parameters:

aXMLNode - The source node to be validated. May not be null.

Returns:

The SVRL document. Never null.

Throws:

SchematronException - in case of a sever error validating the schema

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

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

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

fromClassPath

@Nonnull
public static SchematronResourcePure fromClassPath(@Nonnull@Nonempty
                                           String sSCHPath)

Create a new SchematronResourcePure from a Classpath Schematron rules

Parameters:

sSCHPath - The classpath relative path to the Schematron rules.

Returns:

Never null.

fromFile

@Nonnull
public static SchematronResourcePure fromFile(@Nonnull@Nonempty
                                      String sSCHPath)

Create a new SchematronResourcePure from file system Schematron rules

Parameters:

sSCHPath - The file system path to the Schematron rules.

Returns:

Never null.

fromFile

@Nonnull
public static SchematronResourcePure fromFile(@Nonnull
                                      File aSCHFile)

Create a new SchematronResourcePure from file system Schematron rules

Parameters:

aSCHFile - The file system path to the Schematron rules.

Returns:

Never null.

fromURL

@Nonnull
public static SchematronResourcePure fromURL(@Nonnull@Nonempty
                                     String sSCHURL)
                                      throws MalformedURLException

Create a new SchematronResourcePure from Schematron rules provided at a URL

Parameters:

sSCHURL - The URL to the Schematron rules. May neither be null nor empty.

Returns:

Never null.

Throws:

MalformedURLException - In case an invalid URL is provided

fromURL

@Nonnull
public static SchematronResourcePure fromURL(@Nonnull
                                     URL aSCHURL)

Create a new SchematronResourcePure from Schematron rules provided at a URL

Parameters:

aSCHURL - The URL to the Schematron rules. May not be null.

Returns:

Never null.

fromInputStream

@Nonnull
public static SchematronResourcePure fromInputStream(@Nonnull
                                             InputStream aSchematronIS)

Create a new SchematronResourcePure from Schematron rules provided by an arbitrary InputStream.
Important: in this case, no include resolution will be performed!!

Parameters:

aSchematronIS - The InputStream to read the Schematron rules from. May not be null.

Returns:

Never null.

fromByteArray

@Nonnull
public static SchematronResourcePure fromByteArray(@Nonnull
                                           byte[] aSchematron)

Create a new SchematronResourcePure from Schematron rules provided by an arbitrary byte array.
Important: in this case, no include resolution will be performed!!

Parameters:

aSchematron - The byte array representing the Schematron. May not be null.

Returns:

Never null.

fromString

@Nonnull
public static SchematronResourcePure fromString(@Nonnull
                                        String sSchematron,
                                        @Nonnull
                                        Charset aCharset)

Create a new SchematronResourcePure from Schematron rules provided by an arbitrary String.
Important: in this case, no include resolution will be performed!!

Parameters:

sSchematron - The String representing the Schematron. May not be null .

aCharset - The charset to be used to convert the String to a byte array.

Returns:

Never null.

fromSchema

@Nonnull
public static SchematronResourcePure fromSchema(@Nonnull
                                        PSSchema aSchematron)

Create a new SchematronResourcePure from Schematron rules provided by a domain model.
Important: in this case, no include resolution will be performed!!

Parameters:

aSchematron - The Schematron model to be used. May not be null .

Returns:

Never null.