org.geotools.data.AttributeWriter 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;
import org.opengis.feature.type.AttributeDescriptor;

/**
 * - Added hasNext to support the FeatureWriter API. - Changed order of writer parameters to match
 * Collections, JDBC API. - Added IOExceptions on all methods. - Do we want AttributeWriters to know
 * about the schema and perform validation??
 *
 * @version $Id$
 * @author Ian Schneider
 * @author Sean Geoghegan, Defence Science and Technology Organisation.
 */
public interface AttributeWriter {
    /** The number of attributes this reader can read, i.e the length of a row. */
    int getAttributeCount();

    /** Retrieve the AttributeType at the given index. */
    AttributeDescriptor getAttributeType(int i) throws ArrayIndexOutOfBoundsException;

    /**
     * Advance the AttributeWriter, all calls to write will correspond to the same set of attributes
     * until next is called again.
     */
    void next() throws IOException;

    /**
     * Write the given attribute value at the position indicated. Implementations can choose to
     * immediately flush the write or buffer it.
     */
    void write(int position, Object attribute) throws IOException;

    void close() throws IOException;

    /**
     * Query whether there are other rows in the attribute writer.
     *
     * @see FeatureWriter#hasNext()
     */
    boolean hasNext() throws IOException;
}