Package net.sf.saxon.om

Class AtomicArray

  • All Implemented Interfaces:
    java.lang.Iterable<AtomicValue>, AtomicSequence, GroundedValue, Sequence
    public class AtomicArray
extends java.lang.Object
implements AtomicSequence
    A sequence of atomic values, implemented using an underlying arrayList.

    Often used for representing the typed value of a list-valued node.

    Since:
    9.5

    • Field Detail

      • EMPTY_ATOMIC_ARRAY

        public static AtomicArray EMPTY_ATOMIC_ARRAY

    • Constructor Detail

      • AtomicArray

        public AtomicArray​(java.util.List<AtomicValue> content)
        Create an AtomicArray over a supplied arrayList of atomic values
        Parameters:
        content - the supplied arrayList. The caller warrants that the contents of this array will not change.

      • AtomicArray

        public AtomicArray​(SequenceIterator iter)
            throws XPathException
        Create an AtomicArray supplying the contents as an iterator
        Parameters:
        iter - the iterator that supplies the atomic values (which must be position at the start of the sequence, and which will be consumed by the method).
        Throws:
        XPathException - if evaluation of the SequenceIterator fails
        java.lang.ClassCastException - if any of the items returned by the SequenceIterator is not atomic

    • Method Detail

      • itemAt

        public AtomicValue itemAt​(int n)
        Get the n'th item in the sequence (base-zero addressing)
        Specified by:
        itemAt in interface AtomicSequence
        Specified by:
        itemAt in interface GroundedValue
        Parameters:
        n - the index of the required item, the first item being zero
        Returns:
        the n'th item if n is in range, or null otherwise

      • subsequence

        public AtomicArray subsequence​(int start,
                               int length)
        Get a subsequence of this sequence
        Specified by:
        subsequence in interface GroundedValue
        Parameters:
        start - the index of the first item to be included in the result, counting from zero. A negative value is taken as zero. If the value is beyond the end of the sequence, an empty sequence is returned
        length - the number of items to be included in the result. Specify Integer.MAX_VALUE to get the subsequence up to the end of the base sequence. If the value is negative, an empty sequence is returned. If the value goes off the end of the sequence, the result returns items up to the end of the sequence
        Returns:
        the required subsequence

      • getCanonicalLexicalRepresentation

        public java.lang.CharSequence getCanonicalLexicalRepresentation()
        Get the canonical lexical representation as defined in XML Schema. This is not always the same as the result of casting to a string according to the XPath rules.
        Specified by:
        getCanonicalLexicalRepresentation in interface AtomicSequence
        Returns:
        the canonical lexical representation if defined in XML Schema; otherwise, the result of casting to string according to the XPath 2.0 rules

      • getStringValueCS

        public java.lang.CharSequence getStringValueCS()
        Get the value of the item as a CharSequence. This is in some cases more efficient than the version of the method that returns a String.
        Specified by:
        getStringValueCS in interface AtomicSequence
        Specified by:
        getStringValueCS in interface GroundedValue
        Returns:
        a whitespace-separated concatenation of the string values of the items making up the sequence, as a CharSequence.

      • getStringValue

        public java.lang.String getStringValue()
        Description copied from interface: AtomicSequence
        Get a string representation of the sequence. The is the space-separated concatenation of the result of casting each of the items in the sequence to xs:string
        Specified by:
        getStringValue in interface AtomicSequence
        Specified by:
        getStringValue in interface GroundedValue
        Returns:
        a whitespace-separated concatenation of the string values of the items making up the sequence, as a String.

      • effectiveBooleanValue

        public boolean effectiveBooleanValue()
                              throws XPathException
        Description copied from interface: GroundedValue
        Get the effective boolean value of this sequence
        Specified by:
        effectiveBooleanValue in interface GroundedValue
        Returns:
        the effective boolean value
        Throws:
        XPathException - if the sequence has no effective boolean value (for example a sequence of two integers)

      • getSchemaComparable

        public java.lang.Comparable getSchemaComparable()
        Get a Comparable value that implements the XML Schema ordering comparison semantics for this value. The default implementation is written to compare sequences of atomic values. This method is overridden for AtomicValue and its subclasses.

        In the case of data types that are partially ordered, the returned Comparable extends the standard semantics of the compareTo() method by returning the value SequenceTool.INDETERMINATE_ORDERING when there is no defined order relationship between two given values.

        For comparing key/keyref values, XSD 1.1 defines that a singleton list is equal to its only member. To achieve this, this method returns the schema comparable of the singleton member if the list has length one. This won't give the correct ordering semantics, but we rely on lists never taking part in ordering comparisons.

        Specified by:
        getSchemaComparable in interface AtomicSequence
        Returns:
        a Comparable that follows XML Schema comparison rules

      • reduce

        public GroundedValue reduce()
        Reduce the sequence to its simplest form. If the value is an empty sequence, the result will be EmptySequence.getInstance(). If the value is a single atomic value, the result will be an instance of AtomicValue. If the value is a single item of any other kind, the result will be an instance of SingletonItem. Otherwise, the result will typically be unchanged.
        Specified by:
        reduce in interface GroundedValue
        Returns:
        the simplified sequence

      • iterator

        public java.util.Iterator<AtomicValue> iterator()
        Returns a Java iterator over the atomic sequence.
        Specified by:
        iterator in interface java.lang.Iterable<AtomicValue>
        Returns:
        an Iterator.