Package com.helger.schematron.pure.validation.xpath

Class PSXPathValidationHandlerSVRL

java.lang.Object

com.helger.schematron.pure.validation.xpath.PSXPathValidationHandlerSVRL

All Implemented Interfaces:

IPSValidationHandler

@NotThreadSafe
public class PSXPathValidationHandlerSVRL
extends Object
implements IPSValidationHandler

A special validation handler that creates an SVRL document. This class only works for the XPath binding, as the special PSXPathBoundAssertReport class is referenced!

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
PSXPathValidationHandlerSVRL(IPSErrorHandler aErrorHandler)	Constructor

Method Summary

Modifier and Type	Method	Description
final IPSErrorHandler	getErrorHandler()
com.helger.schematron.svrl.jaxb.SchematronOutputType	getSVRL()
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	onFiredRule(PSRule aRule, String sContext, int nNodeIndex, int nNodeCount)	This method is called for every rule inside the current pattern.
void	onPattern(PSPattern aPattern)	This method is called for every pattern inside the schema.
void	onStart(PSSchema aSchema, PSPhase aActivePhase, String sBaseURI)	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

Methods inherited from interface com.helger.schematron.pure.validation.IPSValidationHandler

and, onEnd, onRuleStart

Constructor Details

PSXPathValidationHandlerSVRL

public PSXPathValidationHandlerSVRL(@Nonnull
 IPSErrorHandler aErrorHandler)

Constructor

Parameters:

aErrorHandler - The error handler to be used. May not be null.

Method Details

getErrorHandler

@Nonnull
public final IPSErrorHandler getErrorHandler()

onStart

public void onStart(@Nonnull
 PSSchema aSchema,
 @Nullable
 PSPhase aActivePhase,
 @Nullable
 String sBaseURI)
             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.

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

Throws:

SchematronValidationException - In case of validation errors

See Also:

• IPSValidationHandler.onEnd(PSSchema, PSPhase)

onPattern

public void onPattern(@Nonnull
 PSPattern aPattern)

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.

onFiredRule

public void onFiredRule(@Nonnull
 PSRule aRule,
 @Nonnull
 String sContext,
 @Nonnull
 int nNodeIndex,
 @Nonnull
 int nNodeCount)

Description copied from interface: IPSValidationHandler

This method is called for every rule inside the current pattern. Was called "onRule" previously.

Specified by:

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

nNodeIndex - 0-based node index currently fired

nNodeCount - The total number of nodes for this rule. Always > 0.

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

getSVRL

@Nullable
public com.helger.schematron.svrl.jaxb.SchematronOutputType getSVRL()