net.sf.saxon.xqj

Class SaxonDuration


public class SaxonDuration
extends Duration

Saxon implementation of the JAXP class javax.xml.datatype.Duration. This is currently used only by the XQJ interface for XQuery: the normal representation of a duration in Saxon is the class DurationValue.

The JAXP specification for this class defines it in terms of XML Schema 1.0 semantics. This defines a structure with six independent components (year, month, day, hour, minute, second). This implementation is more aligned to the XPath 2.0 semantics of the data type, which essentially defines duration as an integer number of months plus a decimal number of seconds.

Constructor Summary

SaxonDuration(DurationValue duration)
Create a SaxonDuration that wraps a supplied DurationValue

Method Summary

Duration
add(Duration rhs)
Computes a new duration whose value is this+rhs.
void
addTo(Calendar calendar)
Adds this duration to a java.util.Calendar object.
int
compare(Duration rhs)
Partial order relation comparison with this Duration instance.
DurationValue
getDurationValue()
Get the underlying DurationValue
Number
getField(DatatypeConstants.Field field)
Gets the value of a field.
int
getSign()
Returns the sign of this duration in -1,0, or 1.
QName
getXMLSchemaType()
Get the type of this duration, as one of the values xs:duration, xs:dayTimeDuration, or xs:yearMonthDuration.
int
hashCode()
Returns a hash code consistent with the definition of the equals method.
boolean
isSet(DatatypeConstants.Field field)
Checks if a field is set.
Duration
multiply(BigDecimal factor)
Computes a new duration whose value is factor times longer than the value of this duration.
Duration
negate()
Returns a new Duration object whose value is -this.
Duration
normalizeWith(Calendar startTimeInstant)
Converts the years and months fields into the days field by using a specific time instant as the reference point.
Duration
subtract(Duration rhs)
Computes a new duration whose value is this-rhs.

Constructor Details

SaxonDuration

public SaxonDuration(DurationValue duration)
Create a SaxonDuration that wraps a supplied DurationValue
Parameters:
duration - the value to be wrapped.

Method Details

add

public Duration add(Duration rhs)
Computes a new duration whose value is this+rhs.

This implementation follows the XPath semantics. This means that the operation will fail if the duration is not a yearMonthDuration or a dayTimeDuration.

Parameters:
rhs - Duration to add to this Duration
Returns:
non-null valid Duration object.
See Also:
subtract(javax.xml.datatype.Duration)

addTo

public void addTo(Calendar calendar)
Adds this duration to a java.util.Calendar object.

Calls java.util.Calendar.add(int,int) in the order of YEARS, MONTHS, DAYS, HOURS, MINUTES, SECONDS, and MILLISECONDS if those fields are present. Because the java.util.Calendar class uses int to hold values, there are cases where this method won't work correctly (for example if values of fields exceed the range of int.)

Also, since this duration class is a Gregorian duration, this method will not work correctly if the given java.util.Calendar object is based on some other calendar systems.

Any fractional parts of this Duration object beyond milliseconds will be simply ignored. For example, if this duration is "P1.23456S", then 1 is added to SECONDS, 234 is added to MILLISECONDS, and the rest will be unused.

Note that because java.util.Calendar.add(int, int) is using int, Duration with values beyond the range of int in its fields will cause overflow/underflow to the given java.util.Calendar. javax.xml.datatype.XMLGregorianCalendar.add(javax.xml.datatype.Duration) provides the same basic operation as this method while avoiding the overflow/underflow issues.

Parameters:
calendar - A calendar object whose value will be modified.

compare

public int compare(Duration rhs)
Partial order relation comparison with this Duration instance.

This implementation follows the XPath semantics. This means that the result is defined only for dayTimeDuration and yearMonthDuration values, and the result is never indeterminate.

Return:

  • javax.xml.datatype.DatatypeConstants.LESSER if this Duration is shorter than duration parameter
  • javax.xml.datatype.DatatypeConstants.EQUAL if this Duration is equal to duration parameter
  • javax.xml.datatype.DatatypeConstants.GREATER if this Duration is longer than duration parameter
  • javax.xml.datatype.DatatypeConstants.INDETERMINATE if a conclusive partial order relation cannot be determined
