Class DbfFile

java.lang.Object

org.geotools.dbffile.DbfFile

All Implemented Interfaces:

AutoCloseable

public class DbfFile
extends Object
implements AutoCloseable

This class represents a DBF (or DBase) file.

Construct it with a filename (including the .dbf) this causes the header and field definitions to be read.

Later queries return rows or columns of the database.

Author:

Ian Turton Centre for Computaional Geography, University of Leeds, LS2 9JT, 1998.

Field Summary

Fields

Modifier and Type	Field	Description
static final SimpleDateFormat	DATE_PARSER
static final int	DBF_ALL_DELETED
static final int	DBF_BAD_DBFID
static final int	DBF_BAD_EODEFS
static final int	DBF_BAD_INT_WIDTH
static final int	DBF_BAD_ITYPE
static final int	DBF_BAD_OFFSET
static final int	DBF_BAD_SIZEOF
static final int	DBF_BUFFSIZE
static final int	DBF_CANNOT_DO_MEMO
static final int	DBF_CENTURY
static final int	DBF_END_OF_DEFS
static final int	DBF_FLOATING_N
static final int	DBF_GET_DATE
static final int	DBF_INT_EXP
static final int	DBF_INT_JUNK
static final int	DBF_INT_REAL
static final int	DBF_MALLOC
static final int	DBF_MALLOC_FIELD
static final int	DBF_MAXFIELDS
static final int	DBF_MAXLEN
static final int	DBF_NAMELEN
static final int	DBF_NO_FIELDS
static final int	DBF_OK
static final int	DBF_READ_DATA
static final int	DBF_READ_DEFS
static final int	DBF_READ_HEAD
static final int	DBF_REC_DELETED
static final int	DBF_REC_TOO_LONG
static final int	DBF_TOO_MANY_FIELDS
static final int	DBF_TOO_WIDE_FOR_INF
static final int	DBF_UNPRINT_DATA
static final int	DBF_WRITE_DATA
static final int	DBF_WRITE_DEFS
static final int	DBF_WRITE_HEAD
static final int	DBF3_MAXFIELDS
static final int	DBF4_MAXFIELDS
DbfFieldDef[]	fielddef

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DbfFile()
	DbfFile(String file)	For compatibilty reasons, this method is a wrapper to the new with Charset functions.
	DbfFile(String file, Charset charset)	Constructor, opens the file and reads the header infomation.

Method Summary

Modifier and Type	Method	Description
void	close()
byte[]	GetDbfRec(long row)	fetches the rowth row of the file
String	getFieldName(int col)
String	getFieldType(int col)
long	getFileSize()	Returns the size of the database file.
int	getLastRec()	Returns the number of records in the database file.
String	getLastUpdate()	Returns the date of the last update of the file as a string.
StringBuffer	GetNextDbfRec()	gets the next record and returns it as a string.
int	getNumFields()	Returns the number of fields in the records in the database file.
int	getRecSize()	Returns the size of the records in the database file.
static void	main(String[] args)
protected Date	parseDate(String s)
Object	ParseRecordColumn(byte[] rec, int wantedCol)	Get a field value from the dbf record data (byte[]) and the field index

Methods inherited from class Object

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

Field Details

fielddef

public DbfFieldDef[] fielddef

DATE_PARSER

public static final SimpleDateFormat DATE_PARSER

DBF_CENTURY

static final int DBF_CENTURY

See Also:

• Constant Field Values

DBF_MAXLEN

static final int DBF_MAXLEN

See Also:

• Constant Field Values

DBF_NAMELEN

static final int DBF_NAMELEN

See Also:

• Constant Field Values

DBF3_MAXFIELDS

static final int DBF3_MAXFIELDS

See Also:

• Constant Field Values

DBF4_MAXFIELDS

static final int DBF4_MAXFIELDS

See Also:

• Constant Field Values

DBF_MAXFIELDS

static final int DBF_MAXFIELDS

See Also:

• Constant Field Values

DBF_BUFFSIZE

static final int DBF_BUFFSIZE

See Also:

• Constant Field Values

DBF_END_OF_DEFS

static final int DBF_END_OF_DEFS

See Also:

• Constant Field Values

DBF_OK

static final int DBF_OK

See Also:

• Constant Field Values

DBF_READ_HEAD

static final int DBF_READ_HEAD

See Also:

• Constant Field Values

DBF_BAD_DBFID

static final int DBF_BAD_DBFID

See Also:

• Constant Field Values

DBF_WRITE_HEAD

static final int DBF_WRITE_HEAD

See Also:

