com.phloc.schematron.pure.validation

Class PSValidationHandlerBreakOnFirstError

java.lang.Object

com.phloc.schematron.pure.validation.PSValidationHandlerDefault

com.phloc.schematron.pure.validation.AbstractPSPartialValidationHandler

com.phloc.schematron.pure.validation.PSValidationHandlerBreakOnFirstError

All Implemented Interfaces:

IPSValidationHandler

@NotThreadSafe
public class PSValidationHandlerBreakOnFirstError
extends AbstractPSPartialValidationHandler

A simple implementation if IPSValidationHandler that stops validation upon the first error (the first failed assert or the first successful report). The final validation result can be retrieved by invoking getValidity().

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
PSValidationHandlerBreakOnFirstError()

Method Summary

Methods

Modifier and Type	Method and Description
com.phloc.commons.state.EValidity	getValidity()
com.phloc.commons.state.EContinue	onFailedAssert(PSAssertReport aAssertReport, String sTestExpression, Node aRuleMatchingNode, int nNodeIndex, Object aContext) This method is called for every failed assert.
com.phloc.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 com.phloc.schematron.pure.validation.PSValidationHandlerDefault

onEnd, onPattern, onRule, onStart

Methods inherited from class java.lang.Object

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

Constructor Detail

PSValidationHandlerBreakOnFirstError

public PSValidationHandlerBreakOnFirstError()

Method Detail

onFailedAssert

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

Description copied from interface: IPSValidationHandler

This method is called for every failed assert.

Specified by:

onFailedAssert in interface IPSValidationHandler

Overrides:

onFailedAssert in class PSValidationHandlerDefault

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.

onSuccessfulReport

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

Description copied from interface: IPSValidationHandler

This method is called for every failed assert.

Specified by:

onSuccessfulReport in interface IPSValidationHandler

Overrides:

onSuccessfulReport in class PSValidationHandlerDefault

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.

getValidity

@Nonnull
public com.phloc.commons.state.EValidity getValidity()

Specified by:

getValidity in class AbstractPSPartialValidationHandler

Returns:

The validity of the XML file. EValidity.VALID if no failed assertion and no successful report occurred, EValidity.INVALID otherwise.