com.phloc.schematron.pure

Class SchematronResourcePure

java.lang.Object

com.phloc.schematron.AbstractSchematronResource

com.phloc.schematron.pure.SchematronResourcePure

All Implemented Interfaces:

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

@Immutable
public class SchematronResourcePure
extends AbstractSchematronResource

A Schematron resource that is not XSLT based but using the pure (native Java) implementation.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
SchematronResourcePure(com.phloc.commons.io.IReadableResource aResource)
SchematronResourcePure(com.phloc.commons.io.IReadableResource aResource, PSBoundSchemaCacheKey aCacheKey)
SchematronResourcePure(com.phloc.commons.io.IReadableResource aResource, String sPhase, IPSErrorHandler aErrorHandler)

Method Summary

Methods

Modifier and Type	Method and Description
Document	applySchematronValidation(com.phloc.commons.io.IReadableResource aXMLResource) Apply the Schematron validation on the passed XML resource and return an SVRL XML DOM Document.
SchematronOutputType	applySchematronValidation(Node aNode) The main method to convert a node to an SVRL document.
Document	applySchematronValidation(Source aXMLSource) Apply the Schematron validation on the passed XML source and return an SVRL XML DOM Document.
SchematronOutputType	applySchematronValidationToSVRL(com.phloc.commons.io.IReadableResource 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.
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
protected IPSBoundSchema	getBoundSchema()
com.phloc.commons.state.EValidity	getSchematronValidity(com.phloc.commons.io.IReadableResource aXMLResource) A method to check if the passed XML DOM node matches the Schematron rules or not.
com.phloc.commons.state.EValidity	getSchematronValidity(Source aXMLSource) A method to check if the passed XML DOM node matches the Schematron rules or not.
boolean	isValidSchematron()

Methods inherited from class com.phloc.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.phloc.commons.io.IReadableResource aResource)

SchematronResourcePure

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

SchematronResourcePure

public SchematronResourcePure(@Nonnull
                      com.phloc.commons.io.IReadableResource aResource,
                      @Nonnull
                      PSBoundSchemaCacheKey aCacheKey)

Method Detail

getBoundSchema

@Nonnull
protected IPSBoundSchema getBoundSchema()

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.

applySchematronValidation

@Nonnull
public SchematronOutputType applySchematronValidation(@Nonnull
                                                     Node aNode)
                                               throws SchematronException

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

Parameters:

aNode - 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.phloc.commons.state.EValidity getSchematronValidity(@Nonnull
                                                              com.phloc.commons.io.IReadableResource 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.phloc.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.phloc.commons.io.IReadableResource 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.phloc.commons.io.IReadableResource 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.