Package org.rogatio.circlead.control

Class CircleadRecurrenceRule

java.lang.Object

org.rogatio.circlead.control.CircleadRecurrenceRule

public class CircleadRecurrenceRule
extends java.lang.Object

The Class CircleadRecurrenceRule allows reccurence-rule-manipulation.

Author:

Matthias Wegner

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CircleadRecurrenceRule.Duration	The Enum Duration.
class	CircleadRecurrenceRule.Event	The Class Event.

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.Map<java.lang.Integer,org.dmfs.rfc5545.Weekday>	DAYOFWEEK2WEEKDAY	The Constant DAYOFWEEK2WEEKDAY maps 1 to monday, 2 to tuesday, ....
static java.util.Map<org.dmfs.rfc5545.Weekday,java.lang.Integer>	WEEKDAY2DAYOFWEEK	The Constant WEEKDAY2DAYOFWEEK maps weekday-enum to number. monday is 1, tuesday is 2
static java.util.List<org.dmfs.rfc5545.Weekday>	WEEKDAYS	The Constant WEEKDAYS contains the enum Weekday as ordered list, beginning on monday.
static java.util.Map<org.dmfs.rfc5545.Weekday,java.lang.String>	WEEKDAYS2GERMAN	The Constant WEEKDAYS2GERMAN map enum weekday to german name of weekday.

Constructor Summary

Constructors

Constructor	Description
CircleadRecurrenceRule(java.lang.String rule)	Instantiates a new circlead recurrence rule.
CircleadRecurrenceRule(org.dmfs.rfc5545.recur.Freq freq)	Instantiates a new circlead recurrence rule.

Method Summary

Modifier and Type	Method	Description
static java.util.Date	convertDate(org.dmfs.rfc5545.DateTime date)	Convert date.
Timeslice	getAllokation(java.lang.String freq, int interval)	Gets the allokation.
java.util.List<Timeslice>	getAllokationSlices(java.lang.String freq)	Gets the allokation slices.
java.util.List<Timeslice>	getAllokationSlices(org.dmfs.rfc5545.recur.Freq freq)	Gets the allokation slices.
double	getAverageAllokation(java.lang.String freq)	Gets the average allokation.
double	getAverageAllokation(org.dmfs.rfc5545.recur.Freq freq)	Gets the average allokation.
java.lang.String	getDetails()	Gets the details.
int	getDuration()	Gets the duration.
java.lang.String	getDurationunit()	Gets the durationunit.
org.dmfs.rfc5545.DateTime	getEndDate(java.lang.String startDateTime)	Gets the end date.
org.dmfs.rfc5545.DateTime	getEndDate(org.dmfs.rfc5545.DateTime startDateTime)	Gets the end date.
CircleadRecurrenceRule.Event	getEvent()	Gets the event.
CircleadRecurrenceRule.Event	getEvent(java.lang.String startDate)	Gets the event.
CircleadRecurrenceRule.Event	getEvent(org.dmfs.rfc5545.DateTime startDate)	Gets the event.
java.util.List<CircleadRecurrenceRule.Event>	getEventList(int maxInstances)	Gets the event list.
java.util.List<CircleadRecurrenceRule.Event>	getEventList(java.lang.String startDateTime, int maxInstances)	Gets the event list.
java.util.List<CircleadRecurrenceRule.Event>	getEventList(org.dmfs.rfc5545.DateTime startDateTime, int maxInstances)	Gets the event list.
java.lang.Integer	getHour()	Gets the hour.
java.lang.String	getRawRule()	Gets the raw rule.
java.lang.String	getReadableRule()	Gets the human readable rule.
org.dmfs.rfc5545.DateTime	getStartDate()	Gets the start date.
org.dmfs.rfc5545.DateTime	getStartDate(java.lang.String startDateTime)	Gets the start date.
java.util.List<org.dmfs.rfc5545.DateTime>	getStartDateList(int maxInstances)	Gets the start date list.
java.util.List<org.dmfs.rfc5545.DateTime>	getStartDateList(java.lang.String startDateTime, int maxInstances)	Gets the start date list.
java.util.List<org.dmfs.rfc5545.DateTime>	getStartDateList(org.dmfs.rfc5545.DateTime startDateTime, int maxInstances)	Gets the start date list.
java.lang.String	getType()	Gets the type.
org.dmfs.rfc5545.DateTime	getUntilDate()	Gets the until date.
org.dmfs.rfc5545.Weekday	getWeekday()	Gets the weekday.
boolean	isInfinite()	Checks if is infinite.
java.lang.Boolean	isRecurrenceOdd()	Checks if is recurrence odd.
void	setByPart(org.dmfs.rfc5545.recur.RecurrenceRule.Part part, java.lang.Integer... values)	Sets the by part.
void	setByPart(org.dmfs.rfc5545.recur.RecurrenceRule.Part part, java.util.List<java.lang.Integer> values)	Sets the by part.
void	setCount(int count)	Sets the count.
void	setDefaultTimeZone(java.util.TimeZone timeZone)	Sets the default time zone.
void	setDuration(CircleadRecurrenceRule.Duration durationunit, int duration)	Sets the duration.
void	setInterval(int interval)	Sets the interval.
void	setStartDate(java.lang.String startDate)	Sets the start date.
void	setStartDateAllDay(java.lang.String startDate)	Sets the start date.
void	setStartDateNonAllDay(int year, int month, int day)	Sets the start date.
void	setStartDateNonAllDay(org.dmfs.rfc5545.DateTime startDate)	Sets the start date non all day.
void	setUntilDate(java.lang.String untilDate)	Sets the until date.
void	setUntilDateAllDay(java.lang.String untilDate)	Sets the until date all day.
void	setUntilDateAllDay(org.dmfs.rfc5545.DateTime until)	Sets the until date.
void	setUntilDateNonAllDay(int year, int month, int day)	Sets the until date.
void	setWeekStart(org.dmfs.rfc5545.Weekday wkst)	Sets the week start.
org.dmfs.rfc5545.recur.RecurrenceRuleIterator	startDateIterator()	Start iterator from actual data and time.
org.dmfs.rfc5545.recur.RecurrenceRuleIterator	startDateIterator(java.lang.String startDateTime)	Start date iterator.
org.dmfs.rfc5545.recur.RecurrenceRuleIterator	startDateIterator(org.dmfs.rfc5545.DateTime start)	Start date iterator.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

