Package adams.flow.core

Interface InputConsumer

All Superinterfaces:

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

All Known Subinterfaces:

DisplayPanelProvider, SpreadSheetMergeActor, WekaMergeInstancesActor

All Known Implementing Classes:

AbstractAppendableFileWriter, AbstractArrayProvider, AbstractCallableWekaClassifierEvaluator, AbstractCallableWekaClustererEvaluator, AbstractContainerUpdater, AbstractContainerValueExtractor, AbstractDataContainerAdd, AbstractDataContainerAppend, AbstractDataContainerDbReader, AbstractDataContainerDbWriter, AbstractDataContainerFileChecker, AbstractDataContainerFileImport, AbstractDataContainerFileReader, AbstractDataContainerFileWriter, AbstractDataContainerTransformer, AbstractDataProcessor, AbstractDbArrayProvider, AbstractDbDataProcessor, AbstractDbSink, AbstractDbTransformer, AbstractDeleteDataContainer, AbstractDeleteDbReportValue, AbstractDeleteReportValue, AbstractDeleteReportValueByExpression, AbstractDisplay, AbstractFileWriter, AbstractFilter, AbstractGetReportValue, AbstractGraphicalDisplay, AbstractGraphicsGenerator, AbstractInPlaceSpreadSheetTransformer, AbstractInstanceGenerator, AbstractInteractiveTransformer, AbstractInteractiveTransformerDialog, AbstractMultiCompress, AbstractMultiDecompress, AbstractMultiView.ViewWrapper, AbstractProcessWekaInstanceWithModel, AbstractReportDbReader, AbstractReportDbUpdater, AbstractReportDbWriter, AbstractReportDbWriterByDBID, AbstractReportDbWriterByID, AbstractReportFileImport, AbstractReportFileReader, AbstractReportFileWriter, AbstractReportValueDbWriter, AbstractScript, AbstractScript, AbstractSetReportValue, AbstractSingleCompress, AbstractSingleDecompress, AbstractSink, AbstractSpreadSheetTransformer, AbstractStringOperation, AbstractTee, AbstractTextualDisplay, AbstractTransformer, AbstractTransformerWithPropertiesUpdating, AbstractWekaClassifierEvaluator, AbstractWekaModelReader, AbstractWekaModelWriter, AbstractWekaPredictionsTransformer, AccessDatabaseInfo, ActualVsPredictedPlot, AddDOMAttribute, AddDOMNode, AddNote, AppendName, ArrayCombinations, ArrayDisplay, ArrayGenerate, ArrayHistogramRanges, ArrayLength, ArrayProcess, ArrayReverse, ArrayStatistic, ArraySubset, ArraySubsetGeneration, ArrayToChunks, ArrayToCollection, ArrayToSequence, ArrayToVariables, AutogeneratedSink, AutogeneratedTransformer, BaseName, BinaryFileReader, BinaryFileWriter, Block, BoofCVDetectLines, BoofCVDetectLineSegments, BoofCVFeatureGenerator, BoofCVMultiImageOperation, BoofCVTransformer, BoxPlot, Branch, Breakpoint, Browser, BufferedImageFeatureGenerator, BufferedImageMultiImageOperation, BufferedImageTransformer, Bzip2, CallableActorScreenshot, CallableSink, CallableTransformer, Canvas, Cast, ChangeImageObjectPrefix, ChangeReportFieldPrefixes, ClassSelector, ClearCallableDisplay, CloseCallableDisplay, CloseInputStream, CloseReader, CollectionAppend, CollectionInsert, CollectionProcess, CollectionSize, CollectionSubset, CollectionToArray, CollectionToSequence, ColorProvider, CompareObjectLocations, CompareObjects, CompareObjectTypes, ConditionalSequence, ConditionalSubProcess, ConditionalTee, ConditionalTrigger, ConfirmationDialog, ConfusionMatrix, Console, ContainerDisplay, ContainerToStorage, ContainerToVariables, ContainerValuePicker, ControlChart, ControlChartPlot, Convert, ConvertFeatures, Copy, CopyCallableSink, CopyCallableTransformer, CopyFile, CopyToClipboard, Count, CounterAdd, CounterInit, CountObjectsInRegion, CreateEmail, DatasetFilter, DatasetRowFilter, DateTimeTypeDifference, DecodeBarcode, DeleteFile, DeleteJsonValue, DeleteMapValue, DeleteOverlappingImageObjects, DeletePropertyValue, DeleteReportValue, DeleteReportValueByExpression, DeleteStorageValue, DeleteVariable, Deserialize, DesktopScreenshot, DetermineOverlappingAreas, DetermineOverlappingObjects, Diff, DirName, Display, DisplayPanelGrid, DisplayPanelManager, DOMDisplay, DownloadContent, DownloadFile, Draw, DumpFile, EmailFileReader, EmailFileWriter, EmailViewer, EnQueue, Exec, ExecuteActor, ExecuteJobs, ExecuteRemoteCommand, ExifTagOperation, ExpandStorage, ExpandVariables, ExternalSink, ExternalTransformer, FileBrowser, FileChanged, FileExtension, FileInfo, FilenameGenerator, FilePreview, FileProcessor, FileTailer, FilterMap, FindInFile, FlowDisplay, FlowFileReader, FlowFileWriter, ForceFlush, FourInOneDisplay, FreeMemory, FTPDelete, FTPDisconnect, FTPGet, FTPNoOp, FTPSend, GC, GenerateFileBasedDataset, GetArrayElement, GetDatabaseID, GetID, GetImageObjectIndices, GetImageObjectMetaData, GetImageObjects, GetJsonKeys, GetJsonValue, GetListElement, GetMapKeys, GetMapValue, GetNotes, GetObjectProperty, GetProperties, GetProperty, GetPropertyNames, GetPropertyValue, GetRemoteCommandPayload, GetReport, GetReportValue, GetStorageValue, Groovy, Groovy, GroupByRegExp, GUNZIP, GZIP, HashSetAdd, HashSetInit, HashSetRemove, HeapDump, HexReplace, Histogram, HistoryDisplay, Html4Display, HttpPostFile, HttpRequest, IDGenerator, 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, InactiveTransformer, IncludeExternalSink, IncludeExternalTransformer, IncStorageValue, IncVariable, IndexedSplitsRunsEvaluation, IndexedSplitsRunsGenerator, IndexedSplitsRunsPredictions, IndexedSplitsRunsReader, IndexedSplitsRunsWriter, InformationDialog, Injector, InputOutputListener, Inspect, IntersectOverUnion, JavaLogging, JDeps, JFreeChartFileWriter, JFreeChartPlot, JMap, JsonDisplay, JsonFileReader, JsonFileWriter, LargeObjectDbWriter, LoadBalancer, LocalScopeTransformer, LocalScopeTrigger, LocateObjects, LogDumper, Logger, LogViewer, LookUp, LookUpAdd, LookUpInit, LookUpRemove, LookUpUpdate, Lzf, Lzma, MakeDir, MakeForecastPlotContainer, MakeJFreeChartDataset, MakeLogEntry, MakePlotContainer, MapToStorageValues, MapToVariables, MapVariableIterator, Mat5ArrayInfo, Mat5ArraySubset, Mat5FileAddArray, Mat5FileAddMap, Mat5FileGetArray, Mat5FileInfo, Mat5FileReader, Mat5FileWriter, Mat5GetMatrixElement, Mat5GetStructField, Mat5SetMatrixElement, Mat5SetStructField, Mat5StructInfo, MatchReportFields, MathExpression, MatrixPlot, Max, MenuItem, MergeFiles, MergeObjectLocations, MergeReport, MergeReportFromMap, MessageDigest, MimeType, Min, MoveFile, MultiMapOperation, MultiMat5MatrixOperation, MultiSpreadSheetOperation, NegativeRegions, NotesWriter, Null, ObjectArrayToPrimitiveArray, ObjectPreview, ObjectViewer, Once, OpenCVFeatureGenerator, OpenCVMultiImageOperation, OpenCVTransformer, OpenFile, OptionProducer, OutlierDetector, PassThrough, PasteFiles, PDFAppendDocument, PDFCloseDocument, PDFCreate, PDFExtract, PDFExtractImages, PDFExtractText, PDFGenerate, PDFInfo, PDFMerge, PDFMetaData, PDFPageCount, PDFRenderPages, PDFStamp, PDFViewer, PixelSelector, PlotContainerSink, PlotContainerUpdater, PlotProcessor, PredictionEccentricity, PrepareFileBasedDataset, PrependDir, PrimitiveArrayToObjectArray, ProbabilityPlotDisplay, ProcessActor, ProgrammaticSink, ProgrammaticTokenListener, ProgressBar, PropertiesDisplay, PropertiesFileReader, PropertiesFileWriter, PropertiesToVariables, Publish, PyroSink, PyroTransformer, PythonExpandScript, RaiseError, Rejector, RelativeDir, RemoteCommandReader, RemoteCommandWriter, RemoteExecutionTrigger, RemoveImageObject, RemoveOutliers, RemoveOverlappingImageObjects, ReportDbUpdater, ReportDisplay, ReportField, ReportFileReader, ReportFileWriter, ReportMathExpression, ReportToStorage, ReportToVariables, Round, ScaleReportObjects, ScatterDisplay, ScpFrom, ScpTo, Screenshot, Scripted, Scripted, SelectArraySubset, SendEmail, SendNotification, SendRemoteCommand, Sequence, SequencePlotter, SequenceToArray, SequenceToCollection, Serialize, SetArrayElement, SetContainerValue, SetDatabaseID, SetID, SetImageObjectMetaData, SetJsonValue, SetManyVariables, SetMapValue, SetPlotContainerValue, SetProperty, SetPropertyValue, SetReportFromFile, SetReportFromSource, SetReportValue, SetStorageFlag, SetStorageValue, SetSystemProperty, SetVariable, SFTPDelete, SFTPGet, SFTPSend, SideBySideDiff, SimpleLogging, SimplePlot, SimpleStringReplace, SinkReset, Sleep, SMBGet, SMBSend, Socket, Sort, SplitFile, SpreadSheetAggregate, SpreadSheetAnonymize, SpreadSheetAppend, SpreadSheetAppendComments, SpreadSheetCellFinder, SpreadSheetCellSelector, SpreadSheetCollapse, SpreadSheetColumnFilter, SpreadSheetColumnIterator, SpreadSheetColumnsByName, SpreadSheetColumnStatistic, SpreadSheetCommonIDs, SpreadSheetConvertCells, SpreadSheetConvertHeaderCells, SpreadSheetCopyColumns, SpreadSheetCopyRows, 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, Stop, StorageCollectionInsert, StorageJFreeChartAddSeries, StorageValueSequence, StringArraySplit, StringCut, StringExpression, StringIndent, StringIndexOf, StringInsert, StringJoin, StringLength, StringMatcher, StringRangeCut, StringReplace, StringSanitizer, StringSplit, StringTree, StringTrim, SubProcess, SubStringCount, SummaryStatistics, SwapVariables, Switch, Tar, Tee, TemplateSink, TemplateTransformer, TesseractOCR, TextFileReader, TextRenderer, TextWriter, TimedSubProcess, TimedTee, TimedTrigger, TimeseriesAdd, TimeseriesAppend, TimeseriesDbReader, TimeseriesDisplay, 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, UpdateProperties, UpdateProperty, ViaAnnotationsToReports, WaitForFile, WebSocketClient, WekaAccumulatedError, WekaAggregateEvaluations, WekaAttributeIterator, WekaAttributeSelection, WekaAttributeSelectionSummary, WekaAttributeSummary, WekaBootstrapping, WekaChooseAttributes, WekaClassifierErrors, WekaClassifierInfo, WekaClassifierOptimizer, WekaClassifierRanker, WekaClassifierSetupProcessor, WekaClassifying, WekaClassSelector, WekaClusterAssignments, WekaClustererInfo, WekaClustererPostProcessor, WekaClusterEvaluationSummary, WekaClustering, WekaCostBenefitAnalysis, WekaCostCurve, WekaCrossValidationClustererEvaluator, WekaCrossValidationEvaluator, WekaCrossValidationSplit, WekaDatabaseWriter, WekaDatasetsMerge, WekaDatasetSplit, WekaEnsembleGenerator, WekaEvaluationInfo, WekaEvaluationPostProcessor, WekaEvaluationSummary, WekaEvaluationValuePicker, WekaEvaluationValues, WekaExperiment, WekaExperimentEvaluation, WekaExperimentExecution, WekaExperimentFileReader, WekaExperimentFileWriter, WekaExperimentGenerator, WekaExtractArray, WekaExtractPLSMatrix, WekaFileReader, WekaFileWriter, WekaFilter, 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, WekaNewInstance, WekaPredictionsToInstances, WekaPredictionsToSpreadSheet, WekaPrimeForecaster, WekaPrincipalComponents, WekaRandomSplit, WekaRegexToRange, WekaRelationName, WekaRenameRelation, WekaReorderAttributesToReference, 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, ZScoreDisplay, Zstd

public interface InputConsumer
extends Actor

Interface for flow actors that can process input tokens.

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[]	accepts()	Returns the class that the consumer accepts.
Token	currentInput()	Returns the current input token, if any.
boolean	hasInput()	Returns whether an input token is currently present.
void	input(Token token)	The method that accepts the input token and then processes it.

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

accepts

Class[] accepts()

Returns the class that the consumer accepts.

Returns:

the Class of objects that can be processed

input

void input(Token token)

The method that accepts the input token and then processes it.

Parameters:

token - the token to accept and process

hasInput

boolean hasInput()

Returns whether an input token is currently present.

Returns:

true if input token present

currentInput

Token currentInput()

Returns the current input token, if any.

Returns:

the input token, null if none present