com.helger.schematron.pure.bound.xpath

Class PSXPathBoundSchema

java.lang.Object

com.helger.schematron.pure.bound.AbstractPSBoundSchema

com.helger.schematron.pure.bound.xpath.PSXPathBoundSchema

All Implemented Interfaces:

IPSBoundSchema

@Immutable
public class PSXPathBoundSchema
extends AbstractPSBoundSchema

The default XPath binding for the pure Schematron implementation.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
PSXPathBoundSchema(IPSQueryBinding aQueryBinding, PSSchema aOrigSchema, String sPhase, IPSErrorHandler aCustomErrorListener, XPathVariableResolver aXPathVariableResolver, XPathFunctionResolver aXPathFunctionResolver) Create a new bound schema.

Method Summary

Modifier and Type	Method and Description
PSXPathBoundSchema	bind()
static XPathFactory	createXPathFactorySaxonFirst()
String	getValidationContext(String sRuleContext) Get the validation context to be used.
XPathFunctionResolver	getXPathFunctionResolver()
XPathVariableResolver	getXPathVariableResolver()
String	toString()
void	validate(Node aNode, IPSValidationHandler aValidationHandler) The generic validation method.
SchematronOutputType	validateComplete(Node aNode) Special validation that creates an SVRL document.

Methods inherited from class com.helger.schematron.pure.bound.AbstractPSBoundSchema

createPartialValidationHandler, error, error, getAllRelevantPatterns, getErrorHandler, getNamespaceContext, getOriginalSchema, getPhase, getPhaseID, getQueryBinding, isDefaultErrorHandler, isPhaseSpecified, validatePartially, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

PSXPathBoundSchema

public PSXPathBoundSchema(@Nonnull
                          IPSQueryBinding aQueryBinding,
                          @Nonnull
                          PSSchema aOrigSchema,
                          @Nullable
                          String sPhase,
                          @Nullable
                          IPSErrorHandler aCustomErrorListener,
                          @Nullable
                          XPathVariableResolver aXPathVariableResolver,
                          @Nullable
                          XPathFunctionResolver aXPathFunctionResolver)
                   throws SchematronBindException

Create a new bound schema. All the XPath pre-compilation happens inside this constructor, so that the validate(Node, IPSValidationHandler) method can be called many times without compiling the XPath statements again and again.

Parameters:

aQueryBinding - The query binding to be used. May not be null.

aOrigSchema - The original schema that should be bound. May not be null.

sPhase - The selected phase. May be null indicating that the default phase of the schema should be used (if present) or all patterns should be evaluated if no default phase is present.

aCustomErrorListener - A custom error listener to be used. May be null in which case a LoggingPSErrorHandler is used internally.

aXPathVariableResolver - Custom XPath variable resolver. May be null.

aXPathFunctionResolver - Custom XPath function resolver. May be null.

Throws:

SchematronBindException - In case XPath expressions are incorrect and pre-compilation fails

Method Detail

createXPathFactorySaxonFirst

@Nonnull
public static XPathFactory createXPathFactorySaxonFirst()
                                                           throws SchematronBindException

Throws:

SchematronBindException

bind

@Nonnull
public PSXPathBoundSchema bind()
                                  throws SchematronBindException

Throws:

SchematronBindException

getXPathVariableResolver

@Nullable
public XPathVariableResolver getXPathVariableResolver()

getXPathFunctionResolver

@Nullable
public XPathFunctionResolver getXPathFunctionResolver()

getValidationContext

@Nonnull
public String getValidationContext(@Nonnull
                                             String sRuleContext)

Description copied from interface: IPSBoundSchema

Get the validation context to be used. As rules can be stated as "element" they are not necessarily present on root level. For XPath this may e.g. be resolved by prepending "//" so that all elements are resolved correctly.

Parameters:

sRuleContext - The original rule context. May not be null.

Returns:

The real validation context to use.

validate

public void validate(@Nonnull
                     Node aNode,
                     @Nonnull
                     IPSValidationHandler aValidationHandler)
              throws SchematronValidationException

Description copied from interface: IPSBoundSchema

The generic validation method. It validates the passed XML node to this bound schema.

Parameters:

aNode - The node to be validated. May not be null.

aValidationHandler - The validation handler that receives the callback informations. May not be null.

Throws:

SchematronValidationException - In case a validation exception occurs

validateComplete

@Nonnull
public SchematronOutputType validateComplete(@Nonnull
                                                       Node aNode)
                                                throws SchematronValidationException

Description copied from interface: IPSBoundSchema

Special validation that creates an SVRL document. This is a specialized call of IPSBoundSchema.validate(Node, IPSValidationHandler).

Parameters:

aNode - The XML node to be validated. May not be null.

Returns:

The SVRL domain object.

Throws:

SchematronValidationException - In case a validation exception occurs

toString

public String toString()

Overrides:

toString in class AbstractPSBoundSchema