de.unknownreality.dataframe

Class DataFrameWriter

java.lang.Object

de.unknownreality.dataframe.DataFrameWriter

public class DataFrameWriter
extends Object

Created by Alex on 23.06.2017.

Field Summary

Fields

Modifier and Type	Field and Description
static WriteFormat	DEFAULT_PRINT_FORMAT Defines the default format used to print dataframes.
static WriteFormat	DEFAULT_WRITE_FORMAT Defines the default format used to write dataframes.
static boolean	DEFAULT_WRITE_META Defines whether meta files should be written per default.

Constructor Summary

Constructors

Constructor and Description
DataFrameWriter()

Method Summary

Modifier and Type	Method and Description
static void	print(DataFrame dataFrame) Prints a dataframe to System.out using the default print format (DEFAULT_WRITE_FORMAT).
static void	print(DataFrame dataFrame, DataWriter dataWriter) Prints a dataframe to System.out using a specified DataWriter.
static void	print(DataFrame dataFrame, WriteFormat writeFormat) Prints a dataframe to System.out using a specified WriteFormat.
static void	write(File file, DataFrame dataFrame) Writes a dataframe to a file using the default write format (DEFAULT_WRITE_FORMAT).
static void	write(File file, DataFrame dataFrame, boolean writeMetaFile) Writes a dataframe to a file using the default write format (DEFAULT_WRITE_FORMAT).
static void	write(File file, DataFrame dataFrame, DataWriter dataWriter) Writes a dataframe to a file using a specified DataWriter.
static void	write(File file, DataFrame dataFrame, DataWriter dataWriter, boolean writeMetaFile) Writes a dataframe to a file using a specified DataWriter.
static void	write(File file, DataFrame dataFrame, WriteFormat writeFormat) Writes a dataframe to a file using a specified WriteFormat.
static void	write(File file, DataFrame dataFrame, WriteFormat writeFormat, boolean writeMetaFile) Writes a dataframe to a file using a specified WriteFormat.
static void	write(OutputStream outputStream, DataFrame dataFrame) Writes a dataframe to a OutputStream using the default write format (DEFAULT_WRITE_FORMAT).
static void	write(OutputStream outputStream, DataFrame dataFrame, DataWriter dataWriter) Writes a dataframe to a OutputStream using a specified DataWriter.
static void	write(OutputStream outputStream, DataFrame dataFrame, WriteFormat writeFormat) Writes a dataframe to a OutputStream using a specified WriteFormat.
static void	write(Writer writer, DataFrame dataFrame) Writes a dataframe to a Writer using the default write format (DEFAULT_WRITE_FORMAT).
static void	write(Writer writer, DataFrame dataFrame, DataWriter dataWriter) Writes a dataframe to a Writer using a specified DataWriter.
static void	write(Writer writer, DataFrame dataFrame, WriteFormat writeFormat) Writes a dataframe to a Writer using a specified WriteFormat.
static void	writeCSV(File file, DataFrame dataFrame, char separator, boolean writeHeader) Writes a dataframe to a file using the CSV file format (CSVFormat) and a specified separator.
static void	writeCSV(File file, DataFrame dataFrame, char separator, boolean writeHeader, boolean writeMetaFile) Writes a dataframe to a file using the CSV file format (CSVFormat) and a specified separator.
static void	writeCSV(File file, DataFrame dataFrame, char separator, String headerPrefix) Writes a dataframe to a file using the CSV file format (CSVFormat) and a specified separator.
static void	writeCSV(File file, DataFrame dataFrame, char separator, String headerPrefix, boolean writeMetaFile) Writes a dataframe to a file using the CSV file format (CSVFormat) and a specified separator.
static void	writeCSV(OutputStream outputStream, DataFrame dataFrame, char separator, boolean writeHeader) Writes a dataframe to a OutputStream using the CSV file format (CSVFormat) and a specified separator.
static void	writeCSV(OutputStream outputStream, DataFrame dataFrame, char separator, String headerPrefix) Writes a dataframe to a OutputStream using the CSV file format (CSVFormat) and a specified separator.
static void	writeCSV(Writer writer, DataFrame dataFrame, char separator, boolean writeHeader) Writes a dataframe to a Writer using the CSV file format (CSVFormat) and a specified separator.
static void	writeCSV(Writer writer, DataFrame dataFrame, char separator, String headerPrefix) Writes a dataframe to a Writer using the CSV file format (CSVFormat) and a specified separator.
static void	writeMetaFile(File file, DataFrame dataFrame, DataWriter dataWriter) Writes the meta file for a dataframe and DataWriter to a target file

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WRITE_META

