com.davisor.data
Class CalendarFieldType

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.CalendarFieldType

All Implemented Interfaces:

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

public class CalendarFieldType

extends DateFormatType

CalendarFieldType defines a data type that formats and parses calendar field information.

Format syntax

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

Since:

JDK1.1

See Also:

CalendarField, CalendarFieldData, CalendarType, TimestampType, Serialized Form

Nested Class Summary

Nested classes inherited from class java.text.Format

java.text.Format.Field

Field Summary

static CalendarFieldType	DEFAULT Default calendarField type.
static java.lang.String	TYPENAME Type name ("CALENDARFIELD").

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

	CalendarFieldType() Default constructor.
	CalendarFieldType(CalendarFieldType ct) Deep copy constructor.
	CalendarFieldType(java.lang.String dataName) Creates a new default type with no identity.
	CalendarFieldType(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.
	CalendarFieldType(java.lang.String dataName, java.lang.String id, java.lang.String format) Creates a new calendar type with localized calendar formatting.
protected	CalendarFieldType(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	zero() Gets zero data value for this type.

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, getSQLCode, getSQLName, getSQLName, getTypeName, isNull, parseObject, register, register, setDataName, setId, setID, setMetaData, setMetaData, setSpecs, toData, toData, 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 CalendarFieldType DEFAULT

Default calendarField type.

TYPENAME

public static final java.lang.String TYPENAME

Type name ("CALENDARFIELD").

See Also:

Constant Field Values

Constructor Detail

CalendarFieldType

public CalendarFieldType()

Default constructor.

CalendarFieldType

public CalendarFieldType(CalendarFieldType ct)

Deep copy constructor.

CalendarFieldType

public CalendarFieldType(java.lang.String dataName)

Creates a new default type with no identity.

Parameters:

dataName - data name (may be null)

CalendarFieldType

public CalendarFieldType(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)

CalendarFieldType

public CalendarFieldType(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)

CalendarFieldType

protected CalendarFieldType(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

Specified by:

dup in class Type

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 DateFormatType

See Also:

FormatType.equals(java.lang.Object)

zero

public DataValue zero()

Gets zero data value for this type.

Specified by:

zero in class Type

Returns:

a new zero value CalendarFieldData object sharing this type

See Also:

DataValue.deinterpolate(com.davisor.data.DataValue, com.davisor.data.DataValue), DataValue.interpolate(double, com.davisor.data.DataValue)