Parameters:
rhs - duration to compare
Returns:
the relationship between this Durationand duration parameter as javax.xml.datatype.DatatypeConstants.LESSER, javax.xml.datatype.DatatypeConstants.EQUAL, javax.xml.datatype.DatatypeConstants.GREATER or javax.xml.datatype.DatatypeConstants.INDETERMINATE.
See Also:
isShorterThan(javax.xml.datatype.Duration), isLongerThan(javax.xml.datatype.Duration)

getDurationValue

public DurationValue getDurationValue()
Get the underlying DurationValue
Returns:
the underlying DurationValue

getField

public Number getField(DatatypeConstants.Field field)
Gets the value of a field.

Fields of a duration object may contain arbitrary large value. Therefore this method is designed to return a Number object.

In case of YEARS, MONTHS, DAYS, HOURS, and MINUTES, the returned number will be a non-negative integer. In case of seconds, the returned number may be a non-negative decimal value.

The Saxon implementation of duration uses normalized values. This means that the YEARS and DAYS fields may be arbitrarily large, but other components will be limited in size: for example MINUTES will never exceed 60 and MONTHS will never exceed 12.

Parameters:
field - one of the six Field constants (YEARS, MONTHS, DAYS, HOURS, MINUTES, or SECONDS.)
Returns:
If the specified field is present, this method returns a non-null non-negative Number object that represents its value. If it is not present, return null. For YEARS, MONTHS, DAYS, HOURS, and MINUTES, this method returns a java.math.BigInteger object. For SECONDS, this method returns a java.math.BigDecimal.

getSign

public int getSign()
Returns the sign of this duration in -1,0, or 1.
Returns:
-1 if this duration is negative, 0 if the duration is zero, and 1 if the duration is positive.

getXMLSchemaType

public QName getXMLSchemaType()
Get the type of this duration, as one of the values xs:duration, xs:dayTimeDuration, or xs:yearMonthDuration. (Note that the XML Schema namespace URI is used, whereas the current implementation of the superclass uses a provisional URI allocated in a 2003 W3C working draft)
Returns:
the type of this duration, as one of the values xs:duration, xs:dayTimeDuration, or xs:yearMonthDuration

hashCode

public int hashCode()
Returns a hash code consistent with the definition of the equals method.
See Also:
Object.hashCode()

isSet

public boolean isSet(DatatypeConstants.Field field)
Checks if a field is set. In this implementation, all fields are always set.
Parameters:
field - one of the six Field constants (YEARS, MONTHS, DAYS, HOURS, MINUTES, or SECONDS.)
Returns:
This implementation always returns true.

multiply

public Duration multiply(BigDecimal factor)
Computes a new duration whose value is factor times longer than the value of this duration.

This implementation follows the XPath semantics. This means that it is defined only on yearMonthDuration and dayTimeDuration. Other cases produce an IllegalStateException.

Parameters:
factor - to multiply by
Returns:
returns a non-null valid Duration object

negate

public Duration negate()
Returns a new Duration object whose value is -this.

Since the Duration class is immutable, this method doesn't change the value of this object. It simply computes a new Duration object and returns it.

Returns:
always return a non-null valid Duration object.

normalizeWith

public Duration normalizeWith(Calendar startTimeInstant)
Converts the years and months fields into the days field by using a specific time instant as the reference point.

This implementation does not support this method

Parameters:
startTimeInstant - Calendar reference point.
Returns:
Duration of years and months of this Duration as days.

subtract

public Duration subtract(Duration rhs)
Computes a new duration whose value is this-rhs.

This implementation follows the XPath semantics. This means that the operation will fail if the duration is not a yearMonthDuration or a dayTimeDuration.

Parameters:
rhs - Duration to subtract from this Duration
Returns:
non-null valid Duration object.
See Also:
add(javax.xml.datatype.Duration)