WEEKDAYS

public static final java.util.List<org.dmfs.rfc5545.Weekday> WEEKDAYS

The Constant WEEKDAYS contains the enum Weekday as ordered list, beginning on monday.

DAYOFWEEK2WEEKDAY

public static final java.util.Map<java.lang.Integer,org.dmfs.rfc5545.Weekday> DAYOFWEEK2WEEKDAY

The Constant DAYOFWEEK2WEEKDAY maps 1 to monday, 2 to tuesday, ....

WEEKDAY2DAYOFWEEK

public static final java.util.Map<org.dmfs.rfc5545.Weekday,java.lang.Integer> WEEKDAY2DAYOFWEEK

The Constant WEEKDAY2DAYOFWEEK maps weekday-enum to number. monday is 1, tuesday is 2

WEEKDAYS2GERMAN

public static final java.util.Map<org.dmfs.rfc5545.Weekday,java.lang.String> WEEKDAYS2GERMAN

The Constant WEEKDAYS2GERMAN map enum weekday to german name of weekday.

Constructor Detail

CircleadRecurrenceRule

public CircleadRecurrenceRule(java.lang.String rule)
                       throws CircleadRecurrenceRuleException

Instantiates a new circlead recurrence rule.

Parameters:

rule - the rule

Throws:

CircleadRecurrenceRuleException

CircleadRecurrenceRule

public CircleadRecurrenceRule(org.dmfs.rfc5545.recur.Freq freq)
                       throws CircleadRecurrenceRuleException

Instantiates a new circlead recurrence rule.

Parameters:

freq - the freq

Throws:

CircleadRecurrenceRuleException

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getReadableRule

public java.lang.String getReadableRule()

