net.sf.saxon.value
Class TimeValue

java.lang.Object
  |
  +--net.sf.saxon.value.Value
        |
        +--net.sf.saxon.value.AtomicValue
              |
              +--net.sf.saxon.value.CalendarValue
                    |
                    +--net.sf.saxon.value.TimeValue
All Implemented Interfaces:
java.lang.Comparable, Expression, Item, java.io.Serializable

public final class TimeValue
extends CalendarValue
implements java.lang.Comparable

A value of type time

See Also:
Serialized Form

Constructor Summary
TimeValue(java.lang.CharSequence s)
          Constructor: create a dateTime value from a supplied string, in ISO 8601 format
 
Method Summary
 int compareTo(java.lang.Object other)
          Compare the value to another dateTime value
 int conversionPreference(java.lang.Class required)
          Get conversion preference for this value to a Java class.
 AtomicValue convert(int requiredType)
          Convert to target data type
 java.lang.Object convertToJava(java.lang.Class target)
          Convert to Java object (for passing to external functions)
 void display(int level, NamePool pool)
          Diagnostic print of expression structure
 boolean equals(java.lang.Object other)
           
 AtomicValue getComponent(int component)
          Get a component of the value.
 int getItemType()
          Determine the data type of the exprssion
 java.lang.String getStringValue()
          Convert to string
 int hashCode()
           
 CalendarValue removeTimezone()
          Return a dateTime with the same localized value, but without the timezone component
 CalendarValue setTimezone(SecondsDurationValue tz)
          Return a date, time, or dateTime with the same normalized value, but in a different timezone
 
Methods inherited from class net.sf.saxon.value.CalendarValue
add, subtract
 
Methods inherited from class net.sf.saxon.value.AtomicValue
effectiveBooleanValue, evaluateAsString, evaluateItem, getCardinality, getTypedValue, iterate
 
Methods inherited from class net.sf.saxon.value.Value
analyze, asItem, asValue, collapseWhitespace, getDependencies, getSpecialProperties, getSubExpressions, inverse, normalizeWhitespace, promote, simplify, stringToInteger, stringToNumber, trimWhitespace
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TimeValue

public TimeValue(java.lang.CharSequence s)
          throws XPathException
Constructor: create a dateTime value from a supplied string, in ISO 8601 format

Method Detail

convert

public AtomicValue convert(int requiredType)
                    throws XPathException
Convert to target data type

Specified by:
convert in class AtomicValue
Parameters:
requiredType - an integer identifying the required atomic type
Returns:
an AtomicValue, a value of the required type
Throws:
XPathException - if the conversion is not possible

getStringValue

public java.lang.String getStringValue()
Convert to string

Specified by:
getStringValue in interface Item
Returns:
ISO 8601 representation, in the localized timezone (the timezone held within the value).

getItemType

public int getItemType()
Determine the data type of the exprssion

Specified by:
getItemType in interface Item
Returns:
Type.TIME,
See Also:
Type

removeTimezone

public CalendarValue removeTimezone()
                             throws XPathException
Return a dateTime with the same localized value, but without the timezone component

Specified by:
removeTimezone in class CalendarValue
Returns:
the result of removing the timezone
Throws:
XPathException

setTimezone

public CalendarValue setTimezone(SecondsDurationValue tz)
                          throws XPathException
Return a date, time, or dateTime with the same normalized value, but in a different timezone

Specified by:
setTimezone in class CalendarValue
Returns:
the date/time in the new timezone
Throws:
XPathException

conversionPreference

public int conversionPreference(java.lang.Class required)
Get conversion preference for this value to a Java class. A low result indicates higher preference.

Specified by:
conversionPreference in class Value

convertToJava

public java.lang.Object convertToJava(java.lang.Class target)
                               throws XPathException
Convert to Java object (for passing to external functions)

Specified by:
convertToJava in class Value
Parameters:
target - The class required by the external function
Returns:
an object of the target class
XPathException

getComponent

public AtomicValue getComponent(int component)
                         throws XPathException
Get a component of the value. Returns null if the timezone component is requested and is not present.

Overrides:
getComponent in class AtomicValue
XPathException

compareTo

public int compareTo(java.lang.Object other)
Compare the value to another dateTime value

Specified by:
compareTo in interface java.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)

equals

public boolean equals(java.lang.Object other)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

display

public void display(int level,
                    NamePool pool)
Diagnostic print of expression structure

Specified by:
display in interface Expression
Parameters:
level - indentation level for this expression