com.davisor.data
Class CalendarType

java.lang.Object
  java.text.Format
      com.davisor.data.Type
          com.davisor.data.LocaleType
              com.davisor.data.FormatType
                  com.davisor.data.DateFormatType
                      com.davisor.data.TimestampType
                          com.davisor.data.CalendarType

All Implemented Interfaces:

java.lang.Cloneable, java.util.Comparator, com.davisor.core.Dupable, java.io.Serializable

public class CalendarType

extends TimestampType

CalendarType defines a data type that formats and parses calendar strings. Calendar strings contain date and time-of-day information, formatted by current type format.

Format syntax

Calendar type inherits it's formatting functionality from it's DateFormatType superclass.

Since:

JDK1.1

See Also:

CalendarData, CalendarFieldType, TimestampType, Serialized Form

Nested Class Summary

Nested classes inherited from class java.text.Format

java.text.Format.Field

Field Summary

static CalendarType	DEFAULT Default calendar type.
static java.lang.String	TYPENAME Type name ("CALENDAR").

Fields inherited from class com.davisor.data.DateFormatType

GMT, LOCAL, M_style, M_timeZone

Fields inherited from class com.davisor.data.FormatType

M_pattern, M_sample

Fields inherited from class com.davisor.data.LocaleType

DEFAULT_LOCALE, M_locale

Fields inherited from class com.davisor.data.Type

METADATA_GROUP, METADATA_NAME, METADATA_PARENT, METADATA_SUBCHANNELS

Constructor Summary

	CalendarType() Default constructor.
	CalendarType(CalendarType ct) Deep copy constructor.
	CalendarType(java.lang.String dataName) Creates a new default type with no identity.
	CalendarType(java.lang.String dataName, java.lang.String id, java.util.Map metaData, java.util.Locale locale, java.lang.String pattern, java.lang.Object sample, int style, java.util.TimeZone timeZone) Creates a new calendar type.
	CalendarType(java.lang.String dataName, java.lang.String id, java.lang.String format) Creates a new calendar type with localized calendar formatting.
protected	CalendarType(java.lang.String typeName, java.lang.String dataName, java.lang.String id, java.util.Map metaData, java.util.Locale locale, java.lang.String pattern, java.lang.Object sample, int style, java.util.TimeZone timeZone) Creates a new calendar type.

Method Summary

com.davisor.core.Dupable	dup() Makes a deep copy of this object.
boolean	equals(java.lang.Object o) Tests if this object is equal to another object.
DataValue	toData(java.sql.CallableStatement statement, int column) Converts a callable statement variable to a data value.
DataValue	toData(java.sql.ResultSet resultSet, int column) Converts a result set column value to a data value.
DataValue	zero() Gets zero data value for this type.

Methods inherited from class com.davisor.data.TimestampType

getSQLCode

Methods inherited from class com.davisor.data.DateFormatType

createCalendar, createCalendar, createCalendar, createCalendar, createCalendar, createCalendar, createFormatter, dateValue, getFormat, getLast, getStyle, getTimeZone, getValueClass, hashCode, setFormat, setStyle, setTimeZone, stringValue, strip, toData, toData, toData, toData

Methods inherited from class com.davisor.data.FormatType

clearFormatter, getFormatter, getPattern, getSample, setFormat, setLocale, setPattern, setSample

Methods inherited from class com.davisor.data.LocaleType

getLocale, setLocale

Methods inherited from class com.davisor.data.Type

ceil, check, check, compare, create, create, create, create, create, dup, floor, format, getCompatibility, getDataName, getId, getID, getMetaData, getMetaData, getSpecs, getSQLName, getSQLName, getTypeName, isNull, parseObject, register, register, setDataName, setId, setID, setMetaData, setMetaData, setSpecs, toString, toXML, xmlEnd, xmlStart

Methods inherited from class java.text.Format

clone, format, formatToCharacterIterator, parseObject

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT

public static final CalendarType DEFAULT

Default calendar type.

TYPENAME

public static final java.lang.String TYPENAME

Type name ("CALENDAR").

See Also:

Constant Field Values

Constructor Detail

CalendarType

public CalendarType()

Default constructor.

CalendarType

public CalendarType(CalendarType ct)

