Mercurial > dive4elements > gnv-client
comparison gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/gap/TimeGap.java @ 810:991e13c3d504
Added Javadoc in timeseries package.
gnv-artifacts/trunk@894 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Ingo Weinzierl <ingo.weinzierl@intevation.de> |
|---|---|
| date | Fri, 09 Apr 2010 10:22:38 +0000 |
| parents | 5dd94448538d |
| children | 05bf8534a35a |
comparison
equal
deleted
inserted
replaced
| 809:d05b17a4f3d0 | 810:991e13c3d504 |
|---|---|
| 1 package de.intevation.gnv.timeseries.gap; | 1 package de.intevation.gnv.timeseries.gap; |
| 2 | 2 |
| 3 import java.io.Serializable; | 3 import java.io.Serializable; |
| 4 | 4 |
| 5 /** | |
| 6 * A class representing a timegap. <code>TimeGap</code>s are used in timeseries | |
| 7 * charts to identify gaps taking account for the resolution of the x-axis | |
| 8 * range. | |
| 9 * | |
| 10 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> | |
| 11 */ | |
| 5 public interface TimeGap extends Serializable { | 12 public interface TimeGap extends Serializable { |
| 6 | 13 |
| 7 public final static String TIME_UNIT_MINUTE = "m"; | 14 public final static String TIME_UNIT_MINUTE = "m"; |
| 8 public final static String TIME_UNIT_HOUR = "h"; | 15 public final static String TIME_UNIT_HOUR = "h"; |
| 9 public final static String TIME_UNIT_DAY = "D"; | 16 public final static String TIME_UNIT_DAY = "D"; |
| 17 public final static long WEEK_IN_MILLIS = 7 * DAY_IN_MILLIS; | 24 public final static long WEEK_IN_MILLIS = 7 * DAY_IN_MILLIS; |
| 18 | 25 |
| 19 | 26 |
| 20 /** | 27 /** |
| 21 * Returns the Lookup-Key for the TimeGap | 28 * Returns the Lookup-Key for the TimeGap |
| 22 * @return | 29 * |
| 30 * @return the timegap key. | |
| 23 */ | 31 */ |
| 24 int getKey(); | 32 int getKey(); |
| 25 | 33 |
| 26 /** | 34 /** |
| 27 * Returns the Value of the TimeValue in the Unit which is also given. | 35 * Returns the Value of the TimeValue in the Unit which is also given. |
| 28 * @return | 36 * |
| 37 * @return the timegap value. | |
| 29 */ | 38 */ |
| 30 int getValue(); | 39 int getValue(); |
| 31 | 40 |
| 32 /** | 41 /** |
| 33 * Returns the Unit of the Timegap (e.g. Minutes, Hours, Days, Weeks, Months, Years) | 42 * Returns the Unit of the Timegap (e.g. Minutes, Hours, Days, Weeks, Months, Years) |
| 34 * @return | 43 * |
| 44 * @return the timegap unit. | |
| 35 */ | 45 */ |
| 36 String getUnit(); | 46 String getUnit(); |
| 37 | 47 |
| 38 } | 48 } |
| 49 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |