magpie.data.utilities.output

Class BaseDatasetOutput

java.lang.Object

magpie.data.utilities.output.BaseDatasetOutput

All Implemented Interfaces:

Options

Direct Known Subclasses:

ARFFOutput, DelimitedOutput, JSONOutput, PropertiesOutput, SimpleOutput

public abstract class BaseDatasetOutput
extends java.lang.Object
implements Options

Base class for tools that output a dataset.

To best user this class, call the appropriate writeDataset(magpie.data.Dataset, java.lang.String) command for your desired output method (e.g., generic stream, file). This will automatically write the entire file. Alternatively, you can call the commands to print the header, entries, and end separately. This might be a be a preferred route if you are, for example, reading entries from a stream and do not want to hold the entire dataset in memory at the same time. But, it is otherwise recommended to use the basic interface.

Developer's Notes: This class is designed around the idea that data files are composed of two segments: a header describing data format, the body containing the data, and some text marking the end of a file. Consequently, any implementation of these class must fulfill 3 operations:

1. printHeader(magpie.data.Dataset, java.io.OutputStream)
2. printEntries(java.util.Collection, java.io.OutputStream)
3. printEnd(java.io.OutputStream)

Constructor Summary

Constructors

Constructor and Description
BaseDatasetOutput()

Method Summary

Modifier and Type	Method and Description
abstract void	printEnd(java.io.OutputStream output) Print the end to a data file
abstract void	printEntries(java.util.Collection<BaseEntry> entries, java.io.OutputStream output) Write out entries to file.
abstract void	printHeader(Dataset data, java.io.OutputStream output) Write header to output.
void	writeDataset(Dataset data, java.io.File file) Write dataset to disk
void	writeDataset(Dataset data, java.io.OutputStream output) Write a dataset to a output stream.
void	writeDataset(Dataset data, java.lang.String filename) Write a dataset to disk

Methods inherited from class java.lang.Object

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

Methods inherited from interface magpie.utility.interfaces.Options

printUsage, setOptions

Constructor Detail

BaseDatasetOutput

public BaseDatasetOutput()

Method Detail

writeDataset

public void writeDataset(Dataset data,
                         java.lang.String filename)
                  throws java.io.IOException

Write a dataset to disk

Parameters:

data - Dataset to be output

filename - Path to output file

Throws:

java.io.IOException

writeDataset

public void writeDataset(Dataset data,
                         java.io.File file)
                  throws java.io.IOException

Write dataset to disk

Parameters:

data - Dataset to be output

file - Output file

Throws:

java.io.IOException

writeDataset

public void writeDataset(Dataset data,
                         java.io.OutputStream output)
                  throws java.io.IOException

Write a dataset to a output stream. Writes both header and body

Parameters:

data - Dataset to be output

output - Output stream for data

Throws:

java.io.IOException

printHeader

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

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

Parameters:

data - Dataset to be written

output - Output stream

printEntries

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

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.

Parameters:

entries - Entries to be written

output - Output stream

printEnd

public abstract void printEnd(java.io.OutputStream output)

Print the end to a data file

Parameters:

output - Output stream