com.helger.schematron.pure.bound

Class PSBoundSchemaCacheKey

java.lang.Object

com.helger.schematron.pure.bound.PSBoundSchemaCacheKey

@Immutable
public class PSBoundSchemaCacheKey
extends Object

This class represents keys for the PSBoundSchemaCache. It is a combination of a resource and a phase. It is the responsible class for reading and binding a Schematron resource.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
PSBoundSchemaCacheKey(com.helger.commons.io.resource.IReadableResource aResource, String sPhase, IPSErrorHandler aErrorHandler, XPathVariableResolver aVariableResolver, XPathFunctionResolver aFunctionResolver, EntityResolver aEntityResolver)

Method Summary

Modifier and Type	Method and Description
IPSBoundSchema	createBoundSchema() The main routine to create a bound schema from the passed resource and phase.
PSSchema	createPreprocessedSchema(PSSchema aSchema, IPSQueryBinding aQueryBinding) Pre-process the read schema, using the determined query binding.
PSPreprocessor	createPreprocessor(IPSQueryBinding aQueryBinding) Create the pre-processor to be used for createPreprocessedSchema(PSSchema, IPSQueryBinding).
boolean	equals(Object o)
EntityResolver	getEntityResolver()
IPSErrorHandler	getErrorHandler()
XPathFunctionResolver	getFunctionResolver()
String	getPhase()
IPSQueryBinding	getQueryBinding(PSSchema aSchema) Determine the query binding for the read schema.
com.helger.commons.io.resource.IReadableResource	getResource()
XPathVariableResolver	getVariableResolver()
int	hashCode()
PSSchema	readSchema(com.helger.commons.io.resource.IReadableResource aResource, IPSErrorHandler aErrorHandler, EntityResolver aEntityResolver) Read the specified schema from the passed resource.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PSBoundSchemaCacheKey

public PSBoundSchemaCacheKey(@Nonnull
                             com.helger.commons.io.resource.IReadableResource aResource,
                             @Nullable
                             String sPhase,
                             @Nullable
                             IPSErrorHandler aErrorHandler,
                             @Nullable
                             XPathVariableResolver aVariableResolver,
                             @Nullable
                             XPathFunctionResolver aFunctionResolver,
                             @Nullable
                             EntityResolver aEntityResolver)

Method Detail

getResource

@Nonnull
public final com.helger.commons.io.resource.IReadableResource getResource()

Returns:

The resource passed in the constructor. Never null.

getPhase

@Nullable
public final String getPhase()

Returns:

The phase selected in the constructor. May be null.

getErrorHandler

@Nullable
public final IPSErrorHandler getErrorHandler()

Returns:

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

getVariableResolver

@Nullable
public final XPathVariableResolver getVariableResolver()

Returns:

The variable resolver to be used. May be null.

getFunctionResolver

@Nullable
public final XPathFunctionResolver getFunctionResolver()

Returns:

The function resolver to be used. May be null.

getEntityResolver

@Nullable
public final EntityResolver getEntityResolver()

Returns:

The XML entity resolver to be used. May be null.

readSchema

@Nonnull
 @OverrideOnDemand
public PSSchema readSchema(@Nonnull
                                                         com.helger.commons.io.resource.IReadableResource aResource,
                                                         @Nullable
                                                         IPSErrorHandler aErrorHandler,
                                                         @Nullable
                                                         EntityResolver aEntityResolver)
                                                  throws SchematronException

Read the specified schema from the passed resource.

Parameters:

aResource - The resource to read from. Never null.

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

aEntityResolver - The XML entity resolver to be used. May be null.

Returns:

The read schema. May not be null.

Throws:

SchematronException - In case there is an error reading.

getQueryBinding

@Nonnull
 @OverrideOnDemand
public IPSQueryBinding getQueryBinding(@Nonnull
                                                                     PSSchema aSchema)
                                                              throws SchematronException

Determine the query binding for the read schema.

Parameters:

aSchema - The read schema. Never null.

Returns:

The query binding to use. Never null.

Throws:

SchematronException - In case the determination fails.

createPreprocessor

@Nonnull
 @OverrideOnDemand
public PSPreprocessor createPreprocessor(@Nonnull
                                                                       IPSQueryBinding aQueryBinding)

Create the pre-processor to be used for createPreprocessedSchema(PSSchema, IPSQueryBinding).

Parameters:

aQueryBinding - The query binding to be determined from the read schema. Never null.

Returns:

The pre-processor to be used.

createPreprocessedSchema

@Nonnull
 @OverrideOnDemand
public PSSchema createPreprocessedSchema(@Nonnull
                                                                       PSSchema aSchema,
                                                                       @Nonnull
                                                                       IPSQueryBinding aQueryBinding)
                                                                throws SchematronException

Pre-process the read schema, using the determined query binding.

Parameters:

aSchema - The read schema. Never null.

aQueryBinding - The determined query binding. Never null.

Returns:

The pre-processed schema and never null.

Throws:

SchematronException - In case pre-processing fails

createBoundSchema

@Nonnull
public IPSBoundSchema createBoundSchema()
                                           throws SchematronException

The main routine to create a bound schema from the passed resource and phase. The usual routine is to

1. read the schema from the resource - see readSchema(IReadableResource, IPSErrorHandler, EntityResolver)
2. resolve the query binding - see getQueryBinding(PSSchema)
3. pre-process the schema - createPreprocessedSchema(PSSchema, IPSQueryBinding)
4. and finally bind it - IPSQueryBinding.bind(PSSchema, String, IPSErrorHandler, javax.xml.xpath.XPathVariableResolver, javax.xml.xpath.XPathFunctionResolver)

Returns:

The bound schema. Never null.

Throws:

SchematronException - In case reading or binding fails.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object