Package net.sf.saxon.event
Class SequenceReceiver
java.lang.Object
net.sf.saxon.event.SequenceReceiver
- Direct Known Subclasses:
Emitter
,EventBuffer
,ProxyReceiver
,SequenceWrapper
,SequenceWriter
,Sink
,TeeOutputter
,TreeReceiver
,WatchManager
SequenceReceiver: this extension of the Receiver interface is used when processing
a sequence constructor. It differs from the Receiver in allowing items (atomic values or
nodes) to be added to the sequence, not just tree-building events.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected PipelineConfiguration
protected boolean
protected String
Fields inherited from interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Append an arbitrary item (node, atomic value, or function) to the output.abstract void
Append an arbitrary item (node, atomic value, or function) to the outputprotected void
Helper method for subclasses to invoke if required: decompose an item into a sequence of node events.protected void
Helper method for subclasses to invoke if required: flatten an array.final Configuration
Get the Saxon Configurationprotected String
Get the name poolfinal PipelineConfiguration
Get the pipeline configurationGet the system IDboolean
Ask whether this Receiver can handle arbitrary items in itsOutputter.append(net.sf.saxon.om.Item, net.sf.saxon.s9api.Location, int)
andOutputter.append(Item, Location, int)
methods.void
open()
Start the output processvoid
setPipelineConfiguration
(PipelineConfiguration pipelineConfiguration) Set the pipeline configurationvoid
setSystemId
(String systemId) Set the system IDvoid
setUnparsedEntity
(String name, String systemID, String publicID) Notify an unparsed entity URI.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
characters, close, comment, endDocument, endElement, processingInstruction, startDocument, startElement, usesTypeAnnotations
-
Field Details
-
previousAtomic
protected boolean previousAtomic -
pipelineConfiguration
-
systemId
-
-
Constructor Details
-
SequenceReceiver
Create a SequenceReceiver- Parameters:
pipe
- the pipeline configuration
-
-
Method Details
-
getPipelineConfiguration
Description copied from interface:Receiver
Get the pipeline configuration- Specified by:
getPipelineConfiguration
in interfaceReceiver
- Returns:
- the pipeline configuration
-
setPipelineConfiguration
Description copied from interface:Receiver
Set the pipeline configuration- Specified by:
setPipelineConfiguration
in interfaceReceiver
- Parameters:
pipelineConfiguration
- the pipeline configuration
-
getConfiguration
Get the Saxon Configuration- Returns:
- the Configuration
-
setSystemId
Set the system ID- Specified by:
setSystemId
in interfaceResult
- Parameters:
systemId
- the URI used to identify the tree being passed across this interface
-
getSystemId
Get the system ID- Specified by:
getSystemId
in interfaceResult
- Returns:
- the system ID that was supplied using the setSystemId() method
-
setUnparsedEntity
Notify an unparsed entity URI.- Specified by:
setUnparsedEntity
in interfaceReceiver
- Parameters:
name
- The name of the unparsed entitysystemID
- The system identifier of the unparsed entitypublicID
- The public identifier of the unparsed entity- Throws:
XPathException
- if an error occurs
-
open
Start the output process- Specified by:
open
in interfaceReceiver
- Throws:
XPathException
- if an error occurs
-
append
Append an arbitrary item (node, atomic value, or function) to the output- Specified by:
append
in interfaceReceiver
- Parameters:
item
- the item to be appendedlocationId
- the location of the calling instruction, for diagnosticsproperties
- 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
-
append
Append an arbitrary item (node, atomic value, or function) to the output. By default, if the item is an element node, it is copied with all namespaces.- Specified by:
append
in interfaceReceiver
- Parameters:
item
- the item to be appended- Throws:
XPathException
- if the operation fails
-
getNamePool
Get the name pool- Returns:
- the Name Pool that was supplied using the setConfiguration() method
-
flatten
protected void flatten(ArrayItem array, Location locationId, int copyNamespaces) throws XPathException Helper method for subclasses to invoke if required: flatten an array. The effect is that each item in each member of the array is appended to thisSequenceReceiver
by calling itsmethod
- Parameters:
array
- the array to be flattenedlocationId
- the location of the instruction triggering this operationcopyNamespaces
- options for copying namespace nodes- Throws:
XPathException
- if things go wrong
-
decompose
Helper method for subclasses to invoke if required: decompose an item into a sequence of node events. Note that when this is used, methods such as characters(), comment(), startElement(), and processingInstruction() are responsible for setting previousAtomic to false.- Parameters:
item
- the item to be decomposed (that is, to be delivered to thisSequenceReceiver
as a sequence of separate eventslocationId
- the location of the originating instructioncopyNamespaces
- options for copying namespace nodes- Throws:
XPathException
- if things go wrong
-
getErrorCodeForDecomposingFunctionItems
-
handlesAppend
public boolean handlesAppend()Ask whether this Receiver can handle arbitrary items in itsOutputter.append(net.sf.saxon.om.Item, net.sf.saxon.s9api.Location, int)
andOutputter.append(Item, Location, int)
methods. If it cannot, then calling these methods will raise an exception (typically but not necessarily anUnsupportedOperationException
). This implementation returns true.- Specified by:
handlesAppend
in interfaceReceiver
- Returns:
- true if the Receiver is able to handle items supplied to
its
Outputter.append(net.sf.saxon.om.Item, net.sf.saxon.s9api.Location, int)
andOutputter.append(Item, Location, int)
methods. A receiver that returns true may still reject some kinds of item, for example it may reject function items.
-