Mercurial > dive4elements > gnv-client
changeset 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 | d05b17a4f3d0 |
| children | df6d980c5418 |
| files | gnv-artifacts/ChangeLog gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/TimeSeriesArtifact.java gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/TimeSeriesMeshArtifact.java gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/gap/DefaultTimeGap.java gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/gap/TimeGap.java |
| diffstat | 5 files changed, 41 insertions(+), 24 deletions(-) [+] |
line wrap: on
line diff
--- a/gnv-artifacts/ChangeLog Fri Apr 09 07:27:38 2010 +0000 +++ b/gnv-artifacts/ChangeLog Fri Apr 09 10:22:38 2010 +0000 @@ -1,3 +1,11 @@ +2010-04-09 Ingo Weinzierl <ingo.weinzierl@intevation.de> + + * src/main/java/de/intevation/gnv/timeseries/TimeSeriesMeshArtifact.java, + src/main/java/de/intevation/gnv/timeseries/gap/TimeGap.java, + src/main/java/de/intevation/gnv/timeseries/gap/DefaultTimeGap.java, + src/main/java/de/intevation/gnv/timeseries/TimeSeriesArtifact.java: Added + more Javadoc. + 2010-04-09 Ingo Weinzierl <ingo.weinzierl@intevation.de> * src/main/java/de/intevation/gnv/state/describedata/NamedArrayList.java,
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/TimeSeriesArtifact.java Fri Apr 09 07:27:38 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/TimeSeriesArtifact.java Fri Apr 09 10:22:38 2010 +0000 @@ -9,6 +9,8 @@ import org.w3c.dom.Document; /** + * Artifact used for product timeseries product. + * * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> * @@ -35,11 +37,6 @@ } - /** - * @see de.intevation.gnv.artifacts.GNVArtifactBase#setup(java.lang.String, - * de.intevation.artifacts.ArtifactFactory, java.lang.Object - * org.w3c.dom.Document) - */ @Override public void setup(String identifier, ArtifactFactory factory, Object context, Document data) {
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/TimeSeriesMeshArtifact.java Fri Apr 09 07:27:38 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/TimeSeriesMeshArtifact.java Fri Apr 09 10:22:38 2010 +0000 @@ -1,16 +1,20 @@ package de.intevation.gnv.timeseries; +/** + * Artifact used for timeseries on meshes. + * + * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> + */ public class TimeSeriesMeshArtifact extends TimeSeriesArtifact { private static final long serialVersionUID = 5680432486700275986L; /** - * * Constructor */ public TimeSeriesMeshArtifact() { super(); super.name = super.name + "Mesh"; } - } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/gap/DefaultTimeGap.java Fri Apr 09 07:27:38 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/gap/DefaultTimeGap.java Fri Apr 09 10:22:38 2010 +0000 @@ -1,10 +1,11 @@ package de.intevation.gnv.timeseries.gap; /** + * The default implementation of <code>TimeGap</code>. + * * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> - * */ -public class DefaultTimeGap implements TimeGap{ +public class DefaultTimeGap implements TimeGap { /** * The UNIT of the TimeGap @@ -27,9 +28,10 @@ /** * Constructor - * @param unit - * @param key - * @param value + * + * @param unit Unit of this value. + * @param key The key of this time gap. + * @param value The value of this gap. */ public DefaultTimeGap(String unit, int key, int value) { super(); @@ -38,25 +40,20 @@ this.value = value; } - /** - * @see de.intevation.gnv.timeseries.gap.TimeGap#getUnit() - */ + public String getUnit() { return this.unit; } - /** - * @see de.intevation.gnv.timeseries.gap.TimeGap#getKey() - */ + public int getKey() { return this.key; } - /** - * @see de.intevation.gnv.timeseries.gap.TimeGap#getValue() - */ + public int getValue() { return this.value; } } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/gap/TimeGap.java Fri Apr 09 07:27:38 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/gap/TimeGap.java Fri Apr 09 10:22:38 2010 +0000 @@ -2,6 +2,13 @@ import java.io.Serializable; +/** + * A class representing a timegap. <code>TimeGap</code>s are used in timeseries + * charts to identify gaps taking account for the resolution of the x-axis + * range. + * + * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> + */ public interface TimeGap extends Serializable { public final static String TIME_UNIT_MINUTE = "m"; @@ -19,20 +26,24 @@ /** * Returns the Lookup-Key for the TimeGap - * @return + * + * @return the timegap key. */ int getKey(); /** * Returns the Value of the TimeValue in the Unit which is also given. - * @return + * + * @return the timegap value. */ int getValue(); /** * Returns the Unit of the Timegap (e.g. Minutes, Hours, Days, Weeks, Months, Years) - * @return + * + * @return the timegap unit. */ String getUnit(); } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file