repicea.io.javadbf

Class DBFWriter

java.lang.Object

repicea.io.FormatWriter<DBFHeader>

repicea.io.javadbf.DBFWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class DBFWriter
extends FormatWriter<DBFHeader>

An object of this class can create a DBF file. Create an object,
then define fields by creating DBFField objects and
add them to the DBFWriter object
add records using the addRecord() method and then
call write() method.

Field Summary

Fields inherited from class repicea.io.FormatWriter

appendFile

Constructor Summary

Constructors

Constructor and Description
DBFWriter() Deprecated.
DBFWriter(java.io.File dbfFile) Deprecated. The append option is automatically determined in this writer depending on whether the file exists. This feature is unsafe. The constructor with the append parameter is preferable to this one.
DBFWriter(java.io.File dbfFile, boolean append) Creates a DBFWriter which can append to records to an existing DBF file.

Method Summary

Modifier and Type	Method and Description
void	addRecord(java.lang.Object[] values) Add a record.
void	close()
FormatField	convertGExportFieldDetailsToFormatField(GExportFieldDetails details) This method generates the appropriate FormatField given a GExportFieldDetails instance.
java.lang.String	getCharactersetName()
void	setCharactersetName(java.lang.String characterSetName)
void	setFields(DBFField[] fields) Deprecated. Use the setFields(Vector fields) method instead
void	setFields(java.util.List<FormatField> fields) This method sets the fields in the header.
void	write()
void	write(java.io.OutputStream out) Writes the set data to the OutputStream.

Methods inherited from class repicea.io.FormatWriter

createFormatWriter, getFilename, getHeader, setFields, setFormatHeader, validateRecord

Methods inherited from class java.lang.Object

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

Constructor Detail

DBFWriter

@Deprecated
public DBFWriter()

Deprecated.

Creates an empty Object.

DBFWriter

@Deprecated
public DBFWriter(java.io.File dbfFile)
                      throws java.io.IOException

Deprecated. The append option is automatically determined in this writer depending on whether the file exists. This feature is unsafe. The constructor with the append parameter is preferable to this one.

Creates a DBFWriter which can append to records to an existing DBF file.

Parameters:

dbfFile - The file passed in should be a valid DBF file.

Throws:

Throws - DBFException if the passed in file does exist but not a valid DBF file, or if an IO error occurs.

java.io.IOException

DBFWriter

public DBFWriter(java.io.File dbfFile,
                 boolean append)
          throws java.io.IOException

Creates a DBFWriter which can append to records to an existing DBF file.

Parameters:

dbfFile - The file passed in should be a valid DBF file.

append - true if the file is to be appended

Throws:

Throws - IOException if the passed in file does exist but not a valid DBF file, or if an IO error occurs.

java.io.IOException

Method Detail

getCharactersetName

public java.lang.String getCharactersetName()

setCharactersetName

public void setCharactersetName(java.lang.String characterSetName)

setFields

@Deprecated
public void setFields(DBFField[] fields)
                           throws java.io.IOException

Deprecated. Use the setFields(Vector fields) method instead

Sets fields.

Throws:

java.io.IOException

setFields

public void setFields(java.util.List<FormatField> fields)
               throws java.io.IOException

Description copied from class: FormatWriter

This method sets the fields in the header.

Overrides:

setFields in class FormatWriter<DBFHeader>

Parameters:

fields - a Vector of FormatField instances

Throws:

java.io.IOException

addRecord

public void addRecord(java.lang.Object[] values)
               throws DBFException

Add a record.

Specified by:

addRecord in class FormatWriter<DBFHeader>

Parameters:

values - an Array of object to be written in the output file

Throws:

DBFException

write

public void write(java.io.OutputStream out)
           throws DBFException

Writes the set data to the OutputStream.

Throws:

DBFException

write

public void write()
           throws DBFException

Throws:

DBFException

close

public void close()

convertGExportFieldDetailsToFormatField

public FormatField convertGExportFieldDetailsToFormatField(GExportFieldDetails details)

Description copied from class: FormatWriter

This method generates the appropriate FormatField given a GExportFieldDetails instance.

Specified by:

convertGExportFieldDetailsToFormatField in class FormatWriter<DBFHeader>

Parameters:

details - a GExportFieldDetails object

Returns:

a FormatField instance