adams.flow.transformer
Class WekaInstancesInfo

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

All Implemented Interfaces:

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

public class WekaInstancesInfo
extends AbstractTransformer

Outputs statistics of a weka.core.Instances object.

Input/output:
- accepts:
weka.core.Instances
- generates:
java.lang.String

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

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

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

-stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 

-type <FULL|HEADER|RELATION_NAME|NUM_ATTRIBUTES|NUM_INSTANCES|NUM_CLASS_LABELS|ATTRIBUTE_NAME|LABELS|CLASS_LABELS|NUM_LABELS|NUM_MISSING_VALUES|NUM_DISTINCT_VALUES|NUM_UNIQUE_VALUES|MIN|MAX|MEAN|STDEV|ATTRIBUTE_TYPE|CLASS_TYPE> (property: type)
    The type of information to generate; NB some of the types are only available 
    for numeric or nominal attributes.
    default: FULL
 

-attribute-index <java.lang.String> (property: attributeIndex)
    The attribute index to use for generating attribute-specific information.
     An index is a number starting with 1; the following placeholders can be 
    used as well: first, second, third, last_2, last_1, last
    default: last
 

Version:

$Revision: 5563 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

static class

WekaInstancesInfo.InfoType The type of information to generate.

Field Summary

protected Index	m_AttributeIndex the index of the attribute to get the information for.
protected Vector	m_Queue the tokens to output.
protected WekaInstancesInfo.InfoType	m_Type the type of information to generate.

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

WekaInstancesInfo()

Method Summary

Class[]	accepts() Returns the class that the consumer accepts.
String	attributeIndexTipText() 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.
Index	getAttributeIndex() Returns the attribute index to use for attribute specific information.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
WekaInstancesInfo.InfoType	getType() Returns the type of information to generate.
String	globalInfo() Returns a string describing the object.
boolean	hasPendingOutput() Checks whether there is pending output to be collected after executing the flow item.
protected void	initialize() Initializes the members.
Token	output() Returns the generated token.
void	setAttributeIndex(Index value) Sets the attribute index to use for attribute-specific information.
void	setType(WekaInstancesInfo.InfoType value) Sets the type of information to generate.
String	typeTipText() Returns the tip text for this property.
void	wrapUp() Cleans up after the execution has finished.

Methods inherited from class adams.flow.transformer.AbstractTransformer

backupState, execute, input, postExecute, reset, restoreState

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, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, 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_Queue

protected Vector m_Queue

the tokens to output.

m_Type

protected WekaInstancesInfo.InfoType m_Type

the type of information to generate.

m_AttributeIndex

protected Index m_AttributeIndex

the index of the attribute to get the information for.

Constructor Detail

WekaInstancesInfo

public WekaInstancesInfo()

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

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractActor

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

setType

public void setType(WekaInstancesInfo.InfoType value)

Sets the type of information to generate.

Parameters:

value - the type

getType

public WekaInstancesInfo.InfoType getType()

Returns the type of information to generate.

Returns:

the type

typeTipText

public String typeTipText()

Returns the tip text for this property.

Returns:

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

setAttributeIndex

public void setAttributeIndex(Index value)

Sets the attribute index to use for attribute-specific information.

Parameters:

value - the 1-based index

getAttributeIndex

public Index getAttributeIndex()

Returns the attribute index to use for attribute specific information.

Returns:

the 1-based index

attributeIndexTipText

public String attributeIndexTipText()

Returns the tip text for this property.

Returns:

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

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Returns:

weka.core.Instances.class

generates

public Class[] generates()

Returns the class of objects that it generates.

Returns:

java.lang.String.class

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message

output

public Token output()

Returns the generated token.

Specified by:

output in interface OutputProducer

Overrides:

output in class AbstractTransformer

Returns:

the generated token

hasPendingOutput

public boolean hasPendingOutput()

Checks whether there is pending output to be collected after executing the flow item.

Specified by:

hasPendingOutput in interface OutputProducer

Overrides:

hasPendingOutput in class AbstractTransformer

Returns:

true if there is pending output

wrapUp

public void wrapUp()

Cleans up after the execution has finished.

Overrides:

wrapUp in class AbstractTransformer