Package com.helger.schematron.pure.validation

Class PSValidationHandlerBreakOnFirstError

java.lang.Object

com.helger.schematron.pure.validation.PSValidationHandlerBreakOnFirstError

All Implemented Interfaces:

IPSPartialValidationHandler, IPSValidationHandler

@NotThreadSafe
public class PSValidationHandlerBreakOnFirstError
extends Object
implements IPSPartialValidationHandler

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	Description
PSValidationHandlerBreakOnFirstError()

Method Summary

Modifier and Type	Method	Description
final com.helger.commons.state.EValidity	getValidity()
com.helger.commons.state.EContinue	onFailedAssert(PSAssertReport aAssertReport, String sTestExpression, Node aRuleMatchingNode, int nNodeIndex, Object aContext)	This method is called for every failed assert.
com.helger.commons.state.EContinue	onSuccessfulReport(PSAssertReport aAssertReport, String sTestExpression, Node aRuleMatchingNode, int nNodeIndex, Object aContext)	This method is called for every failed assert.
String	toString()

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.validation.IPSValidationHandler

and, onEnd, onFiredRule, onPattern, onRuleStart, onStart

Constructor Details

PSValidationHandlerBreakOnFirstError

public PSValidationHandlerBreakOnFirstError()

Method Details

onFailedAssert

@Nonnull
public com.helger.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

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.helger.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

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 final com.helger.commons.state.EValidity getValidity()

Specified by:

getValidity in interface IPSPartialValidationHandler

Returns:

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

toString

public String toString()

Overrides:

toString in class Object