com.helger.schematron.pure.bound

Class AbstractPSBoundSchema

java.lang.Object

com.helger.schematron.pure.bound.AbstractPSBoundSchema

All Implemented Interfaces:

IPSBoundSchema

Direct Known Subclasses:

PSXPathBoundSchema

public abstract class AbstractPSBoundSchema
extends Object
implements IPSBoundSchema

Base implementation of IPSBoundSchema with all common elements. It is independent of the used query binding.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
AbstractPSBoundSchema(IPSQueryBinding aQueryBinding, PSSchema aOrigSchema, String sPhase, IPSErrorHandler aCustomErrorHandler)

Method Summary

Modifier and Type	Method and Description
protected IPSPartialValidationHandler	createPartialValidationHandler() Override this implementation in a derived class to modify the behavior.
protected void	error(IPSElement aSourceElement, String sMsg)
protected void	error(IPSElement aSourceElement, String sMsg, Throwable t)
com.helger.commons.collection.impl.ICommonsList<PSPattern>	getAllRelevantPatterns()
protected IPSErrorHandler	getErrorHandler()
com.helger.xml.namespace.MapBasedNamespaceContext	getNamespaceContext()
PSSchema	getOriginalSchema()
PSPhase	getPhase()
String	getPhaseID()
IPSQueryBinding	getQueryBinding()
protected boolean	isDefaultErrorHandler()
boolean	isPhaseSpecified()
String	toString()
SchematronOutputType	validateComplete(Node aNode, String sBaseURI) Special validation that creates an SVRL document.
com.helger.commons.state.EValidity	validatePartially(Node aNode, String sBaseURI) Special validation that breaks on the first error.
protected void	warn(IPSElement aSourceElement, String sMsg)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.schematron.pure.bound.IPSBoundSchema

getValidationContext, validate

Constructor Detail

AbstractPSBoundSchema

public AbstractPSBoundSchema(@Nonnull
                             IPSQueryBinding aQueryBinding,
                             @Nonnull
                             PSSchema aOrigSchema,
                             @Nullable
                             String sPhase,
                             @Nullable
                             IPSErrorHandler aCustomErrorHandler)

Method Detail

getErrorHandler

@Nonnull
protected IPSErrorHandler getErrorHandler()

isDefaultErrorHandler

protected boolean isDefaultErrorHandler()

warn

@OverridingMethodsMustInvokeSuper
protected void warn(@Nonnull
                                                       IPSElement aSourceElement,
                                                       @Nonnull
                                                       String sMsg)

error

@OverridingMethodsMustInvokeSuper
protected void error(@Nonnull
                                                        IPSElement aSourceElement,
                                                        @Nonnull
                                                        String sMsg)

error

@OverridingMethodsMustInvokeSuper
protected void error(@Nonnull
                                                        IPSElement aSourceElement,
                                                        @Nonnull
                                                        String sMsg,
                                                        @Nullable
                                                        Throwable t)

getQueryBinding

@Nonnull
public final IPSQueryBinding getQueryBinding()

Specified by:

getQueryBinding in interface IPSBoundSchema

Returns:

The query binding that was used to create this bound schema.

getOriginalSchema

@Nonnull
public final PSSchema getOriginalSchema()

Specified by:

getOriginalSchema in interface IPSBoundSchema

Returns:

The original schema used to bind. Never null.

getNamespaceContext

@Nonnull
public final com.helger.xml.namespace.MapBasedNamespaceContext getNamespaceContext()

Specified by:

getNamespaceContext in interface IPSBoundSchema

Returns:

The namespace context as defined by the namespaces in the original schema. Never null.

getPhaseID

@Nonnull
public final String getPhaseID()

Specified by:

getPhaseID in interface IPSBoundSchema

Returns:

Get the phase ID used. If none was specified, the schema defaultPhase is used. If this is not present, than all patterns are used and ID of the phase is CSchematron.PHASE_ALL.

getPhase

@Nullable
public final PSPhase getPhase()

Specified by:

getPhase in interface IPSBoundSchema

Returns:

The phase object to be evaluated. May be null if no specific phase is to be validated!

isPhaseSpecified

public final boolean isPhaseSpecified()

Specified by:

isPhaseSpecified in interface IPSBoundSchema

Returns:

true if a special phase was specified, false if not.

getAllRelevantPatterns

@Nonnull
 @ReturnsMutableCopy
public final com.helger.commons.collection.impl.ICommonsList<PSPattern> getAllRelevantPatterns()

Specified by:

getAllRelevantPatterns in interface IPSBoundSchema

Returns:

A list of all patterns to be validated. If a phase was selected, only the patterns matching the selected phase are contained. Never null.

createPartialValidationHandler

@Nonnull
 @OverrideOnDemand
protected IPSPartialValidationHandler createPartialValidationHandler()

Override this implementation in a derived class to modify the behavior.

Returns:

An implementation of IPSPartialValidationHandler to use for partial validation. May not be null.

validatePartially

@Nonnull
public com.helger.commons.state.EValidity validatePartially(@Nonnull
                                                                      Node aNode,
                                                                      @Nullable
                                                                      String sBaseURI)
                                                               throws SchematronValidationException

Description copied from interface: IPSBoundSchema

Special validation that breaks on the first error. This is a specialized call of IPSBoundSchema.validate(Node, String, IPSValidationHandler).

Specified by:

validatePartially in interface IPSBoundSchema

Parameters:

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

sBaseURI - Base URI of the XML to be validated. May be null.

Returns:

EValidity.VALID if the document is valid, EValidity.INVALID if it is invalid.

Throws:

SchematronValidationException - In case a validation exception occurs

validateComplete

@Nonnull
public SchematronOutputType validateComplete(@Nonnull
                                                       Node aNode,
                                                       @Nullable
                                                       String sBaseURI)
                                                throws SchematronValidationException

Description copied from interface: IPSBoundSchema

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

Specified by:

validateComplete in interface IPSBoundSchema

Parameters:

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

sBaseURI - Base URI of the XML to be validated. May be null.

Returns:

The SVRL domain object.

Throws:

SchematronValidationException - In case a validation exception occurs

toString

public String toString()

Overrides:

toString in class Object