Package com.saxonica.ee.validate

Class CompactStringValue

  • All Implemented Interfaces:
    java.lang.Iterable<AtomicValue>, AtomicSequence, GroundedValue, Sequence
    public class CompactStringValue
extends java.lang.Object
implements AtomicSequence
    A compact representation of an atomic xs:string value used in saved tables for key and keyref constraints, designed to economize on space.
    Since:
    9.6

    • Constructor Detail

      • CompactStringValue

        public CompactStringValue​(UnicodeString content)

    • Method Detail

      • itemAt

        public AtomicValue itemAt​(int n)
        Description copied from interface: AtomicSequence
        Get the Nth item in the sequence, zero-based
        Specified by:
        itemAt in interface AtomicSequence
        Specified by:
        itemAt in interface GroundedValue
        Parameters:
        n - the index of the required item, with 0 representing the first item in the sequence
        Returns:
        the Nth item in the sequence, or null if the index is out of range

      • getCanonicalLexicalRepresentation

        public UnicodeString getCanonicalLexicalRepresentation()
        Description copied from interface: AtomicSequence
        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

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getUnicodeStringValue

        public UnicodeString getUnicodeStringValue()
        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:
        getUnicodeStringValue in interface AtomicSequence
        Specified by:
        getUnicodeStringValue in interface GroundedValue
        Returns:
        a whitespace-separated concatenation of the string values of the items making up the sequence, as a String.

      • getStringValue

        public java.lang.String getStringValue()
                                throws XPathException
        Description copied from interface: GroundedValue
        Get the string value of this sequence, as an instance of String. The string value of an item is the result of applying the XPath string() function. The string value of a sequence is the space-separated result of applying the string-join() function using a single space as the separator.

        The result of this method is always equivalent to the result of the GroundedValue.getUnicodeStringValue() method. Use this method in preference either (a) if you need to use the value in a context where a String is required, or (b) if the underlying value is held as a String, or in a form that is readily converted to a String. This is typically the case (i) when the value is an attribute node in a TinyTree, or (ii) any kind of node in a third-party tree model such as DOM.

        Specified by:
        getStringValue in interface GroundedValue
        Returns:
        the string value of the sequence.
        Throws:
        XPathException - if the sequence contains items that have no string value (for example, function items)

      • subsequence

        public GroundedValue subsequence​(int start,
                                 int length)
        Description copied from interface: GroundedValue
        Get a subsequence of the value
        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 length goes off the end of the sequence, the result returns items up to the end of the sequence
        Returns:
        the required subsequence.

      • 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)

      • reduce

        public GroundedValue reduce()
        Description copied from interface: GroundedValue
        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 Item. Otherwise, the result will typically be unchanged.
        Specified by:
        reduce in interface GroundedValue
        Returns:
        the simplified sequence

      • iterator

        public java.util.Iterator<AtomicValue> iterator()
        Specified by:
        iterator in interface java.lang.Iterable<AtomicValue>

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object