adams.flow.source
Class WekaNewInstances

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.source.AbstractSource
                  adams.flow.source.WekaNewInstances

All Implemented Interfaces:

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

public class WekaNewInstances
extends AbstractSource
implements ProvenanceSupporter

Generates an empty dataset, based on the attribute types and names specified.
Nominal attributes are generated with an empty set of labels. Use the weka.filters.unsupervised.attribute.AddValues filter to add the required labels.
Date attributes are created with the default format of 'yyyy-MM-dd'T'HH:mm:ss'. Use the weka.filters.unsupervised.attribute.ChangeDateFormat filter to change the format to a more suitable format, if required.

Input/output:
- generates:
weka.core.Instances

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

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

-relation-name <java.lang.String> (property: relationName)
    The name of the relation; if left empty, the full name of the actor is used.
    default:
 

-att-type <adams.core.base.AttributeTypeList> (property: attributeTypes)
    A comma-separated list of attribute types (NUM|NOM|STR|DAT).
    default:
 

-att-name <adams.core.base.BaseList> (property: attributeNames)
    The comma-separated list of attribute names; if left empty or not enough
    items available, the prefix 'att-' is used in conjunction with the 1-based
    index of the attribute; for the class attribute (if applicable), the name
    'class' is used, unless otherwise specified.
    default:
 

-class-index <java.lang.String> (property: classIndex)
    The class index to set, leave empty to have none set; 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:
 

-class-name <java.lang.String> (property: className)
    The name of the class attribute; default is 'class'.
    default:
 

Version:

$Revision: 4584 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

static String	ATTRIBUTE_PREFIX the prefix for attributes (if nto specified explicitly).
static String	DEFAULT_CLASS the class attribute name (if not specified explicitly).
static String	DEFAULT_DATE_FORMAT the default date format.
protected BaseList	m_AttributeNames the comma-separated list of attribute names.
protected AttributeTypeList	m_AttributeTypes the comma-separated list of attribute types.
protected Index	m_ClassIndex the index for the class attribute, if any.
protected String	m_ClassName the name for the class attribute, if any.
protected Token	m_OutputToken the token to broadcast.
protected String	m_RelationName the name for the relation, if any.

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

WekaNewInstances()

Method Summary

String	attributeNamesTipText() Returns the tip text for this property.
String	attributeTypesTipText() Returns the tip text for this property.
String	classIndexTipText() Returns the tip text for this property.
String	classNameTipText() 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.
BaseList	getAttributeNames() Returns the list of attribute names.
AttributeTypeList	getAttributeTypes() Returns the list of attribute types.
String	getClassIndex() Returns the index of the class attribute.
String	getClassName() Returns the name of the class attribute.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
String	getRelationName() Returns the name of the relation.
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.
String	relationNameTipText() Returns the tip text for this property.
void	setAttributeNames(BaseList value) Sets the list of attribute names.
void	setAttributeTypes(AttributeTypeList value) Sets the list of attribute types.
void	setClassIndex(String value) Sets the index of the class attribute.
void	setClassName(String value) Sets the name of the class attribute.
void	setRelationName(String value) Sets the name of the relation.
void	updateProvenance(ProvenanceContainer cont) Updates the provenance information in the provided container.

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, debug, destroy, equals, execute, 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, postExecute, preExecute, pruneBackup, pruneBackup, reset, restoreState, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged, wrapUp

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

ATTRIBUTE_PREFIX

public static final String ATTRIBUTE_PREFIX

the prefix for attributes (if nto specified explicitly).

See Also:

Constant Field Values

DEFAULT_CLASS

public static final String DEFAULT_CLASS

the class attribute name (if not specified explicitly).

See Also:

Constant Field Values

DEFAULT_DATE_FORMAT

public static final String DEFAULT_DATE_FORMAT

the default date format.

See Also:

Constant Field Values

m_AttributeTypes

protected AttributeTypeList m_AttributeTypes

the comma-separated list of attribute types.

m_AttributeNames

protected BaseList m_AttributeNames

the comma-separated list of attribute names.

m_ClassIndex

protected Index m_ClassIndex

the index for the class attribute, if any.

m_ClassName

protected String m_ClassName

the name for the class attribute, if any.

m_RelationName

protected String m_RelationName

the name for the relation, if any.

m_OutputToken

protected transient Token m_OutputToken

the token to broadcast.

Constructor Detail

WekaNewInstances

public WekaNewInstances()

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

setRelationName

public void setRelationName(String value)

Sets the name of the relation.

Parameters:

value - the name of the relation, uses full actor name as default if left empty

getRelationName

public String getRelationName()

Returns the name of the relation.

Returns:

the relation name, empty if default is used, i.e., the full actor name

relationNameTipText

public String relationNameTipText()

Returns the tip text for this property.

Returns:

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

setAttributeTypes

public void setAttributeTypes(AttributeTypeList value)

Sets the list of attribute types.

Parameters:

value - the attribute types

getAttributeTypes

public AttributeTypeList getAttributeTypes()

Returns the list of attribute types.

Returns:

the attribute types

attributeTypesTipText

public String attributeTypesTipText()

Returns the tip text for this property.

Returns:

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

setAttributeNames

public void setAttributeNames(BaseList value)

Sets the list of attribute names.

Parameters:

value - the attribute names

getAttributeNames

public BaseList getAttributeNames()

Returns the list of attribute names.

Returns:

the attribute names

attributeNamesTipText

public String attributeNamesTipText()

Returns the tip text for this property.

Returns:

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

setClassIndex

public void setClassIndex(String value)

Sets the index of the class attribute.

Parameters:

value - the index, empty for none

getClassIndex

public String getClassIndex()

Returns the index of the class attribute.

Returns:

the index, none if empty

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.

setClassName

public void setClassName(String value)

Sets the name of the class attribute.

Parameters:

value - the name of the class attribute, uses default if left empty

See Also:

DEFAULT_CLASS

getClassName

public String getClassName()

Returns the name of the class attribute.

Returns:

the class, empty if default

See Also:

DEFAULT_CLASS

classNameTipText

public String classNameTipText()

Returns the tip text for this property.

Returns:

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

generates

public Class[] generates()

Returns the class of objects that it generates.

Specified by:

generates in interface OutputProducer

Returns:

weka.core.Instances.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

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

Returns:

true if there is pending output

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