org.gvsig.fmap.dal.store.dbf.utils

Class DbaseFileHeader

java.lang.Object

org.gvsig.fmap.dal.store.dbf.utils.DbaseFileHeader

public class DbaseFileHeader
extends Object

Class to represent the header of a Dbase III file. Creation date: (5/15/2001 5:15:30 PM)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DbaseFileHeader.DbaseFieldDescriptor Class for holding the information assicated with a record.

Constructor Summary

Constructors

Constructor and Description
DbaseFileHeader() DbaseFileHreader constructor comment.

Method Summary

Modifier and Type	Method and Description
void	addColumn(String inFieldName, char inFieldType, int inFieldLength, int inDecimalCount) Add a column to this DbaseFileHeader.
static DbaseFileHeader	createDbaseHeader(FeatureType featureType)
static DbaseFileHeader	createDbaseHeader(FeatureType featureType, String charsetName)
String	getCharsetName()
String	getCharsetName(int ldid)
int	getFieldDecimalCount(int inIndex)
DbaseFileHeader.DbaseFieldDescriptor	getFieldDescription(int inIndex) Return the Field Descriptor for the given field.
int	getFieldIndex(String name)
int	getFieldLength(int inIndex)
String	getFieldName(int inIndex)
char	getFieldType(int inIndex)
int	getHeaderLength() Return the length of the header
int	getLanguageID() Gets the Language driver IDs (code page) defined on the file header (or guessed from the provided charset) Some examples: 01h DOS USA code page 437 02h DOS Multilingual code page 850 03h Windows ANSI code page 1252 04h Standard Macintosh 64h EE MS-DOS code page 852 65h Nordic MS-DOS code page 865 66h Russian MS-DOS code page 866 67h Icelandic MS-DOS 68h Kamenicky (Czech) MS-DOS 69h Mazovia (Polish) MS-DOS 6Ah Greek MS-DOS (437G) 6Bh Turkish MS-DOS 96h Russian Macintosh 97h Eastern European Macintosh 98h Greek Macintosh C8h Windows EE code page 1250 C9h Russian Windows CAh Turkish Windows CBh Greek Windows See the java equivalences in DbaseCodepage.dbfLdid & DbaseCodepage.ldidJava objects.
Date	getLastUpdateDate() Return the date this file was last updated.
int	getNumFields() Return the number of fields in the records.
int	getNumRecords() Return the number of records in the file
String	getOriginalCharset()
int	getRecordLength() Return the length of the records in bytes.
String	mappingEncoding(String dbfEnconding)
void	readHeader(BigByteBuffer2 in, String charsName, boolean allowDuplicatedFieldNames) Read the header data from the DBF file.
int	removeColumn(String inFieldName) Remove a column from this DbaseFileHeader.
void	setNumRecords(int inNumRecords) Set the number of records in the file
void	writeHeader(FileChannel out) Write the header data to the DBF file.

Methods inherited from class java.lang.Object

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

Constructor Detail

DbaseFileHeader

public DbaseFileHeader()

DbaseFileHreader constructor comment.

Method Detail

addColumn

public void addColumn(String inFieldName,
                      char inFieldType,
                      int inFieldLength,
                      int inDecimalCount)
               throws AttributeFeatureTypeNotSuportedException

Add a column to this DbaseFileHeader. The type is one of (C N L or D) character, number, logical(true/false), or date. The Field length is the total length in bytes reserved for this column. The decimal count only applies to numbers(N), and floating point values (F), and refers to the number of characters to reserve after the decimal point.

Parameters:

inFieldName - DOCUMENT ME!

inFieldType - DOCUMENT ME!

inFieldLength - DOCUMENT ME!

inDecimalCount - DOCUMENT ME!

Throws:

AttributeFeatureTypeNotSuportedException

removeColumn

public int removeColumn(String inFieldName)

Remove a column from this DbaseFileHeader.

Parameters:

inFieldName - DOCUMENT ME!

Returns:

index of the removed column, -1 if no found

getFieldDescription

public DbaseFileHeader.DbaseFieldDescriptor getFieldDescription(int inIndex)

Return the Field Descriptor for the given field.

Parameters:

inIndex, - the index of the requeted field description

Returns:

the dbase field descriptor.

getFieldLength

public int getFieldLength(int inIndex)

getFieldDecimalCount

public int getFieldDecimalCount(int inIndex)

getFieldName

public String getFieldName(int inIndex)

getFieldIndex

public int getFieldIndex(String name)

getFieldType

public char getFieldType(int inIndex)

getLastUpdateDate

public Date getLastUpdateDate()

Return the date this file was last updated.

Returns:

DOCUMENT ME!

getNumFields

public int getNumFields()

Return the number of fields in the records.

Returns:

DOCUMENT ME!

getNumRecords

public int getNumRecords()

Return the number of records in the file

Returns:

DOCUMENT ME!

getRecordLength

public int getRecordLength()

Return the length of the records in bytes.

Returns:

DOCUMENT ME!

getHeaderLength

public int getHeaderLength()

Return the length of the header

Returns:

DOCUMENT ME!

readHeader

public void readHeader(BigByteBuffer2 in,
                       String charsName,
                       boolean allowDuplicatedFieldNames)
                throws UnsupportedVersionException,
                       UnsupportedEncodingException

Read the header data from the DBF file.

Parameters:

in - DOCUMENT ME!

charsName -

Throws:

UnsupportedVersionException

UnsupportedEncodingException

setNumRecords

public void setNumRecords(int inNumRecords)

Set the number of records in the file

Parameters:

inNumRecords - DOCUMENT ME!

getLanguageID

public int getLanguageID()

Gets the Language driver IDs (code page) defined on the file header (or guessed from the provided charset) Some examples: 01h DOS USA code page 437 02h DOS Multilingual code page 850 03h Windows ANSI code page 1252 04h Standard Macintosh 64h EE MS-DOS code page 852 65h Nordic MS-DOS code page 865 66h Russian MS-DOS code page 866 67h Icelandic MS-DOS 68h Kamenicky (Czech) MS-DOS 69h Mazovia (Polish) MS-DOS 6Ah Greek MS-DOS (437G) 6Bh Turkish MS-DOS 96h Russian Macintosh 97h Eastern European Macintosh 98h Greek Macintosh C8h Windows EE code page 1250 C9h Russian Windows CAh Turkish Windows CBh Greek Windows See the java equivalences in DbaseCodepage.dbfLdid & DbaseCodepage.ldidJava objects. See some others here: https://github.com/infused/dbf/blob/master/docs/supported_encodings.csv

Returns:

createDbaseHeader

public static DbaseFileHeader createDbaseHeader(FeatureType featureType)
                                         throws AttributeFeatureTypeNotSuportedException

Throws:

AttributeFeatureTypeNotSuportedException

createDbaseHeader

public static DbaseFileHeader createDbaseHeader(FeatureType featureType,
                                                String charsetName)
                                         throws AttributeFeatureTypeNotSuportedException

Throws:

AttributeFeatureTypeNotSuportedException

writeHeader

public void writeHeader(FileChannel out)
                 throws IOException

Write the header data to the DBF file.

Parameters:

out - A channel to write to. If you have an OutputStream you can obtain the correct channel by using java.nio.Channels.newChannel(OutputStream out).

Throws:

IOException - If errors occur.

getCharsetName

public String getCharsetName()

getCharsetName

public String getCharsetName(int ldid)

getOriginalCharset

public String getOriginalCharset()

mappingEncoding

public String mappingEncoding(String dbfEnconding)