Gets the human readable rule.

Returns:

the readable rule

setUntilDateNonAllDay

public void setUntilDateNonAllDay(int year,
                                  int month,
                                  int day)

Sets the until date.

Parameters:

year - the year

month - the month of the year. January is 1, february is 2, ..., december is 12.

day - the day

setStartDateNonAllDay

public void setStartDateNonAllDay(int year,
                                  int month,
                                  int day)

Sets the start date.

Parameters:

year - the year

month - the month of the year. January is 1, february is 2, ..., december is 12.

day - the day

setUntilDateAllDay

public void setUntilDateAllDay(org.dmfs.rfc5545.DateTime until)

Sets the until date.

Parameters:

until - the new until date

setWeekStart

public void setWeekStart(org.dmfs.rfc5545.Weekday wkst)

Sets the week start.

Parameters:

wkst - the new week start

setDuration

public void setDuration(CircleadRecurrenceRule.Duration durationunit,
                        int duration)

Sets the duration.

Parameters:

durationunit - the durationunit

duration - the duration

getRawRule

public java.lang.String getRawRule()

Gets the raw rule.

Returns:

the raw rule

getAllokationSlices

public java.util.List<Timeslice> getAllokationSlices(org.dmfs.rfc5545.recur.Freq freq)

Gets the allokation slices.

Parameters:

freq - the freq

Returns:

the allokation slices

getAllokationSlices

public java.util.List<Timeslice> getAllokationSlices(java.lang.String freq)

Gets the allokation slices.

Parameters:

freq - the freq

Returns:

the allokation slices

getAverageAllokation

public double getAverageAllokation(org.dmfs.rfc5545.recur.Freq freq)

Gets the average allokation.

Parameters:

freq - the freq

Returns:

the average allokation

getAllokation

public Timeslice getAllokation(java.lang.String freq,
                               int interval)

Gets the allokation.

Parameters:

freq - the freq

interval - the interval

Returns:

the allokation

setDefaultTimeZone

public void setDefaultTimeZone(java.util.TimeZone timeZone)

Sets the default time zone.

Parameters:

timeZone - the new default time zone

getAverageAllokation

public double getAverageAllokation(java.lang.String freq)

Gets the average allokation.

Parameters:

freq - the freq

Returns:

allokation in hours per week

getDurationunit

public java.lang.String getDurationunit()

Gets the durationunit.

Returns:

the durationunit

getDuration

public int getDuration()

Gets the duration.

Returns:

the duration

getWeekday

public org.dmfs.rfc5545.Weekday getWeekday()

Gets the weekday.

Returns:

the weekday

getHour

public java.lang.Integer getHour()

Gets the hour.

Returns:

the hour

isRecurrenceOdd

public java.lang.Boolean isRecurrenceOdd()

Checks if is recurrence odd.

Returns:

the boolean

getType

public java.lang.String getType()

Gets the type.

Returns:

the type

setCount

public void setCount(int count)

Sets the count.

Parameters:

count - the new count

isInfinite

public boolean isInfinite()

Checks if is infinite.

Returns:

true, if is infinite

getEndDate

public org.dmfs.rfc5545.DateTime getEndDate(org.dmfs.rfc5545.DateTime startDateTime)

Gets the end date.

Parameters:

startDateTime - the start date time

Returns:

the end date

getEndDate

public org.dmfs.rfc5545.DateTime getEndDate(java.lang.String startDateTime)

Gets the end date.

Parameters:

startDateTime - the start date time

Returns:

the end date

getEvent

public CircleadRecurrenceRule.Event getEvent(java.lang.String startDate)

Gets the event.

Parameters:

startDate - the start date

Returns:

the event

getEvent

public CircleadRecurrenceRule.Event getEvent(org.dmfs.rfc5545.DateTime startDate)

Gets the event.

Parameters:

startDate - the start date

Returns:

the event

getEvent

public CircleadRecurrenceRule.Event getEvent()

Gets the event.

Returns:

the event

setStartDateNonAllDay

public void setStartDateNonAllDay(org.dmfs.rfc5545.DateTime startDate)

