magpie.data.utilities.output

Class PropertiesOutput

java.lang.Object

magpie.data.utilities.output.BaseDatasetOutput

magpie.data.utilities.output.PropertiesOutput

All Implemented Interfaces:

Options

Direct Known Subclasses:

CompositionOutput

public class PropertiesOutput
extends BaseDatasetOutput

Write attributes and properties out to a CSV file.

Usage: *No options*

Constructor Summary

Constructors

Constructor and Description
PropertiesOutput()

Method Summary

Modifier and Type	Method and Description
protected void	printAttributeNames(Dataset data, java.io.PrintWriter fp) Print out attribute names
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.
protected void	printEntryAttributes(MultiPropertyEntry entry, java.io.PrintWriter fp) Print out attributes of an entry
protected void	printEntryProperties(MultiPropertyEntry entry, java.io.PrintWriter fp) Print out measured and predicted properties of an entry
void	printHeader(Dataset data, java.io.OutputStream output) Write header to output.
java.lang.String	printUsage() Print out required format for options.
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

Constructor Detail

PropertiesOutput

public PropertiesOutput()

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

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

printAttributeNames

protected void printAttributeNames(Dataset data,
                                   java.io.PrintWriter fp)

Print out attribute names

Parameters:

data - Dataset being printed

fp - Output stream

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

printEntryProperties

protected void printEntryProperties(MultiPropertyEntry entry,
                                    java.io.PrintWriter fp)

Print out measured and predicted properties of an entry

Parameters:

entry - Entry to be printed

fp - Output stream

printEntryAttributes

protected void printEntryAttributes(MultiPropertyEntry entry,
                                    java.io.PrintWriter fp)

Print out attributes of an entry

Parameters:

entry - Entry to be printed

fp - 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