bham.leakwatch

Class ArffFileWriter

java.lang.Object

bham.leakwatch.ArffFileWriter

public class ArffFileWriter
extends java.lang.Object

This class writes secrets and observations to a file that is compatible with the Attribute-Relation File Format (ARFF) specification.

Author:

Chris Novakovic

See Also:

ARFF specification (developer version)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArffFileWriter.CompressionType The algorithms that can be used to compress ARFF files.

Constructor Summary

Constructors

Constructor and Description
ArffFileWriter(java.io.File arffFile, ArffFileWriter.CompressionType compressionType, java.lang.String relationName) Creates a new ARFF file at a given path (overwriting any existing file at that path) and writes an ARFF header to the file.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the ARFF file.
void	writeInstance(java.lang.String secrets, java.lang.String observations) Writes a new instance to the ARFF file's dataset.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArffFileWriter

public ArffFileWriter(java.io.File arffFile,
              ArffFileWriter.CompressionType compressionType,
              java.lang.String relationName)
               throws ArffFileException

Creates a new ARFF file at a given path (overwriting any existing file at that path) and writes an ARFF header to the file. The file may optionally be compressed on-the-fly.

Parameters:

arffFile - The location of the new ARFF file.

compressionType - The compression algorithm to use while writing the file.

relationName - The @relation definition to include in the header of the file.

Throws:

ArffFileException - If the ARFF file header could not be written.

Method Detail

writeInstance

public void writeInstance(java.lang.String secrets,
                 java.lang.String observations)

Writes a new instance to the ARFF file's dataset. An instance consists of two strings: the first defines the secret variable names and values encountered during execution of a class, and the second defines the observable values encountered during the same execution. Quotation marks in either string will be escaped with backslashes before being written to the file.

Parameters:

secrets - The secret variable names and values encountered during execution.

observations - The observable values encountered during execution.

close

public void close()

Closes the ARFF file. No more instances can be added to the dataset after this method has been called.