org.apache.xerces.xs.datatypes

Interface XSDateTime

public interface XSDateTime

Interface to expose the values for all date-time related types. The following table shows the methods defined for various XML Schema 1.0 built-in types. 'X' marks whether a particular method is defined for a particular type. Accessing undefined methods may return unexpected values.
XML Schema Datatype getYears() getMonths() getDays() getHours() getMinutes() getSeconds() getTimeZoneHours() getTimeZoneMinutes() getXMLGregorianCalendar() getDuration() hasTimeZone() normalize() isNormalized() getLexicalValue()
gYear X-----XXX-XXXX
gMonth -X----XXX-XXXX
gDay --X---XXX-XXXX
gYearMonth XX----XXX-XXXX
gMonthDay -XX---XXX-XXXX
date XXX---XXX-XXXX
time ---XXXXXX-XXXX
datetime XXXXXXXXX-XXXX
duration -X---X---X---X
Version:
$Id: XSDateTime.java 447250 2006-09-18 05:27:17Z mrglavas $
Author:
Ankit Pasricha, IBM

Method Summary

int
getDays()
Duration
getDuration()
int
getHours()
String
getLexicalValue()
int
getMinutes()
int
getMonths()
double
getSeconds()
int
getTimeZoneHours()
int
getTimeZoneMinutes()
XMLGregorianCalendar
getXMLGregorianCalendar()
int
getYears()
boolean
hasTimeZone()
boolean
isNormalized()
XSDateTime
normalize()

Method Details

getDays

public int getDays()
Returns:
days - cannot be negative;

getDuration

public Duration getDuration()
Returns:
a Duration (if applicable otherwise null)

getHours

public int getHours()
Returns:
hours - cannot be negative;

getLexicalValue

public String getLexicalValue()
Returns:
the original lexical value

getMinutes

public int getMinutes()
Returns:
minutes - cannot be negative;

getMonths

public int getMonths()
Returns:
months - can be negative only for duration types; For duration types, it returns years*12 + months

getSeconds

public double getSeconds()
Returns:
seconds - can be negative only for durations; For duration types, it returns days*24*3600 + hours*3600 + minutes*60 + seconds

getTimeZoneHours

public int getTimeZoneHours()
Returns:
timezone hours (for GMT-xx:xx this will be negative),

getTimeZoneMinutes

public int getTimeZoneMinutes()
Returns:
timezone minutes (for GMT-xx:xx this will be negative),

getXMLGregorianCalendar

public XMLGregorianCalendar getXMLGregorianCalendar()
Returns:
an un-normalized XMLGregorianCalendar (if applicable otherwise null)

getYears

public int getYears()
Returns:
years - can be negative for date-time related types;

hasTimeZone

public boolean hasTimeZone()
Returns:
boolean (true when timezone is specified in the original lexical value)

isNormalized

public boolean isNormalized()
Returns:
whether a date-time related object is normalized or not (value is not useful for types where timezone is not specified)

normalize

public XSDateTime normalize()
Returns:
a new date-time related object with normalized values (has no effect on objects already normalized)

Copyright B) 1999-2007 The Apache Software Foundation. All Rights Reserved.