Inheritance diagram for org.exolab.castor.types.RecurringDuration:

Public Member Functions
	RecurringDuration ()
	RecurringDuration (TimeDuration duration, TimeDuration period)
	RecurringDuration (String duration, String period)
	RecurringDuration (String duration, String period, short[] values) throws OperationNotSupportedException
void	setCentury (short century)
void	setYear (short year) throws OperationNotSupportedException
void	setMonth (short month) throws OperationNotSupportedException
void	setDay (short day) throws OperationNotSupportedException
boolean	isLeap ()
void	setValues (short[] values) throws OperationNotSupportedException
short	getCentury ()
short	getYear ()
short	getMonth ()
short	getDay ()
short[]	getValues ()
Date	toDate () throws ParseException
String	toString ()
boolean	equals (Object object)
boolean	equal (RecurringDuration reccD) throws ValidationException
boolean	isGreater (RecurringDuration reccD) throws ValidationException
Static Public Member Functions
static Object	parse (String str) throws ParseException
static RecurringDuration	parseRecurringDuration (String str) throws ParseException

Detailed Description

Represents recurringDuration utterly a recurringDuration must contain all the fields :

(+|-)CCYY-MM-DDThh:mm:ss.sss(Z|(+|-)hh:mm)

The validation of the date fields is done in the set methods and follows the ISO8601 Date and Time Format

It is possible to omit higher components by using '-'.

Author:: Arnaud Blandin

Version:

Revision:: 1.1.1.1

Constructor & Destructor Documentation

org.exolab.castor.types.RecurringDuration.RecurringDuration ( )

Referenced by org.exolab.castor.types.RecurringDuration.parseRecurringDuration().

org.exolab.castor.types.RecurringDuration.RecurringDuration	(	TimeDuration	duration,
		TimeDuration	period
	)

returns a recurringDuration with the facets duration and period set up

Parameters:

	duration	the TimeDuration representing the duration facet
	period	the TimeDuration reprensenting the period facet

Returns:: a recurringDuration with the facets duration and period set up

org.exolab.castor.types.RecurringDuration.RecurringDuration	(	String	duration,
		String	period
	)

returns a recurringDuration with the facets duration and period set up

Parameters:

	duration	the String representing the duration facet
	period	the String reprensenting the period facet

Returns:: a recurringDuration with the facets duration and period set up

org.exolab.castor.types.RecurringDuration.RecurringDuration	(	String	duration,
		String	period,
		short[]	values
	)			throws OperationNotSupportedException

returns a recurringDuration with the facets duration and period set up but also the fields

Parameters:

	duration	the String representing the duration facet
	period	the String reprensenting the period facet
	values	an array of shorts which contains the values of the fields

Returns:: a recurringDuration with the facets duration and period set up

See also:: setValues

References org.exolab.castor.types.RecurringDuration.setValues().

Member Function Documentation

boolean org.exolab.castor.types.RecurringDuration.equal ( RecurringDuration reccD ) throws ValidationException

Returns true if the present instance of Recurring Duration is equal to the parameter.

The equals relation is the following :

rd1 equals rd2 iff each field of rd1 is equal to the corresponding field of rd2

Parameters:

reccD

the recurring duration to compare with the present instance

Returns:: true if the present instance is equal to the parameter false if not

Referenced by org.exolab.castor.types.RecurringDuration.equals().

boolean org.exolab.castor.types.RecurringDuration.equals ( Object object )

Override the java.lang.equals method

See also:: equal

Reimplemented from org.exolab.castor.types.RecurringDurationBase.

References org.exolab.castor.types.RecurringDuration.equal(), and org.exolab.castor.core.exceptions.CastorException.printStackTrace().

Referenced by org.exolab.castor.types.RecurringDuration.equal(), and org.exolab.castor.types.RecurringDuration.isGreater().

short org.exolab.castor.types.RecurringDuration.getCentury ( )

short org.exolab.castor.types.RecurringDuration.getDay ( )

Referenced by org.exolab.castor.types.RecurringDuration.equal(), org.exolab.castor.types.RecurringDuration.getValues(), org.exolab.castor.types.RecurringDuration.parseRecurringDuration(), and org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler.setValue().

short org.exolab.castor.types.RecurringDuration.getMonth ( )

Referenced by org.exolab.castor.types.RecurringDuration.equal(), org.exolab.castor.types.RecurringDuration.getValues(), org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler.setValue(), org.exolab.castor.types.MonthDescriptor.MonthFieldHandler.setValue(), and org.exolab.castor.types.Month.toString().

short [] org.exolab.castor.types.RecurringDuration.getValues ( )

returns an array of short with all the fields which describe a RecurringDuration

Returns:: an array of short with all the fields which describe a RecurringDuration

Reimplemented from org.exolab.castor.types.RecurringDurationBase.

Referenced by org.exolab.castor.types.RecurringDuration.isGreater().

short org.exolab.castor.types.RecurringDuration.getYear ( )

Referenced by org.exolab.castor.types.RecurringDuration.equal(), org.exolab.castor.types.RecurringDuration.getValues(), org.exolab.castor.types.YearDescriptor.YearFieldHandler.setValue(), org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler.setValue(), org.exolab.castor.types.MonthDescriptor.MonthFieldHandler.setValue(), org.exolab.castor.types.Year.toString(), and org.exolab.castor.types.Month.toString().

boolean org.exolab.castor.types.RecurringDuration.isGreater ( RecurringDuration reccD ) throws ValidationException