Deep copy constructor.

CalendarType

public CalendarType(java.lang.String dataName)

Creates a new default type with no identity.

Parameters:

dataName - data name (may be null)

CalendarType

public CalendarType(java.lang.String dataName,
                    java.lang.String id,
                    java.lang.String format)

Creates a new calendar type with localized calendar formatting.

This is the constructor the SQL type mapper Type.create(Integer,String,String,String) method will call to create a type that matches given SQL type.

Parameters:

dataName - data name (may be null)

id - type identity (may be null)

format - date format (may be null)

See Also:

DateFormatType.setFormat(java.lang.String)

CalendarType

public CalendarType(java.lang.String dataName,
                    java.lang.String id,
                    java.util.Map metaData,
                    java.util.Locale locale,
                    java.lang.String pattern,
                    java.lang.Object sample,
                    int style,
                    java.util.TimeZone timeZone)

Creates a new calendar type.

Parameters:

dataName - data name (may be null)

id - type identity (may be null)

metaData - type meta data map (may be null)

locale - type locale (may be null)

pattern - format pattern (may be null)

sample - format sample (may be null)

style - java.text.DateFormat style code

timeZone - date format time zone

See Also:

FormatType.setLocale(java.util.Locale), FormatType.setPattern(java.lang.String), FormatType.setSample(java.lang.Object), DateFormatType.setStyle(int), DateFormatType.setTimeZone(java.util.TimeZone)

CalendarType

protected CalendarType(java.lang.String typeName,
                       java.lang.String dataName,
                       java.lang.String id,
                       java.util.Map metaData,
                       java.util.Locale locale,
                       java.lang.String pattern,
                       java.lang.Object sample,
                       int style,
                       java.util.TimeZone timeZone)

Creates a new calendar type.

Parameters:

typeName - type name

dataName - data name (may be null)

id - type identity (may be null)

metaData - type meta data map (may be null)

locale - type locale (may be null)

pattern - format pattern (may be null)

sample - format sample (may be null)

style - java.text.DateFormat style code

timeZone - date format time zone

See Also:

FormatType.setLocale(java.util.Locale), FormatType.setPattern(java.lang.String), FormatType.setSample(java.lang.Object), DateFormatType.setStyle(int), DateFormatType.setTimeZone(java.util.TimeZone)

Method Detail

dup

public com.davisor.core.Dupable dup()

Makes a deep copy of this object.

Specified by:

dup in interface com.davisor.core.Dupable

Overrides:

dup in class TimestampType

equals

public boolean equals(java.lang.Object o)

Tests if this object is equal to another object.

Calendar types are equal if their super-classes are.

Specified by:

equals in interface java.util.Comparator

Overrides:

equals in class TimestampType

toData

public DataValue toData(java.sql.CallableStatement statement,
                        int column)
                 throws InvalidDataException,
                        java.sql.SQLException

Converts a callable statement variable to a data value.

Gets statement timestamp value, and returns a corresponding CalendarData value.

Overrides:

toData in class TimestampType

Parameters:

statement - statement holding the data value to be converted

column - SQL column index for the data value to be converted

Returns:

a data value object corresponding to given object value

Throws:

InvalidDataException - if given object value could not be parsed

java.sql.SQLException - if a SQL error occurs

See Also:

DateFormatType.toData(Object), toData(ResultSet,int), DateFormatType.toData(String,ParsePosition), TimestampData

toData

public DataValue toData(java.sql.ResultSet resultSet,
                        int column)
                 throws InvalidDataException,
                        java.sql.SQLException

Converts a result set column value to a data value.

Gets result set column timestamp value, and returns a corresponding CalendarData value.

Overrides:

toData in class TimestampType

Parameters:

resultSet - resultSet holding the data value to be converted

column - SQL column index for the data value to be converted

Returns:

a data value object corresponding to given object value

Throws:

InvalidDataException - if given object value could not be parsed

java.sql.SQLException - if a SQL error occurs

See Also:

toData(CallableStatement,int), DateFormatType.toData(Object), DateFormatType.toData(String,ParsePosition), TimestampData

zero

public DataValue zero()

Gets zero data value for this type.

Overrides:

zero in class TimestampType

Returns:

a new zero value CalendarData object sharing this type