view gnv-artifacts/src/main/java/de/intevation/gnv/timeseries/gap/DefaultTimeGap.java @ 806:2cea76f1112e

Added Javadoc in utils package. gnv-artifacts/trunk@888 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Thu, 08 Apr 2010 13:10:39 +0000
parents c4156275c1e1
children 991e13c3d504
line wrap: on
line source
package de.intevation.gnv.timeseries.gap;

/**
 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
 *
 */
public class DefaultTimeGap implements TimeGap{

    /**
     * The UNIT of the TimeGap
     * See the Constants in de.intevation.gnv.timeseries.gap.TimeGap
     */
    private String unit;

    /**
     * The Key of the TimeGap which must be equivalent to the
     * Key used in the DWH
     */
    private int key;

    /**
     * The Value of the Gap.
     * Use the Unit and the Time Constants to Calculate the
     * value in Milliseconds
     */
    private int value;

    /**
     * Constructor
     * @param unit
     * @param key
     * @param value
     */
    public DefaultTimeGap(String unit, int key, int value) {
        super();
        this.unit = unit;
        this.key = key;
        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;
    }

}

http://dive4elements.wald.intevation.org