Returns true if the present instance of RecurringDuration is greater than the parameter

Note : the order relation follows the W3C XML Schema draft i.e rd1 < rd2 iff rd2-rd1>0

Parameters:

reccD

the recurring duration to compare with the present instance

Returns:: true if the present instance is the greatest, false if not

References org.exolab.castor.types.TimeDuration.equals(), org.exolab.castor.types.RecurringDuration.equals(), org.exolab.castor.types.RecurringDurationBase.getDuration(), org.exolab.castor.types.RecurringDurationBase.getPeriod(), and org.exolab.castor.types.RecurringDuration.getValues().

boolean org.exolab.castor.types.RecurringDuration.isLeap ( )

return true if the year field represents a leap year A specific year is a leap year if it is either evenly divisible by 400 OR evenly divisible by 4 and not evenly divisible by 100

Returns:: true if the year field represents a leap year

Referenced by org.exolab.castor.types.RecurringDuration.setDay().

static Object org.exolab.castor.types.RecurringDuration.parse ( String str ) throws ParseException [static]

Reimplemented in org.exolab.castor.types.Century, org.exolab.castor.types.Month, and org.exolab.castor.types.Year.

References org.exolab.castor.types.RecurringDuration.parseRecurringDuration().

static RecurringDuration org.exolab.castor.types.RecurringDuration.parseRecurringDuration ( String str ) throws ParseException [static]

parse a String and convert it into a recurringDuration

Parameters:

str

the string to parse

Returns:: the recurringDuration represented by the string

Exceptions:

ParseException

a parse exception is thrown if the string to parse does not follow the rigth format (see the description of this class)

Todo:: optimize this method (too much strings)

Referenced by org.exolab.castor.types.RecurringDuration.parse().

void org.exolab.castor.types.RecurringDuration.setCentury ( short century )

set the century field

Parameters:

century

the value to set up

void org.exolab.castor.types.RecurringDuration.setDay ( short day ) throws OperationNotSupportedException

set the Day Field

Parameters:

day

the value to set up Note a validation is done on the day field

Reimplemented in org.exolab.castor.types.Century, org.exolab.castor.types.Month, and org.exolab.castor.types.Year.

References org.exolab.castor.types.RecurringDuration.isLeap().

Referenced by org.exolab.castor.types.RecurringDuration.parseRecurringDuration(), org.exolab.castor.types.TimePeriod.setFields(), org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler.setValue(), and org.exolab.castor.types.RecurringDuration.setValues().

void org.exolab.castor.types.RecurringDuration.setMonth ( short month ) throws OperationNotSupportedException

set the Month Field

Parameters:

month

the value to set up Note 1<month<12

Reimplemented in org.exolab.castor.types.Century, and org.exolab.castor.types.Year.

Referenced by org.exolab.castor.types.Month.parseMonth(), org.exolab.castor.types.RecurringDuration.parseRecurringDuration(), org.exolab.castor.types.TimePeriod.setFields(), org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler.setValue(), org.exolab.castor.types.MonthDescriptor.MonthFieldHandler.setValue(), and org.exolab.castor.types.RecurringDuration.setValues().

void org.exolab.castor.types.RecurringDuration.setValues ( short[] values ) throws OperationNotSupportedException

set all the fields by reading the values in an array

Parameters:

values

an array of shorts with the values the array is supposed to be of length 10 and ordered like that:

century
year
month
day
hour
minute
second
millisecond
zoneHour
zoneMinute

Exceptions:

OperationNotSupportedException

this exception is thrown if changing the value of one field os not allowed

See also:: RecurringDurationBase.setValues

Reimplemented from org.exolab.castor.types.RecurringDurationBase.

References org.exolab.castor.types.RecurringDuration.setCentury(), org.exolab.castor.types.RecurringDuration.setDay(), org.exolab.castor.types.RecurringDurationBase.setHour(), org.exolab.castor.types.RecurringDurationBase.setMinute(), org.exolab.castor.types.RecurringDuration.setMonth(), org.exolab.castor.types.RecurringDurationBase.setSecond(), org.exolab.castor.types.RecurringDuration.setYear(), and org.exolab.castor.types.RecurringDurationBase.setZone().

Referenced by org.exolab.castor.types.RecurringDuration.RecurringDuration().

void org.exolab.castor.types.RecurringDuration.setYear ( short year ) throws OperationNotSupportedException

set the Year field Note: 0000 is not allowed

Parameters:

the

year to set up

Reimplemented in org.exolab.castor.types.Century.

Referenced by org.exolab.castor.types.Month.parseMonth(), org.exolab.castor.types.RecurringDuration.parseRecurringDuration(), org.exolab.castor.types.Year.parseYear(), org.exolab.castor.types.TimePeriod.setFields(), org.exolab.castor.types.YearDescriptor.YearFieldHandler.setValue(), org.exolab.castor.types.RecurringDurationDescriptor.RecurringDurationFieldHandler.setValue(), org.exolab.castor.types.MonthDescriptor.MonthFieldHandler.setValue(), and org.exolab.castor.types.RecurringDuration.setValues().

Date org.exolab.castor.types.RecurringDuration.toDate ( ) throws ParseException

convert this recurringDuration into a local Date

Note : Be aware a the 'local' property of the date i.e toDate() will de the conversion between a UTC date and your computer date format. For instance if you have set up your computer time zone on the Pacific Day Time the conversion of 2000-10-20T00:00:00.000 into a java.util.Date will return Thu Oct 19 17:00:00 PDT 2000