Package adams.flow.transformer

Class FindInFile

  • 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 FindInFile
extends AbstractTransformer
    Searches the incoming (text) file for the specified search string, output the boolean search result.

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


    -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: FindInFile
 
    -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
 
    -find <java.lang.String> (property: find)
    The text to search for.
    default:
 
    -case-sensitive <boolean> (property: caseSensitive)
    If enabled, the search is performed in case-sensitive fashion.
    default: false
 
    -regexp <boolean> (property: regExp)
    If enabled, the search string is interpreted as a regular expression.
    default: false
 
    -use-custom-handler <boolean> (property: useCustomHandler)
    If enabled, the specified file search handler is used instead of auto-detected
    one.
    default: false
 
    -custom-handler <adams.core.io.filesearch.FileSearchHandler> (property: customHandler)
    The custom file search handler to use (if enabled).
    default: adams.core.io.filesearch.TextFileSearchHandler
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Find

        protected String m_Find
        the text to look for.

      • m_CaseSensitive

        protected boolean m_CaseSensitive
        whether the search is case-sensitive.

      • m_RegExp

        protected boolean m_RegExp
        whether the search string represents a regular expression (search handler must support that).

      • m_UseCustomHandler

        protected boolean m_UseCustomHandler
        whether to use a specific file search handler rather than auto-detected one.

      • m_ActualHandler

        protected FileSearchHandler m_ActualHandler
        the actual handler in use.

    • Constructor Detail

      • FindInFile

        public FindInFile()

    • Method Detail

      • setFind

        public void setFind​(String value)
        Sets the search text.
        Parameters:
        value - the text

      • getFind

        public String getFind()
        Returns the search text.
        Returns:
        the text

      • findTipText

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

      • setCaseSensitive

        public void setCaseSensitive​(boolean value)
        Sets whether the search is case-sensitive.
        Parameters:
        value - true if case-sensitive

      • getCaseSensitive

        public boolean getCaseSensitive()
        Returns whether the search is case-sensitive.
        Returns:
        true if case-sensitive

      • caseSensitiveTipText

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

      • setRegExp

        public void setRegExp​(boolean value)
        Sets whether the search string is a regular expression.
        Parameters:
        value - true if regexp

      • getRegExp

        public boolean getRegExp()
        Returns whether the search string is a regular expression.
        Returns:
        true if regexp

      • regExpTipText

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

      • setUseCustomHandler

        public void setUseCustomHandler​(boolean value)
        Sets whether to use the custom handler instead of auto-detected one.
        Parameters:
        value - true if custom handler

      • getUseCustomHandler

        public boolean getUseCustomHandler()
        Returns whether to use the custom handler instead of auto-detected one.
        Returns:
        true if custom handler

      • useCustomHandlerTipText

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

      • setCustomHandler

        public void setCustomHandler​(FileSearchHandler value)
        Sets the file search handler to use.
        Parameters:
        value - the handler

      • getCustomHandler

        public FileSearchHandler getCustomHandler()
        Returns the file search handler to use.
        Returns:
        the handler

      • customHandlerTipText

        public String customHandlerTipText()
        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