weka.experiment
Class DatabaseResultProducer

java.lang.Object
  extended byweka.experiment.DatabaseUtils
      extended byweka.experiment.DatabaseResultListener
          extended byweka.experiment.DatabaseResultProducer
All Implemented Interfaces:
AdditionalMeasureProducer, OptionHandler, ResultListener, ResultProducer, java.io.Serializable

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.14 $
Author:
Len Trigg (trigg@cs.waikato.ac.nz)
See Also:
Serialized Form

Field Summary
protected  java.lang.String[] m_AdditionalMeasures
          The names of any additional measures to look for in SplitEvaluators
protected  Instances m_Instances
          The dataset of interest
protected  ResultListener m_ResultListener
          The ResultListener to send results to
protected  ResultProducer m_ResultProducer
          The ResultProducer used to generate results
 
Fields inherited from class weka.experiment.DatabaseResultListener
m_Cache, m_CacheKey, m_CacheKeyIndex, m_CacheKeyName, m_Debug, m_ResultsTableName
 
Fields inherited from class weka.experiment.DatabaseUtils
BOOL, BYTE, DATE, DOUBLE, DRIVERS, EXP_INDEX_TABLE, EXP_RESULT_COL, EXP_RESULT_PREFIX, EXP_SETUP_COL, EXP_TYPE_COL, FLOAT, INTEGER, LONG, m_checkForUpperCaseNames, m_Connection, m_createIndex, m_DatabaseURL, m_doubleType, m_intType, m_password, m_PreparedStatement, m_setAutoCommit, m_stringType, m_userName, PROPERTIES, PROPERTY_FILE, SHORT, STRING
 
Constructor Summary
DatabaseResultProducer()
          Creates the DatabaseResultProducer, letting the parent constructor do it's thing.
 
Method Summary
 void acceptResult(ResultProducer rp, java.lang.Object[] key, java.lang.Object[] result)
          Accepts results from a ResultProducer.
 void doRun(int run)
          Gets the results for a specified run number.
 void doRunKeys(int run)
          Gets the keys for a specified run number.
 java.util.Enumeration enumerateMeasures()
          Returns an enumeration of any additional measure names that might be in the result producer
 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).
 java.lang.String[] getKeyNames()
          Gets the names of each of the columns produced for a single run.
 java.lang.Object[] getKeyTypes()
          Gets the data types of each of the columns produced for a single run.
 double getMeasure(java.lang.String additionalMeasureName)
          Returns the value of the named measure
 java.lang.String[] getOptions()
          Gets the current settings of the result producer.
 java.lang.String[] getResultNames()
          Gets the names of each of the columns produced for a single run.
 ResultProducer getResultProducer()
          Get the ResultProducer.
 java.lang.Object[] getResultTypes()
          Gets the data types of each of the columns produced for a single run.
 java.lang.String globalInfo()
          Returns a string describing this result producer
 boolean isResultRequired(ResultProducer rp, java.lang.Object[] key)
          Determines whether the results for a specified key must be generated.
 java.util.Enumeration listOptions()
          Returns an enumeration describing the available options..
 void postProcess()
          When this method is called, it indicates that no more requests to generate results for the current experiment will be sent.
 void postProcess(ResultProducer rp)
          When this method is called, it indicates that no more results will be sent that need to be grouped together in any way.
 void preProcess()
          Prepare to generate results.
 void preProcess(ResultProducer rp)
          Prepare for the results to be received.
 java.lang.String resultProducerTipText()
          Returns the tip text for this property
 void setAdditionalMeasures(java.lang.String[] additionalMeasures)
          Set a list of method names for additional measures to look for in SplitEvaluators.
 void setInstances(Instances instances)
          Sets the dataset that results will be obtained for.
 void setOptions(java.lang.String[] options)
          Parses a given list of options.
 void setResultListener(ResultListener listener)
          Sets the object to send results of each run to.
 void setResultProducer(ResultProducer newResultProducer)
          Set the ResultProducer.
 java.lang.String toString()
          Gets a text descrption of the result producer.
 
Methods inherited from class weka.experiment.DatabaseResultListener
cacheKeyNameTipText, determineColumnConstraints, getCacheKeyName, isCacheValid, isKeyInCache, loadCache, setCacheKeyName, updateResultsTableName
 
Methods inherited from class weka.experiment.DatabaseUtils
arrayToString, attributeCaseFix, connectToDatabase, createExperimentIndex, createExperimentIndexEntry, createResultsTable, databaseURLTipText, disconnectFromDatabase, execute, experimentIndexExists, getDatabaseURL, getPassword, getResultFromTable, getResultSet, getResultsTableName, getUsername, isConnected, isKeyInTable, putResultInTable, setDatabaseURL, setPassword, setUsername, tableExists, translateDBColumnType, typeName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

