com.linuxense.javadbf

Class DBFField

java.lang.Object

com.linuxense.javadbf.DBFField

public class DBFField
extends Object

DBFField represents a field specification in an dbf file. DBFField objects are either created and added to a DBFWriter object or obtained from DBFReader object through DBFReader.getField(int) query.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	FIELD_TYPE_C Deprecated. You must use DBFDataType.CHARACTER instead
static byte	FIELD_TYPE_D Deprecated. You must use DBFDataType.DATE instead
static byte	FIELD_TYPE_F Deprecated. You must use DBFDataType.FLOATING_POINT instead
static byte	FIELD_TYPE_L Deprecated. You must use DBFDataType.LOGICAL instead
static byte	FIELD_TYPE_M Deprecated. You must use DBFDataType.MEMO instead
static byte	FIELD_TYPE_N Deprecated. You must use DBFDataType.NUMERIC instead

Constructor Summary

Constructors

Constructor and Description
DBFField() Default constructor
DBFField(String name, DBFDataType type) Creates a field definition
DBFField(String name, DBFDataType type, int length) Creates a field definition
DBFField(String name, DBFDataType type, int length, int decimalCount) Creates a field definition

Method Summary

Modifier and Type	Method and Description
protected static DBFField	createField(DataInput in, Charset charset, boolean useFieldFlags, boolean supportExtendedCharacterFields) Creates a DBFField object from the data read from the given DataInputStream.
protected static DBFField	createFieldDB7(DataInput in, Charset charset, boolean supportExtendedCharacterFields)
byte	getDataType() Deprecated. This method is deprecated and is replaced by getType()
int	getDecimalCount() Returns the decimal part.
int	getFieldLength() Deprecated. use getLength()
byte	getIndexFieldFlag() Get index field flag
int	getLength() Returns field length.
String	getName() Returns the name of the field.
int	getReserv1() Gets reserved field 1 (for internal use only)
short	getReserv2() Gets reserved field 2 (for internal use only)
short	getReserv3() Gets reserved field 3 (for internal use only)
byte[]	getReserv4() Gets reserved field 4 (for internal use only)
byte	getSetFieldsFlag()
DBFDataType	getType() Gets the type for this field
byte	getWorkAreaId() Gets reserved workareaid (for internal use only)
boolean	isBinary() Checks if the field is binary
boolean	isNullable() Checks if the field is nullable
boolean	isSystem() Checks if is a system field
void	setDataType(byte type) Deprecated. This method is deprecated and is replaced by setType(DBFDataType)
void	setDecimalCount(int size) Sets the decimal place size of the field.
void	setFieldLength(int length) Deprecated. use setLength(int)
void	setFieldName(String value) Deprecated. This method is deprecated and is replaced by setName(String).
void	setLength(int length) Set Length of the field.
void	setName(String name) Sets the name of the field.
void	setType(DBFDataType type) Set the type for this field
String	toString()
protected void	write(DataOutput out, Charset charset) Writes the content of DBFField object into the stream as per DBF format specifications.

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_TYPE_C

@Deprecated
public static final byte FIELD_TYPE_C

Deprecated. You must use DBFDataType.CHARACTER instead

Code for character data

See Also:

Constant Field Values

FIELD_TYPE_L

@Deprecated
public static final byte FIELD_TYPE_L

Deprecated. You must use DBFDataType.LOGICAL instead

Code for logical data

See Also:

Constant Field Values

FIELD_TYPE_N

@Deprecated
public static final byte FIELD_TYPE_N

Deprecated. You must use DBFDataType.NUMERIC instead

Code for numeric data

See Also:

Constant Field Values

FIELD_TYPE_F

@Deprecated
public static final byte FIELD_TYPE_F

Deprecated. You must use DBFDataType.FLOATING_POINT instead

Code for floating poing data

See Also:

Constant Field Values

FIELD_TYPE_D

@Deprecated
public static final byte FIELD_TYPE_D

Deprecated. You must use DBFDataType.DATE instead

Code for dates

See Also:

Constant Field Values

FIELD_TYPE_M

@Deprecated
public static final byte FIELD_TYPE_M

Deprecated. You must use DBFDataType.MEMO instead

Code for memo data

See Also:

Constant Field Values

Constructor Detail

DBFField

public DBFField()

Default constructor

DBFField

public DBFField(String name,
                DBFDataType type)

Creates a field definition

Parameters:

name - Field name

type - field type

DBFField

public DBFField(String name,
                DBFDataType type,
                int length)

Creates a field definition

Parameters:

