view geo-backend/src/main/java/de/intevation/gnv/geobackend/base/Result.java @ 890:e9ca6be4dbd2

Modified some JavaDoc so that the Warnings that where caused by mistakes are removed. geo-backend/trunk@916 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Tue, 13 Apr 2010 09:37:59 +0000
parents e5e30090c37c
children ebeb56428409
line wrap: on
line source
package de.intevation.gnv.geobackend.base;

import java.io.Serializable;
import java.util.Date;

/**
 * Interface which provides the Methods for Accessing
 * the Data of an ResultEntry
 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
 *
 */
public interface Result extends Serializable{

    /**
     * Returns the ResultDescriptor which provides the
     * ResultMetadatse
     * @return the ResultDescriptor
     */
    public ResultDescriptor getResultDescriptor();

    /**
     * Returns the Columnvalue as a String
     * @param columnName the Name of the column
     * @return the Columnvalue as a String
     */
    public String getString(String columnName);

    /**
     * Returns the Columnvalue as a String
     * @param column the Position of the Column that should be returned.
     * @return the Columnvalue as a String
     */
    public String getString(int column);

    /**
     * Returns the Columnvalue as a Date
     * @param columnName the Name of the column
     * @return the Columnvalue as a Date
     */
    public Date getDate(String columnName);

    /**
     * Returns the Columnvalue as a Date
     * @param column the Position of the Column that should be returned.
     * @return the Columnvalue as a Date
     */
    public Date getDate(int column);

    /**
     * Returns the Columnvalue as a Integer
     * @param columnName the Name of the column
     * @return the Columnvalue as a Integer
     */
    public Integer getInteger(String columnName);

    /**
     * Returns the Columnvalue as a Integer
     * @param column the Position of the Column that should be returned.
     * @return the Columnvalue as a Integer
     */
    public Integer getInteger(int column);

    /**
     * Returns the Columnvalue as a Float
     * @param columnName the Name of the column
     * @return the Columnvalue as a Float
     */
    public Float getFloat(String columnName);

    /**
     * Returns the Columnvalue as a Float
     * @param column the Position of the Column that should be returned.
     * @return the Columnvalue as a Float
     */
    public Float getFloat(int column);

    /**
     * Returns the Columnvalue as a Double
     * @param columnName the Name of the column
     * @return the Columnvalue as a Double
     */
    public Double getDouble(String columnName);

    /**
     * Returns the Columnvalue as a Double
     * @param column the Position of the Column that should be returned.
     * @return the Columnvalue as a Double
     */
    public Double getDouble(int column);

    /**
     * Returns the Columnvalue as a Object
     * @param columnName the Name of the column
     * @return the Columnvalue as a Object
     */
    public Object getObject(String columnName);

    /**
     * Returns the Columnvalue as a Object
     * @param column the Position of the Column that should be returned.
     * @return the Columnvalue as a Object
     */
    public Object getObject(int column);

    /**
     * Adds an new Columnvalue to the Result.
     * @param column the Position where the column should be inserted.
     * @param value the Value of the Column
     */
    public void addColumnValue(int column, Object value);
}

http://dive4elements.wald.intevation.org