All Superinterfaces:

AdditionalInformationHandler, CleanUpHandler, Comparable, Destroyable, ErrorHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, Serializable, ShallowCopySupporter<Actor>, Stoppable, StoppableWithFeedback, VariableChangeListener, VariablesInspectionHandler

All Known Subinterfaces:

AbstractDatabaseConnectionProvider, ActorHandler, ActorReferenceHandler, ActorTemplateUser, ActorWithConditionalEquivalent, ActorWithTimedEquivalent, ArrayProvider, AtomicExecution, AutogeneratedActor, AutomatableInteractiveActor, AutoStartSupporter, ConditionalIdSupplier, ConnectionHandler, ControlActor, DaemonEvent, DatabaseConnectionProvider, DataContainerDbReader<T>, DataContainerDbWriter<T>, DataInfoActor, DisplayPanelProvider, DisplayTypeSupporter, DryRunSupporter, DynamicInitializer, DynamicModelLoaderSupporter, ErrorScopeRestrictor, Event, FeatureGenerator<T>, FixedNameActorHandler, FlowStructureModifier, Flushable, FlushSupporter, InactiveActor, InputConsumer, InteractiveActor, InteractiveActorWithCustomParentComponent, KeyManagerFactoryProvider, LazySetupSupporter, LocalScopeHandler, MutableActorHandler, OptionalOneTimeInitializer, OptionalPasswordPrompt, OptionalStopRestrictor, OutputProducer, PauseStateHandler, PropertiesUpdater, RemoteExecutionHandler, RestorableActor, ScopeHandler, SortableActorHandler, SpreadSheetMergeActor, SSLContextProvider, StandaloneGroup<T>, StandaloneGroupItem<T>, StandaloneMutableGroup<T>, StopModeSupporter, StopRestrictor, StorageHandler, SubFlowWrapUp, TimedActor, TokenEventHandler, TriggerableEvent, TrustManagerFactoryProvider, WeakExternalActor, WekaMergeInstancesActor

All Known Implementing Classes:

AbstractActor, AbstractAppendableFileWriter, AbstractArrayProvider, AbstractArrayProvider, AbstractBaseExternalActor, AbstractBufferingSource, AbstractCallableActor, AbstractCallableActorPropertyUpdater, AbstractCallableDatabaseConnection, AbstractCallableWekaClassifierEvaluator, AbstractCallableWekaClustererEvaluator, AbstractConditionalIdSupplier, AbstractConnectedControlActor, AbstractContainerUpdater, AbstractContainerValueExtractor, AbstractControlActor, AbstractCopyCallableActor, AbstractDatabaseCheck, AbstractDatabaseConnection, AbstractDatabaseIdSupplier, AbstractDatabaseMetaData, AbstractDataContainerAdd, AbstractDataContainerAppend, AbstractDataContainerDbReader, AbstractDataContainerDbWriter, AbstractDataContainerFileChecker, AbstractDataContainerFileImport, AbstractDataContainerFileReader, AbstractDataContainerFileWriter, AbstractDataContainerTransformer, AbstractDataProcessor, AbstractDbArrayProvider, AbstractDbArrayProvider, AbstractDbDataProcessor, AbstractDbSink, AbstractDbSource, AbstractDbStandalone, AbstractDbTransformer, AbstractDeleteDataContainer, AbstractDeleteDbReportValue, AbstractDeleteReportValue, AbstractDeleteReportValueByExpression, AbstractDirectedControlActor, AbstractDisplay, AbstractDisplay, AbstractExternalActor, AbstractFileWriter, AbstractFilter, AbstractForLoop, AbstractGetReportValue, AbstractGraphicalDisplay, AbstractGraphicsGenerator, AbstractGroovyActor, AbstractIdSupplier, AbstractIncludeExternalActor, AbstractInPlaceSpreadSheetTransformer, AbstractInstanceGenerator, AbstractInstrumentSupplier, AbstractInteractiveArrayProvider, AbstractInteractiveSource, AbstractInteractiveTransformer, AbstractInteractiveTransformerDialog, AbstractListTables, AbstractMultiCompress, AbstractMultiDecompress, AbstractMultiView, AbstractMultiView.ViewWrapper, AbstractMutableActorDaemonEvent, AbstractMutableStandaloneGroupItem, AbstractProcessWekaInstanceWithModel, AbstractPropertyUpdater, AbstractPythonExecution, AbstractReportDbReader, AbstractReportDbUpdater, AbstractReportDbWriter, AbstractReportDbWriterByDBID, AbstractReportDbWriterByID, AbstractReportFileImport, AbstractReportFileReader, AbstractReportFileWriter, AbstractReportValueDbWriter, AbstractScript, AbstractScript, AbstractScript, AbstractScript, AbstractScriptedActor, AbstractScriptingHandlerActor, AbstractSelectObjects, AbstractSetReportValue, AbstractSimpleDbSource, AbstractSimpleSource, AbstractSimpleSourceWithPropertiesUpdating, AbstractSingleCompress, AbstractSingleDecompress, AbstractSink, AbstractSource, AbstractSpreadSheetDbReader, AbstractSpreadSheetTransformer, AbstractStandalone, AbstractStandaloneGroup, AbstractStandaloneGroupItem, AbstractStandaloneGroupItemGroup, AbstractStandaloneGroupItemMutableGroup, AbstractStandaloneMutableGroup, AbstractStringOperation, AbstractTee, AbstractTemplate, AbstractTextualDisplay, AbstractTransformer, AbstractTransformerWithPropertiesUpdating, AbstractWekaClassifierEvaluator, AbstractWekaModelReader, AbstractWekaModelWriter, AbstractWekaPredictionsTransformer, AbstractWekaSetupGenerator, AccessDatabaseInfo, ActualVsPredictedPlot, AddDOMAttribute, AddDOMNode, AddNote, AppendName, ArrayCombinations, ArrayDisplay, ArrayGenerate, ArrayHistogramRanges, ArrayLength, ArrayProcess, ArrayReverse, ArrayStatistic, ArraySubset, ArraySubsetGeneration, ArrayToChunks, ArrayToCollection, ArrayToSequence, ArrayToVariables, AutogeneratedSink, AutogeneratedSource, AutogeneratedStandalone, AutogeneratedTransformer, BaseName, BinaryFileReader, BinaryFileWriter, Block, BoofCVDetectLines, BoofCVDetectLineSegments, BoofCVFeatureGenerator, BoofCVMultiImageOperation, BoofCVTransformer, BoxPlot, Branch, Breakpoint, Browser, BufferedImageFeatureGenerator, BufferedImageMultiImageOperation, BufferedImageTransformer, Bzip2, CallableActors, CallableActorScreenshot, CallableDatabaseConnection, CallableSink, CallableSource, CallableTransformer, Canvas, Cast, ChangeImageObjectPrefix, ChangeReportFieldPrefixes, ClassSelector, ClearCallableDisplay, ClipboardActorContainer, CloseCallableDisplay, CloseInputStream, CloseReader, CollectionAppend, CollectionInsert, CollectionProcess, CollectionSize, CollectionSubset, CollectionToArray, CollectionToSequence, ColorProvider, ColorProvider, CombineArrays, CombineCollections, CombineStorage, CombineVariables, Command, CompareObjectLocations, CompareObjects, CompareObjectTypes, ConditionalSequence, ConditionalStandalones, ConditionalSubProcess, ConditionalTee, ConditionalTrigger, ConfirmationDialog, ConfusionMatrix, Console, ConsoleWindow, ContainerDisplay, ContainerToStorage, ContainerToVariables, ContainerValuePicker, ControlChart, ControlChartPlot, Convert, ConvertFeatures, Copy, CopyCallableSink, CopyCallableSource, CopyCallableStandalone, CopyCallableTransformer, CopyFile, CopyToClipboard, Count, Counter, CounterAdd, CounterInit, CounterInit, CountObjectsInPolygon, CountObjectsInRegion, CreateEmail, Cron, CurrentFlow, CurrentTime, DatabaseCheck, DatabaseConnection, DatabaseMetaData, DatasetFilter, DatasetRowFilter, DateTimeTypeDifference, DecodeBarcode, DelayedEvent, DeleteDir, DeleteFile, DeleteFile, DeleteJsonValue, DeleteMapValue, DeleteOverlappingImageObjects, DeletePropertyValue, DeleteReportValue, DeleteReportValueByExpression, DeleteStorageValue, DeleteStorageValue, DeleteVariable, DeleteVariable, DeQueue, Deserialize, DeserializeToStorage, DesktopScreenshot, DetermineOverlappingAreas, DetermineOverlappingObjects, Diff, DirectoryLister, DirectorySupplier, DirName, DirWatch, Display, DisplayPanelGrid, DisplayPanelManager, DOMDisplay, DownloadContent, DownloadFile, Draw, DumpFile, DumpStorage, DumpVariables, EmailFileReader, EmailFileWriter, EmailViewer, EncodeBarcode, EnQueue, EnterManyValues, EnterValue, Events, Exec, Exec, ExecSQL, ExecuteActor, ExecuteJobs, ExecuteRemoteCommand, ExifTagOperation, ExpandStorage, ExpandVariables, ExternalFlow, ExternalSink, ExternalSource, ExternalStandalone, ExternalTransformer, FileBrowser, FileChanged, FileExtension, FileInfo, FilenameGenerator, FilenameGenerator, FilePreview, FileProcessor, FileSupplier, FileSystemSearch, FileTailer, FilterMap, FindInFile, Flow, FlowDisplay, FlowFileReader, FlowFileWriter, ForceFlush, ForLoop, FourInOneDisplay, FreeMemory, FTPConnection, FTPDelete, FTPDisconnect, FTPGet, FTPLister, FTPNoOp, FTPSend, GC, GenerateFileBasedDataset, GetArrayElement, GetDatabaseID, GetEnvironmentVariable, GetID, GetImageObjectIndices, GetImageObjectMetaData, GetImageObjects, GetJsonKeys, GetJsonValue, GetListElement, GetMapKeys, GetMapValue, GetNotes, GetObjectProperty, GetProperties, GetProperty, GetPropertyNames, GetPropertyValue, GetRemoteCommandPayload, GetReport, GetReportValue, GetStorageValue, GetSystemProperty, GridView, Groovy, Groovy, Groovy, Groovy, GroupByRegExp, GUNZIP, GZIP, HashSet, HashSetAdd, HashSetInit, HashSetInit, HashSetRemove, HeapDump, HexReplace, Histogram, HistoryDisplay, Html4Display, HttpPostFile, HttpRequest, HttpRequest, IDGenerator, Idle, IfStorageValue, IfThenElse, ImageAnnotator, ImageFileReader, ImageFileWriter, ImageHistogram, ImageInfo, ImageLabeler, ImageMetaData, ImageObjectAnnotator, ImageObjectFilter, ImageObjectIndexOffset, ImageObjectInfo, ImageObjectOverlap, ImageObjectOverlapMatrix, ImageObjectToVariables, ImagePreparation, ImageSegmentationAnnotator, ImageSegmentationContainerFilter, ImageSegmentationContainerOperation, ImageSegmentationFileReader, ImageSegmentationFileWriter, ImageSegmentationViewer, ImageSharpness, ImageViewer, InactiveSink, InactiveSource, InactiveStandalone, InactiveTransformer, IncludeExternalSink, IncludeExternalSource, IncludeExternalStandalone, IncludeExternalTransformer, IncStorageValue, IncVariable, IndexedSplitsRunsEvaluation, IndexedSplitsRunsGenerator, IndexedSplitsRunsPredictions, IndexedSplitsRunsReader, IndexedSplitsRunsWriter, InformationDialog, InitPublishSubscribe, InitStorageCache, Injector, InputOutputListener, InputStreamGenerator, Inspect, IntegerRange, IntersectOverUnion, Java, JavaExec, JavaLogging, JDeps, JFreeChartFileWriter, JFreeChartPlot, JMap, JobRunnerInstance, JobRunnerSetup, JsonDisplay, JsonFileReader, JsonFileWriter, LargeObjectDbReader, LargeObjectDbWriter, LaunchTee, LaunchTrigger, ListCallableActors, ListEnvironmentVariables, ListStorageNames, ListSystemProperties, ListTables, ListVariables, LoadBalancer, LocalScopeSubProcess, LocalScopeTee, LocalScopeTransformer, LocalScopeTrigger, LocateObjects, LogDumper, LogEvent, Logger, LogViewer, LookUp, LookUp, LookUpAdd, LookUpInit, LookUpInit, LookUpRemove, LookUpTable, LookUpUpdate, Lzf, Lzma, MakeContainer, MakeDir, MakeDir, MakeForecastPlotContainer, MakeJFreeChartDataset, MakeLogEntry, MakePlotContainer, MapToStorageValues, MapToVariables, MapVariableIterator, Mat5ArrayInfo, Mat5ArraySubset, Mat5FileAddArray, Mat5FileAddMap, Mat5FileGetArray, Mat5FileInfo, Mat5FileReader, Mat5FileWriter, Mat5GetMatrixElement, Mat5GetStructField, Mat5SetMatrixElement, Mat5SetStructField, Mat5StructInfo, MatchReportFields, MathExpression, MathExpression, MatrixPlot, Max, MemoryMonitor, MemoryUsage, MenuItem, MergeFiles, MergeObjectLocations, MergeReport, MergeReportFromMap, MessageDigest, MimeType, Min, MissionControl, ModuleInfo, MoveFile, MultiMapOperation, MultiMat5MatrixOperation, MultiSpreadSheetOperation, MutableConnectedControlActor, MutableControlActor, NegativeRegions, NewArray, NewCollection, NewDOMDocument, NewFlow, NewImage, NewJsonStructure, NewList, NewMap, NewMat5File, NewMat5Matrix, NewMat5Struct, NewProperties, NewRemoteCommand, NewReport, NewSpreadSheet, NewTempFile, NotesWriter, Null, Null, Null, ObjectArrayToPrimitiveArray, ObjectPreview, ObjectViewer, Once, OpenCVDeviceFrameGrabber, OpenCVFeatureGenerator, OpenCVMultiImageOperation, OpenCVTransformer, OpenFile, OptionProducer, OptionProducer, OptionTraverser, OutlierDetector, PassThrough, PasteFiles, PasteFromClipboard, PDFAppendDocument, PDFCloseDocument, PDFCreate, PDFExtract, PDFExtractImages, PDFExtractText, PDFGenerate, PDFInfo, PDFMerge, PDFMetaData, PDFNewDocument, PDFPageCount, PDFRenderPages, PDFStamp, PDFViewer, PipExec, PixelSelector, PlotContainerSink, PlotContainerUpdater, PlotProcessor, PredictionEccentricity, PrepareFileBasedDataset, PrependDir, PrimitiveArrayToObjectArray, ProbabilityPlotDisplay, ProcessActor, ProgrammaticSink, ProgrammaticTokenListener, ProgressBar, PropertiesDisplay, PropertiesFileReader, PropertiesFileWriter, PropertiesToVariables, Publish, PyroNameServer, PyroSink, PyroSource, PyroStandalone, PyroTransformer, PythonEnvironment, PythonExec, PythonExpandScript, PythonVenvExec, QueueEvent, QueueInit, RaiseError, RandomNumberGenerator, ReaderGenerator, RegisterFlow, Rejector, RelativeDir, RemoteCommandReader, RemoteCommandWriter, RemoteExecutionTrigger, RemoteScriptingEngine, RemoveImageObject, RemoveOutliers, RemoveOverlappingImageObjects, ReportDbUpdater, ReportDisplay, ReportField, ReportFileReader, ReportFileWriter, ReportMathExpression, ReportToStorage, ReportToVariables, Round, RSync, Rsync4jRsyncBinary, Rsync4jSshBinary, ScaleReportObjects, ScatterDisplay, ScpFrom, ScpTo, Screenshot, Scripted, Scripted, Scripted, Scripted, SelectArraySubset, SelectCharset, SelectDateTime, SelectDirectory, SelectFile, SelectObjects, SendEmail, SendNotification, SendRemoteCommand, Sequence, SequencePlotter, SequenceSource, SequenceToArray, SequenceToCollection, Serialize, SetArrayElement, SetContainerValue, SetDatabaseID, SetID, SetImageObjectMetaData, SetJsonValue, SetManyVariables, SetManyVariables, SetMapValue, SetPlotContainerValue, SetProperty, SetProperty, SetPropertyValue, SetReportFromFile, SetReportFromSource, SetReportValue, SetStorageFlag, SetStorageValue, SetSystemProperty, SetVariable, SetVariable, SFTPDelete, SFTPGet, SFTPSend, SideBySideDiff, SimpleLogging, SimplePlot, SimpleRSync, SimpleStringReplace, SinkReset, Sleep, SMBConnection, SMBGet, SMBSend, SMTPConnection, Socket, Socket, Sort, SourceReset, SpecifiedActor, SplitFile, SpreadSheetAggregate, SpreadSheetAnonymize, SpreadSheetAppend, SpreadSheetAppendComments, SpreadSheetCellFinder, SpreadSheetCellSelector, SpreadSheetCollapse, SpreadSheetColumnFilter, SpreadSheetColumnIterator, SpreadSheetColumnsByName, SpreadSheetColumnStatistic, SpreadSheetCommonIDs, SpreadSheetConvertCells, SpreadSheetConvertHeaderCells, SpreadSheetCopyColumns, SpreadSheetCopyRows, SpreadSheetDbReader, SpreadSheetDbWriter, SpreadSheetDifference, SpreadSheetDisplay, SpreadSheetExtractArray, SpreadSheetFileReader, SpreadSheetFileWriter, SpreadSheetFilter, SpreadSheetGetCell, SpreadSheetGetColumnIndex, SpreadSheetGetHeaderCell, SpreadSheetHistogramRanges, SpreadSheetInfo, SpreadSheetInsertColumn, SpreadSheetInsertRow, SpreadSheetInsertRowScore, SpreadSheetMatrixStatistic, SpreadSheetMerge, SpreadSheetMethodMerge, SpreadSheetPlotGenerator, SpreadSheetQuery, SpreadSheetRandomSystematicSample, SpreadSheetRemoveColumn, SpreadSheetRemoveRow, SpreadSheetReorderColumns, SpreadSheetReorderRows, SpreadSheetReplaceCellValue, SpreadSheetRowBinning, SpreadSheetRowBuffer, SpreadSheetRowFilter, SpreadSheetRowStatistic, SpreadSheetRowToTimeseries, SpreadSheetRowViewer, SpreadSheetSelectSubset, SpreadSheetSetCell, SpreadSheetSetHeaderCell, SpreadSheetSort, SpreadSheetSortColumns, SpreadSheetStatistic, SpreadSheetStorageRowIterator, SpreadSheetSubset, SpreadSheetSubsetByValue, SpreadSheetSubsetFromGroup, SpreadSheetToTimeseries, SpreadSheetTransformCells, SpreadSheetTransformHeaderCells, SpreadSheetVariableRowIterator, SQLIdSupplier, SSHConnection, SSHExec, Standalones, Start, Stop, Stopwatch, StorageCollectionInsert, StorageForLoop, StorageJFreeChartAddSeries, StorageValue, StorageValuesArray, StorageValueSequence, StringArraySplit, StringConstants, StringCut, StringExpression, StringExpression, StringIndent, StringIndexOf, StringInsert, StringJoin, StringLength, StringMatcher, StringRangeCut, StringReplace, StringSanitizer, StringSplit, StringTree, StringTrim, SubProcess, SubStringCount, SummaryStatistics, SwapVariables, Switch, SwitchedSource, TableCleanUp, TabView, Tar, Tee, TemplateSink, TemplateSource, TemplateStandalone, TemplateTransformer, TesseractConfiguration, TesseractOCR, TextFileReader, TextRenderer, TextWriter, TimedSubProcess, TimedTee, TimedTrigger, TimeseriesAdd, TimeseriesAppend, TimeseriesDbReader, TimeseriesDbReader, TimeseriesDisplay, TimeseriesFeatureGenerator, TimeseriesFileReader, TimeseriesFileWriter, TimeseriesFilter, TimeseriesInfo, TimeseriesReportDbUpdater, TimeseriesSplit, Timestamp, Tool, Tool, Touch, TransformerReset, Trigger, TriggerEvent, TriggerOnce, TryCatch, UnBzip2, UniqueID, UnLzf, UnLzma, UnRAR, UnTar, UnXz, UnZIP, UnZstd, UpdateCallableDisplay, UpdateContainerValue, UpdateProperties, UpdateProperty, URLSupplier, Variable, VariableChangedEvent, VariablesArray, ViaAnnotationsToReports, WaitForFile, WeakExternalStandalone, WebSocketClient, WebSocketServer, WekaAccumulatedError, WekaAggregateEvaluations, WekaAssociatorSetup, WekaAttributeIterator, WekaAttributeSelection, WekaAttributeSelectionSummary, WekaAttributeSummary, WekaBootstrapping, WekaChooseAttributes, WekaClassifierErrors, WekaClassifierGenerator, WekaClassifierInfo, WekaClassifierOptimizer, WekaClassifierRanker, WekaClassifierSetup, WekaClassifierSetupProcessor, WekaClassifying, WekaClassSelector, WekaClusterAssignments, WekaClustererGenerator, WekaClustererInfo, WekaClustererPostProcessor, WekaClustererSetup, WekaClusterEvaluationSummary, WekaClustering, WekaCostBenefitAnalysis, WekaCostCurve, WekaCrossValidationClustererEvaluator, WekaCrossValidationEvaluator, WekaCrossValidationSplit, WekaDatabaseReader, WekaDatabaseWriter, WekaDataGenerator, WekaDatasetsMerge, WekaDatasetSplit, WekaEnsembleGenerator, WekaEvaluationInfo, WekaEvaluationPostProcessor, WekaEvaluationSummary, WekaEvaluationValuePicker, WekaEvaluationValues, WekaExperiment, WekaExperimentEvaluation, WekaExperimentExecution, WekaExperimentFileReader, WekaExperimentFileWriter, WekaExperimentGenerator, WekaExtractArray, WekaExtractPLSMatrix, WekaFileReader, WekaFileWriter, WekaFilter, WekaFilterGenerator, WekaForecasterSetup, WekaForecasting, WekaGenericPLSMatrixAccess, WekaGeneticAlgorithm, WekaGeneticAlgorithmInitializer, WekaGetCapabilities, WekaGetInstancesValue, WekaGetInstanceValue, WekaGraphVisualizer, WekaInstanceBuffer, WekaInstanceDumper, WekaInstanceEvaluator, WekaInstanceFileReader, WekaInstancesAppend, WekaInstancesDisplay, WekaInstancesHistogramRanges, WekaInstancesInfo, WekaInstancesMerge, WekaInstancesPlot, WekaInstancesStatistic, WekaInstanceStreamPlotGenerator, WekaInstanceViewer, WekaMarginCurve, WekaModelReader, WekaModelWriter, WekaMultiLabelSplitter, WekaNearestNeighborSearch, WekaNewExperiment, WekaNewInstance, WekaNewInstances, WekaPackageManagerAction, WekaPackageManagerAction, WekaPackageManagerAction, WekaPredictionsToInstances, WekaPredictionsToSpreadSheet, WekaPrimeForecaster, WekaPrincipalComponents, WekaRandomSplit, WekaRegexToRange, WekaRelationName, WekaRenameRelation, WekaReorderAttributesToReference, WekaRepeatedCrossValidationEvaluator, WekaRepeatedCrossValidationOutput, WekaSelectDataset, WekaSelectObjects, WekaSetInstancesValue, WekaSetInstanceValue, WekaSplitGenerator, WekaSpreadSheetToPredictions, WekaStoreInstance, WekaStreamEvaluator, WekaStreamFilter, WekaSubsets, WekaTestSetClustererEvaluator, WekaTestSetEvaluator, WekaTextDirectoryReader, WekaThresholdCurve, WekaTrainAssociator, WekaTrainClassifier, WekaTrainClusterer, WekaTrainForecaster, WekaTrainTestSetClustererEvaluator, WekaTrainTestSetEvaluator, WekaTreeVisualizer, WhileLoop, XMLFileReader, XMLFileWriter, XPath, XSLT, Xz, YamlFileReader, YamlFileWriter, ZIP, ZipArrays, ZScoreDisplay, Zstd
```
public interface Actor
extends Comparable, AdditionalInformationHandler, CleanUpHandler, StoppableWithFeedback, VariableChangeListener, OptionHandler, ShallowCopySupporter<Actor>, QuickInfoSupporter, ErrorHandler, LoggingSupporter, LoggingLevelHandler, VariablesInspectionHandler
```
Interface for actors.

