Package net.sf.saxon.value
Class IntegerRange
- java.lang.Object
-
- net.sf.saxon.value.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 consecutive ascending integers, for example 1 to 50. The integers must be within the range of a Java long.
-
-
Constructor Summary
Constructors Constructor Description IntegerRange(long start, long end)Construct an integer range expression
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleaneffectiveBooleanValue()Get the effective boolean value of this sequencejava.lang.CharSequencegetCanonicalLexicalRepresentation()Get the canonical lexical representation as defined in XML Schema.longgetEnd()Get the last integer in the sequence (inclusive)intgetLength()Get the length of the sequencejava.lang.ComparablegetSchemaComparable()Get a Comparable value that implements the XML Schema ordering comparison semantics for this value.longgetStart()Get the first integer in the sequence (inclusive)java.lang.StringgetStringValue()Get a string representation of the sequence.java.lang.CharSequencegetStringValueCS()Get a string representation of the sequence.IntegerValuehead()Get the first item in the sequenceIntegerValueitemAt(int n)Get the n'th item in the sequence (starting from 0).AtomicIteratoriterate()Return an Iterator to iterate over the values of a sequence.java.util.Iterator<AtomicValue>iterator()Return a Java iterator over the atomic sequence.GroundedValuereduce()Reduce the sequence to its simplest form.GroundedValuesubsequence(int start, int length)Get a subsequence of the valuejava.lang.StringtoString()-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, materialize, toShortString
-
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
-
-
-
Method Detail
-
getStart
public long getStart()
Get the first integer in the sequence (inclusive)- Returns:
- the first integer in the sequence (inclusive)
-
getEnd
public long getEnd()
Get the last integer in the sequence (inclusive)- Returns:
- 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:
iteratein interfaceAtomicSequence- Specified by:
iteratein interfaceGroundedValue- Specified by:
iteratein interfaceSequence- Returns:
- 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:
itemAtin interfaceAtomicSequence- Specified by:
itemAtin interfaceGroundedValue- 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
-
subsequence
public GroundedValue subsequence(int start, int length)
Get a subsequence of the value- Specified by:
subsequencein interfaceGroundedValue- 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 returnedlength- 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.
-
getLength
public int getLength()
Get the length of the sequence- Specified by:
getLengthin interfaceAtomicSequence- Specified by:
getLengthin interfaceGroundedValue- Returns:
- the number of items in the sequence
-
head
public IntegerValue head()
Description copied from interface:AtomicSequenceGet the first item in the sequence- Specified by:
headin interfaceAtomicSequence- Specified by:
headin interfaceGroundedValue- Specified by:
headin interfaceSequence- Returns:
- the first item in the sequence, or null if the sequence is empty
-
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:
getCanonicalLexicalRepresentationin interfaceAtomicSequence- Returns:
- the canonical lexical representation if defined in XML Schema; otherwise, the result of casting to string according to the XPath 2.0 rules
-
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_ORDERINGwhen there is no defined order relationship between two given values.- Specified by:
getSchemaComparablein interfaceAtomicSequence- Returns:
- a Comparable that follows XML Schema comparison rules
-
getStringValueCS
public java.lang.CharSequence getStringValueCS()
Description copied from interface:AtomicSequenceGet 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:
getStringValueCSin interfaceAtomicSequence- Specified by:
getStringValueCSin interfaceGroundedValue- 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:AtomicSequenceGet 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:
getStringValuein interfaceAtomicSequence- Specified by:
getStringValuein interfaceGroundedValue- Returns:
- a whitespace-separated concatenation of the string values of the items making up the sequence, as a String.
-
effectiveBooleanValue
public boolean effectiveBooleanValue() throws XPathExceptionDescription copied from interface:GroundedValueGet the effective boolean value of this sequence- Specified by:
effectiveBooleanValuein interfaceGroundedValue- 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()
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:
reducein interfaceGroundedValue- Returns:
- the simplified sequence
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
iterator
public java.util.Iterator<AtomicValue> iterator()
Return a Java iterator over the atomic sequence.- Specified by:
iteratorin interfacejava.lang.Iterable<AtomicValue>- Returns:
- an Iterator.
-
-