All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home

Class weka.experiment.DatabaseResultProducer

java.lang.Object
    |
    +----weka.experiment.DatabaseUtils
            |
            +----weka.experiment.DatabaseResultListener
                    |
                    +----weka.experiment.DatabaseResultProducer

public class DatabaseResultProducer
extends DatabaseResultListener
implements ResultProducer, OptionHandler, AdditionalMeasureProducer
DatabaseResultProducer examines a database and extracts out the results produced by the specified ResultProducer and submits them to the specified ResultListener. If a result needs to be generated, the ResultProducer is used to obtain the result.

Version:
$Revision: 1.13 $
Author:
Len Trigg (trigg@cs.waikato.ac.nz)

Constructor Index

 o DatabaseResultProducer()
Creates the DatabaseResultProducer, letting the parent constructor do it's thing.

Method Index

 o acceptResult(ResultProducer, Object[], Object[])
Accepts results from a ResultProducer.
 o doRun(int)
Gets the results for a specified run number.
 o doRunKeys(int)
Gets the keys for a specified run number.
 o enumerateMeasures()
Returns an enumeration of any additional measure names that might be in the result producer
 o getCompatibilityState()
Gets a description of the internal settings of the result producer, sufficient for distinguishing a ResultProducer instance from another with different settings (ignoring those settings set through this interface).
 o getKeyNames()
Gets the names of each of the columns produced for a single run.
 o getKeyTypes()
Gets the data types of each of the columns produced for a single run.
 o getMeasure(String)
Returns the value of the named measure
 o getOptions()
Gets the current settings of the result producer.
 o getResultNames()
Gets the names of each of the columns produced for a single run.
 o getResultProducer()
Get the ResultProducer.
 o getResultTypes()
Gets the data types of each of the columns produced for a single run.
 o globalInfo()
Returns a string describing this result producer
 o isResultRequired(ResultProducer, Object[])
Determines whether the results for a specified key must be generated.
 o listOptions()
Returns an enumeration describing the available options.
 o postProcess()
When this method is called, it indicates that no more requests to generate results for the current experiment will be sent.
 o postProcess(ResultProducer)
When this method is called, it indicates that no more results will be sent that need to be grouped together in any way.
 o preProcess()
Prepare to generate results.
 o preProcess(ResultProducer)
Prepare for the results to be received.
 o resultProducerTipText()
Returns the tip text for this property
 o setAdditionalMeasures(String[])
Set a list of method names for additional measures to look for in SplitEvaluators.
 o setInstances(Instances)
Sets the dataset that results will be obtained for.
 o setOptions(String[])
Parses a given list of options.
 o setResultListener(ResultListener)
Sets the object to send results of each run to.
 o setResultProducer(ResultProducer)
Set the ResultProducer.
 o toString()
Gets a text descrption of the result producer.

Constructor Detail

 o DatabaseResultProducer
public DatabaseResultProducer() throws java.lang.Exception
          Creates the DatabaseResultProducer, letting the parent constructor do it's thing.
Throws:
java.lang.Exception - if an error occurs

Method Detail

 o globalInfo
public java.lang.String globalInfo()
          Returns a string describing this result producer
Returns:
a description of the result producer suitable for displaying in the explorer/experimenter gui
Overrides:
globalInfo in class DatabaseResultListener
 o doRunKeys
public void doRunKeys(int run) throws java.lang.Exception
          Gets the keys for a specified run number. Different run numbers correspond to different randomizations of the data. Keys produced should be sent to the current ResultListener
Parameters:
run - the run number to get keys for.
Throws:
java.lang.Exception - if a problem occurs while getting the keys
 o doRun
public void doRun(int run) throws java.lang.Exception
          Gets the results for a specified run number. Different run numbers correspond to different randomizations of the data. Results produced should be sent to the current ResultListener
Parameters:
run - the run number to get results for.
Throws:
java.lang.Exception - if a problem occurs while getting the results
 o preProcess
public void preProcess(ResultProducer rp) throws java.lang.Exception
          Prepare for the results to be received.
Parameters:
rp - the ResultProducer that will generate the results
Throws:
java.lang.Exception - if an error occurs during preprocessing.
Overrides:
preProcess in class DatabaseResultListener
 o postProcess
public void postProcess(ResultProducer rp) throws java.lang.Exception
          When this method is called, it indicates that no more results will be sent that need to be grouped together in any way.
Parameters:
rp - the ResultProducer that generated the results
Throws:
java.lang.Exception - if an error occurs
Overrides:
postProcess in class DatabaseResultListener
 o preProcess
public void preProcess() throws java.lang.Exception
          Prepare to generate results. The ResultProducer should call preProcess(this) on the ResultListener it is to send results to.
Throws:
java.lang.Exception - if an error occurs during preprocessing.
 o postProcess
public void postProcess() throws java.lang.Exception
          When this method is called, it indicates that no more requests to generate results for the current experiment will be sent. The ResultProducer should call preProcess(this) on the ResultListener it is to send results to.
Throws:
java.lang.Exception - if an error occurs
 o acceptResult
