adams.flow.transformer
Class WekaEvaluationSummary

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.transformer.AbstractTransformer
                  adams.flow.transformer.WekaEvaluationSummary

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable

public class WekaEvaluationSummary
extends AbstractTransformer

Generates a summary string of the weka.classifiers.Evaluation objects that it receives.

Input/output:
- accepts:
weka.classifiers.Evaluation
- generates:
java.lang.String

Valid options are:

-D (property: debug)
    If set to true, scheme may output additional info to the console.
 

-name <java.lang.String> (property: name)
    The name of the actor.
    default: EvaluationSummary
 

-annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default:
 

-skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
 

-relation (property: outputRelationName)
    If set to true, then the relation name of the dataset is output as well.
 

-complexity-stats (property: complexityStatistics)
    If set to true, then the complexity statistics will be output as well.
 

-class-details (property: classDetails)
    If set to true, then the class details are output as well.
 

-comment <adams.core.base.BaseText> (property: comment)
    An optional comment to output in the summary.
    default:
 

Version:

$Revision: 5714 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected boolean	m_ClassDetails whether to print the class details as well.
protected BaseText	m_Comment an optional comment to output.
protected boolean	m_ComplexityStatistics whether to print the complexity statistics as well.
protected boolean	m_OutputRelationName whether to print the relation name of the dataset a well.

Fields inherited from class adams.flow.transformer.AbstractTransformer

BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

Fields inherited from class adams.flow.core.AbstractActor

FILE_EXTENSION, FILE_EXTENSION_GZ, m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

WekaEvaluationSummary()

Method Summary

Class[]	accepts() Returns the class that the consumer accepts.
String	classDetailsTipText() Returns the tip text for this property.
String	commentTipText() Returns the tip text for this property.
String	complexityStatisticsTipText() Returns the tip text for this property.
void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
Class[]	generates() Returns the class of objects that it generates.
boolean	getClassDetails() Returns whether the class details are output as well.
BaseText	getComment() Returns the comment to output in the summary.
boolean	getComplexityStatistics() Returns whether the complexity stats are output as well.
boolean	getOutputRelationName() Returns whether the relation name is output as well.
String	globalInfo() Returns a string describing the object.
String	outputRelationNameTipText() Returns the tip text for this property.
void	setClassDetails(boolean value) Sets whether the class details are output as well.
void	setComment(BaseText value) Sets the comment to output in the summary.
void	setComplexityStatistics(boolean value) Sets whether to output complexity stats as well.
void	setOutputRelationName(boolean value) Sets whether to output the relation name as well.

Methods inherited from class adams.flow.transformer.AbstractTransformer

backupState, execute, hasPendingOutput, input, output, postExecute, reset, restoreState, wrapUp

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, debug, destroy, equals, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getQuickInfo, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

Methods inherited from class java.lang.Object

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

Field Detail

m_OutputRelationName

protected boolean m_OutputRelationName

whether to print the relation name of the dataset a well.

m_ComplexityStatistics

protected boolean m_ComplexityStatistics

whether to print the complexity statistics as well.

m_ClassDetails

protected boolean m_ClassDetails

whether to print the class details as well.

m_Comment

protected BaseText m_Comment

an optional comment to output.

Constructor Detail

WekaEvaluationSummary

public WekaEvaluationSummary()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractActor

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Returns:

weka.classifiers.Evaluation.class

generates

public Class[] generates()

Returns the class of objects that it generates.

Returns:

java.lang.String.class

setOutputRelationName

public void setOutputRelationName(boolean value)

Sets whether to output the relation name as well.

Parameters:

value - if true then the relation name is output as well

getOutputRelationName

public boolean getOutputRelationName()

Returns whether the relation name is output as well.

Returns:

true if the relation name is output as well

outputRelationNameTipText

public String outputRelationNameTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setComplexityStatistics

public void setComplexityStatistics(boolean value)

Sets whether to output complexity stats as well.

Parameters:

value - if true then the complexity stats will be output as well

getComplexityStatistics

public boolean getComplexityStatistics()

Returns whether the complexity stats are output as well.

Returns:

true if the complexity stats are output as well

complexityStatisticsTipText

public String complexityStatisticsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setClassDetails

public void setClassDetails(boolean value)

Sets whether the class details are output as well.

Parameters:

value - if true then the class details are output as well

getClassDetails

public boolean getClassDetails()

Returns whether the class details are output as well.

Returns:

true if the class details are output as well

classDetailsTipText

public String classDetailsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setComment

public void setComment(BaseText value)

Sets the comment to output in the summary.

Parameters:

value - the comment

getComment

public BaseText getComment()

Returns the comment to output in the summary.

Returns:

the comment

commentTipText

public String commentTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message