view geo-backend/src/main/java/de/intevation/gnv/geobackend/sde/datasources/ResultSet.java @ 884:12f88239fb33

Updated Javadocs to the Listed Classes. Also done some Codecleanup and removed unused Methods from the Code. geo-backend/trunk@842 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Fri, 26 Mar 2010 15:23:03 +0000
parents e4eacd613356
children 8b442223741c
line wrap: on
line source
/**
 * 
 */
package de.intevation.gnv.geobackend.sde.datasources;

import org.apache.log4j.Logger;

/**
 * The class <code>ResultSet</code> fulfills the following purposes:
 * <ol>
 * <li>Providing an abstract object for dealing with result sets.</li>
 * </ol>
 *
 * @author blume
 * @author Tim Englich <tim.englich@intevation.de>
 */
public abstract class ResultSet implements java.sql.ResultSet {

    /**
     * Default Logging instance
     */
    private static Logger sLogger = Logger.getLogger(ResultSet.class);

    /**
     * Returns the number of hits.
     * @return count of results.
     */
    public abstract int getCount();

    /**
     * Returns the number of columns returned through the query.
     * @return the number of columns.
     */
    public abstract int getNumberOfColumns();

    /**
     * A ResultSet can tell about the concrete definition of each column.
     * This method returns an array of {@link de.conterra.bsh.gdi.gnviewer.datasources.ColDefinition}-Objects.
     * @return the definitions describing the result set.
     */
    public abstract ColDefinition[] getColumnDefinitions();

    /**
     * Returns an array of Rows. The rows contain the "content" of the current ResultSet.
     *
     * @return the results itself.
     */
    public abstract Row[] getResults();

}

http://dive4elements.wald.intevation.org