Package net.sf.saxon.value
Class YearMonthDurationValue
java.lang.Object
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.DurationValue
net.sf.saxon.value.YearMonthDurationValue
- All Implemented Interfaces:
Comparable<YearMonthDurationValue>,Iterable<AtomicValue>,AtomicMatchKey,AtomicSequence,GroundedValue,IdentityComparable,Item,Sequence,ConversionResult
public final class YearMonthDurationValue
extends DurationValue
implements Comparable<YearMonthDurationValue>
A value of type xs:yearMonthDuration.
The state retained by this class is essentially a signed 32-bit integer representing the number
of months: that is, year*12 + month; plus a type label allowing subtypes of xs:yearMonthDuration
to be represented.
-
Field Summary
Fields inherited from class net.sf.saxon.value.DurationValue
months, nanoseconds, negative, secondsFields inherited from class net.sf.saxon.value.AtomicValue
typeLabelFields inherited from interface net.sf.saxon.expr.sort.AtomicMatchKey
NaN_MATCH_KEY -
Method Summary
Modifier and TypeMethodDescriptionadd(DurationValue other) Add two year-month-durationsintcompareTo(YearMonthDurationValue other) Compare the value to another duration valuecopyAsSubType(AtomicType typeLabel) Create a copy of this atomic value, with a different type labeldivide(double n) Divide duration by a number.divide(DurationValue other) Find the ratio between two durationsstatic YearMonthDurationValuefromMonths(int months) Construct a duration value as a number of months.intGet the number of months in the durationConvert to stringDetermine the primitive type of the value.getXPathComparable(boolean ordered, StringCollator collator, int implicitTimezone) Get a Comparable value that implements the XPath ordering comparison semantics for this value.static ConversionResultStatic factory: create a year-month duration value from a supplied string, in ISO 8601 format [+|-]PnYnMmultiply(double n) Multiply duration by a number.multiply(long factor) Multiply a duration by an integernegate()Negate a duration (same as subtracting from zero, but it preserves the type of the original duration)subtract(DurationValue other) Subtract two year-month-durationsMethods inherited from class net.sf.saxon.value.DurationValue
badDuration, badDuration, equals, formatFractionalSeconds, getComponent, getDays, getHours, getLengthInSeconds, getMicroseconds, getMinutes, getMonths, getNanoseconds, getSchemaComparable, getSchemaComparable, getSeconds, getTotalMonths, getTotalSeconds, getYears, hashCode, makeDuration, makeDuration, normalizeZeroDuration, signum, simpleIntegerMethods inherited from class net.sf.saxon.value.AtomicValue
asAtomic, asMapKey, atomize, checkPermittedContents, checkValidInJavascript, effectiveBooleanValue, getCanonicalLexicalRepresentation, getCardinality, getGenre, getItemType, getLength, getStringValue, getStringValueCS, getUType, head, identityHashCode, isIdentical, isIdentical, isNaN, itemAt, iterate, iterator, setTypeLabel, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface net.sf.saxon.expr.sort.AtomicMatchKey
asAtomicMethods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, materializeMethods inherited from interface net.sf.saxon.om.Item
isStreamed, reduce, subsequence, toShortStringMethods inherited from interface java.lang.Iterable
forEach, spliteratorMethods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Method Details
-
makeYearMonthDurationValue
Static factory: create a year-month duration value from a supplied string, in ISO 8601 format [+|-]PnYnM- Parameters:
s- a string in the lexical space of xs:yearMonthDuration.- Returns:
- either a YearMonthDurationValue, or a ValidationFailure if the string was not in the lexical space of xs:yearMonthDuration.
-
copyAsSubType
Create a copy of this atomic value, with a different type label- Overrides:
copyAsSubTypein classDurationValue- Parameters:
typeLabel- the type label of the new copy. The caller is responsible for checking that the value actually conforms to this type.- Returns:
- the copied value
-
getPrimitiveType
Determine the primitive type of the value. This delivers the same answer as getItemType().getPrimitiveItemType(). The primitive types are the 19 primitive types of XML Schema, plus xs:integer, xs:dayTimeDuration and xs:yearMonthDuration, and xs:untypedAtomic. For external objects, the result is AnyAtomicType.- Overrides:
getPrimitiveTypein classDurationValue- Returns:
- the primitive type
-
getPrimitiveStringValue
Convert to string- Overrides:
getPrimitiveStringValuein classDurationValue- Returns:
- ISO 8601 representation.
-
getLengthInMonths
public int getLengthInMonths()Get the number of months in the duration- Returns:
- the number of months in the duration
-
fromMonths
Construct a duration value as a number of months.- Parameters:
months- the number of months (may be negative)- Returns:
- the corresponding xs:yearMonthDuration value
-
multiply
Multiply a duration by an integer- Overrides:
multiplyin classDurationValue- Parameters:
factor- the number to multiply by- Returns:
- the result of the multiplication
- Throws:
XPathException
-
multiply
Multiply duration by a number.- Overrides:
multiplyin classDurationValue- Parameters:
n- the number to multiply by- Returns:
- the result of the multiplication
- Throws:
XPathException
-
divide
Divide duration by a number.- Overrides:
dividein classDurationValue- Parameters:
n- the number to divide by- Returns:
- the result of the division
- Throws:
XPathException
-
divide
Find the ratio between two durations- Overrides:
dividein classDurationValue- Parameters:
other- the dividend- Returns:
- the ratio, as a decimal
- Throws:
XPathException- if an error occurs, for example division by zero or dividing durations of different type
-
add
Add two year-month-durations- Overrides:
addin classDurationValue- Parameters:
other- the duration to be added to this one- Returns:
- the sum of the two durations
- Throws:
XPathException
-
subtract
Subtract two year-month-durations- Overrides:
subtractin classDurationValue- Parameters:
other- the duration to be subtracted from this one- Returns:
- the difference of the two durations
- Throws:
XPathException
-
negate
Negate a duration (same as subtracting from zero, but it preserves the type of the original duration)- Overrides:
negatein classDurationValue- Returns:
- the original duration with its sign reversed, retaining its type
-
compareTo
Compare the value to another duration value- Specified by:
compareToin interfaceComparable<YearMonthDurationValue>- Parameters:
other- The other dateTime value- Returns:
- negative value if this one is the earler, 0 if they are chronologically equal, positive value if this one is the later. For this purpose, dateTime values with an unknown timezone are considered to be UTC values (the Comparable interface requires a total ordering).
- Throws:
ClassCastException- if the other value is not a DateTimeValue (the parameter is declared as Object to satisfy the Comparable interface)
-
getXPathComparable
public AtomicMatchKey getXPathComparable(boolean ordered, StringCollator collator, int implicitTimezone) Get a Comparable value that implements the XPath ordering comparison semantics for this value. Returns null if the value is not comparable according to XPath rules. The default implementation returns the value itself. This is modified for types such as xs:duration which allow ordering comparisons in XML Schema, but not in XPath.- Overrides:
getXPathComparablein classDurationValue- Parameters:
ordered- true if ordered comparisons need to be supportedcollator- for comparing strings - not usedimplicitTimezone- implicit timezone in the dynamic context - not used- Returns:
- an Object whose equals() and hashCode() methods implement the XPath comparison semantics with respect to this atomic value. If ordered is specified, the result will either be null if no ordering is defined, or will be a Comparable
-