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<XPathComparable>
,Iterable<AtomicValue>
,AtomicMatchKey
,XPathComparable
,AtomicSequence
,GroundedValue
,IdentityComparable
,Item
,Sequence
,ConversionResult
,ContextFreeAtomicValue
public final class YearMonthDurationValue
extends DurationValue
implements XPathComparable, ContextFreeAtomicValue
A value of type xs:yearMonthDuration (or a subtype thereof).
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.
-
Nested Class Summary
Nested classes/interfaces inherited from class net.sf.saxon.value.DurationValue
DurationValue.DurationComparable
-
Field Summary
Fields inherited from class net.sf.saxon.value.DurationValue
_months, _nanoseconds, _negative, _seconds
Fields inherited from class net.sf.saxon.value.AtomicValue
typeLabel
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionadd
(DurationValue other) Add two year-month-durationsint
compareTo
(XPathComparable 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 YearMonthDurationValue
fromMonths
(int months) Construct a duration value as a number of months.int
Get the number of months in the durationConvert to stringDetermine the primitive type of the value.Get an XPathComparable object that supports the semantics of context-free eq and lt comparisons between atomic values.getXPathComparable
(StringCollator collator, int implicitTimezone) Get an object value that implements the XPath equality and ordering comparison semantics for this value.getXPathMatchKey
(StringCollator collator, int implicitTimezone) Get a Comparable value that implements the XPath ordering comparison semantics for this value.static ConversionResult
Static 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 integerMultiply duration by a decimal.negate()
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, getSeconds, getTotalMonths, getTotalSeconds, getYears, hashCode, isNegativeDuration, makeDuration, makeDuration, signum, simpleInteger
Methods inherited from class net.sf.saxon.value.AtomicValue
asAtomic, asMapKey, atomize, checkPermittedContents, checkValidInJavascript, effectiveBooleanValue, getCanonicalLexicalRepresentation, getCardinality, getGenre, getItemType, getLength, getUnicodeStringValue, getUType, head, identityHashCode, isIdentical, isIdentical, isNaN, isUntypedAtomic, itemAt, iterate, iterator, show, toShortString, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface net.sf.saxon.expr.sort.AtomicMatchKey
asAtomic
Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, materialize
Methods inherited from interface net.sf.saxon.om.Item
getStringValue, isStreamed, reduce, subsequence
Methods inherited from interface java.lang.Iterable
forEach, spliterator
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
Constructor Details
-
YearMonthDurationValue
-
-
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:
copyAsSubType
in 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:
getPrimitiveType
in classDurationValue
- Returns:
- the primitive type
-
getPrimitiveStringValue
Convert to string- Overrides:
getPrimitiveStringValue
in 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:
multiply
in classDurationValue
- Parameters:
factor
- the number to multiply by- Returns:
- the result of the multiplication
- Throws:
XPathException
- if an error is detected
-
multiply
Multiply duration by a number.- Overrides:
multiply
in classDurationValue
- Parameters:
n
- the number to multiply by- Returns:
- the result of the multiplication
- Throws:
XPathException
- if an error is detected
-
multiply
Multiply duration by a decimal.- Overrides:
multiply
in classDurationValue
- Parameters:
n
- the number to multiply by- Returns:
- the result of the multiplication
- Throws:
XPathException
- if an error is detected
-
divide
Divide duration by a number.- Overrides:
divide
in classDurationValue
- Parameters:
n
- the number to divide by- Returns:
- the result of the division
- Throws:
XPathException
- if an error is detected
-
divide
Find the ratio between two durations- Overrides:
divide
in 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:
add
in classDurationValue
- Parameters:
other
- the duration to be added to this one- Returns:
- the sum of the two durations
- Throws:
XPathException
- if an error is detected
-
subtract
Subtract two year-month-durations- Overrides:
subtract
in classDurationValue
- Parameters:
other
- the duration to be subtracted from this one- Returns:
- the difference of the two durations
- Throws:
XPathException
- if an error is detected
-
negate
Negate a duration (same as subtracting from zero, but it preserves the type of the original duration)- Overrides:
negate
in classDurationValue
- Returns:
- the original duration with its sign reversed, retaining its type
-
compareTo
Compare the value to another duration value- Specified by:
compareTo
in interfaceComparable<XPathComparable>
- 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
Description copied from class:AtomicValue
Get an object value that implements the XPath equality and ordering comparison semantics for this value. A collation is supplied for comparing strings, and an implicit timezone for comparing date/time values that have no saved timezone. An atomic value may return itself as the result, provided that its ordering rules are independent of the collation and timezone, and provided that it implements the XPathComparable interface: which means that its compareTo, equals, and hashCode methods must be compatible with the rules for XPath value comparisons.- Overrides:
getXPathComparable
in classDurationValue
- Parameters:
collator
- the collation to be used when comparing stringsimplicitTimezone
- the implicit timezone in the dynamic context, used when comparing dates/times with and without timezone- Returns:
- an Object that implements the XPath value comparison semantics with respect to this atomic value. For an atomic type that is not ordered (according to XPath rules), return null.
-
getXPathComparable
Description copied from interface:ContextFreeAtomicValue
Get an XPathComparable object that supports the semantics of context-free eq and lt comparisons between atomic values. Note that in many cases the returned XPathComparable will be the AtomicValue itself; however because of the constraints of the genericComparable
interface, this cannot be assumed.- Specified by:
getXPathComparable
in interfaceContextFreeAtomicValue
- Returns:
- an XPathComparable that can be used in comparisons with other atomic values.
-
getXPathMatchKey
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:
getXPathMatchKey
in classDurationValue
- Parameters:
collator
- 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
-