Package net.sf.saxon.event

Class SequenceWriter

java.lang.Object
net.sf.saxon.event.SequenceReceiver
net.sf.saxon.event.SequenceWriter
All Implemented Interfaces:
Result, Receiver
Direct Known Subclasses:
AdaptiveEmitter, JSONSerializer, MessageListener2Proxy, MessageListenerProxy, SequenceOutputter
public abstract class SequenceWriter extends SequenceReceiver
The SequenceWriter is used when writing a sequence of items, for example, when xsl:variable is used with content and an "as" attribute. The SequenceWriter builds the sequence; the concrete subclass is responsible for deciding what to do with the resulting items.

Items may be supplied in either "composed" form (by calling the SequenceReceiver.append(Item) method, or in "decomposed" form (by a sequence of calls representing XML push events: startDocument(int), startElement(NodeName, SchemaType, Location, int), and so on. When items are supplied in decomposed form, a tree will be built, and the resulting document or element node is then written to the sequence in the same way as if it were supplied directly as a NodeInfo item.

This class is not used to build temporary trees. For that, the ComplexContentOutputter is used. The ComplexContentOutputter provides richer functionality than this class: it detects illegal sequences of events, detects duplicate or inconsistent attributes and namespaces, performs namespace fixup, allocates prefixes where necessary, and detects where it is necessary to call startContent() to mark the end of a start tag. By contrast, this class should only be used where it is known that the sequence of events is complete and consistent.

  • Constructor Details

  • Method Details

    • write

      public abstract void write(Item item) throws XPathException
      Abstract method to be supplied by subclasses: output one item in the sequence.
      Parameters:
      item - the item to be written to the sequence
      Throws:
      XPathException - if any failure occurs while writing the item

    • startDocument

      public void startDocument(int properties) throws XPathException
      Description copied from interface: Receiver
      Notify the start of a document node
      Parameters:
      properties - bit-significant integer indicating properties of the document node. The definitions of the bits are in class ReceiverOptions
      Throws:
      XPathException - if an error occurs

    • setUnparsedEntity

      public void setUnparsedEntity(String name, String systemID, String publicID) throws XPathException
      Description copied from class: SequenceReceiver
      Notify an unparsed entity URI.
      Specified by:
      setUnparsedEntity in interface Receiver
      Overrides:
      setUnparsedEntity in class SequenceReceiver
      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

    • getTreeModel

      public TreeModel getTreeModel()
      Get the tree model that will be used for creating trees when events are written to the sequence
      Returns:
      the tree model, if one has been set using setTreeModel(); otherwise null

    • setTreeModel

      public void setTreeModel(TreeModel treeModel)
      Set the tree model that will be used for creating trees when events are written to the sequence
      Parameters:
      treeModel - the tree model to be used. If none has been set, the default tree model for the configuration is used, unless a mutable tree is required and the default tree model is not mutable, in which case a linked tree is used.

    • endDocument

      public void endDocument() throws XPathException
      Description copied from interface: Receiver
      Notify the end of a document node
      Throws:
      XPathException - if an error occurs

    • startElement

      public void startElement(NodeName elemName, SchemaType typeCode, Location location, int properties) throws XPathException
      Description copied from interface: Receiver
      Notify the start of an element
      Parameters:
      elemName - the name of the element.
      typeCode - the type annotation of the element.
      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 revelant properties, zero is supplied. The definitions of the bits are in class ReceiverOptions
      Throws:
      XPathException - if an error occurs

    • endElement

      public void endElement() throws XPathException
      Description copied from interface: Receiver
      Notify the end of an element. The receiver must maintain a stack if it needs to know which element is ending.
      Throws:
      XPathException - if an error occurs

    • namespace

      public void namespace(NamespaceBindingSet namespaceBindings, int properties) throws XPathException
      Description copied from interface: Receiver
      Notify one or more namespaces. Namespaces are notified after the startElement event, and before any children for the element. The namespaces that are reported are only required to include those that are different from the parent element. The events represent namespace declarations and undeclarations rather than in-scope namespace nodes: an undeclaration is represented by a namespace code of zero. If the sequence of namespace events contains two A namespace must not conflict with any namespaces already used for element or attribute names.
      Parameters:
      namespaceBindings - contains the namespace prefix and namespace URI
      properties - The most important property is REJECT_DUPLICATES. If this property is set, the namespace declaration will be rejected if it conflicts with a previous declaration of the same prefix. If the property is not set, the namespace declaration will be ignored if it conflicts with a previous declaration. This reflects the fact that when copying a tree, namespaces for child elements are emitted before the namespaces of their parent element. Unfortunately this conflicts with the XSLT rule for complex content construction, where the recovery action in the event of conflicts is to take the namespace that comes last. XSLT therefore doesn't recover from this error:
      Throws:
      XPathException - if an error occurs

    • attribute

      public void attribute(NodeName attName, SimpleType typeCode, CharSequence value, Location locationId, int properties) throws XPathException
      Description copied from interface: Receiver
      Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.
      Parameters:
      attName - The name of the attribute
      typeCode - The type annotation of the attribute
      value - the string value of the attribute
      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 attribute
      NO_SPECIAL_CHARACTERS
      Attribute value contains no special characters
      Throws:
      XPathException - if an error occurs

    • startContent

      public void startContent() throws XPathException
      Description copied from interface: Receiver
      Notify the start of the content, that is, the completion of all attributes and namespaces. Note that the initial receiver of output from XSLT instructions will not receive this event, it has to detect it itself. Note that this event is reported for every element even if it has no attributes, no namespaces, and no content.
      Throws:
      XPathException - if an error occurs

    • characters

      public void characters(CharSequence s, Location locationId, int properties) throws XPathException
      Description copied from interface: Receiver
      Notify character data. Note that some receivers may require the character data to be sent in a single event, but in general this is not a requirement.
      Parameters:
      s - 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

      public void comment(CharSequence comment, Location locationId, int properties) throws XPathException
      Description copied from interface: Receiver
      Notify a comment. Comments are only notified if they are outside the DTD.
      Parameters:
      comment - 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

      public void processingInstruction(String target, CharSequence data, Location locationId, int properties) throws XPathException
      Description copied from interface: Receiver
      Output a 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

    • close

      public void close() throws XPathException
      Description copied from interface: Receiver
      Notify the end of the event stream
      Throws:
      XPathException - if an error occurs

    • append

      public void append(Item item, Location locationId, int copyNamespaces) throws XPathException
      Description copied from class: SequenceReceiver
      Append an arbitrary item (node, atomic value, or function) to the output
      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 ReceiverOptions.ALL_NAMESPACES, ReceiverOptions.LOCAL_NAMESPACES; the default (0) means no namespaces
      Throws:
      XPathException

    • usesTypeAnnotations

      public boolean usesTypeAnnotations()
      Description copied from interface: Receiver
      Ask whether this Receiver (or the downstream pipeline) makes any use of the type annotations supplied on element and attribute events. The default implementation of this method returns false.
      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 (or conversely, it may avoid stripping unwanted type annotations)

    • isReadyForBulkCopy

      public boolean isReadyForBulkCopy()

    • bulkCopyElementNode

      public void bulkCopyElementNode(TinyElementImpl node, int copyOptions) throws XPathException
      Throws:
      XPathException

    • isReadyForGrafting

      public boolean isReadyForGrafting()

    • graftElementNode

      public void graftElementNode(TinyElementImpl node, int copyOptions) throws XPathException
      Throws:
      XPathException