com.davisor.data
Class CalendarField

java.lang.Object
  com.davisor.data.CalendarField

All Implemented Interfaces:

com.davisor.core.Dupable

public class CalendarField

extends java.lang.Object

implements com.davisor.core.Dupable

CalendarField represents a calendar field value. Unlike most other time related data objects, a calendar field does not represent an exact moment of time, or even a fixed period of time. Instead, calendar fields represent abstract calendar time periods like "five years" or "three weeks". The interpretation of such values depends on which calendar system is used, and what calendar date it is.

Since:

JDK1.3

See Also:

CalendarFieldData, CalendarFieldType, CalendarFields

Field Summary

protected int	M_code Java Calendar field code.
protected int	M_value Calendar field value.

Constructor Summary

CalendarField()
Default constructor.

CalendarField(CalendarField cf)
Copy constructor.

CalendarField(int code, java.util.Calendar calendar)
Creates a new calendar field.

CalendarField(int code, int value)
Creates a new calendar field.

Method Summary

CalendarField	abs() Returns absolute data value of current value.
com.davisor.core.Dupable	dup() Makes a deep copy of this object.
int	getCode() Gets current field code.
int	getValue() Gets current field value.
CalendarField	negate() Returns the negation of current value.
CalendarField	normalize() Creates a new calendar field value that will cover the current time period in less than 10 steps.
void	set(int code, int value) Sets current field type and value.
void	setValue(int value) Sets current field value.
java.lang.String	toString() Gets the string representation of this object.

Methods inherited from class java.lang.Object

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

Field Detail

M_code

protected int M_code

Java Calendar field code.

M_value

protected int M_value

Calendar field value.

Constructor Detail

CalendarField

public CalendarField()

Default constructor. Creates a time period of zero milliseconds.

CalendarField

public CalendarField(CalendarField cf)

Copy constructor. null calendar source field defaults to zero milliseconds.

Parameters:

cf - calendar field to be copied (may be null)

CalendarField

public CalendarField(int code,
                     int value)

Creates a new calendar field.

Parameters:

code - Java Calendar field code

value - Java Calendar field value

CalendarField

public CalendarField(int code,
                     java.util.Calendar calendar)

Creates a new calendar field.

Parameters:

code - Java Calendar field code

calendar - Java Calendar to get field value from

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

toString

public java.lang.String toString()

Gets the string representation of this object.

See Also:

CalendarFields.getPattern(int)

abs

public CalendarField abs()

Returns absolute data value of current value.

Returns:

a new calendar field object, with absolute value

getCode

public int getCode()

Gets current field code.

getValue

public int getValue()

Gets current field value.

negate

public CalendarField negate()

Returns the negation of current value.

Returns:

a new calendar field object, with negated value

normalize

public CalendarField normalize()

Creates a new calendar field value that will cover the current time period in less than 10 steps.

The current implementation assumes Gregorian style calendar, with 60 seconds in a minute, 24 hours in a day, and so on.

Returns:

a new calendar field with normalized field value

set

public void set(int code,
                int value)

Sets current field type and value.

Parameters:

code - Java Calendar field code

value - Java Calendar field value

setValue

public void setValue(int value)

Sets current field value.

Parameters:

value - Java Calendar field value