net.sf.saxon.event.SequenceNormalizerWithItemSeparator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of Saxon-HE Show documentation
The XSLT and XQuery Processor
There is a newer version: 12.5
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2018-2022 Saxonica Limited
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

package net.sf.saxon.event;

import net.sf.saxon.expr.parser.Loc;
import net.sf.saxon.ma.arrays.ArrayItem;
import net.sf.saxon.om.AttributeMap;
import net.sf.saxon.om.Item;
import net.sf.saxon.om.NamespaceMap;
import net.sf.saxon.om.NodeName;
import net.sf.saxon.s9api.Location;
import net.sf.saxon.str.UnicodeString;
import net.sf.saxon.trans.XPathException;
import net.sf.saxon.type.SchemaType;
import net.sf.saxon.value.AtomicValue;

/**
 * Implement the "sequence normalization" logic as defined in the XSLT 3.0/XQuery 3.0
 * serialization spec.
 *
 * This class is used only if an ItemSeparator is specified. In the absence of an ItemSeparator,
 * the insertion of a single space performed by the ComplexContentOutputter serves the purpose.
 */

public class SequenceNormalizerWithItemSeparator extends SequenceNormalizer {

    private final UnicodeString separator;
    private boolean first = true;

    public SequenceNormalizerWithItemSeparator(Receiver next, UnicodeString separator) {
        super(next);
        this.separator = separator;
    }

    /**
     * Start of event stream
     */
    @Override
    public void open() throws XPathException {
        first = true;
        super.open();
    }

    /**
     * Start of a document node.
     */
    @Override
    public void startDocument(int properties) throws XPathException {
        sep();
        super.startDocument(properties);
    }


    /**
     * Notify the start of an element
     */
    @Override
    public void startElement(NodeName elemName, SchemaType type,
                             AttributeMap attributes, NamespaceMap namespaces,
                             Location location, int properties) throws XPathException {
        sep();
        super.startElement(elemName, type, attributes, namespaces, location, properties);
    }

    /**
     * Character data
     */
    @Override
    public void characters(UnicodeString chars, Location locationId, int properties) throws XPathException {
        sep();
        super.characters(chars, locationId, properties);
    }

    /**
     * Processing Instruction
     */
    @Override
    public void processingInstruction(String target, UnicodeString data, Location locationId, int properties) throws XPathException {
        sep();
        super.processingInstruction(target, data, locationId, properties);
    }

    /**
     * Output a comment
     */
    @Override
    public void comment(UnicodeString chars, Location locationId, int properties) throws XPathException {
        sep();
        super.comment(chars, locationId, properties);
    }

    /**
     * Append an arbitrary item (node or atomic value) to the output
     * @param item           the item to be appended
     * @param locationId     the location of the calling instruction, for diagnostics
     * @param copyNamespaces if the item is an element node, this indicates whether its namespaces
*                       need to be copied. Values are {@link ReceiverOption#ALL_NAMESPACES}; the default (0) means
     */
    @Override
    public void append(Item item, Location locationId, int copyNamespaces) throws XPathException {
        if (item instanceof ArrayItem) {
            flatten((ArrayItem) item, locationId, copyNamespaces);
        } else {
            if (item instanceof AtomicValue) {
                sep();
                nextReceiver.characters(item.getUnicodeStringValue(), locationId, ReceiverOption.NONE);
            } else {
                decompose(item, locationId, copyNamespaces);
            }
        }
    }

    /**
     * End of output. Note that closing this receiver also closes the rest of the
     * pipeline.
     */
    @Override
    public void close() throws XPathException {
        //getNextReceiver().endDocument();
        super.close();
    }

    /**
     * Output the separator, assuming we are at the top level and not at the start
     * @throws XPathException if outputting the separator fails
     */

    private void sep() throws XPathException {
        if (level == 0 && !first) {
            super.characters(separator, Loc.NONE, ReceiverOption.NONE);
        } else {
            first = false;
        }
    }
}