Sets the start date non all day.

Parameters:

startDate - the new start date non all day

setUntilDate

public void setUntilDate(java.lang.String untilDate)

Sets the until date.

Parameters:

untilDate - the new until date

setUntilDateAllDay

public void setUntilDateAllDay(java.lang.String untilDate)

Sets the until date all day.

Parameters:

untilDate - the new until date all day

setStartDate

public void setStartDate(java.lang.String startDate)

Sets the start date.

Parameters:

startDate - the new start date

setStartDateAllDay

public void setStartDateAllDay(java.lang.String startDate)

Sets the start date.

Parameters:

startDate - the new start date

getStartDate

public org.dmfs.rfc5545.DateTime getStartDate()

Gets the start date.

Returns:

the start date

getUntilDate

public org.dmfs.rfc5545.DateTime getUntilDate()

Gets the until date.

Returns:

the until date

getStartDate

public org.dmfs.rfc5545.DateTime getStartDate(java.lang.String startDateTime)

Gets the start date.

Parameters:

startDateTime - the start date time

Returns:

the start date

getEventList

public java.util.List<CircleadRecurrenceRule.Event> getEventList(int maxInstances)

Gets the event list.

Parameters:

maxInstances - the max instances

Returns:

the event list

getDetails

public java.lang.String getDetails()

Gets the details.

Returns:

the details

getStartDateList

public java.util.List<org.dmfs.rfc5545.DateTime> getStartDateList(int maxInstances)

Gets the start date list.

Parameters:

maxInstances - the max instances

Returns:

the start date list

getEventList

public java.util.List<CircleadRecurrenceRule.Event> getEventList(org.dmfs.rfc5545.DateTime startDateTime,
                                                                 int maxInstances)

Gets the event list.

Parameters:

startDateTime - the start date time

maxInstances - the max instances

Returns:

the event list

getEventList

public java.util.List<CircleadRecurrenceRule.Event> getEventList(java.lang.String startDateTime,
                                                                 int maxInstances)

Gets the event list.

Parameters:

startDateTime - the start date time

maxInstances - the max instances

Returns:

the event list

getStartDateList

public java.util.List<org.dmfs.rfc5545.DateTime> getStartDateList(java.lang.String startDateTime,
                                                                  int maxInstances)

Gets the start date list.

Parameters:

startDateTime - the start date time

maxInstances - the max instances

Returns:

the start date list

getStartDateList

public java.util.List<org.dmfs.rfc5545.DateTime> getStartDateList(org.dmfs.rfc5545.DateTime startDateTime,
                                                                  int maxInstances)

Gets the start date list.

Parameters:

startDateTime - the start date time

maxInstances - limit instances for rules that recur forever

Returns:

the start date list

startDateIterator

public org.dmfs.rfc5545.recur.RecurrenceRuleIterator startDateIterator(java.lang.String startDateTime)

Start date iterator.

Parameters:

startDateTime - the start date time

Returns:

the recurrence rule iterator

startDateIterator

public org.dmfs.rfc5545.recur.RecurrenceRuleIterator startDateIterator()

Start iterator from actual data and time.

Returns:

the recurrence rule iterator

startDateIterator

public org.dmfs.rfc5545.recur.RecurrenceRuleIterator startDateIterator(org.dmfs.rfc5545.DateTime start)

Start date iterator.

Parameters:

start - the start

Returns:

the recurrence rule iterator

setInterval

public void setInterval(int interval)

Sets the interval.

Parameters:

interval - the new interval

setByPart

public void setByPart(org.dmfs.rfc5545.recur.RecurrenceRule.Part part,
                      java.util.List<java.lang.Integer> values)

Sets the by part.

Parameters:

part - the part

values - the values

setByPart

public void setByPart(org.dmfs.rfc5545.recur.RecurrenceRule.Part part,
                      java.lang.Integer... values)

Sets the by part.

Parameters:

part - the part

values - the values

convertDate

public static java.util.Date convertDate(org.dmfs.rfc5545.DateTime date)

Convert date.

Parameters:

date - the date

Returns:

the date