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.

    - accepts:
    - generates:

    -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.
    -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 <> (property: reader)
        The reader to use for reading the content of the text file.
    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.
        reader - the reader to use
    • Method Detail

      • reset

        protected void reset()
        Resets the actor.
        reset in class AbstractActor
      • setReader

        public void setReader​(AbstractTextReader value)
        Sets the reader.
        value - the reader
      • getReader

        public AbstractTextReader getReader()
        Returns the reader.
        the reader
      • readerTipText

        public String readerTipText()
        Returns the tip text for this property.
        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.
      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
      • doExecute

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