Package adams.flow.source

Class FTPLister

  • All Implemented Interfaces:
    AdditionalInformationHandler, ArrayProvider, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ArrayProvider, ErrorHandler, OutputProducer, Serializable, Comparable
    @Deprecated
public class FTPLister
extends AbstractArrayProvider
    Deprecated.
    Returns the contents of a FTP directory (files/dirs).

    Input/output:
    - generates:
       java.lang.String


    Valid options are: 

    -D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: FTPLister
 
    -annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
 
    -stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 
    -output-array (property: outputArray)
    Whether to output the files as array or as single strings.
 
    -remote-dir <java.lang.String> (property: remoteDir)
    The FTP directory to list the files for.
    default: /pub
 
    -list-dirs (property: listDirs)
    Whether to include directories in the output.
 
    -list-files (property: listFiles)
    Whether to include files in the output.
 
    -regexp <adams.core.base.BaseRegExp> (property: regExp)
    The regular expression that the files/dirs must match (empty string matches
    all).
    default:
 
    -sorting <NO_SORTING|SORT_BY_NAME|SORT_BY_LAST_MODIFIED> (property: sorting)
    The type of sorting to perform.
    default: NO_SORTING
 
    -descending (property: sortDescending)
    If set to true, the files are sorted in descending manner.
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_RemoteDir

        protected String m_RemoteDir
        Deprecated.
        the directory to list.

      • m_RegExp

        protected BaseRegExp m_RegExp
        Deprecated.
        the regular expression on the file/dir names.

      • m_ListDirs

        protected boolean m_ListDirs
        Deprecated.
        whether to list directories.

      • m_ListFiles

        protected boolean m_ListFiles
        Deprecated.
        whether to list files.

      • m_SortDescending

        protected boolean m_SortDescending
        Deprecated.
        whether to sort descending instead of ascending.

      • m_Connection

        protected FTPConnection m_Connection
        Deprecated.
        the FTP connection to use.

    • Constructor Detail

      • FTPLister

        public FTPLister()
        Deprecated.

    • Method Detail

      • setRemoteDir

        public void setRemoteDir​(String value)
        Deprecated.
        Sets the remote directory.
        Parameters:
        value - the remote directory

      • getRemoteDir

        public String getRemoteDir()
        Deprecated.
        Returns the remote directory.
        Returns:
        the remote directory.

      • remoteDirTipText

        public String remoteDirTipText()
        Deprecated.
        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​(BaseRegExp value)
        Deprecated.
        Sets the regular expression for the files/dirs.
        Parameters:
        value - the regular expression

      • getRegExp

        public BaseRegExp getRegExp()
        Deprecated.
        Returns the regular expression for the files/dirs.
        Returns:
        the regular expression

      • regExpTipText

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

      • setListDirs

        public void setListDirs​(boolean value)
        Deprecated.
        Sets whether to list directories.
        Parameters:
        value - true if directories are to be listed

      • getListDirs

        public boolean getListDirs()
        Deprecated.
        Returns whether directories are listed.
        Returns:
        true if directories are listed

      • listDirsTipText

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

      • setListFiles

        public void setListFiles​(boolean value)
        Deprecated.
        Sets whether to list files.
        Parameters:
        value - true if files are to be listed

      • getListFiles

        public boolean getListFiles()
        Deprecated.
        Returns whether directories are listed.
        Returns:
        true if directories are listed

      • listFilesTipText

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

      • setSorting

        public void setSorting​(FTPLister.Sorting value)
        Deprecated.
        Sets the type of sorting to perform.
        Parameters:
        value - the type of sorting

      • getSorting

        public FTPLister.Sorting getSorting()
        Deprecated.
        Returns the type of sorting to perform.
        Returns:
        the type of sorting

      • sortingTipText

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

      • setSortDescending

        public void setSortDescending​(boolean value)
        Deprecated.
        Sets whether to sort descendingly.
        Parameters:
        value - true if sorting in descending order

      • getSortDescending

        public boolean getSortDescending()
        Deprecated.
        Returns whether to sort descendingly.
        Returns:
        true if sorting in descending order

      • sortDescendingTipText

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

      • doExecute

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