adams.flow.transformer
Class FTPGet

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.transformer.AbstractTransformer
                  adams.flow.transformer.FTPGet

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable

public class FTPGet
extends AbstractTransformer

Downloads a remote file and forwards the local file name.

Input/output:
- accepts:
java.lang.String
- 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: FTPGet
 

-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.
 

-remote-dir <java.lang.String> (property: remoteDir)
    The FTP directory to download the file from.
    default: /pub
 

-output-dir <adams.core.io.PlaceholderDirectory> (property: outputDirectory)
    The directory to store the downloaded files in.
    default: ${CWD}
 

Version:

$Revision: 4584 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected FTPConnection	m_Connection the FTP connection to use.
protected PlaceholderDirectory	m_OutputDirectory the output directory.
protected String	m_RemoteDir the directory to list.

Fields inherited from class adams.flow.transformer.AbstractTransformer

BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

Fields inherited from class adams.flow.core.AbstractActor

FILE_EXTENSION, FILE_EXTENSION_GZ, m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

FTPGet()

Method Summary

Class[]	accepts() Returns the class that the consumer accepts.
void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
Class[]	generates() Returns the class of objects that it generates.
PlaceholderDirectory	getOutputDirectory() Returns the directory to store the downloaded files in.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
String	getRemoteDir() Returns the remote directory.
String	globalInfo() Returns a string describing the object.
String	outputDirectoryTipText() Returns the tip text for this property.
String	remoteDirTipText() Returns the tip text for this property.
void	setOutputDirectory(PlaceholderDirectory value) Sets the directory to store the downloaded files in.
void	setRemoteDir(String value) Sets the remote directory.
String	setUp() Initializes the item for flow execution.

Methods inherited from class adams.flow.transformer.AbstractTransformer

backupState, execute, hasPendingOutput, input, output, postExecute, reset, restoreState, wrapUp

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, debug, destroy, equals, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_RemoteDir

protected String m_RemoteDir

the directory to list.

m_OutputDirectory

protected PlaceholderDirectory m_OutputDirectory

the output directory.

m_Connection

protected FTPConnection m_Connection

the FTP connection to use.

Constructor Detail

FTPGet

public FTPGet()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractActor

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

setRemoteDir

public void setRemoteDir(String value)

Sets the remote directory.

Parameters:

value - the remote directory

getRemoteDir

public String getRemoteDir()

Returns the remote directory.

Returns:

the remote directory.

remoteDirTipText

public String remoteDirTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setOutputDirectory

public void setOutputDirectory(PlaceholderDirectory value)

Sets the directory to store the downloaded files in.

Parameters:

value - the directory

getOutputDirectory

public PlaceholderDirectory getOutputDirectory()

Returns the directory to store the downloaded files in.

Returns:

the directory

outputDirectoryTipText

public String outputDirectoryTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setUp

public String setUp()

Initializes the item for flow execution.

Overrides:

setUp in class AbstractActor

Returns:

null if everything is fine, otherwise error message

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