Package 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
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 Description static java.lang.StringRESULT_NS-
Fields inherited from class net.sf.saxon.event.SequenceReceiver
pipelineConfiguration, previousAtomic, systemId
-
-
Constructor Summary
Constructors Constructor Description SequenceWrapper(Receiver destination)Create a sequence wrapper.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidappend(Item item, Location locationId, int copyNamespaces)Output an item (atomic value or node) to the sequencevoidcharacters(java.lang.CharSequence chars, Location locationId, int properties)Character datavoidclose()Notify the end of the event streamvoidcomment(java.lang.CharSequence chars, Location locationId, int properties)Output a commentvoidendDocument()Notify the end of a document nodevoidendElement()End of elementComplexContentOutputtergetDestination()voidopen()Start the output processvoidprocessingInstruction(java.lang.String target, java.lang.CharSequence data, Location locationId, int properties)Processing InstructionvoidstartDocument(int properties)Start of a document node.voidstartElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties)Notify the start of an elementbooleanusesTypeAnnotations()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
-
-
-
-
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 ComplexContentOutputter getDestination()
-
open
public void open() throws XPathExceptionDescription copied from class:SequenceReceiverStart the output process- Specified by:
openin interfaceReceiver- Overrides:
openin classSequenceReceiver- Throws:
XPathException- if an error occurs
-
startDocument
public void startDocument(int properties) throws XPathExceptionStart of a document node.- Parameters:
properties- properties of the document node- Throws:
XPathException- if an error occurs
-
endDocument
public void endDocument() throws XPathExceptionNotify the end of a document node- Throws:
XPathException- if an error occurs
-
startElement
public void startElement(NodeName elemName, SchemaType type, AttributeMap attributes, NamespaceMap namespaces, Location location, int properties) throws XPathException
Notify the start of an element- Parameters:
elemName- the name of the element.type- the type annotation of the element.attributes- the attributes of this elementnamespaces- the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elementslocation- an object providing information about the module, line, and column where the node originatedproperties- bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in classReceiverOption- Throws:
XPathException- if an error occurs
-
endElement
public void endElement() throws XPathExceptionEnd of element- Throws:
XPathException- if an error occurs
-
characters
public void characters(java.lang.CharSequence chars, Location locationId, int properties) throws XPathExceptionCharacter data- Parameters:
chars- The characterslocationId- 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 XPathExceptionOutput a comment- Parameters:
chars- The content of the commentlocationId- 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 XPathExceptionProcessing Instruction- Parameters:
target- The PI name. This must be a legal name (it will not be checked).data- The data portion of the processing instructionlocationId- 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:
appendin interfaceReceiver- Specified by:
appendin classSequenceReceiver- Parameters:
item- the item to be appendedlocationId- the location of the calling instruction, for diagnosticscopyNamespaces- if the item is an element node, this indicates whether its namespaces need to be copied. Values areReceiverOption.ALL_NAMESPACES; the default (0) means- Throws:
XPathException- if an error occurs
-
close
public void close() throws XPathExceptionNotify 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
-
-