Package adams.flow.source

Class WekaNewInstances

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<adams.flow.core.Actor>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.core.VariablesInspectionHandler, adams.event.VariableChangeListener, adams.flow.core.Actor, adams.flow.core.ErrorHandler, adams.flow.core.OutputProducer, Serializable, Comparable
    public class WekaNewInstances
extends adams.flow.source.AbstractSimpleSource
    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:
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      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 adams.core.base.BaseList m_AttributeNames
      the comma-separated list of attribute names.
      protected AttributeTypeList m_AttributeTypes
      the comma-separated list of attribute types.
      protected adams.core.Index m_ClassIndex
      the index for the class attribute, if any.
      protected String m_ClassName
      the name for the class attribute, if any.
      protected String m_RelationName
      the name for the relation, if any.

      • Fields inherited from class adams.flow.source.AbstractSimpleSource

        m_OutputToken

      • Fields inherited from class adams.flow.core.AbstractActor

        m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

      • Fields inherited from interface adams.flow.core.Actor

        FILE_EXTENSION, FILE_EXTENSION_GZ

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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.
      adams.core.base.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.
      protected void initialize()
      Initializes the members.
      String relationNameTipText()
      Returns the tip text for this property.
      void setAttributeNames​(adams.core.base.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.

      • Methods inherited from class adams.flow.source.AbstractSimpleSource

        hasPendingOutput, output, reset

      • Methods inherited from class adams.flow.core.AbstractActor

        annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, preExecute, pruneBackup, pruneBackup, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged, wrapUp

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

      • Methods inherited from interface adams.flow.core.Actor

        cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged, wrapUp

      • Methods inherited from interface adams.core.AdditionalInformationHandler

        getAdditionalInformation

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel, setLoggingLevel

      • Methods inherited from interface adams.core.logging.LoggingSupporter

        getLogger, isLoggingEnabled

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager

      • Methods inherited from interface adams.core.VariablesInspectionHandler

        canInspectOptions

    • 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

      • m_AttributeTypes

        protected AttributeTypeList m_AttributeTypes
        the comma-separated list of attribute types.

      • m_AttributeNames

        protected adams.core.base.BaseList m_AttributeNames
        the comma-separated list of attribute names.

      • m_ClassIndex

        protected adams.core.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.

    • Constructor Detail

      • WekaNewInstances

        public WekaNewInstances()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.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 adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.flow.core.AbstractActor

      • initialize

        protected void initialize()
        Initializes the members.
        Overrides:
        initialize in class adams.flow.source.AbstractSimpleSource

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.flow.core.Actor
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class adams.flow.core.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​(adams.core.base.BaseList value)
        Sets the list of attribute names.
        Parameters:
        value - the attribute names

      • getAttributeNames

        public adams.core.base.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.
        Returns:
        weka.core.Instances.class

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class adams.flow.core.AbstractActor
        Returns:
        null if everything is fine, otherwise error message