com.saxonica.ee.validate

Class IdValidator

java.lang.Object

net.sf.saxon.event.SequenceReceiver

net.sf.saxon.event.ProxyReceiver

com.saxonica.ee.validate.ValidatingFilter

com.saxonica.ee.validate.IdValidator

All Implemented Interfaces:

javax.xml.transform.Result, Receiver

public class IdValidator
extends ValidatingFilter

This class validates that ID elements and attributes have unique values and that IDREF and IDREFS elements and attributes refer to an ID in the same document. The class assumes that these elements and attributes have already been locally validated (so, for example, a element of type ID will not have child elements).

Field Summary

Fields inherited from class com.saxonica.ee.validate.ValidatingFilter

locallyInvalid

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

Constructors

Constructor and Description
IdValidator(Receiver next) Create a validator for ID/IDREF constraints

Method Summary

Modifier and Type	Method and Description
void	attribute(NodeName nameCode, SimpleType type, java.lang.CharSequence value, Location locationId, int properties) Handle an attribute
void	characters(java.lang.CharSequence chars, Location locationId, int properties) Character data
void	close() End of output.
void	endDocument() End of document
void	endElement() End of element
protected void	reportValidationError(ValidationFailure err, Location locationId) Report a validation error
void	startElement(NodeName nameCode, SchemaType typeCode, Location location, int properties) Notify the start of an element
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 com.saxonica.ee.validate.ValidatingFilter

append, getConstraintChecker, getStartTagBuffer, getValidationContext, reportIfInvalid, reportValidationError, setConstraintChecker, setStartTagBuffer, setValidationContext

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

comment, getNamePool, getNextReceiver, namespace, open, processingInstruction, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startContent, startDocument

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

append, decompose, flatten, getConfiguration, getErrorCodeForDecomposingFunctionItems, getPipelineConfiguration, getSystemId, handlesAppend

Methods inherited from class java.lang.Object

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

Constructor Detail

IdValidator

public IdValidator(Receiver next)

Create a validator for ID/IDREF constraints

Parameters:

next - the next receiver in the pipeline

Method Detail

startElement

public void startElement(NodeName nameCode,
                         SchemaType typeCode,
                         Location location,
                         int properties)
                  throws XPathException

Notify the start of an element

Specified by:

startElement in interface Receiver

Overrides:

startElement in class ProxyReceiver

Parameters:

nameCode - the name of the element.

typeCode - the element's type.

location - the element's location (or the location of the instruction that created it)

properties - for future use. Should be set to zero.

Throws:

XPathException - if an error occurs

characters

public void characters(java.lang.CharSequence chars,
                       Location locationId,
                       int properties)
                throws XPathException

Character data

Specified by:

characters in interface Receiver

Overrides:

characters in class ProxyReceiver

Parameters:

chars - The characters

locationId - provides information such as line number and system ID.

properties - Bit significant value. The following bits are defined:

DISABLE_ESCAPING

Disable escaping for this text node

USE_CDATA

Output as a CDATA section

Throws:

XPathException - if an error occurs

endElement

public void endElement()
                throws XPathException

End of element

Specified by:

endElement in interface Receiver

Overrides:

endElement in class ProxyReceiver

Throws:

XPathException - if an error occurs

attribute

public void attribute(NodeName nameCode,
                      SimpleType type,
                      java.lang.CharSequence value,
                      Location locationId,
                      int properties)
               throws XPathException

Handle an attribute

Specified by:

attribute in interface Receiver

Overrides:

attribute in class ProxyReceiver

Parameters:

nameCode - integer identifying the name of the attribute

type - the type annotation

value - the value of the attribute

locationId - the location of the node in the source, or of the instruction that created it

properties - additional properties of the attribute @throws XPathException On any failure to write the attribute

Throws:

XPathException - if an error occurs

endDocument

public void endDocument()
                 throws XPathException

End of document

Specified by:

endDocument in interface Receiver

Overrides:

endDocument in class ProxyReceiver

Throws:

XPathException - if an error occurs

close

public void close()
           throws XPathException

Description copied from class: ProxyReceiver

End of output. Note that closing this receiver also closes the rest of the pipeline.

Specified by:

close in interface Receiver

Overrides:

close in class ProxyReceiver

Throws:

XPathException - if an error occurs

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 ValidatingFilter

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

reportValidationError

protected void reportValidationError(ValidationFailure err,
                                     Location locationId)
                              throws XPathException

Report a validation error

Parameters:

err - The validation exception

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

Throws:

ValidationException - if the error is determined to be fatal

XPathException