net.sf.saxon.event

Class TypeCheckingFilter

Implemented Interfaces:
Receiver, Result

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 net.sf.saxon.event.ProxyReceiver

nextReceiver

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

pipelineConfiguration, previousAtomic, systemId

Method Summary

void
append(Item item, int locationId, int copyNamespaces)
Output an item (atomic value or node) to the sequence
void
attribute(int nameCode, int 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(int namespaceCode, 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)
void
startDocument(int properties)
Start of a document node.
void
startElement(int nameCode, int typeCode, int locationId, int properties)
Notify the start of an element

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

append, getConfiguration, getNamePool, getPipelineConfiguration, getSystemId, open, setPipelineConfiguration, setSystemId, setUnparsedEntity

Method Details

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 interface ProxyReceiver

attribute

public void attribute(int nameCode,
                      int 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 interface 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
properties - Bit significant value. The following bits are defined:

characters

public void characters(CharSequence chars,
                       int locationId,
                       int properties)
            throws XPathException
Character data
Specified by:
characters in interface Receiver
Overrides:
characters in interface ProxyReceiver

close

public void close()
            throws XPathException
End of event stream
Specified by:
close in interface Receiver
Overrides:
close in interface ProxyReceiver

comment

public void comment(CharSequence chars,
                    int locationId,
                    int properties)
            throws XPathException
Output a comment
Specified by:
comment in interface Receiver
Overrides:
comment in interface ProxyReceiver

endDocument

public void endDocument()
            throws XPathException
Notify the end of a document node
Specified by:
endDocument in interface Receiver
Overrides:
endDocument in interface ProxyReceiver

endElement

public void endElement()
            throws XPathException
End of element
Specified by:
endElement in interface Receiver
Overrides:
endElement in interface ProxyReceiver

namespace

public void namespace(int namespaceCode,
                      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 interface ProxyReceiver
Parameters:
namespaceCode - an integer: the top half is a prefix code, the bottom half a URI code. These may be translated into an actual prefix and URI using the name pool. A prefix code of zero represents the empty prefix (that is, the default namespace). A URI code of zero represents a URI of "", that is, a namespace undeclaration.

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 interface ProxyReceiver

setRequiredType

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

startDocument

public void startDocument(int properties)
            throws XPathException
Start of a document node.
Specified by:
startDocument in interface Receiver
Overrides:
startDocument in interface ProxyReceiver

startElement

public void startElement(int nameCode,
                         int typeCode,
                         int locationId,
                         int properties)
            throws XPathException
Notify the start of an element
Specified by:
startElement in interface Receiver
Overrides:
startElement in interface 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.
properties - properties of the element node