Class SequenceWrapper

java.lang.Object
net.sf.saxon.event.SequenceReceiver
net.sf.saxon.query.SequenceWrapper
All Implemented Interfaces:
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 Details Link icon

  • Constructor Details Link icon

    • SequenceWrapper Link icon

      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 Details Link icon

    • getDestination Link icon

      public ComplexContentOutputter getDestination()
    • open Link icon

      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 Link icon

      public void startDocument(int properties) throws XPathException
      Start of a document node.
      Parameters:
      properties - properties of the document node
      Throws:
      XPathException - if an error occurs
    • endDocument Link icon

      public void endDocument() throws XPathException
      Notify the end of a document node
      Throws:
      XPathException - if an error occurs
    • startElement Link icon

      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 element
      namespaces - the in-scope namespaces of this element: generally this is all the in-scope namespaces, without relying on inheriting namespaces from parent elements
      location - an object providing information about the module, line, and column where the node originated
      properties - bit-significant properties of the element node. If there are no relevant properties, zero is supplied. The definitions of the bits are in class ReceiverOption
      Throws:
      XPathException - if an error occurs
    • endElement Link icon

      public void endElement() throws XPathException
      End of element
      Throws:
      XPathException - if an error occurs
    • characters Link icon

      public void characters(UnicodeString 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 Link icon

      public void comment(UnicodeString 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 Link icon

      public void processingInstruction(String target, UnicodeString 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 Link icon

      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 ReceiverOption.ALL_NAMESPACES; the default (0) means
      Throws:
      XPathException - if an error occurs
    • close Link icon

      public void close() throws XPathException
      Notify the end of the event stream
      Throws:
      XPathException - if an error occurs
    • usesTypeAnnotations Link icon

      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