m_Instances

protected Instances m_Instances
The dataset of interest


m_ResultListener

protected ResultListener m_ResultListener
The ResultListener to send results to


m_ResultProducer

protected ResultProducer m_ResultProducer
The ResultProducer used to generate results


m_AdditionalMeasures

protected java.lang.String[] m_AdditionalMeasures
The names of any additional measures to look for in SplitEvaluators

Constructor Detail

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

globalInfo

public java.lang.String globalInfo()
Returns a string describing this result producer

Overrides:
globalInfo in class DatabaseResultListener
Returns:
a description of the result producer suitable for displaying in the explorer/experimenter gui

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

Specified by:
doRunKeys in interface ResultProducer
Parameters:
run - the run number to get keys for.
Throws:
java.lang.Exception - if a problem occurs while getting the keys

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

Specified by:
doRun in interface ResultProducer
Parameters:
run - the run number to get results for.
Throws:
java.lang.Exception - if a problem occurs while getting the results

preProcess

public void preProcess(ResultProducer rp)
                throws java.lang.Exception
Prepare for the results to be received.

Specified by:
preProcess in interface ResultListener
Overrides:
preProcess in class DatabaseResultListener
Parameters:
rp - the ResultProducer that will generate the results
Throws:
java.lang.Exception - if an error occurs during preprocessing.

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.

Specified by:
postProcess in interface ResultListener
Overrides:
postProcess in class DatabaseResultListener
Parameters:
rp - the ResultProducer that generated the results
Throws:
java.lang.Exception - if an error occurs

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.

Specified by:
preProcess in interface ResultProducer
Throws:
java.lang.Exception - if an error occurs during preprocessing.

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.

Specified by:
postProcess in interface ResultProducer
Throws:
java.lang.Exception - if an error occurs

acceptResult

public void acceptResult(ResultProducer rp,
                         java.lang.Object[] key,
                         java.lang.Object[] result)
                  throws java.lang.Exception
Accepts results from a ResultProducer.

Specified by:
acceptResult in interface ResultListener
Overrides:
acceptResult in class DatabaseResultListener
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.

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.

Specified by:
isResultRequired in interface ResultListener
Overrides:
isResultRequired in class DatabaseResultListener
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.

getKeyNames

public java.lang.String[] getKeyNames()
                               throws java.lang.Exception
Gets the names of each of the columns produced for a single run.

Specified by:
getKeyNames in interface ResultProducer
Returns:
an array containing the name of each column
Throws:
java.lang.Exception - if something goes wrong.

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.

Specified by:
getKeyTypes in interface ResultProducer
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.

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.

Specified by:
getResultNames in interface ResultProducer
Returns:
an array containing the name of each column
Throws:
java.lang.Exception - if something goes wrong.

getResultTypes

public java.lang.Object[] getResultTypes()
                                  throws java.lang.Exception
Gets the data types of each of the columns produced for a single run.

Specified by:
getResultTypes in interface ResultProducer
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.

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.

Specified by:
getCompatibilityState in interface ResultProducer
Returns:
the description of the ResultProducer state, or null if no state is defined

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 result producer.

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

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 result producer.

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

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.

Specified by:
setAdditionalMeasures in interface ResultProducer
Parameters:
additionalMeasures - an array of measure names, null if none

enumerateMeasures

public java.util.Enumeration enumerateMeasures()
Returns an enumeration of any additional measure names that might be in the result producer

Specified by:
enumerateMeasures in interface AdditionalMeasureProducer
Returns:
an enumeration of the measure names

getMeasure

public double getMeasure(java.lang.String additionalMeasureName)
Returns the value of the named measure

Specified by:
getMeasure in interface AdditionalMeasureProducer
Parameters:
additionalMeasureName - 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

setInstances

public void setInstances(Instances instances)
Sets the dataset that results will be obtained for.

Specified by:
setInstances in interface ResultProducer
Parameters:
instances - a value of type 'Instances'.

setResultListener

public void setResultListener(ResultListener listener)
Sets the object to send results of each run to.

Specified by:
setResultListener in interface ResultProducer
Parameters:
listener - a value of type 'ResultListener'

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

getResultProducer

public ResultProducer getResultProducer()
Get the ResultProducer.

Returns:
the ResultProducer.

setResultProducer

public void setResultProducer(ResultProducer newResultProducer)
Set the ResultProducer.

Parameters:
newResultProducer - new ResultProducer to use.

toString

public java.lang.String toString()
Gets a text descrption of the result producer.

Returns:
a text description of the result producer.