magpie.data.utilities.output

Class SimpleOutput

java.lang.Object

magpie.data.utilities.output.BaseDatasetOutput

magpie.data.utilities.output.SimpleOutput

All Implemented Interfaces:

Options

public class SimpleOutput
extends BaseDatasetOutput

Print the name and measured class values of each attribute. Optionally, you can print only the top entries them in ranked order.

Note: printEntries(java.util.Collection, java.io.OutputStream) doesn't actually do anything if entries are ranked. This is because you need the entire dataset to do a ranking. So, iterative printing will not be supported.

Usage: [<ranker> <# to print> <maximize|minimize> <measured|predicted> [<ranker options...>]]
ranker: Optional: Name of BaseEntryRanker used to rank entries before printing
# to print: Optional: Number of top entries to print. Can be "all"
maximum|minimum: Optional: Whether to used measured or predicted class when ranking
measured|predicted: Optional: Whether to used measured or predicted class when ranking
ranker options...: Optional: Options for the entry ranker

Field Summary

Fields

Modifier and Type	Field and Description
protected int	EntryLength Width of largest entry
protected int	NDigits Number of digits in NToPrint.
protected int	NToPrint Number of entries to print, if ranking.
protected BaseEntryRanker	Ranker Tool used to rank entries before printing them.

Constructor Summary

Constructors

Constructor and Description
SimpleOutput()

Method Summary

Modifier and Type	Method and Description
protected void	actuallyPrintEntries(java.util.Collection<BaseEntry> entries, java.io.OutputStream output) Hidden method to print entries.
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.
void	setNToPrint(int nToPrint) Define number of top entries to print.
void	setOptions(java.util.List<java.lang.Object> Options) Set any options for this object.
void	setRanker(BaseEntryRanker ranker) Define tool used to rank entries before printing.

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

Ranker

protected BaseEntryRanker Ranker

Tool used to rank entries before printing them. Optional

NToPrint

protected int NToPrint

Number of entries to print, if ranking. If -1, prints all

NDigits

protected int NDigits

Number of digits in NToPrint. Used to make printing align

EntryLength

protected int EntryLength

Width of largest entry

Constructor Detail

SimpleOutput

public SimpleOutput()

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

setRanker

public void setRanker(BaseEntryRanker ranker)

Define tool used to rank entries before printing. Set to null to print data in the same order as the input dataset

Parameters:

ranker - Desired ranker. Can be null

setNToPrint

public void setNToPrint(int nToPrint)

Define number of top entries to print. Only considered if the entries are being ranker. Provide a negative number to print everything

Parameters:

nToPrint - Number of top entries to print

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

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

actuallyPrintEntries

protected void actuallyPrintEntries(java.util.Collection<BaseEntry> entries,
                                    java.io.OutputStream output)

Hidden method to print entries. This makes it possible for printEntries to act differently if a ranker is used.

Parameters:

entries - Entries to print

output - Output

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