Package com.helger.schematron.xslt

Class SchematronResourceXSLT

java.lang.Object

com.helger.schematron.AbstractSchematronResource

com.helger.schematron.api.xslt.AbstractSchematronXSLTBasedResource<SchematronResourceXSLT>

com.helger.schematron.xslt.SchematronResourceXSLT

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, com.helger.commons.traits.IGenericImplTrait<SchematronResourceXSLT>, com.helger.schematron.api.xslt.ISchematronXSLTBasedResource, com.helger.schematron.ISchematronResource

@NotThreadSafe
public class SchematronResourceXSLT
extends com.helger.schematron.api.xslt.AbstractSchematronXSLTBasedResource<SchematronResourceXSLT>

A Schematron resource that is based on an existing, pre-compiled XSLT script.

Author:

Philip Helger

Nested Class Summary

Nested classes/interfaces inherited from class com.helger.schematron.AbstractSchematronResource

com.helger.schematron.AbstractSchematronResource.NodeAndBaseURI

Field Summary

Fields inherited from class com.helger.schematron.api.xslt.AbstractSchematronXSLTBasedResource

DEFAULT_VALIDATE_SVRL, m_aCustomErrorListener, m_aCustomParameters, m_aCustomURIResolver

Fields inherited from class com.helger.schematron.AbstractSchematronResource

DEFAULT_USE_CACHE

Constructor Summary

Constructors

Constructor	Description
SchematronResourceXSLT(com.helger.commons.io.resource.IReadableResource aXSLTResource)	Constructor

Method Summary

Modifier and Type	Method	Description
static SchematronResourceXSLT	fromByteArray(byte[] aXSLT)	Create a new SchematronResourceXSLT from XSLT Schematron rules provided by an arbitrary byte array.
static SchematronResourceXSLT	fromClassPath(String sXSLTPath)	Create a new SchematronResourceXSLT resource.
static SchematronResourceXSLT	fromClassPath(String sXSLTPath, ClassLoader aClassLoader)	Create a new SchematronResourceXSLT resource.
static SchematronResourceXSLT	fromFile(File aXSLTFile)	Create a new SchematronResourceXSLT resource.
static SchematronResourceXSLT	fromFile(String sXSLTPath)	Create a new SchematronResourceXSLT resource.
static SchematronResourceXSLT	fromInputStream(String sResourceID, InputStream aXSLTIS)	Create a new SchematronResourceXSLT from XSLT Schematron rules provided by an arbitrary InputStream.
static SchematronResourceXSLT	fromString(String sXSLT, Charset aCharset)	Create a new SchematronResourceXSLT from XSLT Schematron rules provided by an arbitrary String.
static SchematronResourceXSLT	fromURL(String sXSLTURL)	Create a new SchematronResourceXSLT from XSLT Schematron rules provided at a URL
static SchematronResourceXSLT	fromURL(URL aXSLTURL)	Create a new SchematronResourceXSLT from XSLT Schematron rules provided at a URL
com.helger.schematron.api.xslt.ISchematronXSLTBasedProvider	getXSLTProvider()

Methods inherited from class com.helger.schematron.api.xslt.AbstractSchematronXSLTBasedResource

applySchematronValidation, applySchematronValidationToSVRL, getErrorListener, getOutputValidityDeterminator, getSchematronValidity, getURIResolver, isValidateSVRL, isValidSchematron, parameters, setEntityResolver, setErrorListener, setOutputValidityDeterminator, setURIResolver, setValidateSVRL, toString

Methods inherited from class com.helger.schematron.AbstractSchematronResource

applySchematronValidation, applySchematronValidation, applySchematronValidationToSVRL, applySchematronValidationToSVRL, getAsNode, getAsNode, getEntityResolver, getID, getResource, getSchematronValidity, getSchematronValidity, internalCreateDOMReaderSettings, internalSetEntityResolver, isLenient, isUseCache, setLenient, setUseCache

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

getID

Methods inherited from interface com.helger.schematron.ISchematronResource