• Constant Field Values

DBF_READ_DEFS

static final int DBF_READ_DEFS

See Also:

• Constant Field Values

DBF_TOO_MANY_FIELDS

static final int DBF_TOO_MANY_FIELDS

See Also:

• Constant Field Values

DBF_NO_FIELDS

static final int DBF_NO_FIELDS

See Also:

• Constant Field Values

DBF_BAD_EODEFS

static final int DBF_BAD_EODEFS

See Also:

• Constant Field Values

DBF_WRITE_DEFS

static final int DBF_WRITE_DEFS

See Also:

• Constant Field Values

DBF_BAD_ITYPE

static final int DBF_BAD_ITYPE

See Also:

• Constant Field Values

DBF_CANNOT_DO_MEMO

static final int DBF_CANNOT_DO_MEMO

See Also:

• Constant Field Values

DBF_BAD_INT_WIDTH

static final int DBF_BAD_INT_WIDTH

See Also:

• Constant Field Values

DBF_BAD_OFFSET

static final int DBF_BAD_OFFSET

See Also:

• Constant Field Values

DBF_FLOATING_N

static final int DBF_FLOATING_N

See Also:

• Constant Field Values

DBF_READ_DATA

static final int DBF_READ_DATA

See Also:

• Constant Field Values

DBF_UNPRINT_DATA

static final int DBF_UNPRINT_DATA

See Also:

• Constant Field Values

DBF_WRITE_DATA

static final int DBF_WRITE_DATA

See Also:

• Constant Field Values

DBF_INT_EXP

static final int DBF_INT_EXP

See Also:

• Constant Field Values

DBF_INT_REAL

static final int DBF_INT_REAL

See Also:

• Constant Field Values

DBF_INT_JUNK

static final int DBF_INT_JUNK

See Also:

• Constant Field Values

DBF_REC_DELETED

static final int DBF_REC_DELETED

See Also:

• Constant Field Values

DBF_ALL_DELETED

static final int DBF_ALL_DELETED

See Also:

• Constant Field Values

DBF_BAD_SIZEOF

static final int DBF_BAD_SIZEOF

See Also:

• Constant Field Values

DBF_REC_TOO_LONG

static final int DBF_REC_TOO_LONG

See Also:

• Constant Field Values

DBF_TOO_WIDE_FOR_INF

static final int DBF_TOO_WIDE_FOR_INF

See Also:

• Constant Field Values

DBF_MALLOC_FIELD

static final int DBF_MALLOC_FIELD

See Also:

• Constant Field Values

DBF_MALLOC

static final int DBF_MALLOC

See Also:

• Constant Field Values

DBF_GET_DATE

static final int DBF_GET_DATE

See Also:

• Constant Field Values

Constructor Details

DbfFile

protected DbfFile()

DbfFile

public DbfFile(String file)
        throws Exception

For compatibilty reasons, this method is a wrapper to the new with Charset functions.

Parameters:

file - file name

Throws:

Exception

DbfFile

public DbfFile(String file,
 Charset charset)
        throws IOException

Constructor, opens the file and reads the header infomation.

Parameters:

file - The file to be opened, includes path and .dbf

Throws:

IOException - If the file can't be opened.

Method Details

getLastUpdate

public String getLastUpdate()

Returns the date of the last update of the file as a string.

getLastRec

public int getLastRec()

Returns the number of records in the database file.

getRecSize

public int getRecSize()

Returns the size of the records in the database file.

getNumFields

public int getNumFields()

Returns the number of fields in the records in the database file.

getFieldName

public String getFieldName(int col)

getFieldType

public String getFieldType(int col)

getFileSize

public long getFileSize()

Returns the size of the database file.

GetNextDbfRec

public StringBuffer GetNextDbfRec()
                           throws IOException

gets the next record and returns it as a string. This method works on a sequential stream and can not go backwards. Only useful if you want to read the whole file in one.

Throws:

IOException - on read error.

GetDbfRec

public byte[] GetDbfRec(long row)
                 throws IOException

fetches the rowth row of the file

Parameters:

row - - the row to fetch

Throws:

IOException - on read error.

ParseRecordColumn

public Object ParseRecordColumn(byte[] rec,
 int wantedCol)
                         throws Exception

Get a field value from the dbf record data (byte[]) and the field index

Parameters:

rec - the byte array representing the record

wantedCol - the wanted column

Returns:

an object representing the field

Throws:

Exception - if an Exception occurred

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException

parseDate

protected Date parseDate(String s)
                  throws ParseException

Throws:

ParseException

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception