com.saxonica.validate
Class ValidatingFilter

java.lang.Object
  extended by net.sf.saxon.event.SequenceReceiver
      extended by net.sf.saxon.event.ProxyReceiver
          extended by 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()
           
 
Method Summary
protected  String getErrorCode()
           
protected  boolean isInvalid()
           
protected  void reportIfInvalid()
           
protected  void reportValidationError(ValidationException err, boolean issueComment, int locationId)
          Report a validation error
 void setErrorCode(String errorCode)
          Set the error code to be used for error messages
protected  void setInvalid(boolean invalid)
           
 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
append, attribute, characters, close, comment, endDocument, endElement, getConfiguration, getDocumentLocator, getNamePool, getUnderlyingReceiver, namespace, open, processingInstruction, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startContent, startDocument, startElement
 
Methods inherited from class net.sf.saxon.event.SequenceReceiver
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()
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()

setInvalid

protected void setInvalid(boolean invalid)

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.

reportValidationError

protected void reportValidationError(ValidationException err,
                                     boolean issueComment,
                                     int locationId)
                              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
Throws:
XPathException

reportIfInvalid

protected void reportIfInvalid()
                        throws ValidationException
Throws:
ValidationException


Copyright (c) Saxonica Limited. All rights reserved.