Class SequenceNormalizer

  • All Implemented Interfaces:
    javax.xml.transform.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 Detail

      • level

        protected int level
    • Constructor Detail

      • SequenceNormalizer

        public SequenceNormalizer​(Receiver next)
    • Method Detail

      • startElement

        public void startElement​(NodeName elemName,
                                 SchemaType type,
                                 AttributeMap attributes,
                                 NamespaceMap namespaces,
                                 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 - 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
      • characters

        public void characters​(UnicodeString 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​(java.lang.String target,
                                          UnicodeString 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​(UnicodeString 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
      • onClose

        public void onClose​(java.util.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)