org.geotools.data.FIDReader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gt-main Show documentation

The main module contains the GeoTools public interfaces that are used by other GeoTools modules (and GeoTools applications). Where possible we make use industry standard terms as provided by OGC and ISO standards. The formal GeoTools public api consists of gt-metadata, jts and the gt-main module. The main module contains the default implementations that are available provided to other GeoTools modules using our factory system. Factories are obtained from an appropriate FactoryFinder, giving applications a chance configure the factory used using the Factory Hints facilities. FilterFactory ff = CommonFactoryFinder.getFilterFactory(); Expression expr = ff.add( expression1, expression2 ); If you find yourself using implementation specific classes chances are you doing it wrong: Expression expr = new AddImpl( expression1, expressiom2 );

The newest version!

/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2003-2008, Open Source Geospatial Foundation (OSGeo)
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation;
 *    version 2.1 of the License.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 */
package org.geotools.data;

import java.io.IOException;

/**
 * FeatureReader customized for FeatureID handling.
 *
 * An experimental method for doing FIDs. I'd like to see it and AttributeReader extend a similar
 * base. Perhaps BaseReader or something? And perhaps have FeatureReader extend it too? This reader just returns an incrementing index. May be sufficient
 * for files, representing rows in a file. For jdbc datasources another fid reader should be used.
 *
 * We could have FIDReader implement AttributeReader, but it doesn't seem to make sense, as the
 * getAttributeType doesn't make much sense, as our featureID is just a string. Or we could consider
 * having a special FID attribute in our hierarchy.
 *
 * @author Chris Holmes
 * @version $Id$
 */
public interface FIDReader {
    /** Release any resources associated with this reader */
    void close() throws IOException;

    /**
     * Returns whether another fid exists for this reader.
     *
     * @return true if more content exists
     */
    boolean hasNext() throws IOException;

    /**
     * Gets the next FID from the Reader.
     *
     * @return Next featureID
     */
    String next() throws IOException;
}