/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.xerces.xs.datatypes;

import javax.xml.datatype.Duration;
import javax.xml.datatype.XMLGregorianCalendar;

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 - - - - - X X X - X X X X
gMonth - X - - - - X X X - X X X X
gDay - - X - - - X X X - X X X X
gYearMonth X X - - - - X X X - X X X X
gMonthDay - X X - - - X X X - X X X X
date X X X - - - X X X - X X X X
time - - - X X X X X X - X X X X
datetime X X X X X X X X X - X X X X
duration - X - - - X - - - X - - - X

Author:Ankit Pasricha, IBM
Version:$Id: XSDateTime.java 447250 2006-09-18 05:27:17Z mrglavas $
/** * <p>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. * * <table border="1"> * <br/> * <tr> * <td> XML Schema Datatype </td> * <td> getYears() </td> * <td> getMonths() </td> * <td> getDays() </td> * <td> getHours() </td> * <td> getMinutes() </td> * <td> getSeconds() </td> * <td> getTimeZoneHours() </td> * <td> getTimeZoneMinutes() </td> * <td> getXMLGregorianCalendar() </td> * <td> getDuration() </td> * <td> hasTimeZone() </td> * <td> normalize() </td> * <td> isNormalized() </td> * <td> getLexicalValue() </td> * </tr> * <tr> * <td> gYear </td> * <td>X</td> * <td>-</td> * <td>-</td> * <td>-</td> * <td>-</td> * <td>-</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>-</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>X</td> * </tr> * <tr> * <td> gMonth </td> * <td>-</td> * <td>X</td> * <td>-</td> * <td>-</td> * <td>-</td> * <td>-</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>-</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>X</td> * </tr> * <tr> * <td> gDay </td> * <td>-</td> * <td>-</td> * <td>X</td> * <td>-</td> * <td>-</td> * <td>-</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>-</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>X</td> * </tr> * <tr> * <td> gYearMonth </td> * <td>X</td> * <td>X</td> * <td>-</td> * <td>-</td> * <td>-</td> * <td>-</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>-</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>X</td> * </tr> * <tr> * <td> gMonthDay </td> * <td>-</td> * <td>X</td> * <td>X</td> * <td>-</td> * <td>-</td> * <td>-</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>-</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>X</td> * </tr> * <tr> * <td> date </td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>-</td> * <td>-</td> * <td>-</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>-</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>X</td> * </tr> * <tr> * <td> time </td> * <td>-</td> * <td>-</td> * <td>-</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>-</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>X</td> * </tr> * <tr> * <td> datetime </td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>-</td> * <td>X</td> * <td>X</td> * <td>X</td> * <td>X</td> * </tr> * <tr> * <td> duration </td> * <td>-</td> * <td>X</td> * <td>-</td> * <td>-</td> * <td>-</td> * <td>X</td> * <td>-</td> * <td>-</td> * <td>-</td> * <td>X</td> * <td>-</td> * <td>-</td> * <td>-</td> * <td>X</td> * </tr> * </table> * </p> * * @author Ankit Pasricha, IBM * * @version $Id: XSDateTime.java 447250 2006-09-18 05:27:17Z mrglavas $ */
public interface XSDateTime {
Returns:years - can be negative for date-time related types;
/** * @return years - can be negative for date-time related types; * */
public int getYears();
Returns:months - can be negative only for duration types; For duration types, it returns years*12 + months
/** * @return months - can be negative only for duration types; * For duration types, it returns years*12 + months */
public int getMonths();
Returns:days - cannot be negative;
/** * @return days - cannot be negative; * */
public int getDays();
Returns:hours - cannot be negative;
/** * @return hours - cannot be negative; * */
public int getHours();
Returns:minutes - cannot be negative;
/** * @return minutes - cannot be negative; * */
public int getMinutes();
Returns:seconds - can be negative only for durations; For duration types, it returns days*24*3600 + hours*3600 + minutes*60 + seconds
/** * @return seconds - can be negative only for durations; * For duration types, it returns days*24*3600 + hours*3600 * + minutes*60 + seconds */
public double getSeconds();
Returns:boolean (true when timezone is specified in the original lexical value)
/** * @return boolean (true when timezone is specified in the original lexical value) * */
public boolean hasTimeZone();
Returns:timezone hours (for GMT-xx:xx this will be negative),
/** * @return timezone hours (for GMT-xx:xx this will be negative), * */
public int getTimeZoneHours();
Returns:timezone minutes (for GMT-xx:xx this will be negative),
/** * @return timezone minutes (for GMT-xx:xx this will be negative), * */
public int getTimeZoneMinutes();
Returns:the original lexical value
/** * @return the original lexical value */
public String getLexicalValue();
Returns:a new date-time related object with normalized values (has no effect on objects already normalized)
/** * @return a new date-time related object with normalized values * (has no effect on objects already * normalized) */
public XSDateTime normalize();
Returns:whether a date-time related object is normalized or not (value is not useful for types where timezone is not specified)
/** * @return whether a date-time related object is normalized or not * (value is not useful for types where timezone is not specified) */
public boolean isNormalized();
Returns:an un-normalized XMLGregorianCalendar (if applicable otherwise null)
/** * @return an un-normalized XMLGregorianCalendar (if applicable otherwise null) */
public XMLGregorianCalendar getXMLGregorianCalendar();
Returns:a Duration (if applicable otherwise null)
/** * @return a Duration (if applicable otherwise null) */
public Duration getDuration(); }