Package hec.io.dbf

Class AsciiSerializableDbfHeader

java.lang.Object

hec.io.dbf.AbstractDBFHeader

hec.io.dbf.AsciiSerializableDbfHeader

All Implemented Interfaces:

DBFHeader, Serializable

Direct Known Subclasses:

AsciiDbfDataStorageHeader

public class AsciiSerializableDbfHeader
extends AbstractDBFHeader

A class that defines all of the dbf header and index information needed for AsciiSerializable DBF files.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Field4infoContainer	_f4infoC	Contains all of the field information.
protected Vector	_fieldNames	A Vector containing the field names.
protected Tag4infoContainer	_tag4infoC	Contains the index information for Ascii Serializable dbf files.
static final String	FIELD_DESC	Constant defining the description field.
static final String	FIELD_ID	Constant defining the id field.
static final String	FIELD_NAME	Constant defining the name field.
static final String	FIELD_OBJ	Constant defining the field name for the AsciiSerialized object.
static final String	TAG_ID	Constant defining the id index tag.
static final String	TAG_NAME	Constant defining the "name" field's index tag.

Fields inherited from class hec.io.dbf.AbstractDBFHeader

_fieldDescriptors, _header, _headerSize, _numRecords, _recordSize, FIELD_DESCRIPTOR_OFFSET, FIELD_DESCRIPTOR_SIZE

Constructor Summary

Constructors

Constructor	Description
AsciiSerializableDbfHeader()

Method Summary

Modifier and Type	Method	Description
DbfRecordQuery	buildDbfRecordIdQuery()	Creates a query for this header that will retrieve all of the records using the Id index tag.
DbfRecordQuery	buildDbfRecordIdQuery(Serializable[] indexTagKeys)	Creates a query for this header that will retrieve all of the records using the Id index tag and the supplied Id tag keys.
DefaultDbfRecordIndexSet	buildDbfRecordIndexSet(Serializable[] indexTagKeys)	Creates a record number set for this header that can be used to delete records.
DbfRecordQuery	buildDbfRecordNameQuery(Serializable[] indexTagKeys)	Creates a query for this header that will retrieve all of the records using the NAME index tag and the supplied Name tag keys.
DbfRecordSet	buildDbfRecordSet()	Returns a DbfRecordSet for this header containing the index tag.
byte	getDbaseVersionCode()
Field4infoContainer	getField4infoContainer()	Returns the field 4 info accessor for this header.
String[]	getFieldNames()	Returns a Vector containing the field names.
Tag4infoContainer	getTag4infoContainer()	Returns the index information for Ascii Serializable Dbf files.
String[]	getTags()	Returns a String array containing the index tags.
protected void	init()	Creates the field descriptors in the super class.

Methods inherited from class hec.io.dbf.AbstractDBFHeader

deleteFieldDescriptor, deleteFieldDescriptor, fillPreHeaderByteArray, getByteArray, getFieldDescriptor, getFieldDescriptor, getFieldDescriptors, getHeaderSize, getNumDescriptors, getNumRecords, getRecordSize, insertFieldDescriptor, readFieldDescriptors, readHeader, readPreHeader, resizeFieldDescriptor

Methods inherited from class java.lang.Object

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

Field Details

TAG_NAME

public static final String TAG_NAME

Constant defining the "name" field's index tag.

See Also:

• Constant Field Values

TAG_ID

public static final String TAG_ID

Constant defining the id index tag.

See Also:

• Constant Field Values

FIELD_ID

public static final String FIELD_ID

Constant defining the id field.

See Also:

• Constant Field Values

FIELD_NAME

public static final String FIELD_NAME

Constant defining the name field.

See Also:

• Constant Field Values

FIELD_DESC

public static final String FIELD_DESC

Constant defining the description field.

See Also:

• Constant Field Values

FIELD_OBJ

public static final String FIELD_OBJ

Constant defining the field name for the AsciiSerialized object.

See Also:

• Constant Field Values

_fieldNames

protected Vector _fieldNames

A Vector containing the field names.

_f4infoC

protected Field4infoContainer _f4infoC

Contains all of the field information.

_tag4infoC

protected Tag4infoContainer _tag4infoC

Contains the index information for Ascii Serializable dbf files.

Constructor Details

AsciiSerializableDbfHeader

public AsciiSerializableDbfHeader()

Method Details

init

protected void init()

Creates the field descriptors in the super class.

getTag4infoContainer

public Tag4infoContainer getTag4infoContainer()
                                       throws codebase.Error4usage

Returns the index information for Ascii Serializable Dbf files.

Throws:

codebase.Error4usage

getFieldNames

public String[] getFieldNames()

Returns a Vector containing the field names.

Specified by:

getFieldNames in interface DBFHeader

Overrides:

getFieldNames in class AbstractDBFHeader

getTags

public String[] getTags()

Returns a String array containing the index tags.

getField4infoContainer

public Field4infoContainer getField4infoContainer()

Returns the field 4 info accessor for this header.

buildDbfRecordIdQuery

public DbfRecordQuery buildDbfRecordIdQuery()

Creates a query for this header that will retrieve all of the records using the Id index tag.

buildDbfRecordIdQuery

public DbfRecordQuery buildDbfRecordIdQuery(Serializable[] indexTagKeys)

Creates a query for this header that will retrieve all of the records using the Id index tag and the supplied Id tag keys.

buildDbfRecordNameQuery

public DbfRecordQuery buildDbfRecordNameQuery(Serializable[] indexTagKeys)

Creates a query for this header that will retrieve all of the records using the NAME index tag and the supplied Name tag keys.

buildDbfRecordIndexSet

public DefaultDbfRecordIndexSet buildDbfRecordIndexSet(Serializable[] indexTagKeys)

Creates a record number set for this header that can be used to delete records.

buildDbfRecordSet

public DbfRecordSet buildDbfRecordSet()

Returns a DbfRecordSet for this header containing the index tag. and field names.

getDbaseVersionCode

public byte getDbaseVersionCode()

Specified by:

getDbaseVersionCode in class AbstractDBFHeader