Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
net.sf.saxon.value.Value
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.DurationValue
net.sf.saxon.value.DayTimeDurationValue
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 |
Constructor Summary | |
|
Method Summary | |
DurationValue |
|
int |
|
Object |
|
AtomicValue |
|
DecimalValue |
|
static DayTimeDurationValue |
|
static DayTimeDurationValue |
|
static DayTimeDurationValue |
|
long |
|
long |
|
double |
|
BuiltInAtomicType |
|
CharSequence |
|
Object |
|
static ConversionResult |
|
DurationValue |
|
DurationValue |
|
DurationValue |
|
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 |
public DayTimeDurationValue(int sign, int days, int hours, int minutes, long seconds, int microseconds) throws IllegalArgumentException
Create a dayTimeDuration given the number of days, hours, minutes, and seconds. This constructor performs no validation. The components (apart from sign) must all be non-negative integers; they need not be normalized (for example, 36 hours is acceptable)
- Parameters:
sign
- positive number for positive durations, negative for negative duratoinsdays
- number of dayshours
- number of hoursminutes
- number of minutesseconds
- number of secondsmicroseconds
- number of microseconds
public DurationValue add(DurationValue other) throws XPathException
Add two dayTimeDurations
- Overrides:
- add in interface DurationValue
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).
public Object convertToJava(Class target, XPathContext context) throws XPathException
Convert to Java object (for passing to external functions)
- Overrides:
- convertToJava in interface DurationValue
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.
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
-
public static DayTimeDurationValue fromMicroseconds(long microseconds) throws IllegalArgumentException
Construct a duration value as a number of microseconds.
- Parameters:
microseconds
- the number of microseconds in the duration. The maximum and minimum limits are such that the number of days in the duration must fit in a 32-bit signed integer.
- Returns:
- the xs:dayTimeDuration represented by the given number of microseconds
public static DayTimeDurationValue fromMilliseconds(long milliseconds) throws ValidationException
Construct a duration value as a number of milliseconds.
- Parameters:
milliseconds
- the number of milliseconds in the duration (may be negative)
- Returns:
- the corresponding xs:dayTimeDuration value
- Throws:
ValidationException
- if implementation-defined limits are exceeded, specifically if the total number of seconds exceeds 2^63.
public static DayTimeDurationValue fromSeconds(BigDecimal seconds) throws XPathException
Construct a duration value as a number of seconds.
- Parameters:
seconds
- the number of seconds in the duration. May be negative
- Returns:
- the xs:dayTimeDuration value with the specified length
public long getLengthInMicroseconds()
Get length of duration in microseconds, as a long
- Returns:
- the length in microseconds
public long getLengthInMilliseconds()
Get length of duration in milliseconds, as a long
- Returns:
- the length of the duration rounded to milliseconds (may be negative)
public double getLengthInSeconds()
Get length of duration in seconds
- Overrides:
- getLengthInSeconds in interface DurationValue
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
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.
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
- true if an ordered comparable is neededcollator
- Collation used for string comparisoncontext
- XPath dynamic context
public static ConversionResult makeDayTimeDurationValue(CharSequence s)
Factory method: create a duration value from a supplied string, in ISO 8601 format [-]PnDTnHnMnS
- Parameters:
s
- the lexical representation of the xs:dayTimeDuration value
- Returns:
- a DayTimeDurationValue if the format is correct, or a ValidationErrorValue if not
public DurationValue multiply(double n) throws XPathException
Multiply duration by a number. This is also used when dividing a duration by a number.
- Overrides:
- multiply in interface DurationValue
public DurationValue negate() throws IllegalArgumentException
Negate a duration (same as subtracting from zero, but it preserves the type of the original duration)
- Overrides:
- negate in interface DurationValue
public DurationValue subtract(DurationValue other) throws XPathException
Subtract two dayTime-durations
- Overrides:
- subtract in interface DurationValue