Package weka.experiment
Class CSVResultListener
java.lang.Object
weka.experiment.CSVResultListener
- All Implemented Interfaces:
Serializable,OptionHandler,RevisionHandler,ResultListener
- Direct Known Subclasses:
InstancesResultListener
public class CSVResultListener
extends Object
implements ResultListener, OptionHandler, RevisionHandler
Takes results from a result producer and assembles
them into comma separated value form.
Valid options are:
-O <file name> The filename where output will be stored. Use - for stdout. (default temp file)
- Version:
- $Revision: 11690 $
- Author:
- Len Trigg (trigg@cs.waikato.ac.nz)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidacceptResult(ResultProducer rp, Object[] key, Object[] result) Just prints out each result as it is received.String[]Determines if there are any constraints (imposed by the destination) on the result columns to be produced by resultProducers.String[]Gets the current settings of the Classifier.Get the value of OutputFile.Returns the revision string.Returns a string describing this result listenerbooleanisResultRequired(ResultProducer rp, Object[] key) Always says a result is required.Returns an enumeration describing the available options..Get the value of OutputFileName.Returns the tip text for this propertyvoidPerform any postprocessing.voidPrepare for the results to be received.voidsetOptions(String[] options) Parses a given list of options.voidsetOutputFile(File newOutputFile) Set the value of OutputFile.voidsetOutputFileName(String name) Set the value of OutputFileName.
-
Constructor Details
-
CSVResultListener
public CSVResultListener()Sets temporary file.
-
-
Method Details
-
globalInfo
Returns a string describing this result listener- Returns:
- a description of the result listener suitable for displaying in the explorer/experimenter gui
-
listOptions
Returns an enumeration describing the available options..- Specified by:
listOptionsin interfaceOptionHandler- Returns:
- an enumeration of all the available options.
-
setOptions
Parses a given list of options. Valid options are:-O <file name> The filename where output will be stored. Use - for stdout. (default temp file)
- Specified by:
setOptionsin interfaceOptionHandler- Parameters:
options- the list of options as an array of strings- Throws:
Exception- if an option is not supported
-
getOptions
Gets the current settings of the Classifier.- Specified by:
getOptionsin interfaceOptionHandler- Returns:
- an array of strings suitable for passing to setOptions
-
outputFileTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getOutputFile
Get the value of OutputFile.- Returns:
- Value of OutputFile.
-
setOutputFile
Set the value of OutputFile. Also sets the OutputFileName.- Parameters:
newOutputFile- Value to assign to OutputFile.
-
outputFileName
Get the value of OutputFileName.- Returns:
- Value of OutputFile.
-
setOutputFileName
Set the value of OutputFileName. Must be used AFTER setOutputFile.- Parameters:
name- the name of OutputFile.
-
preProcess
Prepare for the results to be received.- Specified by:
preProcessin interfaceResultListener- Parameters:
rp- the ResultProducer that will generate the results- Throws:
Exception- if an error occurs during preprocessing.
-
postProcess
Perform any postprocessing. When this method is called, it indicates that no more results will be sent that need to be grouped together in any way.- Specified by:
postProcessin interfaceResultListener- Parameters:
rp- the ResultProducer that generated the results- Throws:
Exception- if an error occurs
-
determineColumnConstraints
Determines if there are any constraints (imposed by the destination) on the result columns to be produced by resultProducers. Null should be returned if there are NO constraints, otherwise a list of column names should be returned as an array of Strings.- Specified by:
determineColumnConstraintsin interfaceResultListener- Parameters:
rp- the ResultProducer to which the constraints will apply- Returns:
- an array of column names to which resutltProducer's results will be restricted.
- Throws:
Exception- if an error occurs.
-
acceptResult
Just prints out each result as it is received.- Specified by:
acceptResultin interfaceResultListener- Parameters:
rp- the ResultProducer that generated the resultkey- The key for the results.result- The actual results.- Throws:
Exception- if the result could not be accepted.
-
isResultRequired
Always says a result is required. If this is the first call, prints out the header for the csv output.- Specified by:
isResultRequiredin interfaceResultListener- Parameters:
rp- the ResultProducer wanting to generate the resultkey- The key for which a result may be needed.- Returns:
- true if the result should be calculated.
- Throws:
Exception- if it could not be determined if the result is needed.
-
getRevision
Returns the revision string.- Specified by:
getRevisionin interfaceRevisionHandler- Returns:
- the revision
-