public static final boolean DEFAULT_WRITE_META

Defines whether meta files should be written per default. At the moment, meta files are written automatically if the DataWriter used to write the DataFrame has a matching ReadFormat (DataWriter.getReadFormat()).

See Also:

Constant Field Values

DEFAULT_PRINT_FORMAT

public static final WriteFormat DEFAULT_PRINT_FORMAT

Defines the default format used to print dataframes. The tab separated file format is used per default.

DEFAULT_WRITE_FORMAT

public static final WriteFormat DEFAULT_WRITE_FORMAT

Defines the default format used to write dataframes. The tab separated file format is used per default.

Constructor Detail

DataFrameWriter

public DataFrameWriter()

Method Detail

write

public static void write(File file,
                         DataFrame dataFrame,
                         DataWriter dataWriter)

Writes a dataframe to a file using a specified DataWriter. If there is a matching DataReader for the DataWriter, a meta file is written automatically

Parameters:

file - target file

dataFrame - input dataframe

dataWriter - data writer used to write the dataframe

write

public static void write(File file,
                         DataFrame dataFrame,
                         DataWriter dataWriter,
                         boolean writeMetaFile)

Writes a dataframe to a file using a specified DataWriter. If there is a matching ReadFormat for the DataWriter, a meta file is written if specified.

Parameters:

file - target file

dataFrame - input dataframe

writeMetaFile - defines whether a meta file should be created

dataWriter - data writer used to write the dataframe

write

public static void write(Writer writer,
                         DataFrame dataFrame,
                         DataWriter dataWriter)

Writes a dataframe to a Writer using a specified DataWriter.

Parameters:

writer - target writer

dataFrame - input dataframe

dataWriter - data writer used to write the dataframe

write

public static void write(OutputStream outputStream,
                         DataFrame dataFrame,
                         DataWriter dataWriter)

Writes a dataframe to a OutputStream using a specified DataWriter.

Parameters:

outputStream - target OutputStream

dataFrame - input dataframe

dataWriter - data writer used to write the dataframe

write

public static void write(File file,
                         DataFrame dataFrame,
                         WriteFormat writeFormat)

Writes a dataframe to a file using a specified WriteFormat. If there is a matching ReadFormat for the WriteFormat, a meta file is written automatically

Parameters:

file - target file

dataFrame - input dataframe

writeFormat - defines the output format used to write the dataframe

write

public static void write(File file,
                         DataFrame dataFrame,
                         WriteFormat writeFormat,
                         boolean writeMetaFile)

Writes a dataframe to a file using a specified WriteFormat. If there is a matching ReadFormat for the WriteFormat, a meta file is written if specified

Parameters:

file - target file

dataFrame - input dataframe

writeFormat - defines the output format used to write the dataframe

writeMetaFile - defines whether a meta file should be created

write

public static void write(Writer writer,
                         DataFrame dataFrame,
                         WriteFormat writeFormat)

Writes a dataframe to a Writer using a specified WriteFormat.

Parameters:

writer - target writer

dataFrame - input dataframe

writeFormat - data writer used to write the dataframe

write

public static void write(OutputStream outputStream,
                         DataFrame dataFrame,
                         WriteFormat writeFormat)

Writes a dataframe to a OutputStream using a specified WriteFormat.

Parameters:

outputStream - target OutputStream

dataFrame - input dataframe

writeFormat - data writer used to write the dataframe

write

public static void write(File file,
                         DataFrame dataFrame)

Writes a dataframe to a file using the default write format (DEFAULT_WRITE_FORMAT). A meta file is written automatically.

Parameters:

file - target file

dataFrame - input dataframe

write

public static void write(File file,
                         DataFrame dataFrame,
                         boolean writeMetaFile)

Writes a dataframe to a file using the default write format (DEFAULT_WRITE_FORMAT). A meta file is written if specified.

Parameters:

file - target file

dataFrame - input dataframe

writeMetaFile - defines whether a meta file should be created

write

public static void write(Writer writer,
                         DataFrame dataFrame)

Writes a dataframe to a Writer using the default write format (DEFAULT_WRITE_FORMAT).

Parameters:

writer - target writer

dataFrame - input dataframe

write

public static void write(OutputStream outputStream,
                         DataFrame dataFrame)

