weka.experiment
Class ExtractionSplitEvaluator

java.lang.Object
  extended byweka.experiment.ExtractionSplitEvaluator
All Implemented Interfaces:
OptionHandler, java.io.Serializable, SplitEvaluator

public class ExtractionSplitEvaluator
extends java.lang.Object
implements SplitEvaluator, OptionHandler

A SplitEvaluator that produces results for an extraction scheme -W classname
Specify the full class name of the extractor to evaluate.

See Also:
Serialized Form

Field Summary
protected  Extractor m_extractor
          The extractor used for evaluation
protected  java.lang.String m_extractorOptions
          The extractor options (if any)
protected  java.lang.String m_extractorVersion
          The extractor version
protected  java.lang.String m_result
          Holds the statistics for the most recent application of the extractor
 
Constructor Summary
ExtractionSplitEvaluator()
          No args constructor.
 
Method Summary
 java.lang.String extractorTipText()
          Returns the tip text for this property
 Extractor getExtractor()
          Get the value of Extractor.
 java.lang.Object[] getKey()
          Gets the key describing the current SplitEvaluator.
 java.lang.String[] getKeyNames()
          Gets the names of each of the key columns produced for a single run.
 java.lang.Object[] getKeyTypes()
          Gets the data types of each of the key columns produced for a single run.
 java.lang.String[] getOptions()
          Gets the current settings of the Extractor.
 java.lang.String getRawResultOutput()
          Gets the raw output from the extractor
 java.lang.Object[] getResult(Instances trainData, Instances testData)
          Gets the results for the supplied train and test datasets.
 java.lang.String[] getResultNames()
          Gets the names of each of the result columns produced for a single run.
 java.lang.Object[] getResultTypes()
          Gets the data types of each of the result columns produced for a single run.
 java.lang.String globalInfo()
          Returns a string describing this split evaluator
 java.util.Enumeration listOptions()
          Returns an enumeration describing the available options..
 void setAdditionalMeasures(java.lang.String[] additionalMeasures)
          Does nothing, since extraction evaluation does not allow additional measures
 void setExtractor(Extractor newExtractor)
          Sets the extractor.
 void setExtractorName(java.lang.String newExtractorName)
          Set the Extractor to use, given it's class name.
 void setOptions(java.lang.String[] options)
          Parses a given list of options.
 java.lang.String toString()
          Returns a text description of the split evaluator.
protected  void updateOptions()
          Updates the options that the current extractor is using.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

m_extractor

protected Extractor m_extractor
The extractor used for evaluation


m_result

protected java.lang.String m_result
Holds the statistics for the most recent application of the extractor


m_extractorOptions

protected java.lang.String m_extractorOptions
The extractor options (if any)


m_extractorVersion

protected java.lang.String m_extractorVersion
The extractor version

Constructor Detail

ExtractionSplitEvaluator

public ExtractionSplitEvaluator()
No args constructor.

Method Detail

globalInfo

public java.lang.String globalInfo()
Returns a string describing this split evaluator

Returns:
a description of the split evaluator suitable for displaying in the explorer/experimenter gui

setAdditionalMeasures

public void setAdditionalMeasures(java.lang.String[] additionalMeasures)
Does nothing, since extraction evaluation does not allow additional measures

Specified by:
setAdditionalMeasures in interface SplitEvaluator
Parameters:
additionalMeasures - a list of method names

listOptions

public java.util.Enumeration listOptions()
Returns an enumeration describing the available options..

Specified by:
listOptions in interface OptionHandler
Returns:
an enumeration of all the available options.

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception
Parses a given list of options. Valid options are:

-W classname
Specify the full class name of the extractor to evaluate.

All option after -- will be passed to the extractor.

Specified by:
setOptions in interface OptionHandler
Parameters:
options - the list of options as an array of strings
Throws:
java.lang.Exception - if an option is not supported

getOptions

public java.lang.String[] getOptions()
Gets the current settings of the Extractor.

Specified by:
getOptions in interface OptionHandler
Returns:
an array of strings suitable for passing to setOptions

getKeyTypes

public java.lang.Object[] getKeyTypes()
Gets the data types of each of the key columns produced for a single run. The number of key fields must be constant for a given SplitEvaluator.

Specified by:
getKeyTypes in interface SplitEvaluator
Returns:
an array containing objects of the type of each key column. The objects should be Strings, or Doubles.

getKeyNames

public java.lang.String[] getKeyNames()
Gets the names of each of the key columns produced for a single run. The number of key fields must be constant for a given SplitEvaluator.

Specified by:
getKeyNames in interface SplitEvaluator
Returns:
an array containing the name of each key column

getKey

public java.lang.Object[] getKey()
Gets the key describing the current SplitEvaluator. For example This may contain the name of the extractor used for extractor predictive evaluation. The number of key fields must be constant for a given SplitEvaluator.

Specified by:
getKey in interface SplitEvaluator
Returns:
an array of objects containing the key.

getResultTypes

public java.lang.Object[] getResultTypes()
Gets the data types of each of the result columns produced for a single run. The number of result fields must be constant for a given SplitEvaluator.

Specified by:
getResultTypes in interface SplitEvaluator
Returns:
an array containing objects of the type of each result column. The objects should be Strings, or Doubles.

getResultNames

public java.lang.String[] getResultNames()
Gets the names of each of the result columns produced for a single run. The number of result fields must be constant for a given SplitEvaluator.

Specified by:
getResultNames in interface SplitEvaluator
Returns:
an array containing the name of each result column

getResult

public java.lang.Object[] getResult(Instances trainData,
                                    Instances testData)
                             throws java.lang.Exception
Gets the results for the supplied train and test datasets.

Specified by:
getResult in interface SplitEvaluator
Parameters:
trainData - the training Instances.
testData - the testing Instances.
Returns:
the raw results stored in an array. The objects stored in the array are object arrays, containing actual P/R/FM values for each point
Throws:
java.lang.Exception - if a problem occurs while getting the results

extractorTipText

public java.lang.String extractorTipText()
Returns the tip text for this property

Returns:
tip text for this property suitable for displaying in the explorer/experimenter gui

getExtractor

public Extractor getExtractor()
Get the value of Extractor.

Returns:
Value of Extractor.

setExtractor

public void setExtractor(Extractor newExtractor)
Sets the extractor.

Parameters:
newExtractor - the new extractor to use.

updateOptions

protected void updateOptions()
Updates the options that the current extractor is using.


setExtractorName

public void setExtractorName(java.lang.String newExtractorName)
                      throws java.lang.Exception
Set the Extractor to use, given it's class name. A new extractor will be instantiated.

Throws:
java.lang.Exception - if the class name is invalid.

getRawResultOutput

public java.lang.String getRawResultOutput()
Gets the raw output from the extractor

Specified by:
getRawResultOutput in interface SplitEvaluator
Returns:
the raw output from the extractor

toString

public java.lang.String toString()
Returns a text description of the split evaluator.

Returns:
a text description of the split evaluator.