|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectnet.sf.saxon.value.Value<AtomicValue>
net.sf.saxon.value.AtomicValue
net.sf.saxon.value.CalendarValue
net.sf.saxon.value.TimeValue
public final class TimeValue
A value of type xs:time
| Field Summary |
|---|
| Fields inherited from class net.sf.saxon.value.CalendarValue |
|---|
NO_TIMEZONE |
| Fields inherited from class net.sf.saxon.value.AtomicValue |
|---|
typeLabel |
| Fields inherited from class net.sf.saxon.value.Value |
|---|
INDETERMINATE_ORDERING |
| Fields inherited from interface net.sf.saxon.om.ValueRepresentation |
|---|
EMPTY_VALUE_ARRAY |
| Constructor Summary | |
|---|---|
TimeValue(byte hour,
byte minute,
byte second,
int microsecond,
int tz)
Construct a time value given the hour, minute, second, and microsecond components. |
|
TimeValue(GregorianCalendar calendar,
int tz)
Constructor: create a time value given a Java calendar object |
|
| Method Summary | |
|---|---|
CalendarValue |
add(DurationValue duration)
Add a duration to a dateTime |
CalendarValue |
adjustTimezone(int timezone)
Return a new time with the same normalized value, but in a different timezone. |
int |
compareTo(CalendarValue other,
XPathContext context)
Compare the value to another dateTime value |
int |
compareTo(Object other)
Compare the value to another dateTime value |
AtomicValue |
copyAsSubType(AtomicType typeLabel)
Make a copy of this time value, but with a different type label |
boolean |
equals(Object other)
The equals() methods on atomic values is defined to follow the semantics of eq when applied to two atomic values. |
GregorianCalendar |
getCalendar()
Get a Java Calendar object corresponding to this time, on a reference date |
CharSequence |
getCanonicalLexicalRepresentation()
Get the canonical lexical representation as defined in XML Schema. |
ComparisonKey |
getComparisonKey(XPathContext context)
Get a comparison key for this value. |
AtomicValue |
getComponent(int component)
Get a component of the value. |
byte |
getHour()
Get the hour component, 0-23 |
int |
getMicrosecond()
Get the microsecond component, 0-999999 |
byte |
getMinute()
Get the minute component, 0-59 |
CharSequence |
getPrimitiveStringValue()
Convert to string |
BuiltInAtomicType |
getPrimitiveType()
Determine the primitive type of the value. |
Comparable |
getSchemaComparable()
Get a Comparable value that implements the XML Schema ordering comparison semantics for this value. |
byte |
getSecond()
Get the second component, 0-59 |
int |
hashCode()
|
static ConversionResult |
makeTimeValue(CharSequence s)
Static factory method: create a time value from a supplied string, in ISO 8601 format |
DayTimeDurationValue |
subtract(CalendarValue other,
XPathContext context)
Determine the difference between two points in time, as a duration |
DateTimeValue |
toDateTime()
Convert to a DateTime value. |
| Methods inherited from class net.sf.saxon.value.CalendarValue |
|---|
adjustTimezone, appendTimezone, appendTimezone, getTimezoneInMinutes, getXPathComparable, hasTimezone, isIdentical, makeCalendarValue, removeTimezone, setTimezoneInMinutes |
| Methods inherited from class net.sf.saxon.value.AtomicValue |
|---|
asAtomic, checkPermittedContents, effectiveBooleanValue, getCardinality, getItemType, getLength, getStringValue, getStringValueCS, getTypedValue, getTypeLabel, isNaN, itemAt, iterate, process, setTypeLabel, subsequence, toString |
| Methods inherited from class net.sf.saxon.value.Value |
|---|
asItem, asItem, asIterator, asValue, convertToJava, fromItem, getIterator, getSequenceLength, reduce |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public TimeValue(byte hour,
byte minute,
byte second,
int microsecond,
int tz)
hour - the hour value, 0-23minute - the minutes value, 0-59second - the seconds value, 0-59microsecond - the number of microseconds, 0-999999tz - the timezone displacement in minutes from UTC. Supply the value
CalendarValue.NO_TIMEZONE if there is no timezone component.
public TimeValue(GregorianCalendar calendar,
int tz)
calendar - holds the date and timetz - the timezone offset in minutes, or NO_TIMEZONE indicating that there is no timezone| Method Detail |
|---|
public static ConversionResult makeTimeValue(CharSequence s)
s - the time in the lexical format hh:mm:ss[.ffffff] followed optionally by
timezone in the form [+-]hh:mm or Z
public BuiltInAtomicType getPrimitiveType()
getPrimitiveType in class AtomicValuepublic byte getHour()
public byte getMinute()
public byte getSecond()
public int getMicrosecond()
public CharSequence getPrimitiveStringValue()
getPrimitiveStringValue in class AtomicValuepublic CharSequence getCanonicalLexicalRepresentation()
getCanonicalLexicalRepresentation in class Value<AtomicValue>public DateTimeValue toDateTime()
toDateTime in class CalendarValuepublic GregorianCalendar getCalendar()
getCalendar in class CalendarValuepublic AtomicValue copyAsSubType(AtomicType typeLabel)
copyAsSubType in class AtomicValuetypeLabel - the new type label. This must be a subtype of xs:time.
public CalendarValue adjustTimezone(int timezone)
adjustTimezone in class CalendarValuetimezone - the new timezone offset, in minutes
public AtomicValue getComponent(int component)
throws XPathException
getComponent in class AtomicValuecomponent - identifies the required component, as a constant defined in class
Component, for example Component.HOURS
XPathException - if a dynamic error occurspublic int compareTo(Object other)
compareTo in interface Comparableother - The other dateTime value
ClassCastException - if the other value is not a TimeValue (the parameter
is declared as Object to satisfy the Comparable interface)
public int compareTo(CalendarValue other,
XPathContext context)
throws NoDynamicContextException
compareTo in class CalendarValueother - The other dateTime valuecontext - the XPath dynamic evaluation context
ClassCastException - if the other value is not a DateTimeValue (the parameter
is declared as Object to satisfy the Comparable interface)
NoDynamicContextException - if the implicit timezone is required and is not available
(because the function is called at compile time)public Comparable getSchemaComparable()
AtomicValueIn the case of data types that are partially ordered, the returned Comparable extends the standard
semantics of the compareTo() method by returning the value Value.INDETERMINATE_ORDERING when there
is no defined order relationship between two given values. This value is also returned when two values
of different types are compared.
getSchemaComparable in class AtomicValue
public ComparisonKey getComparisonKey(XPathContext context)
throws NoDynamicContextException
getComparisonKey in class CalendarValuecontext - XPath dynamic context
NoDynamicContextException - if the implicit timezone is required and is not availablepublic boolean equals(Object other)
AtomicValueThe hashCode() method is consistent with equals().
equals in class AtomicValueother - the other value
public int hashCode()
hashCode in class Value<AtomicValue>
public CalendarValue add(DurationValue duration)
throws XPathException
add in class CalendarValueduration - the duration to be added (may be negative)
XPathException - if the duration is an xs:duration, as distinct from
a subclass thereof
public DayTimeDurationValue subtract(CalendarValue other,
XPathContext context)
throws XPathException
subtract in class CalendarValueother - the other point in timecontext - XPath dynamic evaluation context
XPathException - for example if one value is a date and the other is a time
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||