NB: Not yet final version. Using ShallowCopySupporter<Actor> has far-reaching consequences.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary

Fields
Modifier and Type Field Description

static String FILE_EXTENSION
the file extension for flows (excl.

static String FILE_EXTENSION_GZ
the file extension for gzipped flows (excl.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`cleanUp()`	Cleans up after the execution has finished.
`int`	`compareTo(Object o)`	Compares this object with the specified object for order.
`void`	`destroy()`	Frees up memory in a "destructive" non-reversible way.
`boolean`	`equals(Object o)`	Returns whether the two objects are the same.
`String`	`execute()`	Executes the flow item.
`HashSet<String>`	`findVariables()`	Recursively finds all the variables used in the actor's setup.
`BaseAnnotation`	`getAnnotations()`	Returns the current annotations.
`String`	`getDefaultName()`	Returns the default name of the actor.
`HashSet<String>`	`getDetectedVariables()`	Returns the variables this actor is responsible for.
`ErrorHandler`	`getErrorHandler()`	Returns the current error handler for handling errors in the flow.
`FlowExecutionListeningSupporter`	`getFlowExecutionListeningSupporter()`	Returns the flow execution handler in use.
`String`	`getFullName()`	Returns the full name of the actor, i.e., the concatenated names of all parents.
`String`	`getName()`	Returns the name of the actor.
`Actor`	`getNextSibling()`	If the actor is part of a group, this method returns the actor following it in that group.
`Actor`	`getParent()`	Returns the parent of this actor, e.g., the group.
`Component`	`getParentComponent()`	Returns the current parent component for interactive actors.
`Actor`	`getPreviousSibling()`	If the actor is part of a group, this method returns the actor preceding it in that group.
`String`	`getQuickInfo()`	Returns a quick info about the actor, which will be displayed in the GUI.
`Actor`	`getRoot()`	Returns the root of this actor, e.g., the group at the highest level.
`ScopeHandler`	`getScopeHandler()`	Returns the scope handler for this actor.
`boolean`	`getSilent()`	Returns whether to suppress output in the console.
`boolean`	`getSkip()`	Returns whether transformation is skipped.
`boolean`	`getStopFlowOnError()`	Returns whether to stop the flow execution at this level in case this actor encounters an error.
`String`	`getStopMessage()`	Returns the stop message.
`StorageHandler`	`getStorageHandler()`	Returns the storage handler to use.
`Variables`	`getVariables()`	Returns the Variables instance to use.
`String`	`handleError(Actor source, String type, String msg)`	Handles the given error message with the flow that this actor belongs to, if the flow has error logging turned on.
`boolean`	`hasErrorHandler()`	Checks if an error handler is set.
`boolean`	`hasStopMessage()`	Returns whether a stop message is available (in case the flow was stopped with a message).
`int`	`index()`	Returns the index of this actor in its parent's collection.
`boolean`	`isExecuted()`	Returns whether the actor has been executed, after setting it up.
`boolean`	`isFinished()`	Returns whether the item has finished.
`boolean`	`isHeadless()`	Returns whether the actor is run in headless mode.
`boolean`	`isStopped()`	Returns whether the execution was stopped.
`void`	`setAnnotations(BaseAnnotation value)`	Sets the annoations.
`void`	`setErrorHandler(ErrorHandler value)`	Sets the error handler to use for handling errors in the flow.
`void`	`setName(String value)`	Sets the name of the actor.
`void`	`setParent(Actor value)`	Sets the parent of this actor, e.g., the group it belongs to.
`void`	`setSilent(boolean value)`	Sets whether to suppress output in the console.
`void`	`setSkip(boolean value)`	Sets whether the transformation is skipped or not.
`void`	`setStopFlowOnError(boolean value)`	Sets whether to stop the flow execution at this level in case this actor encounters an error.
`String`	`setUp()`	Initializes the item for flow execution.
`void`	`setVariables(Variables value)`	Updates the Variables instance in use, if different from current one.
`Actor`	`shallowCopy()`	Returns a shallow copy of itself, i.e., based on the commandline options.
`Actor`	`shallowCopy(boolean expand)`	Returns a shallow copy of itself, i.e., based on the commandline options.
`int`	`sizeOf()`	Returns the size of the object.
`void`	`stopExecution()`	Stops the execution.
`void`	`stopExecution(String msg)`	Stops the execution.
`String`	`toCommandLine()`	Returns the commandline string.
`void`	`variableChanged(VariableChangeEvent e)`	Gets triggered when a variable changed (added, modified, removed).
`void`	`wrapUp()`	Cleans up after the execution has finished.

Methods inherited from interface adams.core.AdditionalInformationHandler
getAdditionalInformation

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter
getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler
canInspectOptions

- Field Detail
  - FILE_EXTENSION
```
static final String FILE_EXTENSION
```
    the file extension for flows (excl. dot).
    
    See Also:
    
    Constant Field Values
  - FILE_EXTENSION_GZ
```
static final String FILE_EXTENSION_GZ
```
    the file extension for gzipped flows (excl. dot).
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isHeadless
```
boolean isHeadless()
```
    Returns whether the actor is run in headless mode.
    
    Returns:
    
    true if GUI components are suppressed
  - getDefaultName
```
String getDefaultName()
```
    Returns the default name of the actor.
    
    Returns:
    
    the default name
  - setName
```
void setName(String value)
```
    Sets the name of the actor.
    
    Parameters:
    
    value - the name
  - getName
```
String getName()
```
    Returns the name of the actor.
    
    Returns:
    
    the name
  - setAnnotations
```
void setAnnotations(BaseAnnotation value)
```
    Sets the annoations.
    
    Parameters:
    
    value - the annotations
  - getAnnotations
```
BaseAnnotation getAnnotations()
```
    Returns the current annotations.
    
    Returns:
    
    the annotations
  - setSkip
```
void setSkip(boolean value)
```
    Sets whether the transformation is skipped or not.
    
    Parameters:
    
    value - true if transformation is to be skipped
  - getSkip
```
boolean getSkip()
```
    Returns whether transformation is skipped.
    
    Returns:
    
    true if transformation is skipped
  - setStopFlowOnError
```
void setStopFlowOnError(boolean value)
```
    Sets whether to stop the flow execution at this level in case this actor encounters an error.
    
    Parameters:
    
    value - true if flow gets stopped in case of an error
  - getStopFlowOnError
```
boolean getStopFlowOnError()
```
    Returns whether to stop the flow execution at this level in case this actor encounters an error.
    
    Returns:
    
    true if flow gets stopped in case of an error
  - setSilent
```
void setSilent(boolean value)
```
    Sets whether to suppress output in the console. Note: the enclosing actor handler needs to have this enabled as well.
    
    Parameters:
    
    value - true if to suppress output in the console
  - getSilent
```
boolean getSilent()
```
    Returns whether to suppress output in the console. Note: the enclosing actor handler needs to have this enabled as well.
    
    Returns:
    
    true if to suppress output in the console
  - handleError
```
String handleError(Actor source,
                   String type,
                   String msg)
```
    Handles the given error message with the flow that this actor belongs to, if the flow has error logging turned on. Might stop the flow as well.
    
    Specified by:
    
    handleError in interface ErrorHandler
    
    Parameters:
    
    source - the source of the error
    
    type - the type of error
    
    msg - the error message to log
    
    Returns:
    
    null if error has been handled, otherwise the error message
    
    See Also:
    
    Flow.getLogErrors(), Flow.getErrorHandling(), getStopFlowOnError()
  - setParent
```
void setParent(Actor value)
```
    Sets the parent of this actor, e.g., the group it belongs to.
    
    Parameters:
    
    value - the new parent
  - getParent
```
Actor getParent()
```
    Returns the parent of this actor, e.g., the group.
    
    Returns:
    
    the current parent, can be null
  - getParentComponent
```
Component getParentComponent()
```
    Returns the current parent component for interactive actors.
    
    Returns:
    
    the parent, null if not set
  - index
```
int index()
```
    Returns the index of this actor in its parent's collection.
    
    Returns:
    
    the index, -1 if not applicable (e.g., no parent set)
  - getRoot
```
Actor getRoot()
```
    Returns the root of this actor, e.g., the group at the highest level.
    
    Returns:
    
    the root, can be null
  - setVariables
```
void setVariables(Variables value)
```
    Updates the Variables instance in use, if different from current one.
    
    Use with caution!
    
    Parameters:
    
    value - the instance to use
  - getVariables
```
Variables getVariables()
```
    Returns the Variables instance to use.
    
    Returns:
    
    the variables instance
  - getStorageHandler
```
StorageHandler getStorageHandler()
```
    Returns the storage handler to use.
    
    Returns:
    
    the storage handler
  - getScopeHandler
```
ScopeHandler getScopeHandler()
```
    Returns the scope handler for this actor.
    
    Returns:
    
    the scope handler
  - getFlowExecutionListeningSupporter
```
FlowExecutionListeningSupporter getFlowExecutionListeningSupporter()
```
    Returns the flow execution handler in use.
    
    Returns:
    
    the execution handler
  - getFullName
```
String getFullName()
```
    Returns the full name of the actor, i.e., the concatenated names of all parents. Used in error messages.
    
    Returns:
    
    the full name
  - getQuickInfo
```
String getQuickInfo()
```
    Returns a quick info about the actor, which will be displayed in the GUI.
    
    Default implementation returns null.
    
    Specified by:
    
    getQuickInfo in interface QuickInfoSupporter
    
    Returns:
    
    null if no info available, otherwise short string
  - hasErrorHandler
```
boolean hasErrorHandler()
```
    Checks if an error handler is set.
    
    Returns:
    
    true if an error handler is set
  - setErrorHandler
```
void setErrorHandler(ErrorHandler value)
```
    Sets the error handler to use for handling errors in the flow.
    
    Parameters:
    
    value - the error handler
  - getErrorHandler
```
ErrorHandler getErrorHandler()
```
    Returns the current error handler for handling errors in the flow.
    
    Returns:
    
    the error handler
  - findVariables
```
HashSet<String> findVariables()
```
    Recursively finds all the variables used in the actor's setup.
    
    Returns:
    
    the variables that were found
  - variableChanged
```
void variableChanged(VariableChangeEvent e)
```
    Gets triggered when a variable changed (added, modified, removed).
    
    Specified by:
    
    variableChanged in interface VariableChangeListener
    
    Parameters:
    
    e - the event
  - getDetectedVariables
```
HashSet<String> getDetectedVariables()
```
    Returns the variables this actor is responsible for.
    
    Returns:
    
    the variables
  - setUp
```
String setUp()
```
    Initializes the item for flow execution. Also calls the reset() method first before anything else.
    
    Returns:
    
    null if everything is fine, otherwise error message
  - execute
```
String execute()
```
    Executes the flow item.
    
    Returns:
    
    null if everything is fine, otherwise error message
  - isFinished
```
boolean isFinished()
```
    Returns whether the item has finished. The execute() will be called as long as the isFinished() method returns false.
    
    Returns:
    
    true if finished, false if further calls to execute() are necessary. Default implementation returns always true, i.e., fires only once.
  - wrapUp
```
void wrapUp()
```
    Cleans up after the execution has finished. Graphical output is left untouched.
  - cleanUp
```
void cleanUp()
```
    Cleans up after the execution has finished. Also removes graphical components.
    
    Specified by:
    
    cleanUp in interface CleanUpHandler
  - destroy
```
void destroy()
```
    Frees up memory in a "destructive" non-reversible way.
    
    Calls cleanUp().
    
    Specified by:
    
    destroy in interface Destroyable
  - stopExecution
```
void stopExecution()
```
    Stops the execution. No message set.
    
    Specified by:
    
    stopExecution in interface Stoppable
  - stopExecution
```
void stopExecution(String msg)
```
    Stops the execution.
    
    Parameters:
    
    msg - the message to set as reason for stopping, can be null
  - isStopped
```
boolean isStopped()
```
    Returns whether the execution was stopped.
    
    Specified by:
    
    isStopped in interface StoppableWithFeedback
    
    Returns:
    
    true if the execution was stopped
  - hasStopMessage
```
boolean hasStopMessage()
```
    Returns whether a stop message is available (in case the flow was stopped with a message).
    
    Returns:
    
    true if a message is available
  - getStopMessage
```
String getStopMessage()
```
    Returns the stop message.
    
    Returns:
    
    the message, can be null
  - isExecuted
```
boolean isExecuted()
```
    Returns whether the actor has been executed, after setting it up.
    
    Returns:
    
    true if the actor has been executed
  - getPreviousSibling
```
Actor getPreviousSibling()
```
    If the actor is part of a group, this method returns the actor preceding it in that group.
    
    Returns:
    
    the preceding actor, null if not available
  - getNextSibling
```
Actor getNextSibling()
```
    If the actor is part of a group, this method returns the actor following it in that group.
    
    Returns:
    
    the following actor, null if not available
  - compareTo
```
int compareTo(Object o)
```
    Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
    
    Specified by:
    
    compareTo in interface Comparable
    
    Parameters:
    
    o - the object to be compared.
    
    Returns:
    
    a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
    
    Throws:
    
    ClassCastException - if the specified object's type prevents it from being compared to this object.
  - equals
```
boolean equals(Object o)
```
    Returns whether the two objects are the same.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - the object to be compared
    
    Returns:
    
    true if the object is the same as this one
  - shallowCopy
```
Actor shallowCopy()
```
    Returns a shallow copy of itself, i.e., based on the commandline options.
    
    Specified by:
    
    shallowCopy in interface ShallowCopySupporter<Actor>
    
    Returns:
    
    the shallow copy
  - shallowCopy
```
Actor shallowCopy(boolean expand)
```
    Returns a shallow copy of itself, i.e., based on the commandline options.
    
    Specified by:
    
    shallowCopy in interface ShallowCopySupporter<Actor>
    
    Parameters:
    
    expand - whether to expand variables to their current values
    
    Returns:
    
    the shallow copy
  - sizeOf
```
int sizeOf()
```
    Returns the size of the object.
    
    Returns:
    
    the size of the object
  - toCommandLine
```
String toCommandLine()
```
    Returns the commandline string.
    
    Specified by:
    
    toCommandLine in interface OptionHandler
    
    Returns:
    
    the commandline

Modifier and Type	Field	Description
`static String`	`FILE_EXTENSION`	the file extension for flows (excl.
`static String`	`FILE_EXTENSION_GZ`	the file extension for gzipped flows (excl.

Interface Actor

Field Summary

Method Summary

Methods inherited from interface adams.core.AdditionalInformationHandler

Methods inherited from interface adams.core.logging.LoggingLevelHandler

Methods inherited from interface adams.core.logging.LoggingSupporter

Methods inherited from interface adams.core.option.OptionHandler

Methods inherited from interface adams.core.VariablesInspectionHandler

Field Detail

FILE_EXTENSION

FILE_EXTENSION_GZ

Method Detail

isHeadless

getDefaultName

setName

getName

setAnnotations

getAnnotations

setSkip

getSkip

setStopFlowOnError

getStopFlowOnError

setSilent

getSilent

handleError

setParent

getParent

getParentComponent

index

getRoot

setVariables

getVariables

getStorageHandler

getScopeHandler

getFlowExecutionListeningSupporter

getFullName

getQuickInfo

hasErrorHandler

setErrorHandler

getErrorHandler

findVariables

variableChanged

getDetectedVariables

setUp

execute

isFinished

wrapUp

cleanUp

destroy

stopExecution

stopExecution

isStopped

hasStopMessage

getStopMessage

isExecuted

getPreviousSibling

getNextSibling

compareTo

equals

shallowCopy

shallowCopy

sizeOf

toCommandLine