jfxtras.icalendarfx.properties.component.recurrence.rrule.RecurrenceRuleValue Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfxtras-all Show documentation
Show all versions of jfxtras-all Show documentation
Miscellaneous components for JavaFX
The newest version!
package jfxtras.icalendarfx.properties.component.recurrence.rrule;
import java.lang.reflect.Method;
import java.time.DayOfWeek;
import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.time.temporal.ChronoUnit;
import java.time.temporal.Temporal;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.Spliterator;
import java.util.Spliterators;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;
import jfxtras.icalendarfx.VChild;
import jfxtras.icalendarfx.VParent;
import jfxtras.icalendarfx.VParentBase;
import jfxtras.icalendarfx.properties.component.recurrence.RecurrenceRule;
import jfxtras.icalendarfx.properties.component.recurrence.rrule.Count;
import jfxtras.icalendarfx.properties.component.recurrence.rrule.Frequency;
import jfxtras.icalendarfx.properties.component.recurrence.rrule.FrequencyType;
import jfxtras.icalendarfx.properties.component.recurrence.rrule.Interval;
import jfxtras.icalendarfx.properties.component.recurrence.rrule.RRulePart;
import jfxtras.icalendarfx.properties.component.recurrence.rrule.RecurrenceRuleValue;
import jfxtras.icalendarfx.properties.component.recurrence.rrule.Until;
import jfxtras.icalendarfx.properties.component.recurrence.rrule.WeekStart;
import jfxtras.icalendarfx.properties.component.recurrence.rrule.byxxx.ByDay;
import jfxtras.icalendarfx.properties.component.recurrence.rrule.byxxx.ByHour;
import jfxtras.icalendarfx.properties.component.recurrence.rrule.byxxx.ByMinute;
import jfxtras.icalendarfx.properties.component.recurrence.rrule.byxxx.ByMonth;
import jfxtras.icalendarfx.properties.component.recurrence.rrule.byxxx.ByMonthDay;
import jfxtras.icalendarfx.properties.component.recurrence.rrule.byxxx.ByRule;
import jfxtras.icalendarfx.properties.component.recurrence.rrule.byxxx.ByRuleAbstract;
import jfxtras.icalendarfx.properties.component.recurrence.rrule.byxxx.BySecond;
import jfxtras.icalendarfx.properties.component.recurrence.rrule.byxxx.ByYearDay;
import jfxtras.icalendarfx.utilities.DateTimeUtilities;
import jfxtras.icalendarfx.utilities.ICalendarUtilities;
import jfxtras.icalendarfx.utilities.DateTimeUtilities.DateTimeType;
/**
* RRULE
* Recurrence Rule
* RFC 5545 iCalendar 3.3.10 page 38
*
* Contains the following Recurrence Rule elements:
* COUNT
* UNTIL
* FREQUENCY
* INTERVAL
* BYxxx RULES in a List
*
* The value part of the recurrence rule. It supports the following elements:
* ( "FREQ" "=" freq )
* ( "UNTIL" "=" enddate )
* ( "COUNT" "=" 1*DIGIT )
* ( "INTERVAL" "=" 1*DIGIT )
* ( "BYSECOND" "=" byseclist )
* ( "BYMINUTE" "=" byminlist )
* ( "BYHOUR" "=" byhrlist )
* ( "BYDAY" "=" bywdaylist )
* ( "BYMONTHDAY" "=" bymodaylist )
* ( "BYYEARDAY" "=" byyrdaylist )
* ( "BYWEEKNO" "=" bywknolist )
* ( "BYMONTH" "=" bymolist )
* ( "BYSETPOS" "=" bysplist )
* ( "WKST" "=" weekday )
*
* In addition to methods to support iCalendar recurrence rule parts, there is a method
* {@link #streamRecurrences(Temporal)} that produces a stream of start date/times for the recurrences
* defined by the rule.
*
* @author David Bal
* @see RecurrenceRule
*
*/
public class RecurrenceRuleValue extends VParentBase implements VChild
{
private VParent myParent;
@Override public void setParent(VParent parent) { myParent = parent; }
@Override public VParent getParent() { return myParent; }
private static final String NAME = "RRULE";
@Override public String name() { return NAME; }
/**
* BYxxx Rules
* RFC 5545, iCalendar 3.3.10 Page 42
*
* List contains any of the following. The following list also indicates the processing order:
* {@link ByMonth} {@link ByWeekNo} {@link ByYearDay} {@link ByMonthDay} {@link ByDay} {@link ByHour}
* {@link ByMinute} {@link BySecond} {@link BySetPos}
*
* BYxxx rules modify the recurrence set by either expanding or limiting it.
*
* Each BYxxx rule can only occur once
* */
public List> getByRules() { return byRules; }
private List> byRules;
public void setByRules(List> byRules)
{
if (this.byRules != null)
{
this.byRules.forEach(e -> orderChild(e, null)); // remove old elements
}
this.byRules = byRules;
if (byRules != null)
{
byRules.forEach(e -> orderChild(e));
}
}
public void setByRules(String...byRules)
{
Arrays.stream(byRules).forEach(c -> parseContent(c));
}
public RecurrenceRuleValue withByRules(Collection> byRules)
{
if (getByRules() == null)
{
setByRules(new ArrayList<>());
}
getByRules().addAll(byRules);
if (byRules != null)
{
byRules.forEach(c -> orderChild(c));
}
return this;
}
public RecurrenceRuleValue withByRules(ByRule...byRules)
{
return withByRules(Arrays.asList(byRules));
}
public RecurrenceRuleValue withByRules(String...byRules)
{
setByRules(byRules);
return this;
}
/** Return particular ByRule of passed class */
public ByRule lookupByRule(Class class1)
{
if (getByRules() == null) return null;
Optional> byRule = getByRules()
.stream()
.filter(r -> r instanceof ByDay)
.findAny();
if (! byRule.isPresent()) return null;
return byRule.get();
}
/**
* COUNT:
* RFC 5545 iCalendar 3.3.10, page 41
*
* The COUNT rule part defines the number of occurrences at which to
* range-bound the recurrence. The "DTSTART" property value always
* counts as the first occurrence.
*/
private Count count;
public Count getCount() { return count; }
public void setCount(Count count)
{
orderChild(this.count, count);
this.count = count;
}
public void setCount(int count) { setCount(new Count(count)); }
public RecurrenceRuleValue withCount(Count count)
{
setCount(count);
return this;
}
public RecurrenceRuleValue withCount(int count)
{
setCount(count);
return this;
}
/**
* FREQUENCY
* FREQ
* RFC 5545 iCalendar 3.3.10 p40
*
* required element
*
* The FREQ rule part identifies the type of recurrence rule. This
* rule part MUST be specified in the recurrence rule. Valid values
* include SECONDLY, to specify repeating events based on an interval
* of a second or more; MINUTELY, to specify repeating events based
* on an interval of a minute or more; HOURLY, to specify repeating
* events based on an interval of an hour oparseContentr more; DAILY, to specify
* repeating events based on an interval of a day or more; WEEKLY, to
* specify repeating events based on an interval of a week or more;
* MONTHLY, to specify repeating events based on an interval of a
* month or more; and YEARLY, to specify repeating events based on an
* interval of a year or more.
*/
private Frequency frequency;
public Frequency getFrequency() { return frequency; }
public void setFrequency(Frequency frequency)
{
orderChild(this.frequency, frequency);
this.frequency = frequency;
}
public void setFrequency(String frequency)
{
setFrequency(Frequency.parse(frequency));
}
public void setFrequency(FrequencyType frequency)
{
setFrequency(new Frequency(frequency));
}
public RecurrenceRuleValue withFrequency(Frequency frequency)
{
setFrequency(frequency);
return this;
}
public RecurrenceRuleValue withFrequency(String frequency)
{
setFrequency(frequency);
return this;
}
public RecurrenceRuleValue withFrequency(FrequencyType frequency)
{
setFrequency(frequency);
return this;
}
/**
* INTERVAL
* RFC 5545 iCalendar 3.3.10, page 40
*
* The INTERVAL rule part contains a positive integer representing at
* which intervals the recurrence rule repeats. The default value is
* "1", meaning every second for a SECONDLY rule, every minute for a
* MINUTELY rule, every hour for an HOURLY rule, every day for a
* DAILY rule, every week for a WEEKLY rule, every month for a
* MONTHLY rule, and every year for a YEARLY rule. For example,
* within a DAILY rule, a value of "8" means every eight days.
*/
private Interval interval;
public Interval getInterval() { return interval; }
public void setInterval(Interval interval)
{
orderChild(this.interval, interval);
this.interval = interval;
}
public void setInterval(Integer interval) { setInterval(new Interval(interval)); }
public RecurrenceRuleValue withInterval(int interval) { setInterval(interval); return this; }
public RecurrenceRuleValue withInterval(Interval interval) { setInterval(interval); return this; }
/**
* UNTIL:
* RFC 5545 iCalendar 3.3.10, page 41
*
* The UNTIL rule part defines a DATE or DATE-TIME value that bounds
* the recurrence rule in an inclusive manner. If the value
* specified by UNTIL is synchronized with the specified recurrence,
* this DATE or DATE-TIME becomes the last instance of the
* recurrence. The value of the UNTIL rule part MUST have the same
* value type as the "DTSTART" property. Furthermore, if the
* "DTSTART" property is specified as a date with local time, then
* the UNTIL rule part MUST also be specified as a date with local
* time. If the "DTSTART" property is specified as a date with UTC
* time or a date with local time and time zone reference, then the
* UNTIL rule part MUST be specified as a date with UTC time. In the
* case of the "STANDARD" and "DAYLIGHT" sub-components the UNTIL
* rule part MUST always be specified as a date with UTC time. If
* specified as a DATE-TIME value, then it MUST be specified in a UTC
* time format. If not present, and the COUNT rule part is also not
* present, the "RRULE" is considered to repeat forever
*/
private Until until;
public Until getUntil() { return until; }
public void setUntil(Until until)
{
orderChild(this.until, until);
this.until = until;
}
public void setUntil(Temporal until) { setUntil(new Until(until)); }
public void setUntil(String until) { setUntil(DateTimeUtilities.temporalFromString(until)); }
public RecurrenceRuleValue withUntil(Temporal until) { setUntil(until); return this; }
public RecurrenceRuleValue withUntil(String until) { setUntil(until); return this; }
public RecurrenceRuleValue withUntil(Until until) { setUntil(until); return this; }
/**
* Week Start
* WKST:
* RFC 5545 iCalendar 3.3.10, page 42
*
* The WKST rule part specifies the day on which the workweek starts.
* Valid values are MO, TU, WE, TH, FR, SA, and SU. This is
* significant when a WEEKLY "RRULE" has an interval greater than 1,
* and a BYDAY rule part is specified. This is also significant when
* in a YEARLY "RRULE" when a BYWEEKNO rule part is specified. The
* default value is MO.
*/
private WeekStart weekStart;
public WeekStart getWeekStart() { return weekStart; }
public void setWeekStart(WeekStart weekStart)
{
orderChild(this.weekStart, weekStart);
this.weekStart = weekStart;
}
public void setWeekStart(DayOfWeek weekStart) { setWeekStart(new WeekStart(weekStart)); }
public RecurrenceRuleValue withWeekStart(WeekStart weekStart) { setWeekStart(weekStart); return this; }
public RecurrenceRuleValue withWeekStart(DayOfWeek weekStart) { setWeekStart(weekStart); return this; }
/*
* Changes to getSetter and getGetter methods to provide mapping for any ByRule class
* to the getByRule getter.
*
* (non-Javadoc)
* @see net.balsoftware.icalendar.VParentBase#getSetter(net.balsoftware.icalendar.VChild)
*/
@Override
protected Method getSetter(VChild child)
{
Method setter = getSetters().get(child.getClass());
if ((setter == null) && (ByRule.class.isAssignableFrom(child.getClass())))
{
setter = getSetters().get(ByRule.class);
}
return setter;
}
@Override
protected Method getGetter(VChild child)
{
Method getter = getGetters().get(child.getClass());
if ((getter == null) && (ByRule.class.isAssignableFrom(child.getClass())))
{
getter = getGetters().get(ByRule.class);
}
return getter;
}
/*
* CONSTRUCTORS
*/
public RecurrenceRuleValue()
{
super();
}
// Copy constructor
public RecurrenceRuleValue(RecurrenceRuleValue source)
{
super(source);
setParent(source.getParent());
}
/** Parse component from content line */
@Override
protected List parseContent(String contentLine)
{
List messages = new ArrayList<>();
ICalendarUtilities.parseInlineElementsToListPair(contentLine)
.stream()
.forEach(entry -> processInLineChild(messages, entry.getKey(), entry.getValue(), RRulePart.class));
return messages;
}
/**
* STREAM RECURRENCES
*
* Resulting stream of start date/times by applying Frequency temporal adjuster and all, if any,
*
* Starts on startDateTime, which MUST be a valid occurrence date/time, but not necessarily the
* first date/time (DTSTART) in the sequence. A later startDateTime can be used to more efficiently
* get to later dates in the stream.
*
* @param start - starting point of stream (MUST be a valid occurrence date/time)
* @return
*/
public Stream streamRecurrences(Temporal start)
{
int interval = (getInterval() == null) ? Interval.DEFAULT_INTERVAL : getInterval().getValue();
Stream frequencyStream = getFrequency().streamRecurrences(start, interval);
Stream recurrenceStream = frequencyStream
.flatMap(value ->
{
// process byRules
chronoUnit = getFrequency().getValue().getChronoUnit(); // initial chronoUnit from Frequency
myStream = Arrays.asList(value).stream();
if (getByRules() != null)
{
getByRules().stream()
.sorted()
.forEach(rule ->
{
myStream = rule.streamRecurrences(myStream, chronoUnit, start);
// chronoUnit = RRuleElement.fromClass(rule.getClass()).getChronoUnit();
chronoUnit = ((ByRuleAbstract) rule).elementType.getChronoUnit();
});
}
// must filter out too early recurrences
return myStream.filter(r -> ! DateTimeUtilities.isBefore(r, start));
});
if (getCount() != null)
{
return recurrenceStream.limit(getCount().getValue());
} else if (getUntil() != null)
{
ZoneId zone = (start instanceof ZonedDateTime) ? ((ZonedDateTime) start).getZone() : null;
Temporal convertedUntil = DateTimeType.of(start).from(getUntil().getValue(), zone);
return takeWhile(recurrenceStream, a -> ! DateTimeUtilities.isAfter(a, convertedUntil));
}
return recurrenceStream;
}
private ChronoUnit chronoUnit; // must be field instead of local variable due to use in lambda expression
private Stream myStream; // must be field instead of local variable due to use in lambda expression
/**
* Determines if recurrence set is goes on forever
*
* @return - true if recurrence set is infinite, false otherwise
*/
public boolean isInfinite()
{
return ((getCount() == null) && (getUntil() == null));
}
// takeWhile - From http://stackoverflow.com/questions/20746429/limit-a-stream-by-a-predicate
static Spliterator takeWhile(Spliterator splitr, Predicate predicate)
{
return new Spliterators.AbstractSpliterator(splitr.estimateSize(), 0) {
boolean stillGoing = true;
@Override public boolean tryAdvance(Consumer consumer) {
if (stillGoing) {
boolean hadNext = splitr.tryAdvance(elem -> {
if (predicate.test(elem)) {
consumer.accept(elem);
} else {
stillGoing = false;
}
});
return hadNext && stillGoing;
}
return false;
}
};
}
static Stream takeWhile(Stream stream, Predicate predicate) {
return StreamSupport.stream(takeWhile(stream.spliterator(), predicate), false);
}
@Override
public String toString()
{
return childrenUnmodifiable().stream()
.map(c -> c.toString())
.collect(Collectors.joining(";"));
}
@Override
public List errors()
{
List errors = super.errors();
if (getFrequency() == null)
{
errors.add(name() + ":" + "FREQ is not present. FREQ is REQUIRED and MUST NOT occur more than once");
}
if (getByRules() != null)
{
getByRules().stream().collect(Collectors.groupingBy(ByRule::getClass, Collectors.counting()));
}
boolean isUntilPresent = getUntil() != null;
boolean isCountPresent = getCount() != null;
if (isUntilPresent && isCountPresent)
{
errors.add(name() + ":" + "UNTIL and COUNT are both present. UNTIL or COUNT rule parts are OPTIONAL, but they MUST NOT both occur.");
}
List> byRules = (getByRules() == null) ? Collections.emptyList() : new ArrayList<>(getByRules());
List duplicateByRuleMessages = byRules.stream()
.collect(Collectors.groupingBy(ByRule::getClass, Collectors.counting()))
.entrySet()
.stream()
.filter(e -> e.getValue() > 1)
.map(e -> name() + ":" + e.getKey().getSimpleName() + " can only occur once in a RRULE.")
.collect(Collectors.toList());
errors.addAll(duplicateByRuleMessages);
return errors;
}
@Override
protected boolean checkChild(List messages, String content, String elementName, VChild newChild)
{
boolean isSuperOk = super.checkChild(messages, content, elementName, newChild);
if (newChild instanceof ByRule)
{
List> byRules = (getByRules() == null) ? new ArrayList<>() : new ArrayList<>(getByRules());
byRules.add((ByRule) newChild);
// System.out.println("byRules:" + byRules + " " + newChild);
List duplicateByRuleMessages = byRules.stream()
.collect(Collectors.groupingBy(ByRule::getClass, Collectors.counting()))
.entrySet()
.stream()
.filter(e -> e.getValue() > 1)
.map(e -> new Message(this,
newChild.getClass().getSimpleName() + " can only occur once in a calendar component.",
MessageEffect.MESSAGE_ONLY))
.collect(Collectors.toList());
boolean isDuplicateByRulePresent = duplicateByRuleMessages.isEmpty();
messages.addAll(duplicateByRuleMessages);
return isSuperOk && isDuplicateByRulePresent;
}
return isSuperOk;
}
public static RecurrenceRuleValue parse(String content)
{
return RecurrenceRuleValue.parse(new RecurrenceRuleValue(), content);
}
}