net.sf.flatpack.writer

Class AbstractWriter

java.lang.Object

net.sf.flatpack.writer.AbstractWriter

All Implemented Interfaces:

AutoCloseable, Writer

Direct Known Subclasses:

DelimiterWriter, FixedLengthWriter

public abstract class AbstractWriter
extends Object
implements Writer

This class encapsulates the writer that's used to output the data.

Author:

Dirk Holmes and Holger Holger Hoffstatte

Field Summary

Fields

Modifier and Type	Field and Description
protected String	lineSeparator

Constructor Summary

Constructors

Constructor and Description
AbstractWriter(Writer output)
AbstractWriter(Writer writer, String lineSeparator)

Method Summary

Modifier and Type	Method and Description
Writer	addRecordEntry(String columnName, Object value)
void	close()
Writer	flush()
protected Map<String,Object>	getRowMap()
Writer	nextRecord() Writes a newline to the output and discards the rowMap.
protected abstract boolean	validateColumnTitle(String columnTitle) Subclasses must implement this method to perform validation of columnTitle.
protected void	write(char character)
protected void	write(char[] characters)
protected void	write(Object val)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.flatpack.writer.Writer

printFooter, printHeader

Field Detail

lineSeparator

protected String lineSeparator

Constructor Detail

AbstractWriter

public AbstractWriter(Writer output)

AbstractWriter

public AbstractWriter(Writer writer,
                      String lineSeparator)

Method Detail

addRecordEntry

public Writer addRecordEntry(String columnName,
                             Object value)

Specified by:

addRecordEntry in interface Writer

validateColumnTitle

protected abstract boolean validateColumnTitle(String columnTitle)

Subclasses must implement this method to perform validation of columnTitle.

Parameters:

columnTitle - title of the column to be filled

Returns:

true if the column title is valid else return false.

nextRecord

public Writer nextRecord()
                  throws IOException

Writes a newline to the output and discards the rowMap.

This method must be overridden by subclasses to write out the record data stored in rowMap. Overriders must call super.nextRecord() as the last call in their implementation.

Specified by:

nextRecord in interface Writer

Throws:

IOException

write

protected void write(Object val)
              throws IOException

Throws:

IOException

write

protected void write(char character)
              throws IOException

Throws:

IOException

write

protected void write(char[] characters)
              throws IOException

Throws:

IOException

flush

public Writer flush()
             throws IOException

Specified by:

flush in interface Writer

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Writer

Throws:

IOException

getRowMap

protected Map<String,Object> getRowMap()