Package edu.ie3.datamodel.io.csv

Class BufferedCsvWriter

java.lang.Object

java.io.Writer

java.io.BufferedWriter

edu.ie3.datamodel.io.csv.BufferedCsvWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class BufferedCsvWriter
extends BufferedWriter

This class extends the BufferedWriter and adds information about the file shape of the csv file

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
BufferedCsvWriter(String baseFolder, CsvFileDefinition fileDefinition, boolean append)	Build a new CsvBufferedWriter.
BufferedCsvWriter(String filePath, String[] headLineElements, String csvSep, boolean append)	Build a new CsvBufferedWriter.

Method Summary

Modifier and Type	Method	Description
Writer	append(char c)
Writer	append(CharSequence csq)
Writer	append(CharSequence csq, int start, int end)
boolean	equals(Object o)
int	hashCode()
String	toString()
void	write(Map<String,String> entityFieldData)	Actually persisting the provided entity field data
final void	writeFileHeader()	Writes the file header.

Methods inherited from class java.io.BufferedWriter

close, flush, newLine, write, write, write

Methods inherited from class java.io.Writer

nullWriter, write, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BufferedCsvWriter

public BufferedCsvWriter(String filePath,
 String[] headLineElements,
 String csvSep,
 boolean append)
                  throws IOException

Build a new CsvBufferedWriter. The order of headline elements given in this constructor defines the order of columns in file

Parameters:

filePath - String representation of the full path to the target file

headLineElements - Elements of the csv headline

csvSep - csv separator char

append - true to append to an existing file, false to overwrite an existing file (if any), if no file exists, a new one will be created in both cases

Throws:

IOException - If the FileOutputStream cannot be established.

BufferedCsvWriter

public BufferedCsvWriter(String baseFolder,
 CsvFileDefinition fileDefinition,
 boolean append)
                  throws IOException

Build a new CsvBufferedWriter. This is a "convenience" Constructor. The absolute file path is assembled by concatenation of baseFolder and fileDefinition's file path information. The order of headline elements in fileDefinition defines the order of columns in file

Parameters:

baseFolder - Base folder, from where the file hierarchy should start

fileDefinition - The foreseen shape of the file

append - true to append to an existing file, false to overwrite an existing file (if any), if no file exists, a new one will be created in both cases

Throws:

IOException - If the FileOutputStream cannot be established.

Method Details

write

public void write(Map<String,String> entityFieldData)
           throws IOException,
SinkException

Actually persisting the provided entity field data

Parameters:

entityFieldData - a mapping of an entity instance fields to their values

Throws:

IOException - If writing has failed

SinkException - If the data does not meet the pre-defined head line

writeFileHeader

public final void writeFileHeader()
                           throws IOException

Writes the file header.

Throws:

IOException - If something is messed up

append

public Writer append(CharSequence csq)

Specified by:

append in interface Appendable

Overrides:

append in class Writer

append

public Writer append(CharSequence csq,
 int start,
 int end)

Specified by:

append in interface Appendable

Overrides:

append in class Writer

append

public Writer append(char c)

Specified by:

append in interface Appendable

Overrides:

append in class Writer

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object