Package net.sf.saxon.event
Class SequenceReceiver
- java.lang.Object
-
- net.sf.saxon.event.SequenceReceiver
-
- All Implemented Interfaces:
javax.xml.transform.Result
,Receiver
- Direct Known Subclasses:
ComplexContentOutputter
,ProxyReceiver
,SequenceWrapper
,SequenceWriter
,Sink
,TeeOutputter
,TreeReceiver
public abstract class SequenceReceiver extends java.lang.Object implements Receiver
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
Fields Modifier and Type Field Description protected PipelineConfiguration
pipelineConfiguration
protected boolean
previousAtomic
protected java.lang.String
systemId
-
Constructor Summary
Constructors Constructor Description SequenceReceiver(PipelineConfiguration pipe)
Create a SequenceReceiver
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
append(Item item)
Append an item (node or atomic value) to the outputabstract void
append(Item item, int locationId, int copyNamespaces)
Append an arbitrary item (node or atomic value) to the outputConfiguration
getConfiguration()
Get the Saxon ConfigurationNamePool
getNamePool()
Get the name poolPipelineConfiguration
getPipelineConfiguration()
Get the pipeline configurationjava.lang.String
getSystemId()
Get the system IDvoid
open()
Start the output processvoid
setPipelineConfiguration(PipelineConfiguration pipelineConfiguration)
Set the pipeline configurationvoid
setSystemId(java.lang.String systemId)
Set the system IDvoid
setUnparsedEntity(java.lang.String name, java.lang.String systemID, java.lang.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
attribute, characters, close, comment, endDocument, endElement, namespace, processingInstruction, startContent, startDocument, startElement, usesTypeAnnotations
-
-
-
-
Field Detail
-
previousAtomic
protected boolean previousAtomic
-
pipelineConfiguration
protected PipelineConfiguration pipelineConfiguration
-
systemId
protected java.lang.String systemId
-
-
Constructor Detail
-
SequenceReceiver
public SequenceReceiver(PipelineConfiguration pipe)
Create a SequenceReceiver- Parameters:
pipe
- the pipeline configuration
-
-
Method Detail
-
getPipelineConfiguration
public final PipelineConfiguration getPipelineConfiguration()
Description copied from interface:Receiver
Get the pipeline configuration- Specified by:
getPipelineConfiguration
in interfaceReceiver
- Returns:
- the pipeline configuration
-
setPipelineConfiguration
public void setPipelineConfiguration(PipelineConfiguration pipelineConfiguration)
Description copied from interface:Receiver
Set the pipeline configuration- Specified by:
setPipelineConfiguration
in interfaceReceiver
- Parameters:
pipelineConfiguration
- the pipeline configuration
-
getConfiguration
public final Configuration getConfiguration()
Get the Saxon Configuration- Returns:
- the Configuration
-
setSystemId
public void setSystemId(java.lang.String systemId)
Set the system ID- Specified by:
setSystemId
in interfaceReceiver
- Specified by:
setSystemId
in interfacejavax.xml.transform.Result
- Parameters:
systemId
- the URI used to identify the tree being passed across this interface
-
getSystemId
public java.lang.String getSystemId()
Get the system ID- Specified by:
getSystemId
in interfacejavax.xml.transform.Result
- Returns:
- the system ID that was supplied using the setSystemId() method
-
setUnparsedEntity
public void setUnparsedEntity(java.lang.String name, java.lang.String systemID, java.lang.String publicID) throws XPathException
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
public void open() throws XPathException
Start the output process- Specified by:
open
in interfaceReceiver
- Throws:
XPathException
- if an error occurs
-
append
public abstract void append(Item item, int locationId, int copyNamespaces) throws XPathException
Append an arbitrary item (node or atomic value) to the output- 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 areNodeInfo.ALL_NAMESPACES
,NodeInfo.LOCAL_NAMESPACES
,NodeInfo.NO_NAMESPACES
- Throws:
XPathException
- if the operation fails
-
append
public void append(Item item) throws XPathException
Append an item (node or atomic value) to the output- Parameters:
item
- the item to be appended- Throws:
XPathException
- if the operation fails
-
getNamePool
public NamePool getNamePool()
Get the name pool- Returns:
- the Name Pool that was supplied using the setConfiguration() method
-
-