com.helger.schematron.pure.validation

Class LoggingPSValidationHandler

java.lang.Object

com.helger.schematron.pure.validation.LoggingPSValidationHandler

All Implemented Interfaces:

IPSValidationHandler, Serializable

public class LoggingPSValidationHandler
extends Object
implements IPSValidationHandler

A logging implementation of IPSValidationHandler

Since:

5.3.0

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LoggingPSValidationHandler() Default constructor.
LoggingPSValidationHandler(org.slf4j.Logger aLogger) Constructor with a custom logger

Method Summary

Modifier and Type	Method and Description
static String	getAsString(Node aNode)
static String	getAsString(NodeList aNL)
org.slf4j.Logger	getLogger()
com.helger.commons.error.level.IErrorLevel	getLogLevel()
String	getLogPrefix()
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	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	onRuleStart(PSRule aRule, NodeList aContextList) Called once for each rule, even if the context list is empty.
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.
LoggingPSValidationHandler	setLogLevel(com.helger.commons.error.level.IErrorLevel aLogLevel)
LoggingPSValidationHandler	setLogPrefix(String sLogPrefix)

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, and

Constructor Detail

LoggingPSValidationHandler

public LoggingPSValidationHandler()

Default constructor.

LoggingPSValidationHandler

public LoggingPSValidationHandler(@Nonnull
                                  org.slf4j.Logger aLogger)

Constructor with a custom logger

Parameters:

aLogger - The logger to use. May not be null.

Method Detail

getLogger

@Nonnull
public final org.slf4j.Logger getLogger()

getLogLevel

@Nonnull
public final com.helger.commons.error.level.IErrorLevel getLogLevel()

setLogLevel

@Nonnull
public final LoggingPSValidationHandler setLogLevel(@Nonnull
                                                              com.helger.commons.error.level.IErrorLevel aLogLevel)

getLogPrefix

@Nullable
public final String getLogPrefix()

setLogPrefix

@Nonnull
public final LoggingPSValidationHandler setLogPrefix(@Nullable
                                                               String sLogPrefix)

getAsString

@Nonnull
public static String getAsString(@Nonnull
                                           Node aNode)

getAsString

@Nonnull
public static String getAsString(@Nonnull
                                           NodeList aNL)

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)
               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

onRuleStart

public void onRuleStart(@Nonnull
                        PSRule aRule,
                        @Nonnull
                        NodeList aContextList)
                 throws SchematronValidationException

Description copied from interface: IPSValidationHandler

Called once for each rule, even if the context list is empty.

Specified by:

onRuleStart in interface IPSValidationHandler

Parameters:

aRule - The rule that is to be executed.

aContextList - The list of context nodes. Never null but maybe empty.

Throws:

SchematronValidationException - In case of errors

onFiredRule

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

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.

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, String)