com.helger.schematron.pure.validation

Class PSValidationHandlerDefault

java.lang.Object

com.helger.schematron.pure.validation.PSValidationHandlerDefault

All Implemented Interfaces:

IPSValidationHandler

Direct Known Subclasses:

AbstractPSPartialValidationHandler, PSXPathValidationHandlerSVRL

@NotThreadSafe
public class PSValidationHandlerDefault
extends Object
implements IPSValidationHandler

The empty default implementation of IPSValidationHandler. This class may serve as the basis for your implementations.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
PSValidationHandlerDefault()

Method Summary

Modifier and Type	Method and Description
void	onEnd(PSSchema aSchema, PSPhase aActivePhase) This is the last method called.
com.helger.commons.state.EContinue	onFailedAssert(PSAssertReport aAssertReport, String sTestExpression, Node aRuleMatchingNode, int nNodeIndex, Object aContext) This method is called for every failed assert.
void	onPattern(PSPattern aPattern) This method is called for every pattern inside the schema.
void	onRule(PSRule aRule, String sContext) This method is called for every rule inside the current pattern.
void	onStart(PSSchema aSchema, PSPhase aActivePhase) This is the first method called.
com.helger.commons.state.EContinue	onSuccessfulReport(PSAssertReport aAssertReport, String sTestExpression, Node aRuleMatchingNode, int nNodeIndex, Object aContext) This method is called for every failed assert.

Methods inherited from class java.lang.Object

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

Constructor Detail

PSValidationHandlerDefault

public PSValidationHandlerDefault()

Method Detail

onStart

public void onStart(@Nonnull
                    PSSchema aSchema,
                    @Nullable
                    PSPhase aActivePhase)
             throws SchematronValidationException

Description copied from interface: IPSValidationHandler

This is the first method called.

Specified by:

onStart in interface IPSValidationHandler

Parameters:

aSchema - The Schematron to be validated. Never null.

aActivePhase - The selected phase, if any special phase was selected. May be null.

Throws:

SchematronValidationException - In case of validation errors

See Also:

IPSValidationHandler.onEnd(PSSchema, PSPhase)

onPattern

public void onPattern(@Nonnull
                      PSPattern aPattern)
               throws SchematronValidationException

Description copied from interface: IPSValidationHandler

This method is called for every pattern inside the schema.

Specified by:

onPattern in interface IPSValidationHandler

Parameters:

aPattern - The current pattern. Never null.

Throws:

SchematronValidationException - In case of validation errors

onRule

public void onRule(@Nonnull
                   PSRule aRule,
                   @Nonnull
                   String sContext)
            throws SchematronValidationException

Description copied from interface: IPSValidationHandler

This method is called for every rule inside the current pattern.

Specified by:

onRule in interface IPSValidationHandler

Parameters:

aRule - The current rule. Never null.

sContext - The real context to be used in validation. May differ from the result of PSRule.getContext() because of replaced variables from <let> elements.

Throws:

SchematronValidationException - In case of validation errors

onFailedAssert

@Nonnull
public com.helger.commons.state.EContinue onFailedAssert(@Nonnull
                                                                   PSAssertReport aAssertReport,
                                                                   @Nonnull
                                                                   String sTestExpression,
                                                                   @Nonnull
                                                                   Node aRuleMatchingNode,
                                                                   int nNodeIndex,
                                                                   @Nullable
                                                                   Object aContext)
                                                            throws SchematronValidationException

Description copied from interface: IPSValidationHandler

This method is called for every failed assert.

Specified by:

onFailedAssert in interface IPSValidationHandler

Parameters:

aAssertReport - The current assert element. Never null.

sTestExpression - The source XPath expression that was evaluated for this node. It may be different from the test expression contained in the passed assert/report element because of replaced <let> elements. Never null.

aRuleMatchingNode - The XML node of the document to be validated.

nNodeIndex - The index of the matched node, relative to the current rule.

aContext - A context object - implementation dependent. For the default query binding this is e.g. an PSXPathBoundAssertReport object.

Returns:

EContinue.BREAK to stop validating immediately.

Throws:

SchematronValidationException - In case of validation errors

onSuccessfulReport

@Nonnull
public com.helger.commons.state.EContinue onSuccessfulReport(@Nonnull
                                                                       PSAssertReport aAssertReport,
                                                                       @Nonnull
                                                                       String sTestExpression,
                                                                       @Nonnull
                                                                       Node aRuleMatchingNode,
                                                                       int nNodeIndex,
                                                                       @Nullable
                                                                       Object aContext)
                                                                throws SchematronValidationException

Description copied from interface: IPSValidationHandler

This method is called for every failed assert.

Specified by:

onSuccessfulReport in interface IPSValidationHandler

Parameters:

aAssertReport - The current assert element. Never null.

sTestExpression - The source XPath expression that was evaluated for this node. It may be different from the test expression contained in the passed assert/report element because of replaced <let> elements. Never null.

aRuleMatchingNode - The XML node of the document to be validated.

nNodeIndex - The index of the matched node, relative to the current rule.

aContext - A context object - implementation dependent. For the default query binding this is e.g. an PSXPathBoundAssertReport object.

Returns:

EContinue.BREAK to stop validating immediately.

Throws:

SchematronValidationException - In case of validation errors

onEnd

public void onEnd(@Nonnull
                  PSSchema aSchema,
                  @Nullable
                  PSPhase aActivePhase)
           throws SchematronValidationException

Description copied from interface: IPSValidationHandler

This is the last method called. It indicates that the validation for the current scheme ended.

Specified by:

onEnd in interface IPSValidationHandler

Parameters:

aSchema - The Schematron that was be validated. Never null.

aActivePhase - The selected phase, if any special phase was selected. May be null.

Throws:

SchematronValidationException - In case of validation errors

See Also:

IPSValidationHandler.onStart(PSSchema, PSPhase)