com.saxonica.validate
Class ValidatingFilter

java.lang.Object
  net.sf.saxon.event.SequenceReceiver
      net.sf.saxon.event.ProxyReceiver
          com.saxonica.validate.ValidatingFilter

All Implemented Interfaces:

Result, Receiver

Direct Known Subclasses:

ContentValidator, ValidationStack, XSIAttributeHandler

public class ValidatingFilter
extends ProxyReceiver

This class is used for a filter on the validation pipeline. It provides error reporting services to each of the filters.

Field Summary

Fields inherited from class net.sf.saxon.event.ProxyReceiver

nextReceiver

Fields inherited from class net.sf.saxon.event.SequenceReceiver

pipelineConfiguration, previousAtomic, systemId

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

ValidatingFilter(Receiver next)

Method Summary

void	append(Item item, int locationId, int copyNamespaces) Append an arbitrary item (node or atomic value) to the output
protected String	getErrorCode()
protected int	getInvalidity()
protected boolean	isInvalid()
protected void	reportIfInvalid()
protected void	reportValidationError(ValidationException err, boolean issueComment, int locationId, int severity) Report a validation error
void	setErrorCode(String errorCode) Set the error code to be used for error messages
protected void	setInvalidity(int invalidity) Set invalidity level
boolean	usesTypeAnnotations() Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events

Methods inherited from class net.sf.saxon.event.ProxyReceiver

attribute, characters, close, comment, endDocument, endElement, getNamePool, getUnderlyingReceiver, namespace, open, processingInstruction, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startContent, startDocument, startElement

Methods inherited from class net.sf.saxon.event.SequenceReceiver

append, getConfiguration, getPipelineConfiguration, getSystemId

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidatingFilter

public ValidatingFilter(Receiver next)

Method Detail

setErrorCode

public void setErrorCode(String errorCode)

Set the error code to be used for error messages

Parameters:

errorCode - the error code

getErrorCode

protected String getErrorCode()

setInvalidity

protected void setInvalidity(int invalidity)

Set invalidity level

Parameters:

invalidity - one of: 0=valid, 1=invalid but validation can continue, 2=structurally invalid

getInvalidity

protected int getInvalidity()

isInvalid

protected boolean isInvalid()

usesTypeAnnotations

public boolean usesTypeAnnotations()

Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events

Specified by:

usesTypeAnnotations in interface Receiver

Overrides:

usesTypeAnnotations in class ProxyReceiver

Returns:

true if the Receiver makes any use of this information. If false, the caller may supply untyped nodes instead of supplying the type annotation. Validation filters overwrite any type annotations arriving in the input event stream, so this instance of the method returns false.

append

public void append(Item item,
                   int locationId,
                   int copyNamespaces)
            throws XPathException

Description copied from class: ProxyReceiver

Append an arbitrary item (node or atomic value) to the output

Overrides:

append in class ProxyReceiver

Parameters:

item - the item to be appended

locationId - the location of the calling instruction, for diagnostics

copyNamespaces - if the item is an element node, this indicates whether its namespaces need to be copied. Values are NodeInfo.ALL_NAMESPACES, NodeInfo.LOCAL_NAMESPACES, NodeInfo.NO_NAMESPACES

Throws:

XPathException - if the operation fails

reportValidationError

protected void reportValidationError(ValidationException err,
                                     boolean issueComment,
                                     int locationId,
                                     int severity)
                              throws XPathException

Report a validation error

Parameters:

err - The validation exception

issueComment - true if the validation error message is to be written as an XML comment to the result document

locationId - identifies the location in the source document or stylesheet/query where the validation error was detected

severity - 1=validation can continue, 2=validation of children and siblings should stop

Throws:

XPathException - if reporting the error fails

reportIfInvalid

protected void reportIfInvalid()
                        throws ValidationException

Throws:

ValidationException