Package adams.flow.control

Class AbstractDataContainerFileChecker<T extends DataContainer>

    • Constructor Detail

      • AbstractDataContainerFileChecker

        public AbstractDataContainerFileChecker()

    • Method Detail

      • initialize

        protected void initialize()
        Initializes the members.
        Overrides:
        initialize in class AbstractTee

      • getFormatter

        protected DateFormat getFormatter()
        Returns the formatter for dates (used in the log).
        Returns:
        the formatter

      • getDefaultReader

        protected abstract AbstractDataContainerReader<T> getDefaultReader()
        Returns the default reader to use.
        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.

      • setExpiryInterval

        public void setExpiryInterval​(BaseDateTime value)
        Sets the expiry interval after which blacklisted files get moved from the temporary list to the final list.
        Parameters:
        value - the time interval specification, e.g., "START +1 HOUR"

      • getExpiryInterval

        public BaseDateTime getExpiryInterval()
        Returns the expiry interval after which blacklisted files get moved from the temporary list to the final list.
        Returns:
        the time interval specification, e.g., "START +1 HOUR"

      • expiryIntervalTipText

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

      • setCheckInterval

        public void setCheckInterval​(BaseTime value)
        Sets the check interval after which blacklisted files get checked again whether they can finally be loaded correctly.
        Parameters:
        value - the time interval specification, e.g., "START +1 HOUR"

      • getCheckInterval

        public BaseTime getCheckInterval()
        Returns the check interval after which blacklisted files get checked again whether they can finally be loaded correctly.
        Returns:
        the time interval specification, e.g., "START +1 HOUR"

      • checkIntervalTipText

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

      • setLog

        public void setLog​(PlaceholderFile value)
        Sets the log file to write the files to that expired from the final blacklist. If pointing to a directory, nothing gets written.
        Parameters:
        value - the log file

      • getLog

        public PlaceholderFile getLog()
        Returns the log file to write the files to that expired from the final blacklist. If pointing to a directory, nothing gets written.
        Returns:
        the log file

      • logTipText

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

      • setUpTeeActors

        protected String setUpTeeActors()
        Gets called in the setUp() method. Returns null if tee-actor is fine, otherwise error message.
        Overrides:
        setUpTeeActors in class Tee
        Returns:
        null if everything OK, otherwise error message

      • isValid

        protected boolean isValid​(File file)
        Checks whether the file can be loaded correctly.
        Parameters:
        file - the file to check
        Returns:
        true if the file can be loaded correctly

      • logExpired

        protected void logExpired​(File file,
                          AbstractDataContainerFileChecker.FileInfo info,
                          Date expired)
        Logs the expired file. Does nothing if log is pointing to a directory.
        Parameters:
        file - the file to log
        info - the information about the file
        expired - the timestamp when the file expired

      • canProcessInput

        protected boolean canProcessInput​(Token token)
        Tokens, i.e., files are not automatically forwarded to the tee actor, since only final black-listed ones are output there.
        Overrides:
        canProcessInput in class AbstractTee
        Parameters:
        token - the token to process
        Returns:
        always false

      • doExecute

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