1 /* ====================================================================
2 * The Apache Software License, Version 1.1
3 *
4 * Copyright (c) 2003 Digital Clash LLC. All rights
5 * reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 *
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
17 * distribution.
18 *
19 * 3. The end-user documentation included with the redistribution,
20 * if any, must include the following acknowledgment:
21 * "This product includes software developed by the
22 * ChronicJ team (http://www.chronicj.org/)."
23 * Alternately, this acknowledgment may appear in the software itself,
24 * if and wherever such third-party acknowledgments normally appear.
25 *
26 * 4. The names "ChronicJ" and "Digital Clash" not be used to endorse or
27 * promote products derived from this software without prior written
28 * permission. For written permission, please contact
29 * info@digitalclash.com.
30 *
31 * 5. Products derived from this software may not be called "ChronicJ",
32 * "Digital Clash", nor may "ChronicJ" or "Digital Clash" appear in
33 * their name, without prior written permission of Digital Clash LLC.
34 *
35 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46 * SUCH DAMAGE.
47 * ====================================================================
48 * This product includes software developed by the by the
49 * Apache Software Foundation (http://www.apache.org/).
50 * ====================================================================
51 */
52 package org.chronicj.impl;
53
54 import org.chronicj.TimePoint;
55
56
57 /***
58 * <p>
59 * Implements support for temporal expressions that describe a recurring range
60 * of the year. In pseudocode, this is of the form: "starting May 5th and
61 * ending August 28th" or "From November to December". Expression syntax is
62 * specified using constructors.
63 * </p>
64 *
65 * <p>
66 * This class is based directly on patterns described in a paper by Martin
67 * Fowler which can be found <a
68 * href="http://martinfowler.com/apsupp/recurring.pdf">here</a>.
69 * </p>
70 *
71 * @author <a href="mlipper@US-ABP.com">Matthew Lipper</a>
72 *
73 * @see <a href="http://martinfowler.com/apsupp/recurring.pdf">Recurring Events
74 * for Calendars</a> by Martin Fowler
75 */
76 public class RangeEachYearTE extends AbstractTemporalExpression {
77 private int endDay;
78 private int endMonth;
79 private int startDay;
80 private int startMonth;
81
82 public RangeEachYearTE(int startMonth, int startDay, int endMonth,
83 int endDay) {
84 this.startMonth = startMonth;
85 this.endMonth = endMonth;
86 this.startDay = startDay;
87 this.endDay = endDay;
88 }
89
90 public RangeEachYearTE(int startMonth, int endMonth) {
91 this.startMonth = startMonth;
92 this.endMonth = endMonth;
93 this.startDay = 0;
94 this.endDay = 0;
95 }
96
97 public RangeEachYearTE(int month) {
98 this.startMonth = month;
99 this.endMonth = month;
100 this.startDay = 0;
101 this.endDay = 0;
102 }
103
104 /*
105 * @see org.chronicj.TemporalExpression#includes(org.chronicj.TimePoint)
106 */
107 public boolean includes(TimePoint aTimePoint) {
108 return monthsInclude(aTimePoint) || startMonthIncludes(aTimePoint) ||
109 endMonthIncludes(aTimePoint);
110 }
111
112 private boolean endMonthIncludes(TimePoint aTimePoint) {
113 if (aTimePoint.getMonth() != endMonth) {
114 return false;
115 }
116
117 if (endDay == 0) {
118 return true;
119 }
120
121 return (aTimePoint.getDayOfMonth() <= endDay);
122 }
123
124 private boolean monthsInclude(TimePoint aTimePoint) {
125 int month = aTimePoint.getMonth();
126
127 return ((month > startMonth) && (month < endMonth));
128 }
129
130 private boolean startMonthIncludes(TimePoint aTimePoint) {
131 if (aTimePoint.getMonth() != startMonth) {
132 return false;
133 }
134
135 if (startDay == 0) {
136 return true;
137 }
138
139 return (aTimePoint.getDayOfMonth() >= startDay);
140 }
141 }
This page was automatically generated by Maven