Package org.bedework.convert
Class RecurRuleComponents
java.lang.Object
org.bedework.convert.RecurRuleComponents
Broken out recurrence rule.
recur = "FREQ"=freq *(
; either UNTIL or COUNT may appear in a 'recur',
; but UNTIL and COUNT MUST NOT occur in the same 'recur'
( ";" "UNTIL" "=" enddate ) /
( ";" "COUNT" "=" 1*DIGIT ) /
; the rest of these keywords are optional,
; but MUST NOT occur more than once
( ";" "INTERVAL" "=" 1*DIGIT ) /
( ";" "BYSECOND" "=" byseclist ) /
( ";" "BYMINUTE" "=" byminlist ) /
( ";" "BYHOUR" "=" byhrlist ) /
( ";" "BYDAY" "=" bywdaylist ) /
( ";" "BYMONTHDAY" "=" bymodaylist ) /
( ";" "BYYEARDAY" "=" byyrdaylist ) /
( ";" "BYWEEKNO" "=" bywknolist ) /
( ";" "BYMONTH" "=" bymolist ) /
( ";" "BYSETPOS" "=" bysplist ) /
( ";" "WKST" "=" weekday ) /
( ";" x-name "=" text )
)
freq = "SECONDLY" / "MINUTELY" / "HOURLY" / "DAILY"
/ "WEEKLY" / "MONTHLY" / "YEARLY"
enddate = date
enddate =/ date-time ;An UTC value
byseclist = seconds / ( seconds *("," seconds) )
seconds = 1DIGIT / 2DIGIT ;0 to 59
byminlist = minutes / ( minutes *("," minutes) )
minutes = 1DIGIT / 2DIGIT ;0 to 59
byhrlist = hour / ( hour *("," hour) )
hour = 1DIGIT / 2DIGIT ;0 to 23
bywdaylist = weekdaynum / ( weekdaynum *("," weekdaynum) )
weekdaynum = [([plus] ordwk / minus ordwk)] weekday
plus = "+"
minus = "-"
ordwk = 1DIGIT / 2DIGIT ;1 to 53
weekday = "SU" / "MO" / "TU" / "WE" / "TH" / "FR" / "SA"
;Corresponding to SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY,
;FRIDAY, SATURDAY and SUNDAY days of the week.
bymodaylist = monthdaynum / ( monthdaynum *("," monthdaynum) )
monthdaynum = ([plus] ordmoday) / (minus ordmoday)
ordmoday = 1DIGIT / 2DIGIT ;1 to 31
byyrdaylist = yeardaynum / ( yeardaynum *("," yeardaynum) )
yeardaynum = ([plus] ordyrday) / (minus ordyrday)
ordyrday = 1DIGIT / 2DIGIT / 3DIGIT ;1 to 366
bywknolist = weeknum / ( weeknum *("," weeknum) )
weeknum = ([plus] ordwk) / (minus ordwk)
bymolist = monthnum / ( monthnum *("," monthnum) )
monthnum = 1DIGIT / 2DIGIT ;1 to 12
bysplist = setposday / ( setposday *("," setposday) )
setposday = yeardaynum
- Version:
- 1.0
- Author:
- Mike Douglass douglm - rpi.edu
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAllows us to group days -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic org.bedework.util.misc.response.GetEntitiesResponse<RecurRuleComponents>Return parsed rrules.getByDay()intgetCount()net.fortuna.ical4j.model.Recur.FrequencygetFreq()intgetRule()net.fortuna.ical4j.model.DategetUntil()getWkst()voidvoidsetByHour(Collection<Integer> val) voidsetByMinute(Collection<Integer> val) voidsetByMonth(Collection<Integer> val) voidsetByMonthDay(Collection<Integer> val) voidsetBySecond(Collection<Integer> val) voidsetBySetPos(Collection<Integer> val) voidsetByWeekNo(Collection<Integer> val) voidsetByYearDay(Collection<Integer> val) voidsetCount(int val) voidsetFreq(net.fortuna.ical4j.model.Recur.Frequency val) voidsetInterval(int val) voidvoidsetUntil(net.fortuna.ical4j.model.Date val) void
-
Constructor Details
-
RecurRuleComponents
public RecurRuleComponents()
-
-
Method Details
-
setRule
- Parameters:
val- String rule this is derived from
-
getRule
- Returns:
- String weekstart or null
-
setFreq
public void setFreq(net.fortuna.ical4j.model.Recur.Frequency val) - Parameters:
val- Freq
-
getFreq
public net.fortuna.ical4j.model.Recur.Frequency getFreq()- Returns:
- Freq
-
setUntil
public void setUntil(net.fortuna.ical4j.model.Date val) - Parameters:
val- until Date
-
getUntil
public net.fortuna.ical4j.model.Date getUntil()- Returns:
- Date
-
setCount
public void setCount(int val) - Parameters:
val- count
-
getCount
public int getCount()- Returns:
- int
-
setInterval
public void setInterval(int val) - Parameters:
val- interval
-
getInterval
public int getInterval()- Returns:
- int
-
setBySecond
- Parameters:
val- bySecond list
-
getBySecond
- Returns:
- bySecond list or null
-
setByMinute
- Parameters:
val- byMinute list
-
getByMinute
- Returns:
- byMinute list or null
-
setByHour
- Parameters:
val- byHour list
-
getByHour
- Returns:
- byHour list or null
-
setByDay
- Parameters:
val- byDay map
-
getByDay
- Returns:
- byDay map or null
-
setByMonthDay
- Parameters:
val- byMonthDay list
-
getByMonthDay
- Returns:
- byMonthDay list or null
-
setByYearDay
- Parameters:
val- byYearDay list
-
getByYearDay
- Returns:
- byYearDay list or null
-
setByWeekNo
- Parameters:
val- byWeekNo list
-
getByWeekNo
- Returns:
- byWeekNo list or null
-
setByMonth
- Parameters:
val- byMonth list
-
getByMonth
- Returns:
- byMonth list or null
-
setBySetPos
- Parameters:
val- bySetPos list
-
getBySetPos
- Returns:
- bySetPos list or null
-
setWkst
- Parameters:
val- String weekstart
-
getWkst
- Returns:
- String weekstart or null
-
fromEventRrules
public static org.bedework.util.misc.response.GetEntitiesResponse<RecurRuleComponents> fromEventRrules(BwEvent ev) Return parsed rrules.- Parameters:
ev- containing rules- Returns:
- Response containing status and collection of parsed rrules
-