Package org.geotools.data.shapefile.dbf

Class DbaseFileWriter

Object

DbaseFileWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class DbaseFileWriter
extends Object
implements Closeable

A DbaseFileWriter is used to write a dbase III format file. The general use of this class is:

 DbaseFileHeader header = ...
 WritableFileChannel out = new FileOutputStream("thefile.dbf").getChannel();
 DbaseFileWriter w = new DbaseFileWriter(header,out);
 while ( moreRecords ) {
   w.write( getMyRecord() );
 }
 w.close();
 

You must supply the moreRecords and getMyRecord() logic...

Author:

Ian Schneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DbaseFileWriter.FieldFormatter	Utility for formatting Dbase fields.

Constructor Summary

Constructors

Constructor	Description
DbaseFileWriter(DbaseFileHeader header, WritableByteChannel out)	Create a DbaseFileWriter using the specified header and writing to the given channel.
DbaseFileWriter(DbaseFileHeader header, WritableByteChannel out, Charset charset)	Create a DbaseFileWriter using the specified header and writing to the given channel.
DbaseFileWriter(DbaseFileHeader header, WritableByteChannel out, Charset charset, TimeZone timeZone)	Create a DbaseFileWriter using the specified header and writing to the given channel.

Method Summary

Modifier and Type	Method	Description
void	close()	Release resources associated with this writer.
DbaseFileHeader	getHeader()
boolean	getReportFieldSizeErrors()
void	setReportFieldSizeErrors(boolean reportFieldSizeErrors)
void	write(Object[] record)	Write a single dbase record.

Methods inherited from class Object

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

Constructor Detail

DbaseFileWriter

public DbaseFileWriter(DbaseFileHeader header,
                       WritableByteChannel out)
                throws IOException

Create a DbaseFileWriter using the specified header and writing to the given channel.

Parameters:

header - The DbaseFileHeader to write.

out - The Channel to write to.

Throws:

IOException - If errors occur while initializing.

DbaseFileWriter

public DbaseFileWriter(DbaseFileHeader header,
                       WritableByteChannel out,
                       Charset charset)
                throws IOException

Create a DbaseFileWriter using the specified header and writing to the given channel.

Parameters:

header - The DbaseFileHeader to write.

out - The Channel to write to.

Throws:

IOException - If errors occur while initializing.

DbaseFileWriter

public DbaseFileWriter(DbaseFileHeader header,
                       WritableByteChannel out,
                       Charset charset,
                       TimeZone timeZone)
                throws IOException

Create a DbaseFileWriter using the specified header and writing to the given channel.

Parameters:

header - The DbaseFileHeader to write.

out - The Channel to write to.

charset - The charset the dbf is (will be) encoded in

Throws:

IOException - If errors occur while initializing.

Method Detail

write

public void write(Object[] record)
           throws IOException,
                  DbaseFileException

Write a single dbase record.

Parameters:

record - The entries to write.

Throws:

IOException - If IO error occurs.

DbaseFileException - If the entry doesn't comply to the header.

close

public void close()
           throws IOException

Release resources associated with this writer. Highly recommended

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - If errors occur.

getReportFieldSizeErrors

public boolean getReportFieldSizeErrors()

setReportFieldSizeErrors

public void setReportFieldSizeErrors(boolean reportFieldSizeErrors)

getHeader

public DbaseFileHeader getHeader()