Class IntegerRange

  • All Implemented Interfaces:
    java.lang.Iterable<AtomicValue>, AtomicSequence, GroundedValue, Sequence

    public class IntegerRange
    extends java.lang.Object
    implements AtomicSequence
    This class represents a sequence of integers, for example 1 by 5 to 50. The integers must be within the range of a Java long.
    • Field Detail

      • start

        public long start
      • step

        public long step
      • end

        public long end
    • Constructor Detail

      • IntegerRange

        public IntegerRange​(long start,
                            long step,
                            long end)
        Construct an integer range expression
        start - the first integer in the sequence (inclusive)
        step - the step between consecutive integers in the sequence (non-zero, may be negative)
        end - the last integer in the sequence (inclusive). Must be >= start
    • Method Detail

      • getStart

        public long getStart()
        Get the first integer in the sequence (inclusive)
        the first integer in the sequence (inclusive)
      • getStep

        public long getStep()
        Get the increment in the sequence
        the increment
      • getEnd

        public long getEnd()
        Get the last integer in the sequence (inclusive)
        the last integer in the sequence (inclusive)
      • iterate

        public AtomicIterator iterate()
        Return an Iterator to iterate over the values of a sequence. The value of every expression can be regarded as a sequence, so this method is supported for all expressions. This default implementation handles iteration for expressions that return singleton values: for non-singleton expressions, the subclass must provide its own implementation.
        Specified by:
        iterate in interface AtomicSequence
        Specified by:
        iterate in interface GroundedValue
        Specified by:
        iterate in interface Sequence
        a SequenceIterator that can be used to iterate over the result of the expression
      • itemAt

        public IntegerValue itemAt​(int n)
        Get the n'th item in the sequence (starting from 0). This is defined for all Values, but its real benefits come for a sequence Value stored extensionally (or for a MemoClosure, once all the values have been read)
        Specified by:
        itemAt in interface AtomicSequence
        Specified by:
        itemAt in interface GroundedValue
        n - the index of the required item, with 0 representing the first item in the sequence
        the Nth item in the sequence, or null if the index is out of range
      • subsequence

        public GroundedValue subsequence​(int start,
                                         int length)
        Get a subsequence of the value
        Specified by:
        subsequence in interface GroundedValue
        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
        the required subsequence.
      • getCanonicalLexicalRepresentation

        public UnicodeString 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
        the canonical lexical representation if defined in XML Schema; otherwise, the result of casting to string according to the XPath 2.0 rules
      • 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
        a whitespace-separated concatenation of the string values of the items making up the sequence, as a String.
      • getStringValue

        public java.lang.String getStringValue()
        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
        the string value of the sequence.
      • 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
        the effective boolean value
        XPathException - if the sequence has no effective boolean value (for example a sequence of two integers)
      • 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
        the simplified sequence
      • toString

        public java.lang.String toString()
        toString in class java.lang.Object
      • iterator

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