magpie.data.utilities.output

Class DelimitedOutput

java.lang.Object

magpie.data.utilities.output.BaseDatasetOutput

magpie.data.utilities.output.DelimitedOutput

All Implemented Interfaces:

Options

Direct Known Subclasses:

DelimitedClassOutput

public class DelimitedOutput
extends BaseDatasetOutput

Write data file out to a delimited file (ex: comma separated values). The first row of this datafile includes names of the attributes and the name of the class variable. This header is then followed by a row containing the attributes and measured class (if available, None otherwise) for each entry.

Note: If the name of a variable contains the text to use as the delimiter, it will be replaced with a "_". If "_" is the delimiter, "_" will be replaced with a "-"

Usage: <delimiter>
delimiter: Type of delimeter. Put whitespace inside of quotation marks. This command accepts escaped characters

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	Delimiter Text used as delimeter.

Constructor Summary

Constructors

Constructor and Description
DelimitedOutput() Create a comma delimited file
DelimitedOutput(java.lang.String delimiter) Create a file writer with a certain delimiter

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDelimiter() Get string used to separate words in output file
void	printEnd(java.io.OutputStream output) Print the end to a data file
void	printEntries(java.util.Collection<BaseEntry> entries, java.io.OutputStream output) Write out entries to file.
void	printHeader(Dataset data, java.io.OutputStream output) Write header to output.
java.lang.String	printUsage() Print out required format for options.
protected java.lang.String	replaceDelimiter(java.lang.String string) Replace a delimiter in a string with something else.
void	setDelimiter(java.lang.String Delimiter) Set the delimiter used to separate words
void	setOptions(java.util.List<java.lang.Object> Options) Set any options for this object.

Methods inherited from class magpie.data.utilities.output.BaseDatasetOutput

writeDataset, writeDataset, writeDataset

Methods inherited from class java.lang.Object

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

Field Detail

Delimiter

protected java.lang.String Delimiter

Text used as delimeter. Default = ","

Constructor Detail

DelimitedOutput

public DelimitedOutput()

Create a comma delimited file

DelimitedOutput

public DelimitedOutput(java.lang.String delimiter)

Create a file writer with a certain delimiter

Parameters:

delimiter - Desired delimiter

Method Detail

setOptions

public void setOptions(java.util.List<java.lang.Object> Options)
                throws java.lang.Exception

Description copied from interface: Options

Set any options for this object. If parsing the options fails, return an Exception with the usage as its message.

Parameters:

Options - Array of options as Objects - can be null

Throws:

java.lang.Exception - if problem with inputs

printUsage

public java.lang.String printUsage()

Description copied from interface: Options

Print out required format for options. For consistency, should start with "Usage: ".

Returns:

Usage for this function

setDelimiter

public void setDelimiter(java.lang.String Delimiter)

Set the delimiter used to separate words

Parameters:

Delimiter -

getDelimiter

public java.lang.String getDelimiter()

Get string used to separate words in output file

Returns:

The delimiter

printHeader

public void printHeader(Dataset data,
                        java.io.OutputStream output)

Description copied from class: BaseDatasetOutput

Write header to output. This generally describes the names of attributes

Specified by:

printHeader in class BaseDatasetOutput

Parameters:

data - Dataset to be written

output - Output stream

replaceDelimiter

protected java.lang.String replaceDelimiter(java.lang.String string)

Replace a delimiter in a string with something else. Unless the delimiter is "_", the delimiter will be replaced with a "_". In that case, it will be replaced with a ",".

Parameters:

string - String to be cleaned

Returns:

String with the desired delimiter

printEntries

public void printEntries(java.util.Collection<BaseEntry> entries,
                         java.io.OutputStream output)

Description copied from class: BaseDatasetOutput

Write out entries to file. This should only write information about entries. If the entry block of a file format has a header, this should be written out in print header.

Specified by:

printEntries in class BaseDatasetOutput

Parameters:

entries - Entries to be written

output - Output stream

printEnd

public void printEnd(java.io.OutputStream output)

Description copied from class: BaseDatasetOutput

Print the end to a data file

Specified by:

printEnd in class BaseDatasetOutput

Parameters:

output - Output stream