Class TypeCheckingFilter

java.lang.Object

net.sf.saxon.event.SequenceReceiver

net.sf.saxon.event.ProxyReceiver

net.sf.saxon.event.TypeCheckingFilter

All Implemented Interfaces:

Result, Receiver

public class TypeCheckingFilter
extends ProxyReceiver

A filter on the push pipeline that performs type checking, both of the item type and the cardinality.

Note that the TypeCheckingFilter cannot currently check document node tests of the form document-node(element(X,Y)), so it is not invoked in such cases. This isn't a big problem, because most instructions that return document nodes materialize them anyway.

Field Summary

Fields inherited from class ProxyReceiver

nextReceiver

Fields inherited from class SequenceReceiver

pipelineConfiguration, previousAtomic, systemId

Fields inherited from interface Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

Constructors

Constructor	Description
TypeCheckingFilter(Receiver next)

Method Summary

Modifier and Type	Method	Description
void	append(Item item, int locationId, int copyNamespaces)	Output an item (atomic value or node) to the sequence
void	attribute(NodeName nameCode, SimpleType typeCode, CharSequence value, int locationId, int properties)	Notify an attribute.
void	characters(CharSequence chars, int locationId, int properties)	Character data
void	close()	End of event stream
void	comment(CharSequence chars, int locationId, int properties)	Output a comment
void	endDocument()	Notify the end of a document node
void	endElement()	End of element
void	namespace(NamespaceBinding namespaceBinding, int properties)	Notify a namespace.
void	processingInstruction(String target, CharSequence data, int locationId, int properties)	Processing Instruction
void	setRequiredType(ItemType type, int cardinality, RoleLocator role, SourceLocator locator)
void	startDocument(int properties)	Start of a document node.
void	startElement(NodeName nameCode, SchemaType typeCode, int locationId, 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 ProxyReceiver

getNamePool, getUnderlyingReceiver, open, setPipelineConfiguration, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startContent

Methods inherited from class SequenceReceiver

append, getConfiguration, getPipelineConfiguration, getSystemId

Methods inherited from class Object

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

Constructor Details

TypeCheckingFilter

public TypeCheckingFilter(Receiver next)

Method Details

setRequiredType

public void setRequiredType(ItemType type,
 int cardinality,
 RoleLocator role,
 SourceLocator locator)

attribute

public void attribute(NodeName nameCode,
 SimpleType typeCode,
 CharSequence value,
 int locationId,
 int properties)
               throws XPathException

Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.

Specified by:

attribute in interface Receiver

Overrides:

attribute in class ProxyReceiver

Parameters:

nameCode - The name of the attribute, as held in the name pool

typeCode - The type of the attribute, as held in the name pool

value - the string value of the attribute

locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.

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

DISABLE_ESCAPING

Disable escaping for this attribute

NO_SPECIAL_CHARACTERS

Attribute value contains no special characters

Throws:

XPathException - if an error occurs

characters

public void characters(CharSequence chars,
 int locationId,
 int properties)
                throws XPathException

Character data

Specified by:

characters in interface Receiver

Overrides:

characters in class ProxyReceiver

Parameters:

chars - The characters

locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.

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

comment

public void comment(CharSequence chars,
 int locationId,
 int properties)
             throws XPathException

Output a comment

Specified by:

comment in interface Receiver

Overrides:

comment in class ProxyReceiver

Parameters:

chars - The content of the comment

locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.

properties - Additional information about the comment.

Throws:

XPathException - if an error occurs

namespace

public void namespace(NamespaceBinding namespaceBinding,
 int properties)
               throws XPathException

Notify a namespace. Namespaces are notified after the startElement event, and before any children for the element. The namespaces that are reported are only required to include those that are different from the parent element; however, duplicates may be reported. A namespace must not conflict with any namespaces already used for element or attribute names.

Specified by:

namespace in interface Receiver

Overrides:

namespace in class ProxyReceiver

Parameters:

namespaceBinding - the prefix/uri pair

properties - any special properties to be passed on this call

Throws:

XPathException - if an error occurs

processingInstruction

public void processingInstruction(String target,
 CharSequence data,
 int locationId,
 int properties)
                           throws XPathException

Processing Instruction

Specified by:

processingInstruction in interface Receiver

Overrides:

processingInstruction in class ProxyReceiver

Parameters:

target - The PI name. This must be a legal name (it will not be checked).

data - The data portion of the processing instruction

locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.

properties - Additional information about the PI.

Throws:

XPathException - if an error occurs

startDocument

public void startDocument(int properties)
                   throws XPathException

Start of a document node.

Specified by:

startDocument in interface Receiver

Overrides:

startDocument in class ProxyReceiver

Parameters:

properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOptions

Throws:

XPathException - if an error occurs

startElement

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

Notify the start of an element

Specified by:

startElement in interface Receiver

Overrides:

startElement in class ProxyReceiver

Parameters:

nameCode - integer code identifying the name of the element within the name pool.

typeCode - integer code identifying the element's type within the name pool.

locationId - an integer which can be interpreted using a LocationProvider to return information such as line number and system ID. If no location information is available, the value zero is supplied.

properties - properties of the element node

Throws:

XPathException - if an error occurs

endDocument

public void endDocument()
                 throws XPathException

Notify the end of a document node

Specified by:

endDocument in interface Receiver

Overrides:

endDocument in class ProxyReceiver

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

close

public void close()
           throws XPathException

End of event stream

Specified by:

close in interface Receiver

Overrides:

close in class ProxyReceiver

Throws:

XPathException - if an error occurs

append

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

Output an item (atomic value or node) to the sequence

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

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