Package net.sf.saxon.event

Class SequenceReceiver

java.lang.Object
net.sf.saxon.event.SequenceReceiver
All Implemented Interfaces:
Result, Receiver
Direct Known Subclasses:
ComplexContentOutputter, Emitter, EventBuffer, ProxyReceiver, SequenceWrapper, SequenceWriter, Sink, TeeOutputter, TreeReceiver
public abstract class SequenceReceiver extends 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 Details

    • previousAtomic

      protected boolean previousAtomic

    • pipelineConfiguration

      protected PipelineConfiguration pipelineConfiguration

    • systemId

      protected String systemId

  • Constructor Details

    • SequenceReceiver

      public SequenceReceiver(PipelineConfiguration pipe)
      Create a SequenceReceiver
      Parameters:
      pipe - the pipeline configuration

  • Method Details

    • getPipelineConfiguration

      public final PipelineConfiguration getPipelineConfiguration()
      Description copied from interface: Receiver
      Get the pipeline configuration
      Specified by:
      getPipelineConfiguration in interface Receiver
      Returns:
      the pipeline configuration

    • setPipelineConfiguration

      public void setPipelineConfiguration(PipelineConfiguration pipelineConfiguration)
      Description copied from interface: Receiver
      Set the pipeline configuration
      Specified by:
      setPipelineConfiguration in interface Receiver
      Parameters:
      pipelineConfiguration - the pipeline configuration

    • getConfiguration

      public final Configuration getConfiguration()
      Get the Saxon Configuration
      Returns:
      the Configuration

    • setSystemId

      public void setSystemId(String systemId)
      Set the system ID
      Specified by:
      setSystemId in interface Receiver
      Specified by:
      setSystemId in interface Result
      Parameters:
      systemId - the URI used to identify the tree being passed across this interface

    • getSystemId

      public String getSystemId()
      Get the system ID
      Specified by:
      getSystemId in interface Result
      Returns:
      the system ID that was supplied using the setSystemId() method

    • setUnparsedEntity

      public void setUnparsedEntity(String name, String systemID, String publicID) throws XPathException
      Notify an unparsed entity URI.
      Specified by:
      setUnparsedEntity in interface Receiver
      Parameters:
      name - The name of the unparsed entity
      systemID - The system identifier of the unparsed entity
      publicID - 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 interface Receiver
      Throws:
      XPathException - if an error occurs

    • append

      public abstract void append(Item item, Location locationId, int properties) throws XPathException
      Append an arbitrary item (node, atomic value, or function) to the output
      Specified by:
      append in interface Receiver
      Parameters:
      item - the item to be appended
      locationId - the location of the calling instruction, for diagnostics
      properties - 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

    • append

      public void append(Item item) throws XPathException
      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 interface Receiver
      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

    • flatten

      protected void flatten(ArrayItem array, Location locationId, int copyNamespaces) throws XPathException
      Helper method for subclasses to invoke if required: flatten an array
      Throws:
      XPathException

    • decompose

      protected void decompose(Item item, Location locationId, int copyNamespaces) throws XPathException
      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.
      Throws:
      XPathException

    • getErrorCodeForDecomposingFunctionItems

      protected String getErrorCodeForDecomposingFunctionItems()

    • handlesAppend

      public boolean handlesAppend()
      Ask whether this Receiver can handle arbitrary items in its append(net.sf.saxon.om.Item, net.sf.saxon.expr.parser.Location, int) and append(Item, Location, int) methods. If it cannot, then calling these methods will raise an exception (typically but not necessarily an UnsupportedOperationException). This implementation returns true.
      Specified by:
      handlesAppend in interface Receiver
      Returns:
      true if the Receiver is able to handle items supplied to its append(net.sf.saxon.om.Item, net.sf.saxon.expr.parser.Location, int) and append(Item, Location, int) methods. A receiver that returns true may still reject some kinds of item, for example it may reject function items.