net.sf.saxon.event
Class SequenceChecker

java.lang.Object
  net.sf.saxon.event.ProxyReceiver
      net.sf.saxon.event.SequenceChecker

All Implemented Interfaces:

Result, Receiver, SequenceReceiver

public class SequenceChecker
extends ProxyReceiver
implements SequenceReceiver

This is a receiver that can be inserted into a pipeline to do type checking of the nodes and/or atomic values produced by a content constructor, as they are written. It is used, for example, when xsl:sequence has an "as" attribute to indicate the required type, or to enforce the "as" attribute on xsl:template.

This filter also atomizes any nodes in the sequence if the required item type is atomic.

Field Summary

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

baseReceiver, namePool, systemId

Fields inherited from interface javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

Constructor Summary

SequenceChecker()

Method Summary

void	append(Item item) Output an item (atomic value or node) to the sequence
void	attribute(int nameCode, int typeCode, CharSequence value, int properties) Notify an attribute.
void	characters(CharSequence chars, int properties) Character data
void	comment(CharSequence chars, int properties) Output a comment
void	endElement() End of element
void	finalCheck()
void	namespace(int namespaceCode, int properties) Notify a namespace.
void	processingInstruction(String target, CharSequence data, int properties) Processing Instruction
void	setRequiredType(SequenceType type)
void	startElement(int nameCode, int typeCode, int properties) Notify the start of an element

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

endDocument, getNamePool, getSystemId, getUnderlyingReceiver, setDocumentLocator, setNamePool, setSystemId, setUnderlyingReceiver, setUnparsedEntity, startContent, startDocument

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.saxon.event.Receiver

endDocument, getNamePool, setDocumentLocator, setNamePool, setSystemId, setUnparsedEntity, startContent, startDocument

Methods inherited from interface javax.xml.transform.Result

getSystemId

Constructor Detail

SequenceChecker

public SequenceChecker()

Method Detail

setRequiredType

public void setRequiredType(SequenceType type)

startElement

public void startElement(int nameCode,
                         int typeCode,
                         int properties)
                  throws TransformerException

Description copied from class: ProxyReceiver

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.

Throws:

TransformerException

namespace

public void namespace(int namespaceCode,
                      int properties)
               throws TransformerException

Description copied from class: ProxyReceiver

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:

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.

Throws:

TransformerException

attribute

public void attribute(int nameCode,
                      int typeCode,
                      CharSequence value,
                      int properties)
               throws TransformerException

Description copied from class: ProxyReceiver

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

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:

TransformerException

endElement

public void endElement()
                throws TransformerException

Description copied from class: ProxyReceiver

End of element

Specified by:

endElement in interface Receiver

Overrides:

endElement in class ProxyReceiver

Throws:

TransformerException

characters

public void characters(CharSequence chars,
                       int properties)
                throws TransformerException

Description copied from class: ProxyReceiver

Character data

Specified by:

characters in interface Receiver

Overrides:

characters in class ProxyReceiver

Parameters:

chars - The characters

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

DISABLE_ESCAPING

Disable escaping for this text node

USE_CDATA

Output as a CDATA section

NO_SPECIAL_CHARACTERS

Value contains no special characters

WHITESPACE

Text is all whitespace

Throws:

TransformerException

processingInstruction

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

Description copied from class: ProxyReceiver

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

properties - Additional information about the PI. The following bits are defined:

CHECKED

Data is known to be legal (e.g. doesn't contain "?>")

Throws:

TransformerException

comment

public void comment(CharSequence chars,
                    int properties)
             throws TransformerException

Description copied from class: ProxyReceiver

Output a comment

Specified by:

comment in interface Receiver

Overrides:

comment in class ProxyReceiver

Parameters:

chars - The content of the comment

properties - Additional information about the comment. The following bits are defined:

CHECKED

Comment is known to be legal (e.g. doesn't contain "--")

Throws:

TransformerException

append

public void append(Item item)
            throws TransformerException

Description copied from interface: SequenceReceiver

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

Specified by:

append in interface SequenceReceiver

Throws:

TransformerException

finalCheck

public void finalCheck()
                throws TransformerException

Throws:

TransformerException