001: /*
002: The contents of this file are subject to the Common Public Attribution License
003: Version 1.0 (the "License"); you may not use this file except in compliance with
004: the License. You may obtain a copy of the License at
005: http://www.projity.com/license . The License is based on the Mozilla Public
006: License Version 1.1 but Sections 14 and 15 have been added to cover use of
007: software over a computer network and provide for limited attribution for the
008: Original Developer. In addition, Exhibit A has been modified to be consistent
009: with Exhibit B.
010:
011: Software distributed under the License is distributed on an "AS IS" basis,
012: WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
013: specific language governing rights and limitations under the License. The
014: Original Code is OpenProj. The Original Developer is the Initial Developer and
015: is Projity, Inc. All portions of the code written by Projity are Copyright (c)
016: 2006, 2007. All Rights Reserved. Contributors Projity, Inc.
017:
018: Alternatively, the contents of this file may be used under the terms of the
019: Projity End-User License Agreeement (the Projity License), in which case the
020: provisions of the Projity License are applicable instead of those above. If you
021: wish to allow use of your version of this file only under the terms of the
022: Projity License and not to allow others to use your version of this file under
023: the CPAL, indicate your decision by deleting the provisions above and replace
024: them with the notice and other provisions required by the Projity License. If
025: you do not delete the provisions above, a recipient may use your version of this
026: file under either the CPAL or the Projity License.
027:
028: [NOTE: The text of this license may differ slightly from the text of the notices
029: in Exhibits A and B of the license at http://www.projity.com/license. You should
030: use the latest text at http://www.projity.com/license for your modifications.
031: You may not remove this license text from the source files.]
032:
033: Attribution Information: Attribution Copyright Notice: Copyright © 2006, 2007
034: Projity, Inc. Attribution Phrase (not exceeding 10 words): Powered by OpenProj,
035: an open source solution from Projity. Attribution URL: http://www.projity.com
036: Graphic Image as provided in the Covered Code as file: openproj_logo.png with
037: alternatives listed on http://www.projity.com/logo
038:
039: Display of Attribution Information is required in Larger Works which are defined
040: in the CPAL as a work which combines Covered Code or portions thereof with code
041: not governed by the terms of the CPAL. However, in addition to the other notice
042: obligations, all copies of the Covered Code in Executable and Source Code form
043: distributed must, as a form of attribution of the original author, include on
044: each user interface screen the "OpenProj" logo visible to all users. The
045: OpenProj logo should be located horizontally aligned with the menu bar and left
046: justified on the top left of the screen adjacent to the File menu. The logo
047: must be at least 100 x 25 pixels. When users click on the "OpenProj" logo it
048: must direct them back to http://www.projity.com.
049: */
050: package com.projity.algorithm;
051:
052: import java.util.GregorianCalendar;
053: import com.projity.util.DateTime;
054:
055: /**
056: * A generator corresponding to a start/end with an optional stepping value. The stepping value is specified as
057: * a unit type of the Calendar class (DAY_OF_YEAR for example) as a gregorian calendar is used.
058: */
059: public class RangeIntervalGenerator implements IntervalGenerator {
060: long start;
061: long end;
062: long step;
063: int calendarStepUnit;
064: int calendarStepAmount = 1;
065: long currentEnd;
066: long nextEnd;
067: GregorianCalendar stepCal = null;
068:
069: private RangeIntervalGenerator() {
070: this (0, Long.MAX_VALUE);
071: }
072:
073: private RangeIntervalGenerator(long start, long end) {
074: this .start = start;
075: this .end = end;
076: currentEnd = end;
077: step = end; // make sure that will go past end
078: nextEnd = end + step;
079: }
080:
081: private RangeIntervalGenerator(long start, long end,
082: int calendarStepUnit) {
083: this .start = start;
084: this .end = end;
085: this .calendarStepUnit = calendarStepUnit;
086: stepCal = new GregorianCalendar();
087: stepCal.setTimeInMillis(start);
088: stepCal.add(calendarStepUnit, calendarStepAmount);
089: currentEnd = stepCal.getTimeInMillis();
090: if (currentEnd > end) // in case just one time period
091: currentEnd = end;
092: stepCal.add(calendarStepUnit, calendarStepAmount);
093: nextEnd = stepCal.getTimeInMillis();
094: }
095:
096: /**
097: * Used if filtering values between dates, not in a groupBy
098: * @param start
099: * @param end
100: * @return
101: */
102: public static RangeIntervalGenerator betweenInstance(long start,
103: long end) {
104: RangeIntervalGenerator result = getInstance(start, end);
105: result.currentEnd = start;
106: return result;
107: }
108:
109: /* (non-Javadoc)
110: * @see com.projity.algorithm.IntervalGenerator#current()
111: */
112: public Object current() {
113: return null;
114: }
115:
116: /* (non-Javadoc)
117: * @see com.projity.algorithm.IntervalGenerator#currentEnd()
118: */
119: public long currentEnd() {
120: return currentEnd;
121: }
122:
123: public long currentStart() {
124: return start;
125: }
126:
127: /* (non-Javadoc)
128: * @see com.projity.algorithm.IntervalGenerator#next()
129: */
130: public boolean evaluate(Object obj) {
131: start = currentEnd; // move on to next interval. If only one, then will stop here
132: currentEnd = nextEnd;
133: if (currentEnd > end)
134: currentEnd = end;
135:
136: if (stepCal != null) {
137: stepCal.add(calendarStepUnit, calendarStepAmount);
138: nextEnd = stepCal.getTimeInMillis();
139: } else {
140: nextEnd += step;
141: }
142:
143: if (start >= end)
144: return false;
145: return true;
146: }
147:
148: /* (non-Javadoc)
149: * @see java.lang.Comparable#compareTo(java.lang.Object)
150: */
151: public int compareTo(Object arg0) {
152: // TODO Auto-generated method stub
153: return 0;
154: }
155:
156: /**
157: * @return Returns the end.
158: */
159: public long getEnd() {
160: return end;
161: }
162:
163: /**
164: * @return Returns the start.
165: */
166: public long getStart() {
167: return start;
168: }
169:
170: /**
171: * Continuous time is considered from 1/1/1970 to 1/1/3000. Note I do not use Long.MAX_VALUE because adding to it would cause wrapping to negative values
172: */
173: public static RangeIntervalGenerator continuous() {
174: return getInstance(0, DateTime.getMaxCalendar()
175: .getTimeInMillis());
176: }
177:
178: public static RangeIntervalGenerator empty() {
179: return getInstance(0, 0);
180: }
181:
182: public static RangeIntervalGenerator getInstance() {
183: return new RangeIntervalGenerator();
184: }
185:
186: public static RangeIntervalGenerator getInstance(long start,
187: long end) {
188: return new RangeIntervalGenerator(start, end);
189: }
190:
191: public static RangeIntervalGenerator getInstance(long start,
192: long end, int calendarStepUnit) {
193: return new RangeIntervalGenerator(start, end, calendarStepUnit);
194: }
195:
196: /* (non-Javadoc)
197: * @see com.projity.algorithm.IntervalGenerator#isActive()
198: */
199: public boolean isCurrentActive() {
200: return true;
201: }
202:
203: /* (non-Javadoc)
204: * @see com.projity.algorithm.IntervalGenerator#hasNext()
205: */
206: public boolean hasNext() {
207: return (nextEnd < end);
208: }
209:
210: /* (non-Javadoc)
211: * @see com.projity.algorithm.IntervalGenerator#canBeShared()
212: */
213: public boolean canBeShared() {
214: return true;
215: }
216: }
|