com.linuxense.javadbf

Class DBFWriter

java.lang.Object

com.linuxense.javadbf.DBFBase

com.linuxense.javadbf.DBFWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class DBFWriter
extends DBFBase
implements Closeable

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 com.linuxense.javadbf.DBFBase

DEFAULT_CHARSET, END_OF_DATA

Constructor Summary

Constructors

Constructor and Description
DBFWriter() Creates an empty DBFWriter.
DBFWriter(Charset charset) Creates an empty DBFWriter.
DBFWriter(File dbfFile) Creates a DBFWriter which can append to records to an existing DBF file.
DBFWriter(File dbfFile, Charset charset) Creates a DBFWriter which can append to records to an existing DBF file.

Method Summary

Modifier and Type	Method and Description
void	addRecord(Object[] values) Add a record.
void	close() In sync mode, write the header and close the file
void	setCharset(Charset charset) Sets the charset to use to read and write files.
void	setFields(DBFField[] fields) Sets fields.
void	write() Deprecated. use close()
void	write(OutputStream out) Writes the set data to the OutputStream.

Methods inherited from class com.linuxense.javadbf.DBFBase

getCharactersetName, getCharset, setCharactersetName

Methods inherited from class java.lang.Object

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

Constructor Detail

DBFWriter

public DBFWriter()

Creates an empty DBFWriter.

DBFWriter

public DBFWriter(Charset charset)

Creates an empty DBFWriter.

Parameters:

charset - Charset used to encode field names and field contents

DBFWriter

public DBFWriter(File dbfFile)
          throws DBFException

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

Parameters:

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

Throws:

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

DBFWriter

public DBFWriter(File dbfFile,
                 Charset charset)
          throws DBFException

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

Parameters:

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

charset - The charset used to encode field name and field contents

Throws:

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

Method Detail

setFields

public void setFields(DBFField[] fields)
               throws DBFException

Sets fields.

Throws:

DBFException

addRecord

public void addRecord(Object[] values)
               throws DBFException

Add a record.

Throws:

DBFException

write

public void write(OutputStream out)
           throws DBFException

Writes the set data to the OutputStream.

Throws:

DBFException

close

public void close()
           throws DBFException

In sync mode, write the header and close the file

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

DBFException

write

@Deprecated
public void write()
                       throws DBFException

Deprecated. use close()

In sync mode, write the header and close the file

Throws:

DBFException

setCharset

public void setCharset(Charset charset)

Description copied from class: DBFBase

Sets the charset to use to read and write files. If the library is used in a non-latin environment use this method to set corresponding character set. More information: http://www.iana.org/assignments/character-sets Also see the documentation of the class java.nio.charset.Charset

Overrides:

setCharset in class DBFBase