Package adams.flow.transformer

Class TextFileReader

  • 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 TextFileReader
extends AbstractTransformer
    Reads a text file and forwards the content.
    This actor takes the file to read as input.

    Input/output:
    - accepts:
       java.lang.String
       java.io.File
    - generates:
       java.lang.String[]


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: TextFileReader
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console.
    default: false
 
    -reader <adams.data.io.input.AbstractTextReader> (property: reader)
    The reader to use for reading the content of the text file.
    default: adams.data.io.input.LineArrayTextReader
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Stream

        protected transient InputStream m_Stream
        the file input stream in use.

    • Constructor Detail

      • TextFileReader

        public TextFileReader()
        Default constructor.

      • TextFileReader

        public TextFileReader​(AbstractTextReader reader)
        Initializes with the specified reader.
        Parameters:
        reader - the reader to use

    • Method Detail

      • reset

        protected void reset()
        Resets the actor.
        Overrides:
        reset in class AbstractActor

      • setReader

        public void setReader​(AbstractTextReader value)
        Sets the reader.
        Parameters:
        value - the reader

      • getReader

        public AbstractTextReader getReader()
        Returns the reader.
        Returns:
        the reader

      • readerTipText

        public String readerTipText()
        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:
        java.lang.String.class, java.io.File.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