public void acceptResult(ResultProducer rp,
                         java.lang.Object key[],
                         java.lang.Object result[]) throws java.lang.Exception
          Accepts results from a ResultProducer.
Parameters:
rp - the ResultProducer that generated the results
key - an array of Objects (Strings or Doubles) that uniquely identify a result for a given ResultProducer with given compatibilityState
result - the results stored in an array. The objects stored in the array may be Strings, Doubles, or null (for the missing value).
Throws:
java.lang.Exception - if the result could not be accepted.
Overrides:
acceptResult in class DatabaseResultListener
 o isResultRequired
public boolean isResultRequired(ResultProducer rp,
                                java.lang.Object key[]) throws java.lang.Exception
          Determines whether the results for a specified key must be generated.
Parameters:
rp - the ResultProducer wanting to generate the results
key - an array of Objects (Strings or Doubles) that uniquely identify a result for a given ResultProducer with given compatibilityState
Returns:
true if the result should be generated
Throws:
java.lang.Exception - if it could not be determined if the result is needed.
Overrides:
isResultRequired in class DatabaseResultListener
 o getKeyNames
public java.lang.String[] getKeyNames() throws java.lang.Exception
          Gets the names of each of the columns produced for a single run.
Returns:
an array containing the name of each column
Throws:
java.lang.Exception - if something goes wrong.
 o getKeyTypes
public java.lang.Object[] getKeyTypes() throws java.lang.Exception
          Gets the data types of each of the columns produced for a single run. This method should really be static.
Returns:
an array containing objects of the type of each column. The objects should be Strings, or Doubles.
Throws:
java.lang.Exception - if something goes wrong.
 o getResultNames
public java.lang.String[] getResultNames() throws java.lang.Exception
          Gets the names of each of the columns produced for a single run. A new result field is added for the number of results used to produce each average. If only averages are being produced the names are not altered, if standard deviations are produced then "Dev_" and "Avg_" are prepended to each result deviation and average field respectively.
Returns:
an array containing the name of each column
Throws:
java.lang.Exception - if something goes wrong.
 o getResultTypes
public java.lang.Object[] getResultTypes() throws java.lang.Exception
          Gets the data types of each of the columns produced for a single run.
Returns:
an array containing objects of the type of each column. The objects should be Strings, or Doubles.
Throws:
java.lang.Exception - if something goes wrong.
 o getCompatibilityState
public java.lang.String getCompatibilityState()
          Gets a description of the internal settings of the result producer, sufficient for distinguishing a ResultProducer instance from another with different settings (ignoring those settings set through this interface). For example, a cross-validation ResultProducer may have a setting for the number of folds. For a given state, the results produced should be compatible. Typically if a ResultProducer is an OptionHandler, this string will represent the command line arguments required to set the ResultProducer to that state.
Returns:
the description of the ResultProducer state, or null if no state is defined
 o listOptions
public java.util.Enumeration listOptions()
          Returns an enumeration describing the available options.
Returns:
an enumeration of all the available options
 o 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 result producer.

All option after -- will be passed to the result producer.

Parameters:
options - the list of options as an array of strings
Throws:
java.lang.Exception - if an option is not supported
 o getOptions
public java.lang.String[] getOptions()
          Gets the current settings of the result producer.
Returns:
an array of strings suitable for passing to setOptions
 o setAdditionalMeasures
public void setAdditionalMeasures(java.lang.String additionalMeasures[])
          Set a list of method names for additional measures to look for in SplitEvaluators. This could contain many measures (of which only a subset may be produceable by the current resultProducer) if an experiment is the type that iterates over a set of properties.
Parameters:
additionalMeasures - an array of measure names, null if none
 o enumerateMeasures
public java.util.Enumeration enumerateMeasures()
          Returns an enumeration of any additional measure names that might be in the result producer
Returns:
an enumeration of the measure names
 o getMeasure
public double getMeasure(java.lang.String additionalMeasureName)
          Returns the value of the named measure
Parameters:
measureName - the name of the measure to query for its value
Returns:
the value of the named measure
Throws:
java.lang.IllegalArgumentException - if the named measure is not supported
 o setInstances
public void setInstances(Instances instances)
          Sets the dataset that results will be obtained for.
Parameters:
instances - a value of type 'Instances'.
 o setResultListener
public void setResultListener(ResultListener listener)
          Sets the object to send results of each run to.
Parameters:
listener - a value of type 'ResultListener'
 o resultProducerTipText
public java.lang.String resultProducerTipText()
          Returns the tip text for this property
Returns:
tip text for this property suitable for displaying in the explorer/experimenter gui
 o getResultProducer
public ResultProducer getResultProducer()
          Get the ResultProducer.
Returns:
the ResultProducer.
 o setResultProducer
public void setResultProducer(ResultProducer newResultProducer)
          Set the ResultProducer.
Parameters:
newResultProducer - new ResultProducer to use.
 o toString
public java.lang.String toString()
          Gets a text descrption of the result producer.
Returns:
a text description of the result producer.
Overrides:
toString in class java.lang.Object

All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home