org.databene.model.consumer
Class TextFileExporter<E>

java.lang.Object
  org.databene.model.consumer.AbstractConsumer<E>
      org.databene.model.consumer.FormattingConsumer<E>
          org.databene.model.consumer.TextFileExporter<E>

All Implemented Interfaces:

java.io.Closeable, Consumer<E>, FileExporter<E>

Direct Known Subclasses:

CSVEntityExporter, FlatFileEntityExporter, ScriptedEntityExporter, SQLEntityExporter

public class TextFileExporter<E>
extends FormattingConsumer<E>
implements FileExporter<E>

Parent class for Exporters that export data to a text file.

Created: 11.07.2008 09:50:46

Since:

0.5.4

Author:

Volker Bergmann

Field Summary

protected boolean	append
protected java.lang.String	encoding
protected java.lang.String	lineSeparator
protected java.io.PrintWriter	printer
protected java.lang.String	uri

Fields inherited from class org.databene.model.consumer.FormattingConsumer

plainConverter

Constructor Summary

TextFileExporter()

TextFileExporter(java.lang.String uri)

TextFileExporter(java.lang.String uri, java.lang.String encoding, java.lang.String lineSeparator)

Method Summary

void	close()
void	flush()
java.lang.String	getEncoding()
java.lang.String	getLineSeparator()
java.lang.String	getUri()
protected void	initPrinter(E data)
boolean	isAppend()
protected void	postInitPrinter(E data) This method is called after printer initialization and before writing the first data entry.
void	setAppend(boolean append)
void	setEncoding(java.lang.String encoding)
void	setLineSeparator(java.lang.String lineSeparator)
void	setUri(java.lang.String uri)
void	startConsuming(E data)
protected void	startConsumingImpl(E data) Writes the data to the output file.
java.lang.String	toString()

Methods inherited from class org.databene.model.consumer.FormattingConsumer

format, getDatePattern, getDecimalPattern, getDecimalSeparator, getIntegralPattern, getNullString, getTimePattern, getTimestampPattern, setDatePattern, setDecimalPattern, setDecimalSeparator, setIntegralPattern, setNullString, setTimePattern, setTimestampPattern

Methods inherited from class org.databene.model.consumer.AbstractConsumer

finishConsuming

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.databene.model.consumer.Consumer

finishConsuming

Field Detail

uri

protected java.lang.String uri

encoding

protected java.lang.String encoding

lineSeparator

protected java.lang.String lineSeparator

append

protected boolean append

printer

protected java.io.PrintWriter printer

Constructor Detail

TextFileExporter

public TextFileExporter()

TextFileExporter

public TextFileExporter(java.lang.String uri)

TextFileExporter

public TextFileExporter(java.lang.String uri,
                        java.lang.String encoding,
                        java.lang.String lineSeparator)

Method Detail

postInitPrinter

protected void postInitPrinter(E data)

This method is called after printer initialization and before writing the first data entry. Overwrite this method in child classes e.g. for writing a file header.

Parameters:

data - the first data item to write to the file

startConsumingImpl

protected void startConsumingImpl(E data)

Writes the data to the output file. It uses the parent class settings for rendering the object. Overwrite this in a child class for custom output formats.

Parameters:

data - the data object to output

getUri

public java.lang.String getUri()

Specified by:

getUri in interface FileExporter<E>

setUri

public void setUri(java.lang.String uri)

getEncoding

public java.lang.String getEncoding()

setEncoding

public void setEncoding(java.lang.String encoding)

getLineSeparator

public java.lang.String getLineSeparator()

setLineSeparator

public void setLineSeparator(java.lang.String lineSeparator)

isAppend

public boolean isAppend()

setAppend

public void setAppend(boolean append)

startConsuming

public final void startConsuming(E data)

Specified by:

startConsuming in interface Consumer<E>

flush

public void flush()

Specified by:

flush in interface Consumer<E>

Overrides:

flush in class AbstractConsumer<E>

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface Consumer<E>

Overrides:

close in class AbstractConsumer<E>

initPrinter

protected void initPrinter(E data)
                    throws java.io.IOException

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object