adams.flow.source
Class URLSupplier

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.source.AbstractSource
                  adams.flow.source.AbstractArrayProvider
                      adams.flow.source.URLSupplier

All Implemented Interfaces:

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

public class URLSupplier
extends AbstractArrayProvider

Supplies multiple URLs (uniform resource locators).

Input/output:
- generates:
java.net.URL

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: MultiURLSupplier
 

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

-output-array (property: outputArray)
    Whether to return the URLs as array or one by one.
 

-url <adams.core.base.BaseURL> [-url ...] (property: URLs)
    The URLs to supply.
    default:
 

Version:

$Revision: 6896 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected BaseURL[]

m_URLs the files to broadcast.

Fields inherited from class adams.flow.source.AbstractArrayProvider

m_Index, m_OutputArray, m_Queue

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_ScopeHandler, 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

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

URLSupplier()

Method Summary

void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
protected Class	getItemClass() Returns the based class of the items.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
BaseURL[]	getURLs() Returns the files to broadcast.
String	globalInfo() Returns a string describing the object.
String	outputArrayTipText() Returns the tip text for this property.
void	setURLs(BaseURL[] value) Sets the files to broadcast.
String	URLsTipText() Returns the tip text for this property.

Methods inherited from class adams.flow.source.AbstractArrayProvider

generates, getOutputArray, hasPendingOutput, output, preExecute, reset, setOutputArray, wrapUp

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, debug, destroy, equals, execute, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, postExecute, pruneBackup, pruneBackup, restoreState, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, 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

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, debug, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, sizeOf, stopExecution, stopExecution, variableChanged

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Field Detail

m_URLs

protected BaseURL[] m_URLs

the files to broadcast.

Constructor Detail

URLSupplier

public URLSupplier()

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 AbstractArrayProvider

getQuickInfo

public String getQuickInfo()

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

Specified by:

getQuickInfo in interface QuickInfoSupporter

Specified by:

getQuickInfo in interface Actor

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

getItemClass

protected Class getItemClass()

Returns the based class of the items.

Specified by:

getItemClass in class AbstractArrayProvider

Returns:

the class

setURLs

public void setURLs(BaseURL[] value)

Sets the files to broadcast.

Parameters:

value - the files

getURLs

public BaseURL[] getURLs()

Returns the files to broadcast.

Returns:

the files

URLsTipText

public String URLsTipText()

Returns the tip text for this property.

Returns:

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

outputArrayTipText

public String outputArrayTipText()

Returns the tip text for this property.

Specified by:

outputArrayTipText in interface ArrayProvider

Specified by:

outputArrayTipText in class AbstractArrayProvider

Returns:

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

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

always null