Package adams.flow.core

Interface OutputProducer

All Superinterfaces:

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

All Known Subinterfaces:

DataInfoActor, SpreadSheetMergeActor, WekaMergeInstancesActor

All Known Implementing Classes:

AbstractArrayProvider, AbstractArrayProvider, AbstractBufferingSource, AbstractCallableWekaClassifierEvaluator, AbstractCallableWekaClustererEvaluator, AbstractConditionalIdSupplier, AbstractContainerUpdater, AbstractContainerValueExtractor, AbstractDatabaseIdSupplier, AbstractDatabaseMetaData, AbstractDataContainerAdd, AbstractDataContainerAppend, AbstractDataContainerDbReader, AbstractDataContainerDbWriter, AbstractDataContainerFileChecker, AbstractDataContainerFileImport, AbstractDataContainerFileReader, AbstractDataContainerFileWriter, AbstractDataContainerTransformer, AbstractDataProcessor, AbstractDbArrayProvider, AbstractDbArrayProvider, AbstractDbDataProcessor, AbstractDbSource, AbstractDbTransformer, AbstractDeleteDataContainer, AbstractDeleteDbReportValue, AbstractDeleteReportValue, AbstractDeleteReportValueByExpression, AbstractFilter, AbstractForLoop, AbstractGetReportValue, AbstractIdSupplier, AbstractInPlaceSpreadSheetTransformer, AbstractInstanceGenerator, AbstractInstrumentSupplier, AbstractInteractiveArrayProvider, AbstractInteractiveSource, AbstractInteractiveTransformer, AbstractInteractiveTransformerDialog, AbstractListTables, AbstractMultiCompress, AbstractMultiDecompress, AbstractProcessWekaInstanceWithModel, AbstractPythonExecution, AbstractReportDbReader, AbstractReportDbUpdater, AbstractReportDbWriter, AbstractReportDbWriterByDBID, AbstractReportDbWriterByID, AbstractReportFileImport, AbstractReportFileReader, AbstractReportFileWriter, AbstractReportValueDbWriter, AbstractScript, AbstractScript, AbstractSelectObjects, AbstractSetReportValue, AbstractSimpleDbSource, AbstractSimpleSource, AbstractSimpleSourceWithPropertiesUpdating, AbstractSingleCompress, AbstractSingleDecompress, AbstractSource, AbstractSpreadSheetDbReader, AbstractSpreadSheetTransformer, AbstractStringOperation, AbstractTee, AbstractTransformer, AbstractTransformerWithPropertiesUpdating, AbstractWekaClassifierEvaluator, AbstractWekaModelReader, AbstractWekaPredictionsTransformer, AbstractWekaSetupGenerator, AccessDatabaseInfo, AddDOMAttribute, AddDOMNode, AddNote, AppendArchive, AppendName, ArrayCombinations, ArrayGenerate, ArrayHistogramRanges, ArrayLength, ArrayProcess, ArrayReverse, ArrayStatistic, ArraySubset, ArraySubsetGeneration, ArrayToChunks, ArrayToCollection, ArrayToSequence, ArrayToVariables, AutogeneratedSource, AutogeneratedTransformer, BaseName, BinaryFileReader, Block, BoofCVDetectLines, BoofCVDetectLineSegments, BoofCVFeatureGenerator, BoofCVMultiImageOperation, BoofCVTransformer, Breakpoint, BufferedImageFeatureGenerator, BufferedImageMultiImageOperation, BufferedImageTransformer, Bzip2, CallableActorScreenshot, CallableSource, CallableTransformer, Cast, ChangeImageObjectPrefix, ChangeReportFieldPrefixes, ClassSelector, ClearCallableDisplay, CloseCallableDisplay, CollectionAppend, CollectionInsert, CollectionProcess, CollectionSize, CollectionSubset, CollectionToArray, CollectionToSequence, ColorProvider, ColorProvider, CombineArrays, CombineCollections, CombineStorage, CombineVariables, Command, CompareObjectLocations, CompareObjects, CompareObjectTypes, ConditionalSubProcess, ConditionalTee, ConditionalTrigger, ConfirmationDialog, ConfusionMatrix, ContainerToStorage, ContainerToVariables, ContainerValuePicker, ControlChart, Convert, ConvertFeatures, Copy, CopyCallableSource, CopyCallableTransformer, CopyFile, CopyToClipboard, Count, Counter, CounterAdd, CounterInit, CountObjectsInPolygon, CountObjectsInRegion, CreateEmail, CurrentFlow, CurrentTime, DatabaseConnectionValid, DatabaseMetaData, DatasetFilter, DatasetRowFilter, DateTimeTypeDifference, DecodeBarcode, DeleteFile, DeleteJsonValue, DeleteMapValue, DeleteOverlappingImageObjects, DeletePropertyValue, DeleteReportValue, DeleteReportValueByExpression, DeleteStorageValue, DeleteVariable, DeQueue, Deserialize, DesktopScreenshot, DetermineOverlappingAreas, DetermineOverlappingObjects, Diff, DirectoryLister, DirectorySupplier, DirName, DownloadContent, Draw, DumpStorage, DumpVariables, EmailFileReader, EncodeBarcode, EnterManyValues, EnterValue, Exec, ExecuteActor, ExecuteJobs, ExecuteRemoteCommand, ExifTagOperation, ExpandStorage, ExpandVariables, ExternalSource, ExternalTransformer, ExtractGroup, ExtractID, FileChanged, FileExtension, FileInfo, FilenameGenerator, FilenameGenerator, FileProcessor, FileSupplier, FileSystemSearch, FileTailer, FilterMap, FindInFile, FlowFileReader, ForceFlush, ForLoop, GC, GenerateFileBasedDataset, GetArrayElement, GetDatabaseID, GetEnvironmentVariable, GetID, GetImageObjectIndices, GetImageObjectMetaData, GetImageObjects, GetJsonKeys, GetJsonValue, GetListElement, GetMapKeys, GetMapKeyValuePairs, GetMapValue, GetNotes, GetObjectProperty, GetProperties, GetProperty, GetPropertyNames, GetPropertyValue, GetRemoteCommandPayload, GetReport, GetReportValue, GetStorageValue, GetSystemProperty, Groovy, Groovy, GroupByRegExp, GUNZIP, GZIP, HashSet, HashSetAdd, HashSetInit, HashSetRemove, HeapDump, HexReplace, HttpPostFile, HttpRequest, HttpRequest, IDGenerator, Idle, ImageAnnotator, ImageFileReader, ImageInfo, ImageLabeler, ImageMetaData, ImageObjectAnnotator, ImageObjectFilter, ImageObjectIndexOffset, ImageObjectInfo, ImageObjectOverlap, ImageObjectOverlapMatrix, ImageObjectToVariables, ImagePreparation, ImageSegmentationAnnotator, ImageSegmentationContainerFilter, ImageSegmentationContainerOperation, ImageSegmentationFileReader, ImageSharpness, IMAPOperation, IMAPOperation, InactiveSource, InactiveTransformer, IncludeExternalSource, IncludeExternalTransformer, IncStorageValue, IncVariable, IndexedSplitsRunsEvaluation, IndexedSplitsRunsGenerator, IndexedSplitsRunsPredictions, IndexedSplitsRunsReader, Injector, InputOutputListener, InputStreamGenerator, Inspect, IntegerRange, IntersectOverUnion, JDeps, JMap, JsonFileReader, LargeObjectDbReader, ListCallableActors, ListEnvironmentVariables, ListStorageNames, ListSystemProperties, ListTables, ListVariables, LocalScopeSubProcess, LocalScopeTee, LocalScopeTransformer, LocalScopeTrigger, LocateObjects, LookUp, LookUp, LookUpAdd, LookUpInit, LookUpRemove, LookUpTable, LookUpUpdate, Lzf, Lzma, MakeContainer, MakeDir, MakeForecastPlotContainer, MakeJFreeChartDataset, MakeLogEntry, MakePlotContainer, MakeXChartDataset, MapToStorageValues, MapToVariables, MapVariableIterator, Mat5ArrayInfo, Mat5ArraySubset, Mat5FileAddArray, Mat5FileAddMap, Mat5FileGetArray, Mat5FileInfo, Mat5FileReader, Mat5GetMatrixElement, Mat5GetStructField, Mat5SetMatrixElement, Mat5SetStructField, Mat5StructInfo, MatchReportFields, MathExpression, MathExpression, Max, MemoryUsage, MergeObjectLocations, MergeReport, MergeReportFromMap, MessageDigest, MimeType, Min, ModuleInfo, MoveFile, MultiMapOperation, MultiMat5MatrixOperation, MultiSpreadSheetOperation, NegativeRegions, NewArchive, NewArray, NewCollection, NewDOMDocument, NewFlow, NewImage, NewJsonStructure, NewList, NewMap, NewMat5File, NewMat5Matrix, NewMat5Struct, NewProperties, NewRemoteCommand, NewReport, NewSpreadSheet, NewTempFile, Null, ObjectArrayToPrimitiveArray, Once, OpenCVDeviceFrameGrabber, OpenCVFeatureGenerator, OpenCVMultiImageOperation, OpenCVTransformer, OptionProducer, OptionProducer, OptionTraverser, OutlierDetector, PassThrough, PasteFromClipboard, PDFAppendDocument, PDFCreate, PDFExtract, PDFExtractImages, PDFExtractText, PDFGenerate, PDFInfo, PDFMerge, PDFMetaData, PDFNewDocument, PDFPageCount, PDFRenderPages, PDFStamp, PipExec, PixelSelector, PlotContainerUpdater, PlotProcessor, PredictionEccentricity, PrepareFileBasedDataset, PrependDir, PrimitiveArrayToObjectArray, ProcessActor, ProgrammaticTokenListener, PropertiesFileReader, PropertiesToVariables, PythonExec, PythonExpandScript, PythonVenvExec, RaiseError, RandomNumberGenerator, ReaderGenerator, Rejector, RelativeDir, RemoteCommandReader, RemoteExecutionTrigger, RemoveImageObject, RemoveOutliers, RemoveOverlappingImageObjects, ReportDbUpdater, ReportField, ReportFileReader, ReportFileWriter, ReportMathExpression, ReportToStorage, ReportToVariables, Round, RSync, Rsync4jRsyncBinary, Rsync4jSshBinary, SaveEmailAttachments, ScaleReportObjects, ScpFrom, ScpTo, Scripted, Scripted, SelectArraySubset, SelectCharset, SelectDateTime, SelectDirectory, SelectFile, SelectObjects, SequenceSource, SequenceToArray, SequenceToCollection, SetArrayElement, SetContainerValue, SetDatabaseID, SetID, SetImageObjectMetaData, SetJsonValue, SetManyVariables, SetMapValue, SetPlotContainerValue, SetProperty, SetPropertyValue, SetReportFromFile, SetReportFromSource, SetReportValue, SetStorageFlag, SetStorageValue, SetSystemProperty, SetVariable, SFTPDelete, SFTPGet, SFTPSend, SimpleRSync, SimpleStringReplace, Sleep, SMBGet, SMBSend, Socket, Sort, SourceReset, SpecifiedActor, SplitFile, SpreadSheetAggregate, SpreadSheetAnonymize, SpreadSheetAppend, SpreadSheetAppendComments, SpreadSheetCellFinder, SpreadSheetCellSelector, SpreadSheetCollapse, SpreadSheetColumnFilter, SpreadSheetColumnIterator, SpreadSheetColumnsByName, SpreadSheetColumnStatistic, SpreadSheetCommonIDs, SpreadSheetConvertCells, SpreadSheetConvertHeaderCells, SpreadSheetCopyColumns, SpreadSheetCopyRows, SpreadSheetDbReader, SpreadSheetDifference, SpreadSheetExtractArray, SpreadSheetFileReader, 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, SpreadSheetSelectSubset, SpreadSheetSetCell, SpreadSheetSetHeaderCell, SpreadSheetSort, SpreadSheetSortColumns, SpreadSheetStatistic, SpreadSheetStorageRowIterator, SpreadSheetSubset, SpreadSheetSubsetByValue, SpreadSheetSubsetFromGroup, SpreadSheetToTimeseries, SpreadSheetTransformCells, SpreadSheetTransformHeaderCells, SpreadSheetVariableRowIterator, SQLIdSupplier, SSHExec, Start, StorageCollectionInsert, StorageForLoop, StorageJFreeChartAddSeries, StorageValue, StorageValuesArray, StorageValueSequence, StorageXChartAddDataset, StringArraySplit, StringConstants, StringCut, StringExpression, StringExpression, StringIndent, StringIndexOf, StringInsert, StringJoin, StringLength, StringMatcher, StringRangeCut, StringReplace, StringSanitizer, StringSplit, StringTrim, SubProcess, SubStringCount, SummaryStatistics, SwapVariables, Switch, SwitchedSource, Tar, Tee, TemplateSource, TemplateTransformer, TesseractOCR, TextFileReader, TextRenderer, TimedSource, TimedSubProcess, TimedTee, TimedTrigger, TimeseriesAdd, TimeseriesAppend, TimeseriesDbReader, TimeseriesDbReader, TimeseriesFeatureGenerator, TimeseriesFileReader, TimeseriesFileWriter, TimeseriesFilter, TimeseriesInfo, TimeseriesReportDbUpdater, TimeseriesSplit, Timestamp, Tool, Touch, TransformerReset, Trigger, TriggerEvent, TriggerOnce, TryCatch, UnBzip2, UniqueID, UnLzf, UnLzma, UnRAR, UnTar, UnXz, UnZIP, UnZstd, UpdateCallableDisplay, UpdateContainerValue, UpdateGroup, UpdateID, UpdateProperties, UpdateProperty, URLSupplier, Variable, VariablesArray, ViaAnnotationsToReports, WaitForFile, WekaAccumulatedError, WekaAggregateEvaluations, WekaAssociatorSetup, WekaAttributeIterator, WekaAttributeSelection, WekaAttributeSelectionSummary, WekaBootstrapping, WekaChooseAttributes, WekaClassifierGenerator, WekaClassifierInfo, WekaClassifierOptimizer, WekaClassifierRanker, WekaClassifierSetup, WekaClassifierSetupProcessor, WekaClassifying, WekaClassSelector, WekaClusterAssignments, WekaClustererGenerator, WekaClustererInfo, WekaClustererPostProcessor, WekaClustererSetup, WekaClusterEvaluationSummary, WekaClustering, WekaCrossValidationClustererEvaluator, WekaCrossValidationEvaluator, WekaCrossValidationSplit, WekaDatabaseReader, WekaDataGenerator, WekaDatasetsMerge, WekaDatasetSplit, WekaEnsembleGenerator, WekaEvaluationInfo, WekaEvaluationPostProcessor, WekaEvaluationSummary, WekaEvaluationValuePicker, WekaEvaluationValues, WekaExperiment, WekaExperimentEvaluation, WekaExperimentExecution, WekaExperimentFileReader, WekaExtractArray, WekaExtractPLSMatrix, WekaFileReader, WekaFilter, WekaFilterGenerator, WekaForecasterSetup, WekaForecasting, WekaGenericPLSMatrixAccess, WekaGeneticAlgorithm, WekaGeneticAlgorithmInitializer, WekaGetCapabilities, WekaGetInstancesValue, WekaGetInstanceValue, WekaInstanceBuffer, WekaInstanceDumper, WekaInstanceEvaluator, WekaInstanceFileReader, WekaInstancesAppend, WekaInstancesHistogramRanges, WekaInstancesInfo, WekaInstancesMerge, WekaInstancesStatistic, WekaInstanceStreamPlotGenerator, WekaModelReader, WekaMultiLabelSplitter, WekaNearestNeighborSearch, WekaNewExperiment, WekaNewInstance, WekaNewInstances, 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, WekaTrainAssociator, WekaTrainClassifier, WekaTrainClusterer, WekaTrainForecaster, WekaTrainTestSetClustererEvaluator, WekaTrainTestSetEvaluator, XMLFileReader, XPath, XSLT, Xz, YamlFileReader, ZIP, ZipArrays, Zstd

public interface OutputProducer
extends Actor

Interface for flow actors that generate output.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Method Summary

Modifier and Type	Method	Description
Class[]	generates()	Returns the class of objects that it generates.
boolean	hasPendingOutput()	Checks whether there is pending output to be collected after executing the flow item.
Token	output()	Returns the generated token.

Methods inherited from interface adams.flow.core.Actor

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

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

Method Detail

generates

Class[] generates()

Returns the class of objects that it generates.

Returns:

the Class of the generated tokens

output

Token output()

Returns the generated token.

Returns:

the generated token

hasPendingOutput

boolean hasPendingOutput()

Checks whether there is pending output to be collected after executing the flow item.

The method is not allowed allowed to return "true" before the actor has been executed. For actors that return an infinite number of tokens, the m_Executed flag can be returned.

Returns:

true if there is pending output