org.tinfour.gis.shapefile

Class DbfFileReader

java.lang.Object

org.tinfour.gis.shapefile.DbfFileReader

All Implemented Interfaces:

Closeable, AutoCloseable

public class DbfFileReader
extends Object
implements Closeable

Provides elements and methods for reading the DBF file associated with a Shapefile

Constructor Summary

Constructors

Constructor and Description
DbfFileReader(File file) Construct a DbfFileReader from the specified file

Method Summary

Modifier and Type	Method and Description
void	close()
DbfField	getFieldByName(String name) Get the field matching the specified name
List<DbfField>	getFields() Get a safe copy of a list of the fields specified in the DBF file.
int	getRecordCount() Get the number of records in the DBF file
void	readField(int recordNumber, DbfField field) Read the content of the file into the field object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DbfFileReader

public DbfFileReader(File file)
              throws IOException

Construct a DbfFileReader from the specified file

Parameters:

file - a valid file reference to a .dbf file

Throws:

IOException - in the event of an unrecoverable I/O condition

Method Detail

getRecordCount

public int getRecordCount()

Get the number of records in the DBF file

Returns:

a positive integer

getFields

public List<DbfField> getFields()

Get a safe copy of a list of the fields specified in the DBF file.

Returns:

a valid list.

getFieldByName

public DbfField getFieldByName(String name)

Get the field matching the specified name

Parameters:

name - a valid string

Returns:

if found, a valid instance; otherwise, a null.

readField

public void readField(int recordNumber,
                      DbfField field)
               throws IOException

Read the content of the file into the field object

Parameters:

recordNumber - a valid record in the range 1 to record-count.

field - a valid field obtained from the DbfFileReader instance and used to hold the data read from the file

Throws:

IOException - in the event of an unrecoverable I/O condition.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException