Package adams.flow.transformer

Class FlowFileReader

  • 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 FlowFileReader
extends AbstractTransformer
    Reads the flow file and outputs the actor(s).
    A custom reader can be specified in case of reading from files, but must be specified when reading from java.io.Reader or java.io.InputStream objects.

    Input/output:
    - accepts:
       java.lang.String
       java.io.File
    - generates:
       adams.flow.core.Actor


    -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: FlowFileReader
 
    -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 execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
 
    -use-custom-reader <boolean> (property: useCustomReader)
    If enabled, the specified reader will be used instead of auto-detection.
    default: false
 
    -custom-reader <adams.data.io.input.FlowReader> (property: customReader)
    The reader to use if a custom reader is to be used.
    default: adams.data.io.input.DefaultFlowReader
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_UseCustomReader

        protected boolean m_UseCustomReader
        whether to use a custom reader.

      • m_CustomReader

        protected FlowReader m_CustomReader
        the custom reader to use.

    • Constructor Detail

      • FlowFileReader

        public FlowFileReader()

    • Method Detail

      • setUseCustomReader

        public void setUseCustomReader​(boolean value)
        Sets whether to use a custom reader.
        Parameters:
        value - true if to use a custom reader

      • getUseCustomReader

        public boolean getUseCustomReader()
        Returns whether to use a custom reader.
        Returns:
        true if to use a custom reader

      • useCustomReaderTipText

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

      • setCustomReader

        public void setCustomReader​(FlowReader value)
        Sets the custom reader to use.
        Parameters:
        value - the reader

      • getCustomReader

        public FlowReader getCustomReader()
        Returns the custom reader to use.
        Returns:
        the reader

      • customReaderTipText

        public String customReaderTipText()
        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:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the Class of the generated tokens

      • doExecute

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