/*
DBFField
Class represents a "field" (or column) definition of a DBF data structure.
This file is part of JavaDBF packege.
author: anil@linuxense.com
license: LGPL (http://www.gnu.org/copyleft/lesser.html)
$Id: DBFField.java,v 1.7 2004/03/31 10:50:11 anil Exp $
*/
package whitebox.geospatialfiles.shapefile.attributes;
import java.io.*;
import java.util.Arrays;
import java.util.Calendar;
import static whitebox.geospatialfiles.shapefile.attributes.DBFField.DBFDataType.BOOLEAN;
import static whitebox.geospatialfiles.shapefile.attributes.DBFField.DBFDataType.DATE;
import static whitebox.geospatialfiles.shapefile.attributes.DBFField.DBFDataType.FLOAT;
import static whitebox.geospatialfiles.shapefile.attributes.DBFField.DBFDataType.MEMO;
import static whitebox.geospatialfiles.shapefile.attributes.DBFField.DBFDataType.NUMERIC;
import static whitebox.geospatialfiles.shapefile.attributes.DBFField.DBFDataType.STRING;
/**
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 getField( int) query.
*/
public class DBFField {
public static final byte FIELD_TYPE_C = (byte) 'C';
public static final byte FIELD_TYPE_L = (byte) 'L';
public static final byte FIELD_TYPE_N = (byte) 'N';
public static final byte FIELD_TYPE_F = (byte) 'F';
public static final byte FIELD_TYPE_D = (byte) 'D';
public static final byte FIELD_TYPE_M = (byte) 'M';
/* Field struct variables start here */
byte[] fieldName = new byte[11]; /* 0-10*/
//byte dataType; /* 11 */
private DBFField.DBFDataType dataType;
int reserv1; /* 12-15 */
int fieldLength; /* 16 */
byte decimalCount; /* 17 */
short reserv2; /* 18-19 */
byte workAreaId; /* 20 */
short reserv3; /* 21-22 */
byte setFieldsFlag; /* 23 */
byte[] reserv4 = new byte[7]; /* 24-30 */
byte indexFieldFlag; /* 31 */
/* Field struct variables end here */
/* other class variables */
int nameNullIndex = 0;
/**
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.
@param in DataInputStream
@return Returns the created DBFField object.
@throws IOException If any stream reading problems occures.
*/
protected static DBFField createField(DataInput in)
throws IOException {
DBFField field = new DBFField();
byte t_byte = in.readByte(); /* 0 */
if (t_byte == (byte) 0x0d) {
//System.out.println( "End of header found");
return null;
}
in.readFully(field.fieldName, 1, 10); /* 1-10 */
field.fieldName[0] = t_byte;
for (int i = 0; i < field.fieldName.length; i++) {
if (field.fieldName[ i] == (byte) 0) {
field.nameNullIndex = i;
break;
}
}
//field.dataType = in.readByte(); /* 11 */
field.dataType = DBFField.DBFDataType.getTypeBySymbol(in.readByte());
field.reserv1 = Utils.readLittleEndianInt(in); /* 12-15 */
field.fieldLength = in.readUnsignedByte(); /* 16 */
field.decimalCount = in.readByte(); /* 17 */
field.reserv2 = Utils.readLittleEndianShort(in); /* 18-19 */
field.workAreaId = in.readByte(); /* 20 */
field.reserv2 = Utils.readLittleEndianShort(in); /* 21-22 */
field.setFieldsFlag = in.readByte(); /* 23 */
in.readFully(field.reserv4); /* 24-30 */
field.indexFieldFlag = in.readByte(); /* 31 */
return field;
}
/**
* Creates a default DBFField.
*/
public DBFField() {
this.dataType = DBFField.DBFDataType.STRING;
this.fieldLength = 10;
this.decimalCount = 0;
}
/**
Writes the content of DBFField object into the stream as per
DBF format specifications.
@param os OutputStream
@throws IOException if any stream related issues occur.
*/
protected void write(DataOutput out)
throws IOException {
//DataOutputStream out = new DataOutputStream( os);
// Field Name
out.write(fieldName); /* 0-10 */
out.write(new byte[11 - fieldName.length]);
// data type
out.writeByte(dataType.symbol); /* 11 */
out.writeInt(0x00); /* 12-15 */
out.writeByte(fieldLength); /* 16 */
out.writeByte(decimalCount); /* 17 */
out.writeShort((short) 0x00); /* 18-19 */
out.writeByte((byte) 0x00); /* 20 */
out.writeShort((short) 0x00); /* 21-22 */
out.writeByte((byte) 0x00); /* 23 */
out.write(new byte[7]); /* 24-30*/
out.writeByte((byte) 0x00); /* 31 */
}
/**
Returns the name of the field.
@return Name of the field as String.
*/
public String getName() {
return new String(this.fieldName, 0, nameNullIndex);
}
/**
Returns the data type of the field.
@return Data type as byte.
*/
public DBFField.DBFDataType getDataType() {
return dataType;
}
/**
Returns field length.
@return field length as int.
*/
public int getFieldLength() {
return fieldLength;
}
/**
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.
@return decimal field size as int.
*/
public int getDecimalCount() {
return decimalCount;
}
// Setter methods
// byte[] fieldName = new byte[ 11]; /* 0-10*/
// byte dataType; /* 11 */
// int reserv1; /* 12-15 */
// byte fieldLength; /* 16 */
// byte decimalCount; /* 17 */
// short reserv2; /* 18-19 */
// byte workAreaId; /* 20 */
// short reserv3; /* 21-22 */
// byte setFieldsFlag; /* 23 */
// byte[] reserv4 = new byte[ 7]; /* 24-30 */
// byte indexFieldFlag; /* 31 */
/**
Sets the name of the field.
@param name of the field as String.
@since 0.3.3.1
*/
public void setName(String value) {
if (value == null) {
throw new IllegalArgumentException("Field name cannot be null");
}
if (value.length() == 0 || value.length() > 10) {
throw new IllegalArgumentException("Field name should be of length 0-10");
}
// Always use full 11 bytes for name
// Copy each byte into fieldName
this.fieldName = new byte[11];
int i = 0;
for (byte b : value.getBytes()) {
this.fieldName[i] = b;
i++;
}
this.nameNullIndex = this.fieldName.length;
}
/**
Sets the data type of the field.
* @param value
*/
public void setDataType(DBFField.DBFDataType value) {
if (value == this.dataType) {
return;
}
if (value == DBFField.DBFDataType.DATE) {
setFieldLength(8);
}
this.dataType = value;
}
/**
Length of the field.
This method should be called before calling setDecimalCount().
@param Length of the field as int.
*/
public void setFieldLength(int value) {
if (value <= 0) {
throw new IllegalArgumentException("Field length should be a positive number");
}
if (this.dataType == DBFField.DBFDataType.DATE) {
throw new UnsupportedOperationException("Cannot do this on a Date field");
}
fieldLength = value;
}
/**
Sets the decimal place size of the field.
Before calling this method the size of the field
should be set by calling setFieldLength().
@param Size of the decimal field.
*/
public void setDecimalCount(int value) {
if (value < 0) {
throw new IllegalArgumentException("Decimal length should be a positive number");
}
if (value > fieldLength) {
throw new IllegalArgumentException("Decimal length should be less than field length");
}
decimalCount = (byte) value;
}
/**
* Representation of the field's data type
*/
public enum DBFDataType {
DATE((byte) 'D', "Date"),
STRING((byte) 'C', "String"),
BOOLEAN((byte) 'L', "Boolean"),
NUMERIC((byte) 'N', "Numeric"),
FLOAT((byte) 'F', "Float"),
MEMO((byte) 'M', "Memo");
private final byte symbol;
private final String displayName;
DBFDataType(byte symbol, String displayName) {
this.symbol = symbol;
this.displayName = displayName;
}
/**
* Gets the single byte character symbol that is used by the dbf format
* @return single byte character
*/
public byte getSymbol() {
return this.symbol;
}
/**
* Generator for getting the correct enum value for a single byte symbol
* @param symbol
* @return DBFDataType enum value
*/
public static DBFField.DBFDataType getTypeBySymbol(byte symbol) {
for (DBFField.DBFDataType type : DBFField.DBFDataType.values()) {
if (type.symbol == symbol) {
return type;
}
}
return null;
}
/**
* Gets a Java class equivalent for representing a dbf data type
* @return
*/
public Class<?> getEquivalentClass() {
switch (this) {
case STRING:
case MEMO:
return String.class;
case DATE:
return Calendar.class;
case FLOAT:
case NUMERIC:
return Double.class;
case BOOLEAN:
return Boolean.class;
}
return null;
}
@Override
public String toString() {
return this.displayName;
}
}
@Override
public int hashCode() {
int hash = 7;
hash = 37 * hash + Arrays.hashCode(this.fieldName);
hash = 37 * hash + this.dataType.symbol;
hash = 37 * hash + this.fieldLength;
hash = 37 * hash + this.decimalCount;
return hash;
}
@Override
public boolean equals(Object obj) {
if (obj == null) {
return false;
}
if (getClass() != obj.getClass()) {
return false;
}
final DBFField other = (DBFField) obj;
if (!Arrays.equals(this.fieldName, other.fieldName)) {
return false;
}
if (this.dataType != other.dataType) {
return false;
}
if (this.fieldLength != other.fieldLength) {
return false;
}
if (this.decimalCount != other.decimalCount) {
return false;
}
return true;
}
}