net.sf.saxon.value

Class YearMonthDurationValue

Implemented Interfaces:
Comparable, ConversionResult, GroundedValue, Item, PullEvent, Serializable, SequenceIterable, ValueRepresentation

public final class YearMonthDurationValue
extends DurationValue
implements Comparable

A value of type xs:yearMonthDuration

Field Summary

Fields inherited from class net.sf.saxon.value.DurationValue

microseconds, months, negative, seconds

Fields inherited from class net.sf.saxon.value.AtomicValue

typeLabel

Fields inherited from class net.sf.saxon.value.Value

EMPTY_CLASS_ARRAY, INDETERMINATE_ORDERING

Fields inherited from interface net.sf.saxon.om.ValueRepresentation

EMPTY_VALUE_ARRAY

Method Summary

DurationValue
add(DurationValue other)
Add two year-month-durations
int
compareTo(Object other)
Compare the value to another duration value
Object
convertToJava(Class target, XPathContext context)
Convert to Java object (for passing to external functions)
AtomicValue
copyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a different type label
DecimalValue
divide(DurationValue other)
Find the ratio between two durations
static YearMonthDurationValue
fromMonths(int months)
Construct a duration value as a number of months.
int
getLengthInMonths()
Get the number of months in the duration
BuiltInAtomicType
getPrimitiveType()
Determine the primitive type of the value.
CharSequence
getStringValueCS()
Convert to string
Object
getXPathComparable(boolean ordered, StringCollator collator, XPathContext context)
Get a Comparable value that implements the XPath ordering comparison semantics for this value.
static ConversionResult
makeYearMonthDurationValue(CharSequence s)
Static factory: create a duration value from a supplied string, in ISO 8601 format [+|-]PnYnM
DurationValue
multiply(double n)
Multiply duration by a number.
DurationValue
negate()
Negate a duration (same as subtracting from zero, but it preserves the type of the original duration)
DurationValue
subtract(DurationValue other)
Subtract two year-month-durations

Methods inherited from class net.sf.saxon.value.DurationValue

add, badDuration, convertPrimitive, convertToJava, copyAsSubType, divide, equals, getComponent, getDays, getHours, getLengthInSeconds, getMicroseconds, getMinutes, getMonths, getPrimitiveType, getSchemaComparable, getSchemaComparable, getSeconds, getStringValue, getStringValueCS, getXPathComparable, getYears, hashCode, makeDuration, multiply, negate, normalizeDuration, normalizeZeroDuration, signum, simpleInteger, subtract

Methods inherited from class net.sf.saxon.value.AtomicValue

asAtomic, checkPermittedContents, convert, convert, convertPrimitive, copyAsSubType, effectiveBooleanValue, equals, getCardinality, getComponent, getItemType, getLength, getPrimitiveType, getSchemaComparable, getStringValue, getStringValueCS, getTypeLabel, getTypedValue, getXPathComparable, isNaN, itemAt, iterate, process, setTypeLabel, subsequence, toString

Methods inherited from class net.sf.saxon.value.Value

asItem, asItem, asIterator, asValue, checkPermittedContents, convertJavaObjectToXPath, convertToJava, convertToJava, effectiveBooleanValue, equals, fromItem, getCanonicalLexicalRepresentation, getCardinality, getItemType, getIterator, getLength, getSchemaComparable, getStringValue, getStringValueCS, itemAt, iterate, iterate, makeQNameValue, process, reduce, stringToNumber, toString

Method Details

add

public DurationValue add(DurationValue other)
            throws XPathException
Add two year-month-durations
Overrides:
add in interface DurationValue

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

convertToJava

public Object convertToJava(Class target,
                            XPathContext context)
            throws XPathException
Convert to Java object (for passing to external functions)
Overrides:
convertToJava in interface DurationValue

copyAsSubType

public AtomicValue copyAsSubType(AtomicType typeLabel)
Create a copy of this atomic value, with a different type label
Overrides:
copyAsSubType in interface DurationValue
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)
            throws XPathException
Find the ratio between two durations
Overrides:
divide in interface DurationValue
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

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.
Overrides:
getPrimitiveType in interface DurationValue

getStringValueCS

public CharSequence getStringValueCS()
Convert to string
Specified by:
getStringValueCS in interface Item
getStringValueCS in interface ValueRepresentation
Overrides:
getStringValueCS in interface DurationValue
Returns:
ISO 8601 representation.

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.
Overrides:
getXPathComparable in interface DurationValue
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)
            throws XPathException
Multiply duration by a number. Also used when dividing a duration by a number
Overrides:
multiply in interface DurationValue

negate

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

subtract

public DurationValue subtract(DurationValue other)
            throws XPathException
Subtract two year-month-durations
Overrides:
subtract in interface DurationValue