repicea.io.javadbf

Class DBFReader

java.lang.Object

repicea.io.FormatReader<DBFHeader>

repicea.io.javadbf.DBFReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class DBFReader
extends FormatReader<DBFHeader>

DBFReader class can creates objects to represent DBF data. This Class is used to read data from a DBF file. Meta data and records can be queried against this document.

DBFReader cannot write anythng to a DBF file. For creating DBF files use DBFWriter.

Fetching rocord is possible only in the forward direction and cannot re-wound. In such situation, a suggested approach is to reconstruct the object.

The nextRecord() method returns an array of Objects and the types of these Object are as follows:

xBase Type	Java Type
C	String
N	Integer
F	Double
L	Boolean
D	java.util.Date

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.DataInputStream	dataInputStream

Constructor Summary

Constructors

Constructor and Description
DBFReader(java.lang.String filename) Initializes a DBFReader object.

Method Summary

Modifier and Type	Method and Description
void	close()
java.lang.String	getCharactersetName()
DBFField	getField(int index) Returns the asked Field.
java.lang.Object[]	nextRecord(int skipThisNumberOfLines) Reads the returns the next row in the DBF stream.
void	setCharactersetName(java.lang.String characterSetName)
java.lang.String	toString()

Methods inherited from class repicea.io.FormatReader

createFormatReader, getFieldCount, getFilename, getHeader, getRecordCount, isSystemResource, nextRecord, openStream, setFormatHeader

Methods inherited from class java.lang.Object

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

Field Detail

dataInputStream

protected java.io.DataInputStream dataInputStream

Constructor Detail

DBFReader

public DBFReader(java.lang.String filename)
          throws java.io.IOException

Initializes a DBFReader object. When this constructor returns the object will have completed reading the hader (meta date) and header information can be quried there on. And it will be ready to return the first row.

Parameters:

filename - the filename where the data is read from.

Throws:

java.io.IOException

Method Detail

getCharactersetName

public java.lang.String getCharactersetName()

setCharactersetName

public void setCharactersetName(java.lang.String characterSetName)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getField

public DBFField getField(int index)

Returns the asked Field. In case of an invalid index, it returns a ArrayIndexOutofboundsException.

Overrides:

getField in class FormatReader<DBFHeader>

Parameters:

index - Index of the field. Index of the first field is zero.

Returns:

a FormatField instance

nextRecord

public java.lang.Object[] nextRecord(int skipThisNumberOfLines)
                              throws DBFException

Reads the returns the next row in the DBF stream.

Specified by:

nextRecord in class FormatReader<DBFHeader>

Parameters:

skipThisNumberOfLines - the number of lines to skip before reading the observation

Returns:

The next row as an Object array. Types of the elements these arrays follow the convention mentioned in the class description.

Throws:

DBFException

close

public void close()