net.sf.saxon.query

Class SequenceWrapper

java.lang.Object

net.sf.saxon.event.SequenceReceiver

net.sf.saxon.query.SequenceWrapper

All Implemented Interfaces:

javax.xml.transform.Result, Receiver

Direct Known Subclasses:

SequenceWrapperPE

public class SequenceWrapper
extends SequenceReceiver

This class can be used in a push pipeline: it accepts any sequence as input, and generates a document in which the items of the sequence are wrapped by elements containing information about the types of the items in the input sequence.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RESULT_NS

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
SequenceWrapper(Receiver destination) Create a sequence wrapper.

Method Summary

Modifier and Type	Method and Description
void	append(Item item, Location locationId, int copyNamespaces) Output an item (atomic value or node) to the sequence
void	attribute(NodeName attName, SimpleType typeCode, java.lang.CharSequence value, Location locationId, int properties) Notify an attribute.
void	characters(java.lang.CharSequence chars, Location locationId, int properties) Character data
void	close() Notify the end of the event stream
void	comment(java.lang.CharSequence chars, Location locationId, int properties) Output a comment
void	endDocument() Notify the end of a document node
void	endElement() End of element
Receiver	getDestination()
void	namespace(NamespaceBindingSet namespaceBindings, int properties) Notify a namespace.
void	open() Start the output process
void	processingInstruction(java.lang.String target, java.lang.CharSequence data, Location locationId, int properties) Processing Instruction
void	startContent() Notify the start of the content, that is, the completion of all attributes and namespaces.
void	startDocument(int properties) Start of a document node.
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 net.sf.saxon.event.SequenceReceiver

append, decompose, flatten, getConfiguration, getErrorCodeForDecomposingFunctionItems, getNamePool, getPipelineConfiguration, getSystemId, handlesAppend, setPipelineConfiguration, setSystemId, setUnparsedEntity

Methods inherited from class java.lang.Object

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

Field Detail

RESULT_NS

public static final java.lang.String RESULT_NS

Constructor Detail

SequenceWrapper

public SequenceWrapper(Receiver destination)

Create a sequence wrapper. This creates an XML representation of the items sent to destination in which the types of all items are made explicit

Parameters:

destination - the sequence being wrapped

Method Detail

getDestination

public Receiver getDestination()

open

public void open()
          throws XPathException

Description copied from class: SequenceReceiver

Start the output process

Specified by:

open in interface Receiver

Overrides:

open in class SequenceReceiver

Throws:

XPathException - if an error occurs

startDocument

public void startDocument(int properties)
                   throws XPathException

Start of a document node.

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

endDocument

public void endDocument()
                 throws XPathException

Notify the end of a document node

Throws:

XPathException - if an error occurs

startElement

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

Notify the start of an element

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.

location - location of the element

properties - properties of the element node

Throws:

XPathException - if an error occurs

endElement

public void endElement()
                throws XPathException

End of element

Throws:

XPathException - if an error occurs

attribute

public void attribute(NodeName attName,
                      SimpleType typeCode,
                      java.lang.CharSequence value,
                      Location 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.

Parameters:

attName - The name of the attribute

typeCode - The type of the attribute

locationId - location of the attribute

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

value - the string value of the attribute

Throws:

IllegalStateException: - attempt to output an attribute when there is no open element start tag

XPathException - if an error occurs

namespace

public void namespace(NamespaceBindingSet namespaceBindings,
                      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.

Parameters:

namespaceBindings - the namespace binding or bindings being notified

properties - The most important property is REJECT_DUPLICATES. If this property is set, the namespace declaration will be rejected if it conflicts with a previous declaration of the same prefix. If the property is not set, the namespace declaration will be ignored if it conflicts with a previous declaration. This reflects the fact that when copying a tree, namespaces for child elements are emitted before the namespaces of their parent element. Unfortunately this conflicts with the XSLT rule for complex content construction, where the recovery action in the event of conflicts is to take the namespace that comes last. XSLT therefore doesn't recover from this error:

Throws:

IllegalStateException: - attempt to output a namespace when there is no open element start tag

XPathException - if an error occurs

characters

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

Character data

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

comment

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

Output a comment

Parameters:

chars - The content of the comment

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

properties - Additional information about the comment.

Throws:

XPathException - if an error occurs

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.CharSequence data,
                                  Location locationId,
                                  int properties)
                           throws XPathException

Processing Instruction

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 - provides information such as line number and system ID.

properties - Additional information about the PI.

Throws:

XPathException - if an error occurs

append

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

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

Specified by:

append in interface Receiver

Specified by:

append in class SequenceReceiver

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 ReceiverOptions.ALL_NAMESPACES, ReceiverOptions.LOCAL_NAMESPACES; the default (0) means no namespaces

Throws:

XPathException

startContent

public void startContent()
                  throws XPathException

Notify the start of the content, that is, the completion of all attributes and namespaces. Note that the initial receiver of output from XSLT instructions will not receive this event, it has to detect it itself. Note that this event is reported for every element even if it has no attributes, no namespaces, and no content.

Throws:

XPathException - if an error occurs

close

public void close()
           throws XPathException

Notify the end of the event stream

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

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