Writes a dataframe to a OutputStream using the default write format (DEFAULT_WRITE_FORMAT).

Parameters:

outputStream - target outputStream

dataFrame - input dataframe

writeCSV

public static void writeCSV(File file,
                            DataFrame dataFrame,
                            char separator,
                            boolean writeHeader)

Writes a dataframe to a file using the CSV file format (CSVFormat) and a specified separator. A header is written if specified. A meta file is written automatically.

Parameters:

file - target file

separator - separator char

writeHeader - defines whether the header should be written to the file

dataFrame - input dataframe

writeCSV

public static void writeCSV(File file,
                            DataFrame dataFrame,
                            char separator,
                            boolean writeHeader,
                            boolean writeMetaFile)

Writes a dataframe to a file using the CSV file format (CSVFormat) and a specified separator. Header and meta file are written if specified.

Parameters:

file - target file

separator - separator char

writeHeader - defines whether the header should be written to the file

writeMetaFile - defines whether a meta file should be written

dataFrame - input dataframe

writeCSV

public static void writeCSV(Writer writer,
                            DataFrame dataFrame,
                            char separator,
                            boolean writeHeader)

Writes a dataframe to a Writer using the CSV file format (CSVFormat) and a specified separator. Header and meta file are written if specified.

Parameters:

writer - target writer

separator - separator char

writeHeader - defines whether the header should be written to the file

dataFrame - input dataframe

writeCSV

public static void writeCSV(OutputStream outputStream,
                            DataFrame dataFrame,
                            char separator,
                            boolean writeHeader)

Writes a dataframe to a OutputStream using the CSV file format (CSVFormat) and a specified separator. Header and meta file are written if specified.

Parameters:

outputStream - target OutputStream

separator - separator char

writeHeader - defines whether the header should be written to the file

dataFrame - input dataframe

writeCSV

public static void writeCSV(File file,
                            DataFrame dataFrame,
                            char separator,
                            String headerPrefix)

Writes a dataframe to a file using the CSV file format (CSVFormat) and a specified separator. Header is written and a header prefix is added. A meta file is written automatically.

Parameters:

file - target file

separator - separator char

headerPrefix - header prefix

dataFrame - input dataframe

writeCSV

public static void writeCSV(File file,
                            DataFrame dataFrame,
                            char separator,
                            String headerPrefix,
                            boolean writeMetaFile)

Writes a dataframe to a file using the CSV file format (CSVFormat) and a specified separator. Header is written and a header prefix is added. A meta file is written if specified.

Parameters:

file - target file

separator - separator char

headerPrefix - header prefix

writeMetaFile - defines whether a meta file should be written

dataFrame - input dataframe

writeCSV

public static void writeCSV(Writer writer,
                            DataFrame dataFrame,
                            char separator,
                            String headerPrefix)

Writes a dataframe to a Writer using the CSV file format (CSVFormat) and a specified separator. Header is written and a header prefix is added.

Parameters:

writer - target writer

separator - separator char

headerPrefix - header prefix

dataFrame - input dataframe

writeCSV

public static void writeCSV(OutputStream outputStream,
                            DataFrame dataFrame,
                            char separator,
                            String headerPrefix)

Writes a dataframe to a OutputStream using the CSV file format (CSVFormat) and a specified separator. Header is written and a header prefix is added.

Parameters:

outputStream - target OutputStream

separator - separator char

headerPrefix - header prefix

dataFrame - input dataframe

writeMetaFile

public static void writeMetaFile(File file,
                                 DataFrame dataFrame,
                                 DataWriter dataWriter)

Writes the meta file for a dataframe and DataWriter to a target file

Parameters:

file - target file

dataFrame - input dataframe

dataWriter - DataWriter used to write the dataframe

print

public static void print(DataFrame dataFrame)

Prints a dataframe to System.out using the default print format (DEFAULT_WRITE_FORMAT).

Parameters:

dataFrame - input dataframe

print

public static void print(DataFrame dataFrame,
                         DataWriter dataWriter)

Prints a dataframe to System.out using a specified DataWriter.

Parameters:

dataWriter - data writer used to print the dataframe

dataFrame - input dataframe

print

public static void print(DataFrame dataFrame,
                         WriteFormat writeFormat)

Prints a dataframe to System.out using a specified WriteFormat.

Parameters:

writeFormat - write format used to print the dataframe

dataFrame - input dataframe