com.linuxense.javadbf

Class DBFReader

java.lang.Object

com.linuxense.javadbf.DBFBase

com.linuxense.javadbf.DBFReader

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

DBCDATASUSReader

public class DBFReader
extends DBFBase
implements Closeable

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 to a DBF file. For creating DBF files use DBFWriter.

Fetching records is possible only in the forward direction and cannot be re-wound. In such situations, 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	java.math.BigDecimal
F	java.math.BigDecimal
L	Boolean
D	java.util.Date
Y	java.math.BigDecimal
I	Integer
T	java.util.Date
@	java.util.Date
	Integer
V	String
O	Double
M	java.lang.String or byte[]
B	byte[] or java.lang.Double
G	byte[]
P	byte[]
Q	byte[]

Field Summary

Fields

Modifier and Type	Field and Description
protected DataInputStream	dataInputStream
protected InputStream	inputStream

Fields inherited from class com.linuxense.javadbf.DBFBase

DEFAULT_CHARSET, END_OF_DATA

Constructor Summary

Constructors

Constructor and Description
DBFReader(InputStream in) Intializes a DBFReader object.
DBFReader(InputStream in, Boolean showDeletedRows) Intializes a DBFReader object.
DBFReader(InputStream in, Charset charset) Initializes a DBFReader object.
DBFReader(InputStream in, Charset charset, boolean showDeletedRows) Initializes a DBFReader object.
DBFReader(InputStream in, Charset charset, boolean showDeletedRows, boolean supportExtendedCharacterFields) Initializes a DBFReader object.

Method Summary

Modifier and Type	Method and Description
void	close()
protected int	getEstimatedOutputSize()
DBFField	getField(int index) Returns the asked Field.
int	getFieldCount() Returns the number of field in the DBF.
protected Object	getFieldValue(DBFField field)
protected DBFHeader	getHeader()
Date	getLastModificationDate() Returns the last time the file was modified
int	getRecordCount() Returns the number of records in the DBF.
boolean	isTrimRightSpaces() Determine if character fields should be right trimmed (default true)
Object[]	nextRecord() Reads the returns the next row in the DBF stream.
DBFRow	nextRow() Reads the returns the next row in the DBF stream.
void	setMemoFile(File file) Sets the memo file (DBT or FPT) where memo fields will be readed.
void	setMemoFile(File file, boolean inMemory) Sets the memo file (DBT or FPT) where memo fields will be readed.
void	setTrimRightSpaces(boolean trimRightSpaces) Determine if character fields should be right trimmed (default true)
protected void	skip(int bytesToSkip) Safely skip bytesToSkip bytes (in some bufferd scenarios skip doesn't really skip all requested bytes)
void	skipRecords(int recordsToSkip) Skip records from reading.
String	toString()

Methods inherited from class com.linuxense.javadbf.DBFBase

getCharactersetName, getCharset, setCharactersetName, setCharset

Methods inherited from class java.lang.Object

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

Field Detail

inputStream

protected InputStream inputStream

dataInputStream

protected DataInputStream dataInputStream

Constructor Detail

DBFReader

public DBFReader(InputStream in)

Intializes a DBFReader object. Tries to detect charset from file, if failed uses default charset ISO-8859-1 When this constructor returns the object will have completed reading the header (meta date) and header information can be queried there on. And it will be ready to return the first row.

Parameters:

in - the InputStream where the data is read from.

DBFReader

public DBFReader(InputStream in,
                 Boolean showDeletedRows)

Intializes a DBFReader object. Tries to detect charset from file, if failed uses default charset ISO-8859-1 When this constructor returns the object will have completed reading the header (meta date) and header information can be queried there on. And it will be ready to return the first row.

Parameters:

in - the InputStream where the data is read from.

showDeletedRows - can be used to identify records that have been deleted.

DBFReader

public DBFReader(InputStream in,
                 Charset charset)

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

Parameters:

in - the InputStream where the data is read from.

charset - charset used to decode field names and field contents. If null, then is autedetected from dbf file

DBFReader

public DBFReader(InputStream in,
                 Charset charset,
                 boolean showDeletedRows)

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

Parameters:

in - the InputStream where the data is read from.

charset - charset used to decode field names and field contents. If null, then is autedetected from dbf file

showDeletedRows - can be used to identify records that have been deleted.

DBFReader

public DBFReader(InputStream in,
                 Charset charset,
                 boolean showDeletedRows,
                 boolean supportExtendedCharacterFields)

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

Parameters:

in - the InputStream where the data is read from.

charset - charset used to decode field names and field contents. If null, then is autedetected from dbf file

showDeletedRows - can be used to identify records that have been deleted.

supportExtendedCharacterFields - Defines whether 2-byte (extended) length character fields should be supported (see DBFField.adjustLengthForLongCharSupport(), default: true).

Method Detail

getRecordCount

public int getRecordCount()

Returns the number of records in the DBF. This number includes deleted (hidden) records

Returns:

number of records in the DBF file.

getLastModificationDate

public Date getLastModificationDate()

Returns the last time the file was modified

Returns:

the las time the file was modified

getField

public DBFField getField(int index)

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

Parameters:

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

Returns:

Field definition for selected field

getFieldCount

public int getFieldCount()

Returns the number of field in the DBF.

Returns:

number of fields in the DBF file

nextRecord

public Object[] nextRecord()

Reads the returns the next row in the DBF stream.

Returns:

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

nextRow

public DBFRow nextRow()

Reads the returns the next row in the DBF stream.

Returns:

The next row as an DBFRow

getFieldValue

protected Object getFieldValue(DBFField field)
                        throws IOException

Throws:

IOException

skip

protected void skip(int bytesToSkip)
             throws IOException

Safely skip bytesToSkip bytes (in some bufferd scenarios skip doesn't really skip all requested bytes)

Parameters:

bytesToSkip - number of bytes to skip

Throws:

IOException - if some IO error happens

skipRecords

public void skipRecords(int recordsToSkip)
                 throws IOException

Skip records from reading. Treat "deleted" records as normal records.

Parameters:

recordsToSkip - Number of records to skip.

Throws:

IOException - if some IO error happens

getHeader

protected DBFHeader getHeader()

isTrimRightSpaces

public boolean isTrimRightSpaces()

Determine if character fields should be right trimmed (default true)

Returns:

true if data is right trimmed

setTrimRightSpaces

public void setTrimRightSpaces(boolean trimRightSpaces)

Determine if character fields should be right trimmed (default true)

Parameters:

trimRightSpaces - if reading fields should trim right spaces

setMemoFile

public void setMemoFile(File file)

Sets the memo file (DBT or FPT) where memo fields will be readed. If no file is provided, then this fields will be null.

Parameters:

file - the file containing the memo data

setMemoFile

public void setMemoFile(File file,
                        boolean inMemory)

Sets the memo file (DBT or FPT) where memo fields will be readed. If no file is provided, then this fields will be null.

Parameters:

file - the file containing the memo data

inMemory - if the memoFile shoud be loaded in memory (caution, it may hang your jvm if memo file is too big)

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

toString

public String toString()

Overrides:

toString in class Object

getEstimatedOutputSize

protected int getEstimatedOutputSize()