org.eclipse.tptp.platform.report.tools.internal
Class CalendarField

java.lang.Object
  org.eclipse.tptp.platform.report.tools.internal.CalendarField

All Implemented Interfaces:

IDStringSerializable, IDXmlSerializable

public class CalendarField

extends java.lang.Object

implements IDXmlSerializable, IDStringSerializable

CalendarField designed to hold one or more fields of a java.util.Calendar as the user set() them. One difference from Calendar is java.util.Calendar complete a date using default fields values, CalendarField Doesn't. This class was designed for step purpose in DAxis object using Date, but if it's suitable for you feel free to use it.

See Also:

Calendar, DAxis

Constructor Summary

CalendarField()
Create a CalendarField, all fields unset with undefined values.

CalendarField(int _field, int _value)
Create a CalendarField and set value for one of them.

Method Summary

static java.lang.String	FieldName(int _field) Deprecated. prefer use getFieldName For debug purpose, return the Calendar field name from field value, or number converted to string, if field isn't known.
int	get(int _field) Return current value of a field.
static int	getFieldIndex(java.lang.String name)
static java.lang.String	getFieldName(int _field)
boolean	isSet(int _field) Check is a field have been set.
void	readXml(org.w3c.dom.Node node)
void	reset() Reset all previously fields set.
void	serializeFromString(java.lang.String s) Uses the string character to catch the information and store it in the object.
java.lang.String	serializeToString() Translates a Calendar Field content to an equivalent string.
void	set(int _field, int _value) Change value of a fied.
void	unset(int _field) Unset field value.
java.lang.String	writeXml() Writes the object in a string which has an xml syntax

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CalendarField

public CalendarField()

Create a CalendarField, all fields unset with undefined values. Fields can be setset(), or unset(). Check is a field have been set using isSet(). Retrieve value using get()

CalendarField

public CalendarField(int _field,
                     int _value)

Create a CalendarField and set value for one of them. Equivalent to (new CalendarField()).set( _field, _value)

Method Detail

reset

public void reset()

Reset all previously fields set.

set

public void set(int _field,
                int _value)

Change value of a fied.

Parameters:

_field - one of field constant defined in java.util.Calendar.

_value - new value of field, for correct value range report to java.util.Calendar.

See Also:

Calendar

get

public int get(int _field)

Return current value of a field.

Parameters:

_field - one of field constant defined in java.util.Calendar.

Returns:

current field value, or undefined value if field haven't been set before.

isSet

public boolean isSet(int _field)

Check is a field have been set.

Parameters:

_field - one of field constant defined in java.util.Calendar.

Returns:

true if value set, false otherwise.

unset

public void unset(int _field)

Unset field value.

Parameters:

_field - one of field constant defined in java.util.Calendar.

FieldName

public static java.lang.String FieldName(int _field)

Deprecated. prefer use getFieldName For debug purpose, return the Calendar field name from field value, or number converted to string, if field isn't known.

Parameters:

_field - one of constant defined in java.util.Calendar

Returns:

name or value of field.

getFieldName

public static java.lang.String getFieldName(int _field)

Parameters:

_field - one of constant defined in java.util.Calendar the value are:

  Calendar.YEAR                    => year  
  Calendar.MONTH                   => month  
  Calendar.DST_OFFSET              => dst_offset 
  Calendar.DAY_OF_MONTH            => day of month
  Calendar.MILLISECOND             => ms
  Calendar.SECOND                  => s  
  Calendar.DAY_OF_WEEK_IN_MONTH    => day of week in monthday  
  Calendar.DAY_OF_YEAR             => day of year  
  Calendar.DAY_OF_WEEK             => day of week  
  Calendar.ERA                     => era  
  Calendar.AM_PM                   => am pm  
  Calendar.HOUR                    => h  
  Calendar.HOUR_OF_DAY             => hour of day  
  Calendar.WEEK_OF_MONTH           => week of month  
  Calendar.WEEK_OF_YEAR            => week of year  
  Calendar.ZONE_OFFSET             => zone offset  
 

Returns:

the Calendar field name from field value, or number converted to string, if field isn't known.

getFieldIndex

public static int getFieldIndex(java.lang.String name)

Returns:

the index of the calendar field corresponding the name in the strin parameter

writeXml

public java.lang.String writeXml()

Writes the object in a string which has an xml syntax

Specified by:

writeXml in interface IDXmlSerializable

readXml

public void readXml(org.w3c.dom.Node node)

Specified by:

readXml in interface IDXmlSerializable

serializeToString

public java.lang.String serializeToString()

Translates a Calendar Field content to an equivalent string. Ex: year, 1, month, 3

Specified by:

serializeToString in interface IDStringSerializable

serializeFromString

public void serializeFromString(java.lang.String s)

Uses the string character to catch the information and store it in the object.

Specified by:

serializeFromString in interface IDStringSerializable