Package adams.flow.transformer

Class WaitForFile

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, MultiAttemptSupporter, MultiAttemptWithWaitSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class WaitForFile
extends AbstractTransformer
implements MultiAttemptWithWaitSupporter
    Waits for the file passing through to become available, i.e., not in use by another process.

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


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: WaitForFile
 
    -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
    min-user-mode: Expert
 
    -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
    min-user-mode: Expert
 
    -check <adams.core.io.fileuse.AbstractFileUseCheck> (property: check)
    The check scheme to use.
    default: adams.core.io.fileuse.Default
 
    -max-attempts <int> (property: numAttempts)
    The maximum number of intervals to wait.
    default: 10
    minimum: 1
 
    -attempt-nterval <int> (property: attemptInterval)
    The interval in milliseconds to wait before continuing with the execution.
    default: 100
    minimum: 1
 
    -generate-error <boolean> (property: generateError)
    If enabled, will generate an error in case the maximum number of waits has
    been reached and the file is in use.
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_NumAttempts

        protected int m_NumAttempts
        the maximum number of interval to wait.

      • m_AttemptInterval

        protected int m_AttemptInterval
        the interval in milliseconds to wait.

      • m_GenerateError

        protected boolean m_GenerateError
        whether to generate an error, in case the file is still not available after the maximum wait.

    • Constructor Detail

      • WaitForFile

        public WaitForFile()

    • Method Detail

      • setCheck

        public void setCheck​(AbstractFileUseCheck value)
        Sets the 'in use' check scheme.
        Parameters:
        value - the check scheme

      • getCheck

        public AbstractFileUseCheck getCheck()
        Returns the 'in use' check scheme.
        Returns:
        the check scheme

      • checkTipText

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

      • setNumAttempts

        public void setNumAttempts​(int value)
        Sets the maximum number of intervals to wait.
        Specified by:
        setNumAttempts in interface MultiAttemptSupporter
        Parameters:
        value - the maximum

      • getNumAttempts

        public int getNumAttempts()
        Returns the maximum number of intervals to wait.
        Specified by:
        getNumAttempts in interface MultiAttemptSupporter
        Returns:
        the maximum

      • numAttemptsTipText

        public String numAttemptsTipText()
        Returns the tip text for this property.
        Specified by:
        numAttemptsTipText in interface MultiAttemptSupporter
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • attemptIntervalTipText

        public String attemptIntervalTipText()
        Returns the tip text for this property.
        Specified by:
        attemptIntervalTipText in interface MultiAttemptWithWaitSupporter
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setGenerateError

        public void setGenerateError​(boolean value)
        Sets whether to generate an error if the maximum number of waits has been reached, but the file is still in use.
        Parameters:
        value - true if to generate error

      • getGenerateError

        public boolean getGenerateError()
        Returns whether to generate an error if the maximum number of waits has been reached, but the file is still in use.
        Returns:
        true if to generate error

      • generateErrorTipText

        public String generateErrorTipText()
        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.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        java.lang.String.class, java.io.File.class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        java.lang.String.class, java.io.File.class

      • doExecute

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