adams.flow.transformer
Class WekaClassSelector

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

All Implemented Interfaces:

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

public class WekaClassSelector
extends AbstractWekaInstanceAndWekaInstancesTransformer
implements ProvenanceSupporter

Sets the class index. Can either honour an already existing one or override it. Also, one can apply the index on a subset of attributes defined by a regular expression applied to the attribute names (one can set the class index to the last attribute that starts with 'att_').

Input/output:
- accepts:
weka.core.Instance
weka.core.Instances
adams.data.instance.Instance
- generates:
weka.core.Instance
weka.core.Instances
adams.data.instance.Instance

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: ClassSelector
 

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

-class <java.lang.String> (property: classIndex)
    The index within the attribute subset defined by the regular expression
    ('first' and 'last' are accepted as well).
    default: last
 

-override (property: override)
    If set to true, then any existing class index will be overriden; otherwise
    the class index will only be set if not already set.
 

-regex <java.lang.String> (property: regexName)
    The regular expression used for selecting the subset of attributes.
    default: .*
 

Version:

$Revision: 5563 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected Index	m_ClassIndex the class index.
protected boolean	m_Override whether to override any set class attribute.
protected BaseRegExp	m_RegexName the regular expression on the attribute for selecting the sub-set of attributes.

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

WekaClassSelector()

Method Summary

String	classIndexTipText() Returns the tip text for this property.
void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
Index	getClassIndex() Returns the class index.
boolean	getOverride() Returns whether any existing class index will be overriden or not.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
BaseRegExp	getRegexName() Returns the regular expression for selecting the attributes.
String	globalInfo() Returns a string describing the object.
protected void	initialize() Initializes the members.
String	overrideTipText() Returns the tip text for this property.
String	regexNameTipText() Returns the tip text for this property.
void	setClassIndex(Index value) Sets the class index.
void	setOverride(boolean value) Sets whether to override any existing class index or nor.
void	setRegexName(BaseRegExp value) Sets the regular expression for selecting the attributes.
void	updateProvenance(ProvenanceContainer cont) Updates the provenance information in the provided container.

Methods inherited from class adams.flow.transformer.AbstractWekaInstanceAndWekaInstancesTransformer

accepts, generates

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, 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_ClassIndex

protected Index m_ClassIndex

the class index.

m_Override

protected boolean m_Override

whether to override any set class attribute.

m_RegexName

protected BaseRegExp m_RegexName

the regular expression on the attribute for selecting the sub-set of attributes.

Constructor Detail

WekaClassSelector

public WekaClassSelector()

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

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractActor

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions 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

setClassIndex

public void setClassIndex(Index value)

Sets the class index.

Parameters:

value - the index

getClassIndex

public Index getClassIndex()

Returns the class index.

Returns:

the index

classIndexTipText

public String classIndexTipText()

Returns the tip text for this property.

Returns:

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

setOverride

public void setOverride(boolean value)

Sets whether to override any existing class index or nor.

Parameters:

value - if true then any class index will be override

getOverride

public boolean getOverride()

Returns whether any existing class index will be overriden or not.

Returns:

true if any class index will be overriden

overrideTipText

public String overrideTipText()

Returns the tip text for this property.

Returns:

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

setRegexName

public void setRegexName(BaseRegExp value)

Sets the regular expression for selecting the attributes.

Parameters:

value - the regex

getRegexName

public BaseRegExp getRegexName()

Returns the regular expression for selecting the attributes.

Returns:

the regex

regexNameTipText

public String regexNameTipText()

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

updateProvenance

public void updateProvenance(ProvenanceContainer cont)

Updates the provenance information in the provided container.

Specified by:

updateProvenance in interface ProvenanceSupporter

Parameters:

cont - the provenance container to update