com.helger.schematron.pure.validation

Interface IPSValidationHandler

All Known Implementing Classes:

AbstractPSPartialValidationHandler, PSValidationHandlerBreakOnFirstError, PSValidationHandlerBreakOnFirstFailedAssert, PSValidationHandlerDefault, PSXPathValidationHandlerSVRL

public interface IPSValidationHandler

Base interface for a Schematron validation callback handler. It is only invoked when validating an XML against a Schematron file.

Author:

Philip Helger

See Also:

IPSBoundSchema.validate(Node, IPSValidationHandler)

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.

Method Detail

onStart

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

This is the first method called.

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:

onEnd(PSSchema, PSPhase)

onPattern

void onPattern(@Nonnull
               PSPattern aPattern)
        throws SchematronValidationException

This method is called for every pattern inside the schema.

Parameters:

aPattern - The current pattern. Never null.

Throws:

SchematronValidationException - In case of validation errors

onRule

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

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

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
com.helger.commons.state.EContinue onFailedAssert(@Nonnull
                                                            PSAssertReport aAssertReport,
                                                            @Nonnull
                                                            String sTestExpression,
                                                            @Nonnull
                                                            Node aRuleMatchingNode,
                                                            int nNodeIndex,
                                                            @Nullable
                                                            Object aContext)
                                                     throws SchematronValidationException

This method is called for every failed assert.

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
com.helger.commons.state.EContinue onSuccessfulReport(@Nonnull
                                                                PSAssertReport aAssertReport,
                                                                @Nonnull
                                                                String sTestExpression,
                                                                @Nonnull
                                                                Node aRuleMatchingNode,
                                                                int nNodeIndex,
                                                                @Nullable
                                                                Object aContext)
                                                         throws SchematronValidationException

This method is called for every failed assert.

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

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

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

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:

onStart(PSSchema, PSPhase)