repicea.io

Class FormatWriter<H extends FormatHeader>

java.lang.Object

repicea.io.FormatWriter<H>

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

CSVWriter, DBFWriter, SQLWriter

public abstract class FormatWriter<H extends FormatHeader>
extends java.lang.Object
implements java.io.Closeable

Format reader is a general class for all the writers that exists (e.g. DBFWriter).

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	appendFile

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FormatWriter() Deprecated. Use constructor FormatWriter(File outputFile) instead
protected	FormatWriter(java.io.File outputFile, boolean append)

Method Summary

Modifier and Type	Method and Description
abstract void	addRecord(java.lang.Object[] record) This method writes a record in the output file.
abstract FormatField	convertGExportFieldDetailsToFormatField(GExportFieldDetails details) This method generates the appropriate FormatField given a GExportFieldDetails instance.
static FormatWriter<? extends FormatHeader<? extends FormatField>>	createFormatWriter(boolean append, java.lang.String... fileSpec) This method selects the appropriate FormatWriter class.
protected java.lang.String	getFilename() This method returns the name of the output file.
H	getHeader() This method returns the header of the output file.
void	setFields(FormatHeader<FormatField> formatHeader) This method sets the fields in the header.
void	setFields(java.util.List<FormatField> fields) This method sets the fields in the header.
protected void	setFormatHeader(H header) This method sets the header of the output file.
protected void	validateRecord(java.lang.Object[] record) This method validates the record before adding it to the output file.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Field Detail

appendFile

protected boolean appendFile

Constructor Detail

FormatWriter

@Deprecated
protected FormatWriter()

Deprecated. Use constructor FormatWriter(File outputFile) instead

Empty constructor needed for the DBFWriter.

FormatWriter

protected FormatWriter(java.io.File outputFile,
                       boolean append)
                throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getHeader

public H getHeader()

This method returns the header of the output file.

Returns:

a FormatHeader instance

setFormatHeader

protected void setFormatHeader(H header)

This method sets the header of the output file.

Parameters:

header - a FormatHeader instance

setFields

public void setFields(FormatHeader<FormatField> formatHeader)
               throws java.io.IOException

This method sets the fields in the header.

Parameters:

formatHeader - a H instance

Throws:

java.io.IOException

setFields

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

This method sets the fields in the header.

Parameters:

fields - a Vector of FormatField instances

Throws:

java.io.IOException

getFilename

protected java.lang.String getFilename()

This method returns the name of the output file.

Returns:

a String instance

addRecord

public abstract void addRecord(java.lang.Object[] record)
                        throws java.io.IOException

This method writes a record in the output file.

Parameters:

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

Throws:

java.io.IOException

validateRecord

protected void validateRecord(java.lang.Object[] record)
                       throws java.io.IOException

This method validates the record before adding it to the output file.

Parameters:

record -

Throws:

java.io.IOException

createFormatWriter

public static FormatWriter<? extends FormatHeader<? extends FormatField>> createFormatWriter(boolean append,
                                                                                             java.lang.String... fileSpec)
                                                                                      throws java.io.IOException

This method selects the appropriate FormatWriter class.

Parameters:

append - true if the file is to be appended or false otherwise

fileSpec - a series of string, the first being at least the name of the output file, the second can be the table if exporting in a database for example

Returns:

a FormatWriter instance

Throws:

java.io.IOException

convertGExportFieldDetailsToFormatField

public abstract FormatField convertGExportFieldDetailsToFormatField(GExportFieldDetails details)

This method generates the appropriate FormatField given a GExportFieldDetails instance.

Parameters:

details - a GExportFieldDetails object

Returns:

a FormatField instance