Package net.sf.saxon.event

Class SequenceNormalizer

java.lang.Object
net.sf.saxon.event.SequenceReceiver
net.sf.saxon.event.ProxyReceiver
net.sf.saxon.event.SequenceNormalizer
All Implemented Interfaces:
Result, Receiver
Direct Known Subclasses:
SequenceNormalizerWithItemSeparator, SequenceNormalizerWithSpaceSeparator
public abstract class SequenceNormalizer extends ProxyReceiver
Implement the "sequence normalization" logic as defined in the XSLT 3.0/XQuery 3.0 serialization spec.

There are two subclasses, which handle the different logic for the case where an item-separator is provided, and the case where whitespace-separation is used. Note that the whitespace case behaves differently from the case where the item-separator is set to a single space.

Because this Receiver is often used as the entry point to the pipeline for a Destination, it includes logic allowing onClose action for the Destination to be triggered when the Receiver is closed.

  • Field Details

    • level

      protected int level

    • inStartTag

      protected boolean inStartTag

  • Constructor Details

    • SequenceNormalizer

      public SequenceNormalizer(Receiver next)

  • Method Details

    • open

      public void open() throws XPathException
      Start of event stream
      Specified by:
      open in interface Receiver
      Overrides:
      open in class ProxyReceiver
      Throws:
      XPathException - if an error occurs

    • startDocument

      public void startDocument(int properties) throws XPathException
      Start of a document node.
      Specified by:
      startDocument in interface Receiver
      Overrides:
      startDocument in class ProxyReceiver
      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

    • endDocument

      public void endDocument() throws XPathException
      Notify the end of a document node
      Specified by:
      endDocument in interface Receiver
      Overrides:
      endDocument in class ProxyReceiver
      Throws:
      XPathException - if an error occurs

    • startElement

      public void startElement(NodeName elemName, SchemaType typeCode, Location location, int properties) throws XPathException
      Notify the start of an element
      Specified by:
      startElement in interface Receiver
      Overrides:
      startElement in class ProxyReceiver
      Parameters:
      elemName - integer code identifying the name of the element within the name pool.
      typeCode - integer code identifying the element's type within the name pool.
      location -
      properties - properties of the element node
      Throws:
      XPathException - if an error occurs

    • attribute

      public void attribute(NodeName name, SimpleType typeCode, CharSequence value, Location locationId, int properties) throws XPathException
      Notify an attribute. Attributes are notified after the startElement event, and before any children. Namespaces and attributes may be intermingled.
      Specified by:
      attribute in interface Receiver
      Overrides:
      attribute in class ProxyReceiver
      Parameters:
      name - The name of the attribute
      typeCode - The type of the attribute
      value -
      locationId - the location of the node in the source, or of the instruction that created it
      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

    • namespace

      public void namespace(NamespaceBindingSet namespaceBindings, int properties) throws XPathException
      Notify a namespace. 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; however, duplicates may be reported. A namespace must not conflict with any namespaces already used for element or attribute names.
      Specified by:
      namespace in interface Receiver
      Overrides:
      namespace in class ProxyReceiver
      Parameters:
      namespaceBindings - the prefix/uri pair representing the namespace binding
      properties - any special properties to be passed on this call
      Throws:
      XPathException - if an error occurs

    • startContent

      public void startContent() throws XPathException
      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.
      Specified by:
      startContent in interface Receiver
      Overrides:
      startContent in class ProxyReceiver
      Throws:
      XPathException - if an error occurs

    • characters

      public void characters(CharSequence chars, Location locationId, int properties) throws XPathException
      Character data
      Specified by:
      characters in interface Receiver
      Overrides:
      characters in class ProxyReceiver
      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

    • processingInstruction

      public void processingInstruction(String target, CharSequence data, Location locationId, int properties) throws XPathException
      Processing Instruction
      Specified by:
      processingInstruction in interface Receiver
      Overrides:
      processingInstruction in class ProxyReceiver
      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

    • comment

      public void comment(CharSequence chars, Location locationId, int properties) throws XPathException
      Output a comment
      Specified by:
      comment in interface Receiver
      Overrides:
      comment in class ProxyReceiver
      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

    • endElement

      public void endElement() throws XPathException
      End of element
      Specified by:
      endElement in interface Receiver
      Overrides:
      endElement in class ProxyReceiver
      Throws:
      XPathException - if an error occurs

    • close

      public void close() throws XPathException
      End of output. Note that closing this receiver also closes the rest of the pipeline.
      Specified by:
      close in interface Receiver
      Overrides:
      close in class ProxyReceiver
      Throws:
      XPathException - if an error occurs

    • onClose

      public void onClose(List<Action> actionList)
      Set actions to be performed when this Receiver is closed
      Parameters:
      actionList - a list of actions to be performed

    • onClose

      public void onClose(Action action)