Package adams.flow.core

Interface ArrayProvider

All Superinterfaces:

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

All Known Implementing Classes:

AbstractArrayProvider, AbstractArrayProvider, AbstractConditionalIdSupplier, AbstractDatabaseIdSupplier, AbstractDataContainerFileReader, AbstractDbArrayProvider, AbstractDbArrayProvider, AbstractIdSupplier, AbstractInstrumentSupplier, AbstractInteractiveArrayProvider, AbstractListTables, AbstractReportFileReader, AbstractSelectObjects, AccessDatabaseInfo, ArrayHistogramRanges, BinaryFileReader, BoofCVMultiImageOperation, BoofCVTransformer, BufferedImageMultiImageOperation, BufferedImageTransformer, ColorProvider, ControlChart, DirectoryLister, DirectorySupplier, EmailFileReader, FileSupplier, FileSystemSearch, ForLoop, FTPLister, GetImageObjectIndices, GetImageObjects, GetJsonKeys, GetJsonValue, GetMapKeys, GetProperties, GetPropertyNames, GetPropertyValue, GroupByRegExp, IntegerRange, LargeObjectDbReader, ListCallableActors, ListEnvironmentVariables, ListStorageNames, ListSystemProperties, ListTables, ListVariables, LocateObjects, Mat5ArrayInfo, Mat5FileInfo, Mat5StructInfo, MatchReportFields, MultiMat5MatrixOperation, OpenCVMultiImageOperation, OpenCVTransformer, PDFInfo, PrepareFileBasedDataset, RandomNumberGenerator, ReportField, ReportFileReader, SelectFile, SelectObjects, SpreadSheetCellFinder, SpreadSheetColumnIterator, SpreadSheetExtractArray, SpreadSheetFileReader, SpreadSheetGetCell, SpreadSheetHistogramRanges, SpreadSheetInfo, SpreadSheetPlotGenerator, SpreadSheetRowToTimeseries, SpreadSheetToTimeseries, SQLIdSupplier, StringArraySplit, StringConstants, StringJoin, TimeseriesFileReader, TimeseriesSplit, URLSupplier, ViaAnnotationsToReports, WekaAttributeIterator, WekaEvaluationPostProcessor, WekaGeneticAlgorithm, WekaInstanceFileReader, WekaInstancesHistogramRanges, WekaInstancesInfo, WekaRandomSplit, WekaSelectDataset, WekaSelectObjects, WekaSplitGenerator

public interface ArrayProvider
extends Actor, ArrayProvider

For actors that can output the items either as an array or one-by-one.

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
boolean	getOutputArray()	Returns whether to output the items as array or as single strings.
String	outputArrayTipText()	Returns the tip text for this property.
void	setOutputArray(boolean value)	Sets whether to output the items as array or as single strings.

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

setOutputArray

void setOutputArray(boolean value)

Sets whether to output the items as array or as single strings.

Specified by:

setOutputArray in interface ArrayProvider

Parameters:

value - true if output is an array

getOutputArray

boolean getOutputArray()

Returns whether to output the items as array or as single strings.

Specified by:

getOutputArray in interface ArrayProvider

Returns:

true if output is an array

outputArrayTipText

String outputArrayTipText()

Returns the tip text for this property.

Specified by:

outputArrayTipText in interface ArrayProvider

Returns:

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