org.gicentre.geomap.io

Class DbaseFileReader

java.lang.Object

org.gicentre.geomap.io.DbaseFileReader

public class DbaseFileReader
extends java.lang.Object

Reads Dbase III files. This code is based on the class provided as part of the Geotools OpenSource mapping toolkit - http://www.geotools.org/ under the GNU Lesser General Public License. The general use of this class is:

 FileChannel in = new FileInputStream("thefile.dbf").getChannel();
 DbaseFileReader r = new DbaseFileReader( in )
 Object[] fields = new Object[r.getHeader().getNumFields()];
 while (r.hasNext()) 
 {
    r.readEntry(fields);
    // do stuff
 }
 r.close();
 

For consumers who wish to be a bit more selective with their reading of rows, the Row object has been added. The semantics are the same as using the readEntry method, but remember that the Row object is always the same. The values are parsed as they are read, so it pays to copy them out (as each call to Row.read() will result in an expensive String parse).
EACH CALL TO readEntry OR readRow ADVANCES THE FILE!
An example of using the Row method of reading:

 FileChannel in = new FileInputStream("thefile.dbf").getChannel();
 DbaseFileReader r = new DbaseFileReader(in)
 int fields = r.getHeader().getNumFields();
 while (r.hasNext()) 
 {
   DbaseFileReader.Row row = r.readRow();
   for (int i = 0; i < fields; i++) 
   {
     // do stuff
     Foo.bar(row.read(i));
   }
 }
 r.close();
 

Version:

2.4, 10th January 2012.

Author:

Ian Schneider with minor modifications by Jo Wood.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DbaseFileReader.Row Stores an individual row in the database.

Constructor Summary

Constructors

Constructor and Description
DbaseFileReader(java.nio.channels.ReadableByteChannel channel) Creates a new instance of DBaseFileReader.
DbaseFileReader(java.nio.channels.ReadableByteChannel channel, java.util.logging.Logger logger) Creates a new instance of DBaseFileReader with warning messages reported to the given logger.

Method Summary

Modifier and Type	Method and Description
void	close() Cleans up all resources associated with this reader.
DbaseFileHeader	getHeader() Retrieves the header from this file.
boolean	hasNext() Queries the reader as to whether there is another record.
java.lang.Object[]	readEntry() Retrieves the next record (entry).
java.lang.Object[]	readEntry(java.lang.Object[] entry, boolean doSimple) Copies the next entry into the array.
java.lang.Object[]	readEntry(java.lang.Object[] entry, int offset, boolean doSimple) Copies the next record into the array starting at offset.
DbaseFileReader.Row	readRow() Reads the next row from the database.
java.lang.Object[]	readSimpleEntry() Retrieves the next record (entry), formatted as a collection of numbers and/or strings.
void	skip() Skips the next record.

Methods inherited from class java.lang.Object

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

Constructor Detail

DbaseFileReader

public DbaseFileReader(java.nio.channels.ReadableByteChannel channel)
                throws java.io.IOException

Creates a new instance of DBaseFileReader.

Parameters:

channel - The readable channel to use.

Throws:

java.io.IOException - If an error occurs while initializing.

DbaseFileReader

public DbaseFileReader(java.nio.channels.ReadableByteChannel channel,
                       java.util.logging.Logger logger)
                throws java.io.IOException

Creates a new instance of DBaseFileReader with warning messages reported to the given logger.

Parameters:

channel - The readable channel to use.

logger - Logger to monitor warning messages.

Throws:

java.io.IOException - If an error occurs while initializing.

Method Detail

getHeader

public DbaseFileHeader getHeader()

Retrieves the header from this file. The header is read upon instantiation.

Returns:

The header associated with this file or null if an error occurred.

close

public void close()
           throws java.io.IOException

Cleans up all resources associated with this reader. Should be called after all required data has been extracted from the database.

Throws:

java.io.IOException - If an error occurs.

hasNext

public boolean hasNext()

Queries the reader as to whether there is another record.

Returns:

True if more records exist, false otherwise.

readEntry

public java.lang.Object[] readEntry()
                             throws java.io.IOException

Retrieves the next record (entry). Will return a new array of values.

Returns:

A new array of values.

Throws:

java.io.IOException - If an error occurs.

readSimpleEntry

public java.lang.Object[] readSimpleEntry()
                                   throws java.io.IOException

Retrieves the next record (entry), formatted as a collection of numbers and/or strings. Will return a new array of values.

Returns:

A new array of values.

Throws:

java.io.IOException - If an error occurs.

readRow

public DbaseFileReader.Row readRow()
                            throws java.io.IOException

Reads the next row from the database. Advances the file pointer to the start of the next record.

Returns:

Next row in the database.

Throws:

java.io.IOException - if error occurs when reading.

skip

public void skip()
          throws java.io.IOException

Skips the next record.

Throws:

java.io.IOException - if an error occurs.

readEntry

public java.lang.Object[] readEntry(java.lang.Object[] entry,
                                    int offset,
                                    boolean doSimple)
                             throws java.io.IOException

Copies the next record into the array starting at offset.

Parameters:

entry - The array to copy into.

offset - The offset to start at.

doSimple - Will format as strings/numbers if true.

Returns:

The same array passed in.

Throws:

java.io.IOException - id an error occurs.

readEntry

public java.lang.Object[] readEntry(java.lang.Object[] entry,
                                    boolean doSimple)
                             throws java.io.IOException

Copies the next entry into the array.

Parameters:

entry - The array to copy into.

doSimple - Will format as strings/numbers if true.

Returns:

The same array passed in.

Throws:

java.io.IOException - If an error occurs when trying to read entry from database.