applySchematronValidation, applySchematronValidation, applySchematronValidationToSVRL, applySchematronValidationToSVRL, getEntityResolver, getResource, getSchematronValidity, getSchematronValidity, isLenient, isUseCache, setLenient, setUseCache

Methods inherited from interface com.helger.schematron.api.xslt.ISchematronXSLTBasedResource

setAllowForeignElements

Constructor Details

SchematronResourceXSLT

public SchematronResourceXSLT(@Nonnull
 com.helger.commons.io.resource.IReadableResource aXSLTResource)

Constructor

Parameters:

aXSLTResource - The XSLT resource. May not be null.

Method Details

getXSLTProvider

@Nullable
public com.helger.schematron.api.xslt.ISchematronXSLTBasedProvider getXSLTProvider()

Specified by:

getXSLTProvider in class com.helger.schematron.api.xslt.AbstractSchematronXSLTBasedResource<SchematronResourceXSLT>

fromClassPath

@Nonnull
public static SchematronResourceXSLT fromClassPath(@Nonnull @Nonempty
 String sXSLTPath)

Create a new SchematronResourceXSLT resource.

Parameters:

sXSLTPath - The classpath relative path to the Schematron XSLT file. May neither be null nor empty.

Returns:

Never null.

fromClassPath

@Nonnull
public static SchematronResourceXSLT fromClassPath(@Nonnull @Nonempty
 String sXSLTPath,
 @Nullable
 ClassLoader aClassLoader)

Create a new SchematronResourceXSLT resource.

Parameters:

sXSLTPath - The classpath relative path to the Schematron XSLT file. May neither be null nor empty.

aClassLoader - The class loader to be used to retrieve the classpath resource. May be null.

Returns:

Never null.

fromFile

@Nonnull
public static SchematronResourceXSLT fromFile(@Nonnull @Nonempty
 String sXSLTPath)

Create a new SchematronResourceXSLT resource.

Parameters:

sXSLTPath - The file system path to the Schematron XSLT file. May neither be null nor empty.

Returns:

Never null.

fromFile

@Nonnull
public static SchematronResourceXSLT fromFile(@Nonnull
 File aXSLTFile)

Create a new SchematronResourceXSLT resource.

Parameters:

aXSLTFile - The File of the Schematron XSLT file. May not be null.

Returns:

Never null.

fromURL

@Nonnull
public static SchematronResourceXSLT fromURL(@Nonnull @Nonempty
 String sXSLTURL)
                                      throws MalformedURLException

Create a new SchematronResourceXSLT from XSLT Schematron rules provided at a URL

Parameters:

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

Returns:

Never null.

Throws:

MalformedURLException - In case an invalid URL is provided

fromURL

@Nonnull
public static SchematronResourceXSLT fromURL(@Nonnull
 URL aXSLTURL)

Create a new SchematronResourceXSLT from XSLT Schematron rules provided at a URL

Parameters:

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

Returns:

Never null.

fromInputStream

@Nonnull
public static SchematronResourceXSLT fromInputStream(@Nonnull @Nonempty
 String sResourceID,
 @Nonnull
 InputStream aXSLTIS)

Create a new SchematronResourceXSLT from XSLT Schematron rules provided by an arbitrary InputStream.

Parameters:

sResourceID - Resource ID to be used as the cache key. Should neither be null nor empty.

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

Returns:

Never null.

fromByteArray

@Nonnull
public static SchematronResourceXSLT fromByteArray(@Nonnull
 byte[] aXSLT)

Create a new SchematronResourceXSLT from XSLT Schematron rules provided by an arbitrary byte array.

Parameters:

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

Returns:

Never null.

fromString

@Nonnull
public static SchematronResourceXSLT fromString(@Nonnull
 String sXSLT,
 @Nonnull
 Charset aCharset)

Create a new SchematronResourceXSLT from XSLT Schematron rules provided by an arbitrary String.

Parameters:

sXSLT - The String representing the XSLT Schematron. May not be null.

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

Returns:

Never null.