org.geotools.data
Interface AttributeReader

All Known Implementing Classes:

IndexedShapefileDataStore.Reader, JoiningAttributeReader, PropertyAttributeReader, QueryData, ShapefileDataStore.Reader, TigerAttributeReader

public interface AttributeReader

The low-level attribute reading API. An AttributeReader is responsible for reading a finite set of attributes from an underlying storage format. It provides meta-data regarding the data it can provide, and an iterative, row-based approach for accessing the data.

Version:

$Id: AttributeReader.java 17701 2006-01-23 00:00:51Z desruisseaux $

Author:

Ian Schneider

See Also:

AttributeAcceptor

Method Summary

void	close() Release any resources associated with this reader
int	getAttributeCount() The number of attributes this reader can read, i.e the length of a row.
AttributeType	getAttributeType(int index) Retrieve the AttributeType at the given index.
boolean	hasNext() Does another set of attributes exist in this reader?
void	next() Advance the reader to the next set of attributes.
java.lang.Object	read(int index) Read the attribute at the given index.

Method Detail

getAttributeCount

public int getAttributeCount()

The number of attributes this reader can read, i.e the length of a row.

Returns:

Number of attribtues this reader can read

getAttributeType

public AttributeType getAttributeType(int index)
                               throws java.lang.ArrayIndexOutOfBoundsException

Retrieve the AttributeType at the given index.

Returns:

AttributeType at given index

Throws:

java.lang.ArrayIndexOutOfBoundsException

close

public void close()
           throws java.io.IOException

Release any resources associated with this reader

Throws:

java.io.IOException

hasNext

public boolean hasNext()
                throws java.io.IOException

Does another set of attributes exist in this reader?

Returns:

true if additional content exists for AttributeReader

Throws:

java.io.IOException

next

public void next()
          throws java.io.IOException

Advance the reader to the next set of attributes.

Throws:

java.io.IOException

read

public java.lang.Object read(int index)
                      throws java.io.IOException,
                             java.lang.ArrayIndexOutOfBoundsException

Read the attribute at the given index.

Returns:

Object Attribute at given index

Throws:

java.io.IOException

java.lang.ArrayIndexOutOfBoundsException