dbf.datafile

Module to load and save DBF files

class DBF;

Simple class to access a DBF file.

Loading and saving are performed from wherever the stream is at that moment, and the stream is not closed after loading or saving. All this means that if you have a Stream which contains more than just the DBF, you can keep using it.

Bugs	Only works for data types: L, C, N, D No character conversion is made, so non-Unicode strings will generate exceptions

Examples

string file = args[1]; DBF dbf = new DBF (file); dbf.read(); ... void foo (Stream stream) { (new DBF(stream)).load(); }

See Also

Mango

this(Stream stream);

Initializes the DBF from a Stream

Parameters

Stream stream the Stream containing the DBF or where the DBF should be saved

this(string file);

Initializes the DBF from a file

Parameters

string file the file containing the DBF or where the DBF should be saved

void load();

Loads the DBF from the specified source

void save();

Saves the DBF to the specified source

auto getRecordCount();

Returns the number of records

auto getFieldCount();

Returns the number of fields

auto getFieldName(uint index);

Returns the name of a field by its index

auto getFieldIndex(string name);

Returns the index of a field by its name

void removeField(string name);

Removes a field from this DBF

Throws

DBFException if there's no field named name

void removeField(uint index);

Removes a field from this DBF

Throws

DBFException if index is greater than the number of fields

void addField(string fname, DataType dataType, ushort flength);

Adds a field to this DBF

If type == DataType.Number, flength represents the fieldLength, and the decimalCount is set to 0.

If type == DataType.Date, flength is ignored and automatically set to 8.

This method fails if there're already records in the DBF. To modify the fields in the DBF, you must first remove all its records.

Parameters

string fname the name of the field DataType dataType the type of the field ushort flength the length of the field

Throws

DBFException if there're records in the DBF or if there's already a field with this name

void addNumericField(string fname, ubyte flength, ubyte fdecimals);

Adds a numeric field to this DBF

This method fails if there're already records in the DBF. To modify the fields in the DBF, you must first remove all its records.

Parameters

string fname the name of the field ubyte flength the length of the field ubyte fdecimals the decimal count of the field

Throws

DBFException if there're records in the DBF or if there's already a field with this name

void addDateField(string fname);

Adds a date field to this DBF

This method fails if there're already records in the DBF. To modify the fields in the DBF, you must first remove all its records.

Parameters

string fname the name of the field

Throws

DBFException if there're records in the DBF or if there's already a field with this name

int opApply(int delegate(Field) dg);
int opApply(int delegate(uint, Field) dg);
int opApply(int delegate(string, Field) dg);

Foreach the fields of this DBF

int opApply(int delegate(Record) dg);
int opApply(int delegate(uint, Record) dg);

Foreach the records of this DBF

void removeRecord(uint index);

Removes a record from this DBF

Throws

DBFException if index is greater than the number of records

void removeAllRecords();

Removes all records from this DBF

Record addEmptyRecord();

Adds a record to this DBF

This record contains no data and the fields must be explicitly filled by the user. However, it already belongs to the DBF.

void addRecord(...);

Adds a record to this DBF

The types passed here must be compatible with those defined by the fields.