net.sf.saxon.value

Class YearMonthDurationValue

public final class YearMonthDurationValue extends DurationValue implements Comparable

A value of type xs:yearMonthDuration
Method Summary
DurationValueadd(DurationValue other)
Add two year-month-durations
intcompareTo(Object other)
Compare the value to another duration value
AtomicValuecopyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a different type label
DecimalValuedivide(DurationValue other)
Find the ratio between two durations
static YearMonthDurationValuefromMonths(int months)
Construct a duration value as a number of months.
intgetLengthInMonths()
Get the number of months in the duration
CharSequencegetPrimitiveStringValue()
Convert to string
BuiltInAtomicTypegetPrimitiveType()
Determine the primitive type of the value.
ObjectgetXPathComparable(boolean ordered, StringCollator collator, XPathContext context)
Get a Comparable value that implements the XPath ordering comparison semantics for this value.
static ConversionResultmakeYearMonthDurationValue(CharSequence s)
Static factory: create a duration value from a supplied string, in ISO 8601 format [+|-]PnYnM
DurationValuemultiply(double n)
Multiply duration by a number.
DurationValuenegate()
Negate a duration (same as subtracting from zero, but it preserves the type of the original duration)
DurationValuesubtract(DurationValue other)
Subtract two year-month-durations

Method Detail

add

public DurationValue add(DurationValue other)
Add two year-month-durations

compareTo

public int compareTo(Object other)
Compare the value to another duration value

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)

copyAsSubType

public AtomicValue copyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a different type label

Parameters: typeLabel the type label of the new copy. The caller is responsible for checking that the value actually conforms to this type.

divide

public DecimalValue divide(DurationValue other)
Find the ratio between two durations

Parameters: other the dividend

Returns: the ratio, as a decimal

Throws: XPathException

fromMonths

public static YearMonthDurationValue fromMonths(int months)
Construct a duration value as a number of months.

Parameters: months the number of months (may be negative)

Returns: the corresponding xs:yearMonthDuration value

getLengthInMonths

public int getLengthInMonths()
Get the number of months in the duration

Returns: the number of months in the duration

getPrimitiveStringValue

public CharSequence getPrimitiveStringValue()
Convert to string

Returns: ISO 8601 representation.

getPrimitiveType

public BuiltInAtomicType 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.

getXPathComparable

public Object getXPathComparable(boolean ordered, StringCollator collator, XPathContext context)
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.

Parameters: ordered collator context

makeYearMonthDurationValue

public static ConversionResult makeYearMonthDurationValue(CharSequence s)
Static factory: create a 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.

multiply

public DurationValue multiply(double n)
Multiply duration by a number. Also used when dividing a duration by a number

negate

public DurationValue negate()
Negate a duration (same as subtracting from zero, but it preserves the type of the original duration)

subtract

public DurationValue subtract(DurationValue other)
Subtract two year-month-durations