Package adams.flow.transformer

Class WekaTextDirectoryReader

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class WekaTextDirectoryReader
extends AbstractTransformer
    Loads all text files in a directory and uses the subdirectory names as class labels. The content of the text files will be stored in a String attribute, the filename can be stored as well.
    Uses the WEKA weka.core.converters.TextDirectoryLoader converter.

    Input/output:
    - accepts:
       java.lang.String
       java.io.File
    - 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: WekaTextDirectoryReader
 
    -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.
 
    -store-filename (property: storeFilename)
    If enabled, the filename will be stored in extra attribute.
 
    -char-set <java.lang.String> (property: charSet)
    The character set to use when loading the text files.
    default: UTF-8
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_StoreFilename

        protected boolean m_StoreFilename
        whether to store the filename as extra attribute.

      • m_CharSet

        protected String m_CharSet
        the character set.

    • Constructor Detail

      • WekaTextDirectoryReader

        public WekaTextDirectoryReader()

    • Method Detail

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        java.lang.String.class, java.io.File.class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        weka.core.Instances.class

      • setStoreFilename

        public void setStoreFilename​(boolean value)
        Sets whether to store the filename in extra attribute.
        Parameters:
        value - if true then filename gets stored as well

      • getStoreFilename

        public boolean getStoreFilename()
        Returns whether the filename gets stored in extra attribute.
        Returns:
        true if a filename gets stored

      • storeFilenameTipText

        public String storeFilenameTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setCharSet

        public void setCharSet​(String value)
        Sets the character set to use.
        Parameters:
        value - the character set

      • getCharSet

        public String getCharSet()
        Returns the character set in use.
        Returns:
        the character set

      • charSetTipText

        public String charSetTipText()
        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