Package net.sf.saxon.value
Class MonthDurationValue
- java.lang.Object
-
- net.sf.saxon.value.Value
-
- net.sf.saxon.value.AtomicValue
-
- net.sf.saxon.value.DurationValue
-
- net.sf.saxon.value.MonthDurationValue
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable
,Expression
,Item
,ValueRepresentation
public final class MonthDurationValue extends DurationValue implements java.lang.Comparable
A value of type xsd:yearMonthDuration- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class net.sf.saxon.value.DurationValue
days, hours, microseconds, minutes, months, negative, normalized, seconds, years
-
Fields inherited from class net.sf.saxon.value.Value
EMPTY_CLASS_ARRAY
-
Fields inherited from interface net.sf.saxon.expr.Expression
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD
-
Fields inherited from interface net.sf.saxon.om.ValueRepresentation
EMPTY_VALUE_ARRAY
-
-
Constructor Summary
Constructors Constructor Description MonthDurationValue(java.lang.CharSequence s)
Constructor: create a duration value from a supplied string, in ISO 8601 format [+|-]PnYnM
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description DurationValue
add(DurationValue other)
Add two year-month-durationsint
compareTo(java.lang.Object other)
Compare the value to another duration valuejava.lang.Object
convertToJava(java.lang.Class target, XPathContext context)
Convert to Java object (for passing to external functions)DecimalValue
divide(DurationValue other)
Find the ratio between two durationsstatic MonthDurationValue
fromMonths(int months)
Construct a duration value as a number of months.ItemType
getItemType(TypeHierarchy th)
Determine the data type of the exprssionint
getLengthInMonths()
Get the number of months in the durationjava.lang.CharSequence
getStringValueCS()
Convert to stringDurationValue
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)void
normalize()
Normalize the value, for example 90M becomes 1H30MDurationValue
subtract(DurationValue other)
Subtract two year-month-durations-
Methods inherited from class net.sf.saxon.value.DurationValue
badDuration, convertPrimitive, equals, getComponent, getLengthInSeconds, getStringValue, hashCode, normalizeDuration, normalizeZeroDuration, signum
-
Methods inherited from class net.sf.saxon.value.AtomicValue
checkPermittedContents, convert, convert, display, effectiveBooleanValue, evaluateAsString, evaluateItem, getCardinality, getImplementationMethod, getLength, getPrimitiveValue, getTypedValue, hasBuiltInType, iterate, process, toString
-
Methods inherited from class net.sf.saxon.value.Value
asItem, asIterator, asValue, convert, convertJavaObjectToXPath, getDependencies, getIterator, getParentExpression, getSpecialProperties, itemAt, iterateSubExpressions, makeQNameValue, optimize, promote, reduce, simplify, stringToNumber, typeCheck
-
-
-
-
Constructor Detail
-
MonthDurationValue
public MonthDurationValue(java.lang.CharSequence s) throws XPathException
Constructor: create a duration value from a supplied string, in ISO 8601 format [+|-]PnYnM- Throws:
XPathException
-
-
Method Detail
-
getStringValueCS
public java.lang.CharSequence getStringValueCS()
Convert to string- Specified by:
getStringValueCS
in interfaceItem
- Specified by:
getStringValueCS
in interfaceValueRepresentation
- Overrides:
getStringValueCS
in classDurationValue
- Returns:
- ISO 8601 representation.
- See Also:
Item.getStringValue()
-
normalize
public void normalize()
Normalize the value, for example 90M becomes 1H30M
-
getLengthInMonths
public int getLengthInMonths()
Get the number of months in the duration
-
fromMonths
public static MonthDurationValue fromMonths(int months)
Construct a duration value as a number of months.
-
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 classDurationValue
- Throws:
XPathException
-
divide
public DecimalValue divide(DurationValue other) throws XPathException
Find the ratio between two durations- Overrides:
divide
in classDurationValue
- Parameters:
other
- the dividend- Returns:
- the ratio, as a decimal
- Throws:
XPathException
-
add
public DurationValue add(DurationValue other) throws XPathException
Add two year-month-durations- Overrides:
add
in classDurationValue
- Throws:
XPathException
-
subtract
public DurationValue subtract(DurationValue other) throws XPathException
Subtract two year-month-durations- Overrides:
subtract
in classDurationValue
- Throws:
XPathException
-
negate
public DurationValue negate()
Negate a duration (same as subtracting from zero, but it preserves the type of the original duration)- Overrides:
negate
in classDurationValue
-
getItemType
public ItemType getItemType(TypeHierarchy th)
Determine the data type of the exprssion- Specified by:
getItemType
in interfaceExpression
- Overrides:
getItemType
in classDurationValue
- Parameters:
th
-- Returns:
- Type.YEAR_MONTH_DURATION,
-
convertToJava
public java.lang.Object convertToJava(java.lang.Class target, XPathContext context) throws XPathException
Convert to Java object (for passing to external functions)- Overrides:
convertToJava
in classDurationValue
- Throws:
XPathException
-
compareTo
public int compareTo(java.lang.Object other)
Compare the value to another duration value- Specified by:
compareTo
in interfacejava.lang.Comparable
- 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:
java.lang.ClassCastException
- if the other value is not a DateTimeValue (the parameter is declared as Object to satisfy the Comparable interface)
-
-