name - Field name

type - Field type

length - Field length

DBFField

public DBFField(String name,
                DBFDataType type,
                int length,
                int decimalCount)

Creates a field definition

Parameters:

name - Field name

type - Field type

length - Field length

decimalCount - number of decimal places to use

Method Detail

createField

protected static DBFField createField(DataInput in,
                                      Charset charset,
                                      boolean useFieldFlags,
                                      boolean supportExtendedCharacterFields)
                               throws IOException

Creates a DBFField object from the data read from the given DataInputStream. The data in the DataInputStream object is supposed to be organised correctly and the stream "pointer" is supposed to be positioned properly.

Parameters:

in - DataInputStream

charset - charset to use

useFieldFlags - If the file can store field flags (setting this to false ignore any data in byes 18-19)

supportExtendedCharacterFields - True if 2-byte (extended) length character fields should be supported, see adjustLengthForLongCharSupport()

Returns:

Returns the created DBFField object.

Throws:

IOException - If any stream reading problems occures.

createFieldDB7

protected static DBFField createFieldDB7(DataInput in,
                                         Charset charset,
                                         boolean supportExtendedCharacterFields)
                                  throws IOException

Throws:

IOException

write

protected void write(DataOutput out,
                     Charset charset)
              throws IOException

Writes the content of DBFField object into the stream as per DBF format specifications.

Parameters:

out - OutputStream

charset - dbf file's charset

Throws:

IOException - if any stream related issues occur.

getName

public String getName()

Returns the name of the field.

Returns:

Name of the field as String.

getLength

public int getLength()

Returns field length.

Returns:

field length as int.

getDecimalCount

public int getDecimalCount()

Returns the decimal part. This is applicable only if the field type if of numeric in nature. If the field is specified to hold integral values the value returned by this method will be zero.

Returns:

decimal field size as int.

setName

public void setName(String name)

Sets the name of the field.

Parameters:

name - of the field as String.

Since:

0.3.3.1

getReserv1

public int getReserv1()

Gets reserved field 1 (for internal use only)

Returns:

reserved field 1

getReserv2

public short getReserv2()

Gets reserved field 2 (for internal use only)

Returns:

reserved field 2

getWorkAreaId

public byte getWorkAreaId()

Gets reserved workareaid (for internal use only)

Returns:

reserved workareaid

getReserv3

public short getReserv3()

Gets reserved field 3 (for internal use only)

Returns:

reserved field 3

getSetFieldsFlag

public byte getSetFieldsFlag()

getReserv4

public byte[] getReserv4()

Gets reserved field 4 (for internal use only)

Returns:

reserved field 4

getIndexFieldFlag

public byte getIndexFieldFlag()

Get index field flag

Returns:

index field flag

setLength

public void setLength(int length)

Set Length of the field. This method should be called before calling setDecimalCount().

Parameters:

length - of the field as int.

getType

public DBFDataType getType()

Gets the type for this field

Returns:

The type for this field

setType

public void setType(DBFDataType type)

Set the type for this field

Parameters:

type - The type for this field

Throws:

IllegalArgumentException - if type is not write supported

setDecimalCount

public void setDecimalCount(int size)

Sets the decimal place size of the field. Before calling this method the size of the field should be set by calling setFieldLength().

Parameters:

size - of the decimal field.

isSystem

public boolean isSystem()

Checks if is a system field

Returns:

true if it is a system field

isNullable

public boolean isNullable()

Checks if the field is nullable

Returns:

true if the field is nullable

isBinary

public boolean isBinary()

Checks if the field is binary

Returns:

true if the field is binary

toString

public String toString()

Overrides:

toString in class Object

getFieldLength

@Deprecated
public int getFieldLength()

Deprecated. use getLength()

Returns field length.

Returns:

field length as int.

setFieldLength

@Deprecated
public void setFieldLength(int length)

Deprecated. use setLength(int)

Length of the field. This method should be called before calling setDecimalCount().

Parameters:

length - of the field as int.

setDataType

@Deprecated
public void setDataType(byte type)

Deprecated. This method is deprecated and is replaced by setType(DBFDataType)

Sets the data type of the field.

Parameters:

type - of the field. One of the following:
C, L, N, F, D, M

setFieldName

@Deprecated
public void setFieldName(String value)

Deprecated. This method is deprecated and is replaced by setName(String).

Parameters:

value - the name of the field

getDataType

@Deprecated
public byte getDataType()

Deprecated. This method is deprecated and is replaced by getType()

Returns the data type of the field.

Returns:

Data type as byte.