com.helger.schematron

Class SchematronHelper

java.lang.Object

com.helger.schematron.SchematronHelper

@Immutable
public final class SchematronHelper
extends Object

This is a helper class that provides a way to easily apply an Schematron resource on an XML resource.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
static SchematronOutputType	applySchematron(ISchematronResource aSchematron, com.helger.commons.io.resource.IReadableResource aXML) Apply the passed schematron on the passed XML resource using a custom error handler.
static SchematronOutputType	applySchematron(ISchematronResource aSchematron, Node aNode) Apply the passed schematron on the passed XML node.
static SchematronOutputType	applySchematron(ISchematronResource aSchematron, Source aXML) Apply the passed schematron on the passed XML resource.
static com.helger.commons.error.IResourceErrorGroup	convertToResourceErrorGroup(SchematronOutputType aSchematronOutput, String sResourceName) Convert a SchematronOutputType to an IResourceErrorGroup.
static com.helger.xml.microdom.IMicroDocument	getWithResolvedSchematronIncludes(com.helger.commons.io.resource.IReadableResource aResource) Resolve all Schematron includes of the passed resource.
static com.helger.xml.microdom.IMicroDocument	getWithResolvedSchematronIncludes(com.helger.commons.io.resource.IReadableResource aResource, com.helger.xml.serialize.read.ISAXReaderSettings aSettings) Deprecated.
static com.helger.xml.microdom.IMicroDocument	getWithResolvedSchematronIncludes(com.helger.commons.io.resource.IReadableResource aResource, com.helger.xml.serialize.read.ISAXReaderSettings aSettings, IPSErrorHandler aErrorHandler) Resolve all Schematron includes of the passed resource.

Methods inherited from class java.lang.Object

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

Method Detail

applySchematron

@Nullable
public static SchematronOutputType applySchematron(@Nonnull
                                                              ISchematronResource aSchematron,
                                                              @Nonnull
                                                              com.helger.commons.io.resource.IReadableResource aXML)

Apply the passed schematron on the passed XML resource using a custom error handler.

Parameters:

aSchematron - The Schematron resource. May not be null.

aXML - The XML resource. May not be null.

Returns:

null if either the Schematron or the XML could not be read.

Throws:

IllegalStateException - if the processing throws an unexpected exception.

applySchematron

@Nullable
public static SchematronOutputType applySchematron(@Nonnull
                                                              ISchematronResource aSchematron,
                                                              @Nonnull
                                                              Source aXML)

Apply the passed schematron on the passed XML resource.

Parameters:

aSchematron - The Schematron resource. May not be null.

aXML - The XML resource. May not be null.

Returns:

null if either the Schematron or the XML could not be read.

Throws:

IllegalStateException - if the processing throws an unexpected exception.

applySchematron

@Nullable
public static SchematronOutputType applySchematron(@Nonnull
                                                              ISchematronResource aSchematron,
                                                              @Nonnull
                                                              Node aNode)

Apply the passed schematron on the passed XML node.

Parameters:

aSchematron - The Schematron resource. May not be null.

aNode - The XML node. May not be null.

Returns:

null if either the Schematron or the XML could not be read.

Throws:

IllegalStateException - if the processing throws an unexpected exception.

convertToResourceErrorGroup

@Nonnull
public static com.helger.commons.error.IResourceErrorGroup convertToResourceErrorGroup(@Nonnull
                                                                                                 SchematronOutputType aSchematronOutput,
                                                                                                 @Nullable
                                                                                                 String sResourceName)

Convert a SchematronOutputType to an IResourceErrorGroup.

Parameters:

aSchematronOutput - The result of Schematron validation

sResourceName - The name of the resource that was validated (may be a file path etc.)

Returns:

List non-null error list of SVRLResourceError objects.

getWithResolvedSchematronIncludes

@Nullable
public static com.helger.xml.microdom.IMicroDocument getWithResolvedSchematronIncludes(@Nonnull
                                                                                                  com.helger.commons.io.resource.IReadableResource aResource)

Resolve all Schematron includes of the passed resource.

Parameters:

aResource - The Schematron resource to read. May not be null.

Returns:

null if the passed resource could not be read as XML document

getWithResolvedSchematronIncludes

@Nullable
 @Deprecated
public static com.helger.xml.microdom.IMicroDocument getWithResolvedSchematronIncludes(@Nonnull
                                                                                                                com.helger.commons.io.resource.IReadableResource aResource,
                                                                                                                @Nullable
                                                                                                                com.helger.xml.serialize.read.ISAXReaderSettings aSettings)

Deprecated.

Resolve all Schematron includes of the passed resource.

Parameters:

aResource - The Schematron resource to read. May not be null.

aSettings - The SAX reader settings to be used. May be null to use the default settings.

Returns:

null if the passed resource could not be read as XML document

getWithResolvedSchematronIncludes

@Nullable
public static com.helger.xml.microdom.IMicroDocument getWithResolvedSchematronIncludes(@Nonnull
                                                                                                  com.helger.commons.io.resource.IReadableResource aResource,
                                                                                                  @Nullable
                                                                                                  com.helger.xml.serialize.read.ISAXReaderSettings aSettings,
                                                                                                  @Nonnull
                                                                                                  IPSErrorHandler aErrorHandler)

Resolve all Schematron includes of the passed resource.

Parameters:

aResource - The Schematron resource to read. May not be null.

aSettings - The SAX reader settings to be used. May be null to use the default settings.

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

Returns:

null if the passed resource could not be read as XML document