Frames | No Frames |
1: /* ======================================================================== 2: * JCommon : a free general purpose class library for the Java(tm) platform 3: * ======================================================================== 4: * 5: * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors. 6: * 7: * Project Info: http://www.jfree.org/jcommon/index.html 8: * 9: * This library is free software; you can redistribute it and/or modify it 10: * under the terms of the GNU Lesser General Public License as published by 11: * the Free Software Foundation; either version 2.1 of the License, or 12: * (at your option) any later version. 13: * 14: * This library is distributed in the hope that it will be useful, but 15: * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 16: * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 17: * License for more details. 18: * 19: * You should have received a copy of the GNU Lesser General Public 20: * License along with this library; if not, write to the Free Software 21: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 22: * USA. 23: * 24: * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 25: * in the United States and other countries.] 26: * 27: * ------------------------- 28: * DayOfWeekInMonthRule.java 29: * ------------------------- 30: * (C) Copyright 2000-2003, by Object Refinery Limited. 31: * 32: * Original Author: David Gilbert (for Object Refinery Limited); 33: * Contributor(s): -; 34: * 35: * $Id: DayOfWeekInMonthRule.java,v 1.5 2005/11/16 15:58:40 taqua Exp $ 36: * 37: * Changes (from 26-Oct-2001) 38: * -------------------------- 39: * 26-Oct-2001 : Changed package to com.jrefinery.date.*; 40: * 03-Oct-2002 : Fixed errors reported by Checkstyle (DG); 41: * 01-Jun-2005 : Removed the explicit clonable declaration, it is declared 42: * in the super class. 43: */ 44: 45: package org.jfree.date; 46: 47: /** 48: * An annual date rule that specifies the nth day of the week in a given month 49: * (for example, the third Wednesday in June, or the last Friday in November). 50: * 51: * @author David Gilbert 52: */ 53: public class DayOfWeekInMonthRule extends AnnualDateRule { 54: 55: /** FIRST, SECOND, THIRD, FOURTH or LAST. */ 56: private int count; 57: 58: /** The day of the week (SerialDate.MONDAY, SerialDate.TUESDAY...). */ 59: private int dayOfWeek; 60: 61: /** The month (1 to 12, or SerialDate.JANUARY, SerialDate.FEBRUARY...). */ 62: private int month; 63: 64: /** 65: * Default constructor: builds a rule for the first Monday in January by default. 66: */ 67: public DayOfWeekInMonthRule() { 68: this(1, SerialDate.MONDAY, MonthConstants.JANUARY); 69: } 70: 71: /** 72: * Standard constructor: builds a rule with the specified attributes. 73: * 74: * @param count one of: FIRST, SECOND, THIRD, FOURTH or LAST. 75: * @param dayOfWeek the day-of-the-week (SerialDate.MONDAY, SerialDate.TUESDAY, etc.). 76: * @param month the month (SerialDate.JANUARY, SerialDate.FEBRUARY, etc.). 77: */ 78: public DayOfWeekInMonthRule(final int count, final int dayOfWeek, final int month) { 79: this.count = count; 80: this.dayOfWeek = dayOfWeek; 81: this.month = month; 82: } 83: 84: /** 85: * Returns the 'count' for this rule (one of FIRST, SECOND, THIRD, FOURTH and LAST). 86: * 87: * @return the 'count'. 88: */ 89: public int getCount() { 90: return this.count; 91: } 92: 93: /** 94: * Sets the 'count' for this rule (one of FIRST, SECOND, THIRD, FOURTH and LAST). 95: * 96: * @param count the 'count'. 97: */ 98: public void setCount(final int count) { 99: this.count = count; 100: } 101: 102: /** 103: * Returns the day-of-the-week for this rule (SerialDate.MONDAY, SerialDate.TUESDAY, etc.). 104: * 105: * @return the day-of-the-week. 106: */ 107: public int getDayOfWeek() { 108: return this.dayOfWeek; 109: } 110: 111: /** 112: * Sets the day-of-the-week for this rule. 113: * 114: * @param dayOfWeek the day-of-the-week. 115: */ 116: public void setDayOfWeek(final int dayOfWeek) { 117: this.dayOfWeek = dayOfWeek; 118: } 119: 120: /** 121: * Returns the month for this rule. 122: * 123: * @return the month. 124: */ 125: public int getMonth() { 126: return this.month; 127: } 128: 129: /** 130: * Sets the month for this rule. 131: * 132: * @param month the month (SerialDate.JANUARY, SerialDate.FEBRUARY, etc.). 133: */ 134: public void setMonth(final int month) { 135: this.month = month; 136: } 137: 138: /** 139: * Return the date for this rule, given the year. 140: * 141: * @param year the year. 142: * 143: * @return the date generated by the rule for the given year. 144: */ 145: public SerialDate getDate(final int year) { 146: SerialDate result; 147: if (this.count != SerialDate.LAST_WEEK_IN_MONTH) { 148: // start at the beginning of the month 149: result = SerialDate.createInstance(1, this.month, year); 150: while (result.getDayOfWeek() != this.dayOfWeek) { 151: result = SerialDate.addDays(1, result); 152: } 153: result = SerialDate.addDays(7 * (this.count - 1), result); 154: 155: } 156: else { 157: // start at the end of the month and work backwards... 158: result = SerialDate.createInstance(1, this.month, year); 159: result = result.getEndOfCurrentMonth(result); 160: while (result.getDayOfWeek() != this.dayOfWeek) { 161: result = SerialDate.addDays(-1, result); 162: } 163: 164: } 165: return result; 166: } 167: 168: }