Uses of Interface
adams.core.AdditionalInformationHandler
-
-
Uses of AdditionalInformationHandler in adams.data
Subinterfaces of AdditionalInformationHandler in adams.data Modifier and Type Interface Description interfaceCompressionSupporter<T extends DataContainer>Interface forDataContainerWriterclasses that support compression. -
Uses of AdditionalInformationHandler in adams.data.conversion
Classes in adams.data.conversion that implement AdditionalInformationHandler Modifier and Type Class Description classAbstractConversionAncestor for all conversions.classAbstractConversionFromStringAncestor for conversion schemes that convert strings into other objects.classAbstractConversionToStringAncestor for conversion schemes that convert objects into strings.classAbstractImageToByteArrayConverts an image into a byte array.classAbstractInPlaceSpreadSheetConversionAncestor for spreadsheet conversion that allow working on the incoming data rather than on a copy (to conserve memory).classAbstractMatchWekaInstanceAgainstHeaderAncestor for classes that match Instance objects against Instances headers.classAbstractMatrixToSpreadSheetAncestor for conversions that turn a matrix of some type into a spreadsheet.classAbstractObjectToJsonConverts the Map into a JSON object.classAbstractScriptAncestor for conversion scripts.classAbstractScriptedConversionAbstract ancestor for actors that execute external scripts.classAbstractSpreadSheetColumnConverter<T>Ancestor for column converter schemes.classAbstractSpreadSheetConversionAncestor for conversion schemes that transform one spreadsheet into another one.classAbstractSpreadSheetToMatrix<T>Ancestor for conversions that turn a spreadsheet into a matrix of some data type.classAbstractStringConversionAncestor for string conversion schemes.classAbstractSwapObjectAncestor for classes that swap all occurrences of one object for another.classAbstractValidateStringAncestor for string conversions that ensure a string only contains valid characters according to some rules.classAdamsInstanceToWekaInstanceConverts adams.data.instance.Instance objects into weka.core.Instance ones.classAnyImageToByteArrayTurns any image container into a byte array.classAnyImageToOpenCVTurns an Image container into an OpenCV container.classAnyToCommandlineGenerates a commandline string from any object.classAnyToStringTurns any object into a String, using its 'toString()' method.classArrayToCollectionDeprecated.classArrayToJsonArrayTurns an object array into a JSON array.classArrayToReportTurns an array into a report.classArrayToYamlStringConverts the object array into a YAML string.classBackQuoteBackquotes, i.e., escapes with a backslash, characters like quotes (single and double), new lines, tabs.
See also:
adams.data.conversion.Quote
adams.data.conversion.UnQuote
adams.data.conversion.UnBackQuote
Valid options are:classBase64ToByteArrayDecodes a base64 string into a byte array.classBase64ToStringDecodes a base64 string.classBaseDateTimeMsecToStringTurns a BaseDateTimeMsec format string into a String, evaluted using user-supplied start and end dates (ignored if future INF dates).
Example: 2015-12-01 07:13:12.034 +3 MINUTE
(<date>|NOW|-INF|+INF|START|END) [expr (MILLISECOND|SECOND|MINUTE|HOUR|DAY|BUSINESSDAY|WEEK|MONTH|YEAR)]*
expr ::= ( expr )
| - expr
| + expr
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr % expr
| expr ^ expr
| abs ( expr )
| sqrt ( expr )
| log ( expr )
| exp ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| NUMBER
classBaseDateTimeToStringTurns a BaseDateTime format string into a String, evaluted using user-supplied start and end dates (ignored if future INF dates).
Example: 2015-12-01 07:13:12 +3 MINUTE
(<date>|NOW|-INF|+INF|START|END) [expr (SECOND|MINUTE|HOUR|DAY|BUSINESSDAY|WEEK|MONTH|YEAR)]*
expr ::= ( expr )
| - expr
| + expr
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr % expr
| expr ^ expr
| abs ( expr )
| sqrt ( expr )
| log ( expr )
| exp ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| NUMBER
classBaseDateToStringTurns a BaseDate format string into a String, evaluted using user-supplied start and end dates (ignored if future INF dates).
Example: 2015-12-01 +3 DAY
(<date>|NOW|-INF|+INF|START|END) [expr (DAY|BUSINESSDAY|WEEK|MONTH|YEAR)]*
expr ::= ( expr )
| - expr
| + expr
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr % expr
| expr ^ expr
| abs ( expr )
| sqrt ( expr )
| log ( expr )
| exp ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| NUMBER
classBaseTimeToStringTurns a BaseTime format string into a String, evaluted using user-supplied start and end times (ignored if future INF times).
Example: 07:13:12 +3 MINUTE
(<date>|NOW|-INF|+INF|START|END) [expr (SECOND|MINUTE|HOUR)]*
expr ::= ( expr )
| - expr
| + expr
| expr + expr
| expr - expr
| expr * expr
| expr / expr
| expr % expr
| expr ^ expr
| abs ( expr )
| sqrt ( expr )
| log ( expr )
| exp ( expr )
| rint ( expr )
| floor ( expr )
| pow[er] ( expr , expr )
| ceil ( expr )
| NUMBER
classBlobContainerToByteArrayObtains the byte array content of a adams.data.blob.BlobContainer and forwards that.classBoofCVToBufferedImageTurns a BoofCV container into a BufferedImage one.classBooleanToStringTurns a Boolean into a String.classBreakUpStringBreaks up a string into multiple lines if wider than the specified number of columns.classBufferedImageBitmaskContainerToBufferedImagesTurns the bitmask container back into an array of containers for BufferedImage objects, with the image being the first and the bitmasks the other elements.
The incoming report gets cloned into all of the outgoing containers.classBufferedImagesToBufferedImageBitmaskContainerTurns the BufferedImage containers into a container with image (index=0) and bitmasks (index>=1).
Only the report from the first container is transferred.classBufferedImageSupporterToBufferedImageContainerConverts a adams.data.image.BufferedImageSupporter to a adams.data.image.BufferedImageContainer
classBufferedImageToBoofCVTurns a BufferedImage container into a BoofCV one.classBufferedImageToBufferedImageDummy conversion, performs no conversion at all.classBufferedImageToByteArrayTurns a BufferedImage object into a byte array.classByteArrayToBase64Encodes a byte array as base64 string.classByteArrayToBlobContainerWraps the byte array in a adams.data.blob.BlobContainer, which allows the storage of meta-data using the attached report and/or notes.classByteArrayToBufferedImageConverts the byte array representating a binary image (e.g., JPG or PNG) into a BufferedImage container.classByteArrayToDataContainerUses the specified reader to generate data container(s) from the incoming byte array.static classByteArrayToDataContainer.DummyReaderDummy reader.classByteArrayToImageContainerclassByteArrayToJavaObjectDeserializes a Java object from the byte array.classByteArrayToPrimitiveArrayTurns a byte array (IEE754) into a primitive array.classByteArrayToStringTurns a byte array into a String.classByteToHexTurns a Byte into a hexadecimal string.classByteToIntTurns a Byte into an Integer.classByteToStringTurns a Byte into a String.classCharArrayToStringTurns a char array into a String.classCollectionToArrayTurns a collection into an array.classColorToHexTurns a color object into its hexa-decimal representation, e.g., '#ffffff'.classCommandlineToAnyTurns a command-line into an object.classContainerToSpreadSheetConverts any container into a SpreadSheet object.classConvertDateTimeTypeTurns instances of the specified input date/time type into instances of the specified output date/time type.classConvertSpreadSheetRowsConverts the rows in the spreadsheet into a new format.classDataContainerToByteArrayUses the specified writer to generate a byte array from the incoming data container.static classDataContainerToByteArray.DummyWriterDummy writer.classDataContainerToStringUses the specified writer to generate a byte array from the incoming data container.static classDataContainerToString.DummyWriterDummy writer.classDateTimeTypeToStringTurns instances of the specified date/time type into a string using the specified format.classDOMNodeListToArrayTurns a DOM org.w3c.dom.NodeList into an array of org.w3c.dom.Node.classDOMNodeToStringTurns a org.w3c.dom.Node DOM object into a String.classDOMToPropertiesFlattens a DOM object (or node) into a Properties object.classDOMToStringTurns a org.w3c.dom.Node or org.w3c.dom.Document DOM object into a String.
In case of org.w3c.dom.Node objects, the owner document is converted to String.classDoubleMatrixToBufferedImageTurns a matrix of double values into a BufferedImage.classDoubleMatrixToMat5ArrayTurns a double matrix into a 2-dimensional Matlab matrix array.classDoubleMatrixToSpreadSheetConverts a double matrix into a SpreadSheet object.classDoubleToFloatTurns a Double into a Float.classDoubleToIntTurns a Double into an Integer.classDoubleToLongTurns a Double into a Long.classDoubleToStringTurns a Double into a String.classEmailToPlainTextTurns an Email object into a plain text string.classExcelDoubleColumnToDateConverts the specified double column to a date column.classExcelDoubleColumnToDateTimeConverts the specified double column to a date/time column.classExtractDateTimeFieldExtracts the specified field from a date/time type.
A custom format string can be used with field CUSTOM.classExtractSimpleContainerContentObtains the content of a adams.data.container.AbstractSimpleContainer derived class and forwards that.classFieldToStringTurns a Field object into a String.classFileToStringTurns a File object into a String.classFloatToDoubleTurns a Float into a Double.classGroovyA conversion that uses a Groovy script for processing the data.classHashCodeGenerates the hash code of an arbitrary object, using the object's hashcode() method.classHexToByteTurns a hexadecimal string into a Byte.classHexToColorTurns a hexa-decimal representation of a color, e.g., '#ffffff' into a color object again.classHexToIntTurns a hexadecimal string into an Integer.classHtmlCharacterEntitiesToStringTurns HTML character entities like '<' into their character representations like '<'.classImageContainerToByteArrayclassImageContainerToSpreadSheetTurns the image of an image container into a spreadsheet for viewing the pixel values.classInformativeStatisticTurns the statistics obtained from a adams.data.statistics.InformativeStatisticSupporter into a spreadsheet.classIntToByteTurns an Integer into a Byte.classIntToDoubleTurns an Integer into a Double.classIntToHexTurns an Integer into a hexadecimal string.classIntToLongTurns an Integer into a Long.classIntToRomanConverts an integer (1-3999) into a roman numeral string (eg 'MCM').classIntToStringTurns an Integer into a String.
Can be optionally formatted using a byte format string.classJavaObjectToByteArraySerializes the Java Object into a byte array.classJoinOptionsAssumes the string array to be an option array and joins them into a single string.classJsonArrayToArrayTurns a JSON array into an object array.classJsonArrayToListclassJsonObjectToMapTurns a JSON object into a map.classJsonToReportTurns a JSON string into a report.
Input format:
{
"Sample ID": "someid",
"GLV2": 1.123,
"valid": true
}
classJsonToSpreadSheetTurns a JSON object into a spreadsheet, essentially flattening it.classJsonToStringTurns a JSON object/array into a string.classLeftPadLeft pads a string up to a maximum number of characters.classListToJsonConverts the java.util.List into a JSON object.classListToJsonArrayTurns a Java list into a JSON array.classListToYamlStringConverts the java.util.List object into a YAML string.classLocatedObjectsToReportConverts the array of LocatedObject instances to a report.classLocatedObjectToRectangleConverts a adams.flow.transformer.locateobjects.LocatedObject to a rectangle.classLongToDoubleTurns a Long into a Double.classLongToIntTurns a Long into an Integer.classLongToStringTurns a Long into a String.
Can be optionally formatted using a byte format string.classLowerCaseTurns a String into a lowercase String.classMapToJsonConverts the java.util.Map into a JSON object.classMapToKeyValuePairsConverts the java.util.Map into key-value pairs.classMapToMat5FileConverts a map into a Matlab file object.
Supported nested elements:
- java.util.Map
- Matlab array/struct
- spreadsheet
- Double matrix
classMapToMat5StructConverts a map into a Matlab struct object.
Supported nested elements:
- java.util.Map
- Matlab array/struct
- spreadsheet
- Double matrix
classMapToReportTurns a map object into a report.classMapToSpreadSheetTurns a java.util.Map object into a SpreadSheet object.classMapToStringTurns a map object into a simple string.
When encountering date objects as values, they get turned into a string using: yyyy-MM-dd HH:mm:ss
Output format:
<key>:
<value>
classMapToWekaInstanceConverts a map into a Weka Instance, using the provided storage object (Instances) as template.classMapToYamlStringConverts the java.util.Map object into a YAML string.classMat5ArrayToDoubleMatrixConverts a 2-dimensional Matlab array into a double matrix.classMat5ArrayToSpreadSheetTurns the Matlab array into a spreadsheet.classMat5ArrayToStringConverts matrices into a textual representation, otherwise just outputs the dimensions.classMat5CharToStringclassMat5FileToMapTurns the Mat5File data structure into a nested map.classMat5StructToMapTurns the Matlab struct into a map.
In case of multi-dimensional (outermost) structs, an index can be supplied to retrieve just a single element instead of all of them.classMatchWekaInstanceAgainstFileHeaderMatches an Instance against a dataset header loaded from a file, i.e., it automatically converts STRING attributes into NOMINAL ones and vice versa.
The file can be any format that WEKA recognizes.classMatchWekaInstanceAgainstStorageHeaderMatches an Instance against a dataset header from storage, i.e., it automatically converts STRING attributes into NOMINAL ones and vice versa.classMathExpressionEvaluates a mathematical expression.
The input value (double or integer) can be accessed via 'X'.
Variables are supported as well, e.g.: pow(X,@{exp}) with '@{exp}' being a variable available at execution time.
The following grammar is used for the expressions:
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr !classMaximumIf the numbers passing through get above the defined maximum, the maximum is returned instead.classMinimumIf the numbers passing through fall below the defined minimum, the minimum is returned instead.classMovingAverageComputes the average on a window of numbers that have passed through and outputs the average.classMultiConversionMeta-conversion that allows the chaining of multiple conversions.classNotesSubsetGenerates a subset of a adams.data.Notes object.classNotesToSpreadSheetTurns an adams.data.Notes object into a SpreadSheet object.classNotesToStringTurns an adams.data.Notes object into a string.classNumberToByteTurns an Number into a Byte.classNumberToDoubleTurns an Number into a Double.classNumberToFloatTurns an Number into a Float.classNumberToIntTurns an Number into a Int.classNumberToLongTurns an Number into a Long.classObjectAnnotationsToImageSegmentationLayersConverts the annotations to image segmentation layers.classObjectArrayToPrimitiveArrayConverts an object array to its primitive counterpart.classObjectContainerToObjectObtains the object content of a adams.data.container.ObjectContainer and forwards that.classObjectToObjectDummy converter, does not perform any conversion.classObjectToObjectContainerWraps the object in a adams.data.container.ObjectContainer, which allows the storage of meta-data using the attached report and/or notes.classObjectToStringTurns the object into a JSON string using Jackson's ObjectMapper (https://github.com/FasterXML/jackson-databind).classOneBasedToZeroBasedConverts 1-based indices into 0-based ones.
See also:
adams.data.conversion.ZeroBasedToOneBased
classOpenCVToBufferedImageTurns an OpenCV container into a BufferedImage one.classPathSplitSplits the path into its individual parts.
Handles forward slashes and backslashes.
Drive letters and servers from UNC paths are handled as separate part.classPoint2DToStringTurns a java.awt.geom.Point2D into a string of the format 'x y'.classPrettyPrintXMLTurns the XML string into a pretty-printed XML string.
See also:
adams.data.conversion.XMLToDOM
adams.data.conversion.DOMToString
classPrimitiveArrayToByteArrayTurns a primitive array into a byte array (IEE754).classPrimitiveArrayToObjectArrayConverts a primitive array to its object counterpart.classPropertiesToKeyValuePairsConverts the java.util.Properties into key-value pairs.classPropertiesToMapTurns a Properties object into a java.util.Map.classPropertiesToSpreadSheetTurns a properties object into a spreadsheet with two columns, one for the key and one for the value.classPropertiesToStringTurns a Properties object into a String.classQuadrilateralLocationCenterDetermines the center of the quadrilateral object and returns them as a java.awt.geom.Point2D.classQuadrilateralLocationToStringTurns a quadrilateral object into a string of the format 'A.x A.y B.x B.y C.x C.y D.x D.y'.classQuoteSurrounds a string with quotes (single or double), if necessary due to blanks or other characters (new line, tab) in the string.
However, you can also 'force' the quoting.
See also:
adams.data.conversion.UnQuote
adams.data.conversion.BackQuote
adams.data.conversion.UnBackQuote
classReceivedEmailToMapConverts the properties of a jodd.mail.ReceivedEmail to a map.classRectangleCenterDetermines the center of the rectangle and returns them as a java.awt.geom.Point2D.classRectangleToStringTurns a rectangle into a string of the format 'x y w h' or 'x0 y0 x1 y1'.classRemoteCommandToStringTurns a remote command into a string.classRenameSpreadSheetRenames the spreadsheet.classRenameSpreadSheetColumnRenames a single column in a spreadsheet.classReplaceFileExtensionInterprets the string as file name and replaces its extension with the provided one.classReportArrayToMapConverts the incoming report array into a map using the sample ID as key.classReportToJsonTurns a report into a JSON string.
Output format:
{
"Sample ID": "someid",
"GLV2": 1.123,
"valid": true
}
classReportToMapTurns a Report object into a java.util.Map.classReportToSpreadSheetTurns a report into a spreadsheet.classReportToStringGenerates a string representation from the report using the specified report writer.classReportToWekaInstanceConverts a report into a weka.core.Instance objects.classRightPadRight pads a string up to a maximum number of characters.classRomanToIntConverts a roman numeral string (eg 'MCM') into an integer (eg 1900).classRoundRounds double values and turns them into integers..classRowArrayToSpreadSheetConverts a an array of spreadsheet rows into a single spreadsheet.classScriptedA conversion that uses any scripting handler for processing the data with a script located in the specified file.classSideBySideDiffToStringTurns a side-by-side diff object into a string.classSimpleAsciiToUnicodeTurns an ASCII string into a Unicode one, by replacing hexadecimal unicode character representations like '\xf3' with their unicode characters.
For instance, "D'\xe1'cil" becomes "Dácil".classSimpleUnicodeToAsciiTurns a Unicode string into an ASCII one, by replacing the Unicode characters with something like '\xf3' (including the single quotes).
For instance, "Dácil" becomes "D'\xe1'cil".classSplitOptionsAssumes the string to be an option string and splits it into its individual elements.classSpreadSheetAddFormulaColumnAdds a column with a user-supploed formula for the specified rows.classSpreadSheetAddFormulaRowAdds a row with a user-supplied formula for the specified columns.classSpreadSheetAddRowIDAdds an ID column to the spreadsheet, using the row index as value.classSpreadSheetAddSumColumnAdds a column with 'sum' formulas for the specified rows.classSpreadSheetAddSumRowAdds a row with 'sum' formulas for the specified columns.classSpreadSheetAnyColumnToStringConverts the specified spreadsheet column from any type to string.classSpreadSheetBinarizeBinarizes the non-numeric columns in the selected column range by creating a new column for each of the labels.classSpreadSheetCellFinderToPositionsDeprecated.classSpreadSheetCellLocationToCoordinatesTurns the cell location obtained from a cell finder into an integer array with the 1-based coordinates (row/column).classSpreadSheetCellLocationToPositionTurns the cell location obtained from a cell finder into a position (like 'A2').classSpreadSheetColumnFinderToRangeTurns the columns that the specified column finder locates into a 1-based range string.classSpreadSheetColumnsToReportTurns spreadsheet columns into reports.classSpreadSheetDoubleColumnToLongConverts the specified spreadsheet column from double to long.
Simply uses the Double's 'longValue()' method.classSpreadSheetDoubleColumnToStringConverts the specified spreadsheet double column to string.classSpreadSheetEscapeColumnNameEscapes a column name (if necessary) to be used in a column range expression.classSpreadSheetHeaderToMat5ArrayConverts the spreadsheet header with the column names into a Matlab array.classSpreadSheetInsertCellLocationReplaces the specified placeholder with a cell location generated from the user-supplied row and column.classSpreadSheetInsertColumnPositionReplaces the specified placeholder with a column string (e.g., BG) generated from the user-supplied column.classSpreadSheetJoinColumnsMerges two or more columns in a spreadsheet into a single column.
Columns can be out-of-order.classSpreadSheetLongColumnToDoubleConverts the specified spreadsheet column from long to double.
Simply uses the cell's 'toDouble()' method.classSpreadSheetMaterializeFormulasFinds cells with formulas in a spreadsheet and replaces the cell content with the value calculated by the formula.classSpreadSheetObjectColumnToStringConverts the specified spreadsheet column from the object type to string.classSpreadSheetRowFinderToRangeTurns the rows that the specified row finder locates into a 1-based range string.classSpreadSheetRowsToReportTurns spreadsheet rows into report.classSpreadSheetSplitColumnSplits the string representation of the cells of a column into multiple columns using a regular expression.classSpreadSheetStringColumnToBooleanConverts the specified spreadsheet column from string to boolean.classSpreadSheetStringColumnToDateConverts the specified spreadsheet column from string to date, according to the provided format.
For more information on the format, see Javadoc of 'java.text.SimpleDateFormat' class:
http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html
Valid options are:classSpreadSheetStringColumnToDateTimeConverts the specified spreadsheet column from string to date/time, according to the provided format.
For more information on the format, see Javadoc of 'java.text.SimpleDateFormat' class:
http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html
Valid options are:classSpreadSheetStringColumnToDateTimeMsecConverts the specified spreadsheet column from string to date/time/msec, according to the provided format.
For more information on the format, see Javadoc of 'java.text.SimpleDateFormat' class:
http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html
Valid options are:classSpreadSheetStringColumnToDoubleConverts the specified spreadsheet column from string to double, according to the provided format.
For more information on the format, see Javadoc of 'java.text.DecimalFormat' class:
http://docs.oracle.com/javase/6/docs/api/java/text/DecimalFormat.html
Valid options are:classSpreadSheetStringColumnToLongConverts the specified spreadsheet column from string to long, according to the provided format.
For more information on the format, see Javadoc of 'java.text.DecimalFormat' class:
http://docs.oracle.com/javase/6/docs/api/java/text/DecimalFormat.html
Valid options are:classSpreadSheetStringColumnToObjectConverts the specified spreadsheet column from string to an object, using the specified handler.classSpreadSheetStringColumnToTimeConverts the specified spreadsheet column from string to time, according to the provided format.
For more information on the format, see Javadoc of 'java.text.SimpleTimeFormat' class:
http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html
classSpreadSheetStringColumnToTimeMsecConverts the specified spreadsheet column from string to time/msec, according to the provided format.
For more information on the format, see Javadoc of 'java.text.SimpleTimeFormat' class:
http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html
classSpreadSheetSupporterToSpreadSheetclassSpreadSheetToCreateTableStatementTurns a spreadsheet into a SQL 'CREATE TABLE' statement.
Requires two columns: column names, SQL column types.
An optional 3rd column can be used to indicate whether a column is to be used as an index (boolean).classSpreadSheetToDatasetTurns a spreadsheet object into a dataset object.classSpreadSheetToDoubleMatrixTurns a spreadsheet into a double matrix, using only the numeric columns.classSpreadSheetToJsonTurns a spreadsheet into a JSON array.classSpreadSheetToMapTurns two columns (key and value) of a spreadsheet into a map object of the specified type.classSpreadSheetToMat5ArrayConverts a spreadsheet to a Matlab array (either matrix or a cell array)
classSpreadSheetToNumericTurns a spreadsheet into a purely numeric one.
Missing cells can get replaced with a specified value or skipped.
Booleans gets turned into 0/1 (false/true).
Date/time types get turned into numeric ones by using their Java epoch.
Strings (per column) get a 0-based index assigned in the order they appear.
Any other cell type get flagged as missing or, if provided, set to the unhandled value.classSpreadSheetToRowArrayConverts a spreadsheet into an array of spreadsheet rows.classSpreadSheetToStringTurns a spreadsheet into a string using the specified spreadsheet writer.classSpreadSheetToStringMatrixTurns a spreadsheet into a string matrix.classSpreadSheetToTimeseriesTurns a SpreadSheet object into a Timeseries.classSpreadSheetToWekaInstancesGenerates a weka.core.Instances object from a SpreadSheet object.
If there are too many unique lables for a NOMINAL attribute, it gets turned into a STRING attribute (see 'maxLabels' property).classSpreadSheetUnescapeColumnNameUnescapes a column name (if necessary) that was to be used in a column range expression.classSpreadSheetUniqueColumnNamesEnsures that column names are unique.classSpreadSheetUseRowAsHeaderUses the values of the specified data row for the header.classStringArrayToURLParametersTurns a string array into parameters of a URL, e.g., '?classStringExpressionEvaluates a string expression.
Variables are supported as well, e.g.: pow(X,@{exp}) with '@{exp}' being a variable available at execution time.
The following grammar is used for the expressions:
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr !classStringMatrixToSpreadSheetConverts a string matrix into a SpreadSheet object.classStringToBase64Encodes a string as base64.classStringToBooleanTurns a String into a Boolean, ie any string regardless of case that matches 'true' returns true otherwise false.classStringToByteTurns a String into a Byte.classStringToByteArrayConverts a string into a byte array.classStringToCharArrayConverts a string into a char array.classStringToCustomStringRepresentationTurns a String into an object of a class with an associated object editor that has implements adams.gui.goe.CustomStringRepresentationHandler.classStringToDataContainerUses the specified reader to generate data container(s) from the incoming string.static classStringToDataContainer.DummyReaderDummy reader.classStringToDateTimeTypeParses a string and turns it into an instance of the specified date/time type.classStringToDoubleTurns a String into a Double.classStringToFieldTurns a String into a Field object.classStringToFileTurns a String into a File object.classStringToHtmlCharacterEntitiesTurns a string into valid HTML, replacing characters like '<', '>' etc with their character entities.classStringToIntTurns a String into an Integer.classStringToJsonTurns a string into a JSON object or array.classStringToLongTurns a String into a Long.classStringToMat5ArrayConverts a string like '[1, 2; 3, 4]' into a Matlab matrix.classStringToObjectConverts the JSON string into an object of the specified class.classStringToPoint2DclassStringToPropertiesTurns a String into a Properties object.classStringToQuadrilateralLocationConverts a string into a adams.core.base.QuadrilateralLocation object.classStringToRectangleConverts a string into a adams.core.base.BaseRectangle object, using 'x y w h' or 'x0 y0 x1 y1'.classStringToRemoteCommandParses the String and turns it into a RemoteCommand object.classStringToReportReads the report from the incoming string using the specified report reader.classStringToSpreadSheetTurns a string representation of a spreadsheet into a SpreadSheet object, using the specified reader setup.classStringToStringDummy converter, does not perform any conversion.classStringToTextContainerWraps the String in a adams.data.text.TextContainer, which allows the storage of meta-data using the attached report and/or notes.classStringToURLTurns a String into a URL object.classStringToValidFileNameTurns any string into a valid file name.classStringToValidStorageNameTurns any string into a valid storage name.classStringToValidVariableNameTurns any string into a valid variable name.classSwapObjectsSwaps all occurrences of one object with another one.classSwapPLSSwaps one PLS filter for another.classTextContainerToStringObtains the string content of a adams.data.text.TextContainer and forwards that.classTextRendererTurns incoming objects into their textual representation, either automatic detection based on their data type or by explicitly specifying a renderer.
See also:
adams.flow.transformer.TextRenderer
classTimeseriesToArrayTurns the values of a timeseries into a Double array.classTimeseriesToSpreadSheetTurns a timeseries into a SpreadSheet object.classTimeseriesToWekaInstancesTurns a timeseries into a WEKA Instances object.classTimeToStringTurns a number representing milli-seconds since 1970 (Java date) into a String.
For more information on formatting the date, see:
Javadoc. java.text.SimpleDateFormat.classTransposeSpreadSheetTransposes a spreadsheet, i.e., swaps columns with rows.classUnBackQuoteReverses backquoting, i.e., removes the escaping with backslash, restoring characters like quotes (single and double), new lines, tabs.
See also:
adams.data.conversion.Quote
adams.data.conversion.UnQuote
adams.data.conversion.BackQuote
Valid options are:classUnknownToUnknownDummy converter, does not perform any conversion.classUnQuoteRemoves the quotes (single or double) surrounding a string.classUpperCaseTurns a String into an uppercase String.classURLDecodeDecodes the URL encoded string back to a regular string (uses java.net.URLDecoder).classURLEncodeEncodes the string to make it usable within a URL (uses java.net.URLEncoder).classURLParametersToStringArrayTurns URL parameters like '...?classURLToStringTurns a URL object into a String.classUseForwardSlashesConverts backslashes in file names to forward slashes.
Does not touch the '\\' prefix of UNC paths.classWekaCapabilitiesToInstancesTurns a weka.core.Capabilities object into a Weka dataset filled with random data that is compatible with these capabilities.classWekaCapabilitiesToSpreadSheetTurns a weka.core.Capabilities object into a spreadsheet, listing all individual capabilities and whether they are supported.classWekaCommandToCodeApplies a commandline converter to the incoming commandline to generate code.
Uses the following project:
https://github.com/fracpete/command-to-code-weka-package
classWekaDrawableToStringExtracts the string representation of a weka.core.Drawable object, e.g., the tree representation of a decision tree or the graph of a BayesNet.classWekaEvaluationToCostCurveGenerates cost-curve data from a WEKA Evaluation object.classWekaEvaluationToMarginCurveGenerates margin-curve data from a WEKA Evaluation object.classWekaEvaluationToThresholdCurveGenerates threshold-curve data from a WEKA Evaluation object.classWekaForecastContainerToArrayTurns a series of predictions of a adams.flow.container.WekaForecastContainer container into a Double array.classWekaForecastContainerToTimeseriesTurns a series of predictions of a adams.flow.container.WekaForecastContainer container into a adams.data.timeseries.Timeseries.classWekaInstancesToSpreadSheetGenerates a spreadsheet from a weka.core.Instances object.classWekaInstancesToTimeseriesTurns a WEKA Instances object into a Timeseries.classWekaInstanceToAdamsInstanceConverts weka.core.Instance objects into adams.data.instance.Instance ones.classWekaInstanceToMapTurns the Weka Instance into a Map, with the attribute names the keys.classWekaPackageToMapTurns the Weka Package into a Map.classWekaPredictionContainerToSpreadSheetTurns a WEKA prediction container into a SpreadSheet object.classXMLToDOMTurns an XML string into a org.w3c.dom.Document DOM object.classYamlStringToListConverts the YAML string into a java.util.Map object.classYamlStringToMapConverts the YAML string into a java.util.Map object.classZeroBasedToOneBasedConverts 0-based indices into 1-based ones.
See also:
adams.data.conversion.OneBasedToZeroBased
-
Uses of AdditionalInformationHandler in adams.data.io.input
Subinterfaces of AdditionalInformationHandler in adams.data.io.input Modifier and Type Interface Description interfaceDataContainerReader<T extends DataContainer>Interface for readers that read files in various formats and turn them into data containers.interfaceStreamableBinaryDataContainerReader<T extends DataContainer>Indicator interface forStreamableDataContainerReaderclasses that use binary data.interfaceStreamableDataContainerReader<T extends DataContainer>Interface forDataContainerReaderreaders that can read fromInputStreams.interfaceStreamableTextBasedDataContainerReader<T extends DataContainer>Indicator interface forStreamableDataContainerReaderclasses that use text-based data.Classes in adams.data.io.input that implement AdditionalInformationHandler Modifier and Type Class Description classAbstractDataContainerReader<T extends DataContainer>Abstract ancestor for readers that read files in various formats and turn them into data containers.classAbstractExcelSpreadSheetReader<T extends Range>Ancestor for special Excel readers.classAbstractMultiSheetSpreadSheetReader<T extends Range>Ancestor for spreadsheet readers that can read multiple sheets from a document in one go.classAbstractMultiSheetSpreadSheetReaderWithMissingValueSupport<T extends Range>Ancestor for spreadsheet readers that allow the specification of a custom missing value string.classAbstractSpreadSheetReaderAncestor for classes that can read spreadsheets.classAbstractSpreadSheetReaderWithMissingValueSupportAncestor for spreadsheet readers that allow the specification of a custom missing value string.classAbstractTimeseriesReaderAncestor for timeseries readers.classAbstractWekaSpreadSheetReaderAncestor for WEKA file format readers.classAccessSpreadSheetReaderAllows the reading of MS Access databases.classArffSpreadSheetReaderReads WEKA datasets in ARFF format and turns them into spreadsheets.classAutoWidthTabularSpreadSheetReaderReads simple tabular text files, using column widths as defined by the header row.classCsvSpreadSheetReaderReads CSV files.
It is possible to force columns to be text.classExcelSpreadSheetReaderReads MS Excel files (using DOM).classExcelStreamingSpreadSheetReaderReads large MS Excel XML files (using streaming via SAX).
Increasing the debug level to more than 1 results in outputting detailed information on cells.classFastCsvSpreadSheetReaderSimplified CSV spreadsheet reader for loading large files.classFixedTabularSpreadSheetReaderReads simple tabular text files with fixed column widths, as used by dot matrix printers in days gone by.classGnumericSpreadSheetReaderReads Gnumeric workbook files (GZIP compressed or uncompressed XML), version 1.10.13.classInstanceReaderReads WEKA datasets in various formats.classJSONSpreadSheetReaderReads WEKA datasets in JSON format and turns them into spreadsheets.classLibSVMSpreadSheetReaderReads WEKA datasets in LibSVM format and turns them into spreadsheets.classMat5SpreadSheetReaderReads Matlab .mat files (format 5)
classMatlabSpreadSheetReaderReads WEKA datasets in ARFF format and turns them into spreadsheets.classODFSpreadSheetReaderReads ODF (Open Document Format) spreadsheet files.
If a row contains only empty cells, this is interpreted as the end of the sheet.classPNGSpreadSheetReaderReads PNGs as spreadsheet, e.g., for reading indexed PNGs.classPropertiesSpreadSheetReaderTurns Java properties files into spreadsheets with two columns: Key and Value.classSimpleArffSpreadSheetReaderSimple reader for Weka ARFF files, only supports NUMERIC, NOMINAL, STRING and DATE attributes.classSimpleCsvSpreadSheetReaderReads CSV files.
It is possible to force columns to be text.classSimpleStreamSpreadSheetReaderReads file in simple stream format:
- one spreadsheet row per line in the output
- cells are separated by TAB
- cell format: '<1-based index>:<content-type ID>:<content>'
NB: tabs, new lines etc in the content get backquoted.classSimpleTimeseriesReaderReader for the simple timeseries data format, CSV-like with preceding comments.classSpreadSheetTimeseriesReaderReads timeseries containers from columns of a spreadsheet.
A new container is started, whenever the value of the ID column changes (hence you need to ensure that the data is ordered on this column).
However, it is not required to have an ID column present.classSqlDumpSpreadSheetReaderReads in SQL dump files.classSVMLightSpreadSheetReaderReads WEKA datasets in ARFF format and turns them into spreadsheets.classTsvSpreadSheetReaderReads TSV (tab-separated values) files.
It is possible to force columns to be text.classXrffSpreadSheetReaderReads WEKA datasets in ARFF format and turns them into spreadsheets. -
Uses of AdditionalInformationHandler in adams.data.io.output
Subinterfaces of AdditionalInformationHandler in adams.data.io.output Modifier and Type Interface Description interfaceDataContainerWriter<T extends DataContainer>Interface for writers that write data containers to files in various formats.interfaceStreamableBinaryDataContainerWriter<T extends DataContainer>Indicator interface forStreamableDataContainerWriterclasses that use binary data.interfaceStreamableDataContainerWriter<T extends DataContainer>Interface forDataContainerWriterclasses that can write toOutputStreams.interfaceStreamableTextBasedDataContainerWriter<T extends DataContainer>Indicator interface forStreamableDataContainerWriterclasses that use text-based data.Classes in adams.data.io.output that implement AdditionalInformationHandler Modifier and Type Class Description classAbstractDataContainerWriter<T extends DataContainer>Abstract ancestor for writers that write data containers to files in various formats.classAbstractFormattedSpreadSheetWriterAncestor for writers that format the numbers.classAbstractMultiSheetFormattedSpreadSheetWriterAncestor for writers that format the numbers.classAbstractMultiSheetSpreadSheetWriterAncestor for spreadsheet writers that can write multiple sheets into a single document.classAbstractMultiSheetSpreadSheetWriterWithMissingValueSupportAncestor for spreadsheet writers that support missing values.classAbstractSpreadSheetWriterAncestor for classes that can write spreadsheet objects.classAbstractSpreadSheetWriterWithMissingValueSupportAncestor for spreadsheet writers that support a custom missing value string.classAbstractTimeseriesWriterAncestor for timeseries writers.classAbstractWekaSpreadSheetWriterAncestor for WEKA file format readers.classAccessSpreadSheetWriterWrites spreadsheet data to a MS Access database.classArffSpreadSheetWriterWrites a spreadsheet in ARFF file format.classAutoWidthTabularSpreadSheetWriterOutputs the spreadsheet in a simple tabular format with column widths to fit the content in each row.classCsvSpreadSheetWriterWrites CSV files.classExcelSpreadSheetWriterWrites MS Excel files.classExcelStreamingSpreadSheetWriterWrites OOXML MS Excel files in streaming mode (more memory efficient).classFixedTabularSpreadSheetWriterOutputs the spreadsheet in a simple tabular format with fixed column width, as used by dot matrix printers in days gone by.classGnumericSpreadSheetWriterWrites Gnumeric workbook files (GZIP compressed or uncompressed XML), version 1.10.13.classJSONSpreadSheetWriterWrites a spreadsheet in JSON file format.classLibSVMSpreadSheetWriterWrites a spreadsheet in LibSVM file format.classMat5SpreadSheetWriterWrites Matlab .mat files (format 5)
classMatlabSpreadSheetWriterWrites a spreadsheet in ARFF file format.classODFSpreadSheetWriterWrites ODF (Open Document Format) spreadsheet files.classPropertiesSpreadSheetWriterOutputs two columns (key and value) from a spreadsheet as Java properties file.classSimpleArffSpreadSheetWriterSimple writer for Weka ARFF files, only supports NUMERIC, NOMINAL, STRING and DATE attributes.classSimpleStreamSpreadSheetWriterSimple stream format for spreadsheets:
- one spreadsheet row per line in the output
- cells are separated by TAB
- cell format: '<1-based index>:<content-type ID>:<content>'
NB: tabs, new lines etc in the content get backquoted.classSimpleTimeseriesWriterWriter for the simply timeseries format, CSV-like with preceding comments.classSpreadSheetTimeseriesWriterWrites timeseries data using a spreadsheet writer.classSqlDumpSpreadSheetWriterGenerates an SQL dump from the spreadsheet, which can be imported into a database.classSVMLightSpreadSheetWriterWrites a spreadsheet in SVMLight file format.classTsvSpreadSheetWriterWrites TSV (tab-separated values) files,
classXrffSpreadSheetWriterWrites a spreadsheet in XRFF file format. -
Uses of AdditionalInformationHandler in adams.data.statistics
Classes in adams.data.statistics that implement AdditionalInformationHandler Modifier and Type Class Description classAbstractArrayDistance<T extends Number>Ancestor for distance measures.classAbstractArrayStatistic<T extends Serializable>Ancestor for classes that calculate statistics from arrays.classAbstractOptionalSampleArrayStatistic<T extends Serializable>Abstract super class for array statistics that can interprete the arrays either as samples or populations.classArrayAndrewsCurves<T extends Number>Generates Andrews Curves from array data.
César Ignacio GarcÃa Osorio, Colin Fyfe (2003).classArrayAngle<T extends Number>Calculates the angle between the first array and the remaining arrays.classArrayBinning<T extends Number>Bins the data from given array using the specified algorithm and post-processing approach.classArrayChebyshevDistanceCalculates the Chebyshev distance between the first array and the remaining arrays.classArrayCorrelationCoefficient<T extends Number>Calculates the correlation coefficient between the first array and the remaining arrays.classArrayCosineSimilarity<T extends Number>Calculates the cosine similarity between the first array and the remaining arrays.classArrayCovariance<T extends Number>Calculates the covariance between the first array and the remaining arrays.classArrayDifference<T extends Number>Calculates the difference between the arrays.classArrayEuclideanDistanceCalculates the Euclidean distance between the first array and the remaining arrays.classArrayHistogram<T extends Number>Generates a histogram from the given array.
The formulas for the various width/#bin calculations can be found here:
WikiPedia (2010).classArrayKendallTheil<T extends Number>Calculates the Kendall-Theil robust slope (also called Theil-Sen estimator) between the first array and the remaining arrays.classArrayLength<T extends Serializable>Determines the length of an array.classArrayLinearRegression<T extends Number>Calculates the slope and intercept of linear regression between two arrays (x and y).
If more than two arrays supplied, then the linear regression is computed between the first (x) and all the other ones (y).classArrayManhattanDistanceCalculates the Manhattan distance between the first array and the remaining arrays.classArrayMax<T extends Number>Determines the max value in a numeric array.classArrayMean<T extends Number>Calculates the mean for a numeric array.classArrayMeanAbsoluteError<T extends Number>Calculates the mean absolute error (MAE) between the first array (actual) and the remaining arrays (predicted).classArrayMedian<T extends Number>Calculates the median for a numeric array.classArrayMin<T extends Number>Determines the min value in a numeric array.classArrayMinkowskiDistanceCalculates the Minkowski distance between the first array and the remaining arrays.classArrayNormalize<T extends Number>Normalizes the array(s), i.e., the sum of its/their values is 1.0.classArrayNormalizeRange<T extends Number>Normalizes the array(s) to the specified lower and upper bound.classArrayPercentile<T extends Number>Determines the percentile for an array.classArrayRelativeAbsoluteError<T extends Number>Calculates the relative absolute error (RAE) between the first array (actual) and the remaining arrays (predicted).classArrayRootMeanSquaredError<T extends Number>Calculates the root mean squared error (RMSE) between the first array (actual) and the remaining arrays (predicted).classArrayRootRelativeSquaredError<T extends Number>Calculates the root relative squared error (RRSE) between the first array (actual) and the remaining arrays (predicted).classArrayRSquared<T extends Number>Calculates the R^2 between the first array and the remaining arrays.classArrayStandardDeviation<T extends Number>Calculates the standard deviation for a numeric array.classArrayStandardize<T extends Number>Standardizes the values in the array(s) to have mean 0 and stdev 1.classArrayStandardScores<T extends Number>Calculates the standard scores (or z scores) of the provided arrays.The arrays must be numeric, of course.classArraySum<T extends Number>Determines the sum of all values in a numeric array.classMultiArrayStatistic<T extends Number>Merges the spreadsheets generated by its sub-statistics into a single one. -
Uses of AdditionalInformationHandler in adams.flow.control
Subinterfaces of AdditionalInformationHandler in adams.flow.control Modifier and Type Interface Description interfaceAtomicExecutionInterface for actors that can be configured to finish execution first before attempting to be stopped.interfaceFlowStructureModifierInterface for actors that modify the flow structure somehow.interfaceLocalScopeHandlerInterface for actor handlers that provide a local scope for their sub-actors.interfaceScopeHandlerFor actors that define a scope like theFloworLocalScopeTriggeractor.interfaceStorageHandlerInterface for actors that allow the storing of temporary data.Classes in adams.flow.control that implement AdditionalInformationHandler Modifier and Type Class Description classAbstractConnectedControlActorAncestor for all actors that control (connected) sub-actors in some way.classAbstractContainerUpdaterAncestor for control actors that update a specific value of a container using the defined sub-actors.classAbstractControlActorAncestor for all actors that control sub-actors in some way.classAbstractDataContainerFileChecker<T extends DataContainer>Abstract ancestor for transformers that check data container files whether they are consistents before passing on the file/file arrays.classAbstractDirectedControlActorAncestor for all actors that control sub-actors in some way.classAbstractTeeAbstract ancestor for actors that tee-off tokens.classArrayGenerateApplies all sub-actors to the input token and generates an array from the collected output.
Each of the branches is expected to produce at most one output token (ideally one per branch, otherwise there will be null elements in the output array).classArrayProcessApplies all sub-actors to each of the array elements.classBlockBlocks the propagation of tokens if the condition evaluates to 'true', therefore acts like the 'continue' control statement.
In case of integer or double tokens that arrive at the input, these can be accessed in the expression via 'X'.
The following grammar is used for evaluating the boolean expressions (depends on the selected condition):
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr !classBranchBranches off the flow into several sub-branches, each being supplied with a copy of the same object being passed into this meta-actor.classBreakpointAllows to pause the execution of the flow when this actor is reached and the condition evaluates to 'true'.classCallableActorScreenshotTakes a screenshot of a callable actor whenever a token passes through.
The screenshot can either be written to disk (and the input token is forwarded), or the screenshot is forwarded as adams.data.image.BufferedImageContainer (dropping the input token).classCastCasts the incoming data to the specified classname.classClearCallableDisplayClears the referenced callable graphical actor whenever a token passes through.classCloseCallableDisplayCloses the referenced callable graphical actor whenever a token passes through.classCollectionProcessApplies all sub-actors to each of the collection elements.classConditionalSequenceThe sequence gets only executed if the condition holds true.classConditionalSubProcessEncapsulates a sequence of flow items.classConditionalTeeTees off the tokens if the condition evaluates to 'true'.classConditionalTriggerExecutes the tee-actor whenever a token gets passed through.classContainerValuePickerPicks a named value from any container object and tees it off.
With the 'switch-outputs' option it is possible to forward the named value and teeing off the container instead.
If 'ignore missing' is turned off, any value that cannot be found will generate an error logging message and, in case of switched outputs, an actual error.classCountCounts the number of tokens that pass through and meet the condition and tees off the current count every n-th token.classDesktopScreenshotTakes a screenshot of the desktop whenever a token passes through.classFileProcessorclassFlowContainer object for actors, used for executing a flow.classForceFlushForces all actors that implement adams.flow.core.FlushSupporter
See also:
adams.flow.sink.DumpFile
Input/output:
- accepts:
adams.flow.core.Unknown
- generates:
adams.flow.core.Unknown
classFreeMemoryAttempts to free up memory of the sub-flow that it belongs to.
This actor is useful in case when sub-flows are only executed once, but still keep their data-structures and gobble up unnecessary memory.classGCCalls the garbage collector.classHeapDumpGenerates a heapdump and saves it to the specified file (with .hprof extension) whenever a token passes through.classIfStorageValueAn If-Then-Else source actor for storage values.classIfThenElseEmulates an If-Then-Else construct.classInjectorInjects a string token into the token sequence.
The string can be inject before or after the current token.classInputOutputListenerListens to the input/output tokens of the sub-actors, sending them to callable actors.classInspectAllows the user to inspect tokens with the specified viewer.
Inspection can be done interactively, allowing the user to drop tokens, or non-interactively, with the viewer updating whenever a token passes through.
Of course, this actor should only be used during development for debugging purposes as can slow down the execution significantly depending on how expensive the view generation is.classJDepsRuns jdeps on the classname arriving at the input.
The application's classpath is automatically added to the command-line if no classpath directories or jars are provided.
Classpath directories and jars get combined, but directories take precedence over jars.classJMapRuns jmap whenever a token gets passed through.classLaunchTeeLaunches the sub-flow in a separate thread each time a token arrives.
Internally, a adams.flow.control.LocalScopeTee is used to manage the scope and forward the token.
However, when imposing thread limits, a job gets created with the sub-actors and placed into a job runner for execution.classLaunchTriggerLaunches the sub-flow in a separate thread each time a token arrives.
Internally, a adams.flow.control.LocalScopeTrigger is used to manage the scope.
However, when imposing thread limits, a job gets created with the sub-actors and placed into a job runner for execution.classLoadBalancerRuns the specified 'load actor' in as many separate threads as specified with the 'num-threads' parameter.
Always uses a copy of the variables.
NB: no callable transformer or sink allowed.classLocalScopeSubProcessProvides a local scope for the sub-actors.
It is possible to 'propagate' or 'leak' variables and storage items from within the local scope back to the output scope.classLocalScopeTeeExecutes the sub-actors whenever a token gets passed through, just like the adams.flow.control.Tee actor, but also provides its own scope for variables and internal storage.
It is possible to 'propagate' or 'leak' variables and storage items from within the local scope back to the output scope.classLocalScopeTransformerProvides a local scope for the sub-actors.
It is possible to 'propagate' or 'leak' variables and storage items from within the local scope back to the output scope.classLocalScopeTriggerExecutes the sub-actors whenever a token gets passed through, just like the adams.flow.control.Trigger actor, but also provides its own scope for variables and internal storage.
It is possible to 'propagate' or 'leak' variables and storage items from within the local scope back to the output scope.classMissionControlDisplays a control panel for pausing/resuming/stopping the flow.
Useful when executing flows from command-line with the flow runner, offering a minimal control interface.classMutableConnectedControlActorAbstract superclass for actors that allow their sub-actors to modified (adding, removing, editing).classMutableControlActorAbstract superclass for actors that allow their sub-actors to modified (adding, removing, editing).classOnceTees off a token only once to its sub-actors.
However, this can be reset when the monitored variable changes.classPlotContainerUpdaterApplies all sub-actors to process either the selected value of the plot container.classPlotProcessorApplies the specified processing algorithm to the stream of plot containers passing through.classRaiseErrorRaises a java.lang.Error if the condition evaluates to 'true', using the provided error message.
See also:
adams.flow.control.TryCatch
Input/output:
- accepts:
adams.flow.core.Unknown
- generates:
adams.flow.core.Unknown
classRejectorRejects data containers with errors attached.classRemoteExecutionTriggerTransfers the actors below itself, the specified storage items and variables using the specified connection for remote execution.
Uses the adams.scripting.command.flow.RemoteFlowExecution remote command behind the scenes.classRemoveOutliersAllows the user to interactively remove outliers.
You can toggle the 'outlier' state of individual points by left-clicking them.
You can also toggle whole regions by selecting a polygon around them: use SHIFT+left-click to place vertices and SHIFT+right-click to finish the polygon.classSequenceEncapsulates a sequence of flow items.classSetContainerValueUpdates a single item in the container passing through, using either the data obtained from a callable actor or a storage item.
Using the 'force' option, additional meta-data can be stored in the container as well.classSinkResetResets all sub-actors in case the monitored variable changed since the last execution.classSleepWaits for a fixed amount of milliseconds.classSourceResetResets all sub-actors in case the monitored variable changed since the last execution.classStopStops the execution of the flow when triggered.classStorageValueSequenceAfter executing a sequence of actors, the stored item is forwarded in the flow.classSubProcessEncapsulates a sequence of flow items.classSwitchEmulates a Switch control statement.classTeeAllows to tap into the flow and tee-off tokens.classTimedSubProcessEncapsulates a sequence of flow items.classTimedTeeAllows to tap into the flow and tee-off tokens.
Times how long the sub-flow execution takes and sends the time in milli-seconds (as double) in a adams.flow.container.TimingContainer container to the specified callable actor.classTimedTriggerExecutes the subs-actors whenever a token gets passed through.classTransformerResetResets all sub-actors in case the monitored variable changed since the last execution.classTriggerExecutes the tee-actor whenever a token gets passed through.classTriggerEventTriggers the specified event.classTriggerOnceTriggers the sub-flow only once.
However, this can be reset when the monitored variable changes.classTryCatchSafe-guards the execution of the 'try' sequence of actors.classUpdateCallableDisplayUpdates callable display actors that implement adams.flow.core.DataPlotUpdaterHandler.classUpdateContainerValueApplies all sub-actors to process the specified value of the container passing through.classUpdatePropertiesUpdates the properties of the sub-actor using the values associated with the specfiied variables.classWhileLoopEmulates a while-loop. -
Uses of AdditionalInformationHandler in adams.flow.core
Subinterfaces of AdditionalInformationHandler in adams.flow.core Modifier and Type Interface Description interfaceActorInterface for actors.interfaceActorHandlerFor actors that handle "sub-actors".interfaceActorReferenceHandlerInterface for actors that manage callable actors.interfaceActorWithConditionalEquivalentActors that have an conditional equivalent, i.e., one that implementsBooleanConditionSupporter.interfaceActorWithTimedEquivalentActors that have a timed equivalent, i.e., one that implementsTimedActor.interfaceArrayProviderFor actors that can output the items either as an array or one-by-one.interfaceAutogeneratedActorIndicator interface for actors that have been automatically generated.interfaceAutomatableInteractiveActorInterface for actors that interact with the user, but can also be automated, e.g., for testing purposes.interfaceAutoStartSupporterInterface for actors that support "auto-start" functionality.interfaceConnectionHandlerFor actors that handle "sub-actors" that are connected.interfaceControlActorIndicator interface for control actors.interfaceDaemonEventIndicator interface for events that run in the background and will get executed when the Events actor gets executed.interfaceDataInfoActorIndicator interface for actors that produce information on data structures.interfaceDisplayTypeSupporterInterface for actors that allow how their graphical output is being displayed.interfaceDryRunSupporterInterface for actors that support dry runs.interfaceDynamicInitializerInterface for actors that can be initialized at runtime and files may not be present at startup time.interfaceDynamicModelLoaderSupporterInterface for classes that support model loading.interfaceErrorScopeRestrictorInterface for actors that restrict the error scope.interfaceEventIndicator interface for actors that can be used with the Events standalone.interfaceFixedNameActorHandlerInterface for actor handlers that use fixed names for their sub-actors, e.g., IfThenElse.interfaceFlowControlButtonsSupporterInterfaces for actors that can display flow control button(s).interfaceFlowControlSubMenuSupporterInterfaces for actors that can display a flow control sub-menu.interfaceFlushableInterface for actors that can be flushed, i.e., the execution stopped without actually stopping the actor.interfaceFlushSupporterInterface for actors that can be flushed.interfaceHeadlessExecutionSupporterInterface for actors that indicate whether they support headless execution.interfaceInactiveActorIndicator interface for actors that have been "put to sleep".interfaceInputConsumerInterface for flow actors that can process input tokens.interfaceInteractiveActorInterface for actors that interact with the user.interfaceInteractiveActorWithCustomParentComponentInterface for interactive actors that allow the selection of a custom parent component using a callable actor; instead of just using the outer dialog/frame.interfaceKeyManagerFactoryProviderInterface for actors that provide an instance to aKeyManagerFactory.interfaceLazySetupSupporterInterface for actors that optionally perform aActor.setUp()call first time they get executed.interfaceMutableActorHandlerInterface for actors that allow to add/remove sub-actors as well.interfaceOptionalOneTimeInitializerInterface for actors that can be fixed to be only initialized once.interfaceOptionalPasswordPromptInterface for actors that prompt the user to enter a password in case no password currently provided.interfaceOptionalStopRestrictorInterface for stop restrictors that can turn on/off stop restrictions.interfaceOutputProducerInterface for flow actors that generate output.interfacePauseStateHandlerInterface for actors that manage the pause state in some sense.interfacePropertiesUpdaterInterface for actors that update one or more properties of a Java object using variables.interfaceRemoteExecutionHandlerInterface for actors that manage remote execution.interfaceRestorableActorInterface for actors that can save their state to disk and restore it again next time they are run.interfaceSortableActorHandlerInterface for actor handlers that can sort their child actors.interfaceSSLContextProviderInterface for actors that provide access to an instance ofSSLContext.interfaceStopModeSupporterInterface for actors that support a specific stop mode.interfaceStopRestrictorInterface for actors that can limit the scope of theStopcontrol actor or other actors that can stop the execution.interfaceSubFlowWrapUpInterface for actors that can wrap-up (i.e., save memory) their sub-actors and, if need be, re-initialize again.interfaceTimedActorInterface for actors that time their execution and send the timing data to a callable actor.interfaceTokenEventHandlerInterface for actors that supportTokenEvents and handleTokenListeners.interfaceTriggerableEventIndicator interface for events that can be triggered with the TriggerEvent actor.interfaceTrustManagerFactoryProviderInterface for actors that provide an instance to aTrustManagerFactory.interfaceWeakExternalActorIndicator interface for weak external actor handlers, which are only used at design time and deactivated at runtime.Classes in adams.flow.core that implement AdditionalInformationHandler Modifier and Type Class Description classAbstractActorAbstract base class for actors.classAbstractBaseExternalActorAncestor of actors that load another actor from disk and execute it.classAbstractCallableActorAbstract ancestor for all actors that access callable actors.classAbstractCallableActorPropertyUpdaterAbstract ancestor for actors that manipulate properties of callable actors, e.g., WEKA classes.classAbstractCopyCallableActorAncestor for actors that use a copy of a callable actor.classAbstractDisplayAncestor for actors that display stuff.classAbstractExternalActorAncestor of actors that load another actor from disk and execute it.classAbstractGroovyActorAbstract ancestor for actors that execute Groovy scripts.classAbstractIncludeExternalActorAncestor for actors that get replaced with the externally stored actor.classAbstractPropertyUpdaterAbstract ancestor for actors that manipulate properties of objects.classAbstractScriptedActorAbstract ancestor for actors that execute external scripts.classAbstractScriptingHandlerActorAbstract ancestor for actors that execute external scripts using a scripting handler.classAbstractTemplateAbstract ancestor for all actors that use a template to generate the actual actor/sub-flow to be executed. -
Uses of AdditionalInformationHandler in adams.flow.sink
Subinterfaces of AdditionalInformationHandler in adams.flow.sink Modifier and Type Interface Description interfaceDisplayPanelProviderInterface for graphical sinks that can also generate a panel from scratch for a new token.Classes in adams.flow.sink that implement AdditionalInformationHandler Modifier and Type Class Description classAbstractAppendableFileWriterAncestor for file writers that allow appending to the file instead of just replacing any existing files.classAbstractDbSinkAncestor for sinks that use the database.classAbstractDisplayAncestor for actors that display stuff.classAbstractFileWriterAncestor for sinks that write to output files.classAbstractGraphicalDisplayAncestor for actors that display stuff.classAbstractGraphicsGeneratorAncestor for actors that generate graphics of some kind.classAbstractScriptAncestor for sink script actors.classAbstractSinkAncestor for all flow items that function as sink.classAbstractTextualDisplayAncestor for actors that display textual stuff.classAbstractWekaModelWriterAncestor for actors that serialize models.classActualVsPredictedPlotPlots actual vs predicted columns obtained from a spreadsheet.classArrayDisplayDisplays the array elements in a single panel.classAutogeneratedSinkEncapsulates a sequence of auto-generated actors.
Can be removed with the adams.flow.processor.RemoveAutogeneratedActors processor.classBinaryFileWriterWrites a byte array or adams.data.blob.BlobContainer to a binary file.classBoxPlot* Actor for displaying box plots.
*
* For more information, see:
* http://en.wikipedia.org/wiki/Box_plot *
Valid options are:classBrowserDisplays a URL in a webbrowser.
By default, the system's default browser is used.classCallableSinkLets a callable sink consume the input tokens.classCanvasGeneral purpose drawing canvas.classCloseArchiveFinalizes the archive.
See also:
adams.flow.source.NewArchive
adams.flow.transformer.AppendArchive
Input/output:
- accepts:
adams.core.io.ArchiveManager
classCloseInputStreamCloses the incoming input stream instance.
See also:
adams.flow.source.InputStreamGenerator
Input/output:
- accepts:
java.io.InputStream
classCloseReaderCloses the incoming reader instance.
See also:
adams.flow.source.ReaderGenerator
Input/output:
- accepts:
java.io.Reader
classConsoleNon-graphical actor that outputs any object that arrives at its input port via the 'toString()' method on stdout.classContainerDisplayActor for displaying a spreadsheet.classControlChartPlotActor for generating control chart plots.
The plot needs to be initialized with a class adams.flow.container.ControlChartContainer.classCopyCallableSinkCopies a callable sink to consume the tokens.classDisplayActor that outputs any object that arrives at its input port via the 'toString()' method.classDisplayPanelGridSink that places a panel in the grid for each each arriving token.
Uses the user-defined panel provider for creating the panels.classDisplayPanelManagerActor that displays a 'history' of panels created by the selected panel provider.classDOMDisplayDisplays a DOM node object as tree structure.classDownloadFileDownloads a file from a URL and saves it locally.
Also handles basic authentication when using URLs like this:
http://user:pass@domain.com/url
Input/output:
- accepts:
java.lang.String
java.net.URL
classDumpFileActor that just dumps any input token into a separate line of the specified output file.classEmailFileWriterActor that writes Email objects to files.classEmailViewerActor for displaying an email object.classEnQueueEnqueues the incoming data in the specified queue in internal storage.classExecPipes the incoming data, after converting it using the provided conversion scheme, into the started process.classExternalSinkSink that executes an external sink actor stored on disk.classFileBrowserDisplays the file or directory with the system's file browser.classFilePreviewActor for previewing file contents.classFlowDisplayDisplays an actor or flow.classFlowFileWriterWrites the incoming actor(s) to a file.
A custom flow writer can be specified.classFourInOneDisplayActor for displaying a four-in-one plot.classGroovyA sink that uses a Groovy script for processing the token(s).classHistogramGenerates a histogram based on the incoming data.classHistoryDisplayActor that outputs any object that arrives at its input port via the 'toString()' method in a separate 'history' entry.classHtml4DisplayViewer for HTML 4.classImageFileWriterWrites the image to disk using the specified writer.classImageHistogramDisplays a histogram of a gray image or histograms per channel for color image.classImageSegmentationFileWriterWrite image segmentation containers using the specified writer.classImageSegmentationViewerDisplays image segmentation containers.classImageViewerActor for displaying an image.classInactiveSinkEncapsulates a sequence of inactive actors.
Can be removed with the adams.flow.processor.ReactivateActors processor.classIncludeExternalSinkIncludes an external sink.classIndexedSplitsRunsWriterReads indexed splits runs from disk using the specified writer.classInformationDialogDisplays the incoming message in a message box.classJavaLoggingUses the Java logging framework to output the incoming data.
Simply uses an object's 'toString()' method.classJFreeChartFileWriterGenerates a JFreeChart plot and writes the bitmap to a file.
Dataset generation is skipped if the incoming data already represents a JFreeChart dataset.classJFreeChartPlotGenerates and displays a plot using JFreeChart.Dataset generation is skipped if the incoming data already represents a JFreeChart dataset.classJsonDisplayDisplays a JSON object as tree structure.classJsonFileWriterWrites a JSON object/array to a file.classLargeObjectDbWriterAllows storing large objects in a SQL database.classLogDumperActor that stores LogEntry objects in a file (CSV format).classLoggerActor that stores LogEntry objects in the Log table.classLogViewerActor that displays LogEntry objects, but doesn't store them in the database.classMat5FileWriterWrites the Mat5File object to the specified file.classMatrixPlotActor for displaying a matrix of scatter plots
Valid options are:classMenuItemLaunches a menu item from the main menu.classMergeFilesCombines the incoming files in a single one.classNotesWriterSaves the notes attached to a data structure to a text file.classNullActor that gobbles up all tokens, like '/dev/null' in Unix.classObjectPreviewActor for previewing file contents.classObjectViewerAllows to inspect any object using ADAMS' inspection capabilities.classOpenFileOpens the incoming file with the appropriate platform-specific application.
Does nothing in a headless (non-graphical) environment.classPasteFilesGenerates a single file from combined lines from the input files.classPDFCloseDocumentCloses the incoming PDF document, writing out its content.
The PDF document can be generated with adams.flow.source.PDFNewDocument and appended using adams.flow.transformer.PDFAppendDocument.
See also:
adams.flow.source.PDFNewDocument
adams.flow.transformer.PDFAppendDocument
Input/output:
- accepts:
adams.flow.transformer.pdfproclet.PDFGenerator
classPDFViewerActor for displaying PDF files.classPlotContainerSinkActor that outputs the plot containers in various formats.classProbabilityPlotDisplayActor for displaying a probability plot
Valid options are:classProgrammaticSinkFor programmatically hooking into a flow and receive tokens.classProgressBarDisplays a progress bar.classProgressConsoleOutputs progress information in the console.classPropertiesDisplayDisplays a Properties object as table.classPropertiesFileWriterWrites a Java properties object to a file.classPublishPublishes the incoming data using the specified publish/subscribe handler in storage.classRemoteCommandWriterSends a command to the remote host defined by the connection settings.
Unsuccessful commands can be store on disk to retry later.classReportDisplayDisplays reports.classScatterDisplayActor for displaying a scatter plot of one attribute vs another.classScreenshotActor that takes screenshots of graphical components.classScriptedA sink that uses an exterrnal script for processing the token(s).classSendEmailActor for sending emails.classSendNotificationSends the incoming message string via the configured notification scheme.classSendRemoteCommandSends a command to the remote host defined by the connection settings.
Unsuccessful commands can be store on disk to retry later.classSequencePlotterActor that plots sequences over time.
See also:
adams.flow.sink.SimplePlot
Input/output:
- accepts:
adams.flow.container.SequencePlotterContainer
adams.flow.container.SequencePlotterContainer[]
Container information:
- adams.flow.container.SequencePlotterContainer: PlotName, X, Y, Content type, Error X, Error Y, MetaData
classSerializeSaves a Java object to a file using the specified object writer.classSideBySideDiffActor for displaying a side-by-side diff.classSimpleLoggingTurns the incoming objects into strings, formats them with the selected formatter and then outputs them with the specified output(s).classSimplePlotActor for generating simple plots.
See also:
adams.flow.sink.SequencePlotter
Input/output:
- accepts:
adams.flow.container.SequencePlotterContainer
adams.flow.container.SequencePlotterContainer[]
Container information:
- adams.flow.container.SequencePlotterContainer: PlotName, X, Y, Content type, Error X, Error Y, MetaData
classSocketJust outputs the data to the specified socket.
Any incoming data that isn't a byte array gets converted to a string and its bytes (using the specified encoding) are then transmitted.
See also:
adams.flow.source.Socket
Input/output:
- accepts:
java.lang.Object
byte[]
java.lang.Byte[]
classSpreadSheetDbWriterTransfers a SpreadSheet object into a database.classSpreadSheetDisplayActor for displaying a spreadsheet.
Custom background for negative/positive values can be specified as well.classSpreadSheetFileWriterActor that writes SpreadSheet objects to files.classSpreadSheetRowViewerActor for displaying spreadsheet rows in a graphical way, like the 'Spreadsheet Explorer' tool.classStringTreeGenerates a tree from the strings arriving at the input, splitting them into parts using the specified separator.classTemplateSinkLets a sink generated from a template consume the input tokens.classTextWriterWrites incoming textual data to a text file.classTimeseriesDisplayActor that displays timeseries.classWebSocketClientSends the incoming data to a websocket server and forwards the received data.classWekaAttributeSummaryDisplays an attribute summary.classWekaClassifierErrorsActor for displaying classifier errors.classWekaCostBenefitAnalysisActor for displaying a cost benefit analysis dialog.classWekaCostCurveActor for displaying a cost curve.classWekaDatabaseWriterActor for saving a weka.core.Instances object in a database.
The relation name of the incoming dataset can be used to replace the current filename (path and extension are kept).classWekaExperimentFileWriterSaves an experiment file.classWekaExperimentGeneratorGenerates an experiment setup that can be used in conjunction with the Experiment transformer actor.classWekaFileWriterActor for saving a weka.core.Instances object as file.
The relation name of the incoming dataset can be used to replace the current filename (path and extension are kept).classWekaGraphVisualizerDisplays BayesNet graphs in XML or BIF notation
Either displays the contents of a file or an object that implements weka.core.Drawable and generates a BayesNet graph.classWekaInstancesDisplayActor for displaying a weka.core.Instances object in table format.classWekaInstancesPlotActor for plotting one attribute vs another.classWekaInstanceViewerActor for displaying adams.data.instance.Instance objects in a graphical way (using the internal format), like the 'Instance Explorer' tool.classWekaMarginCurveActor for displaying margin errors.classWekaModelWriterActor for saving a model (classifier or clusterer) alongside an optional header (i.e., weka.core.Instances object) as file.classWekaThresholdCurveActor for displaying threshold curves, like ROC or precision/recall.classWekaTreeVisualizerDisplays trees in dot notation.classXChartFileWriterGenerates an XChart plot and writes the bitmap to a file.
Dataset generation is skipped if the incoming data already represents a XChart dataset.classXChartPlotGenerates and displays a plot using XChart.Dataset generation is skipped if the incoming data already represents a XChart dataset.classXMLFileWriterWrites a org.w3c.dom.Document to an XML file.
In case of org.w3c.dom.Node objects, the owning document is written to disk.classYamlFileWriterWrites a Map object to a YAML file.
http://yaml.org/
Input/output:
- accepts:
java.util.Map
java.util.List
classZScoreDisplayActor for displaying a z score plot
Valid options are: -
Uses of AdditionalInformationHandler in adams.flow.source
Subinterfaces of AdditionalInformationHandler in adams.flow.source Modifier and Type Interface Description interfaceConditionalIdSupplierInterface for ID suppliers that use a conditions object.Classes in adams.flow.source that implement AdditionalInformationHandler Modifier and Type Class Description classAbstractArrayProviderAncestor for source actors that can output items one by one or as a single array.classAbstractBufferingSourceAncestor for queues that need to buffer output from eg another process.classAbstractConditionalIdSupplierAbstract ancestor for ID suppliers that use a conditions object.classAbstractDatabaseIdSupplierAbstract ancestor for ID suppliers.classAbstractDatabaseMetaDataAncestor for sources that output the database meta-data.classAbstractDbArrayProviderAncestor for array providers that use the database.classAbstractDbSourceAncestor for sources that access the database..classAbstractForLoopAbstract ancestor for for-loops.classAbstractIdSupplierAbstract ancestor for ID suppliers.classAbstractInstrumentSupplierAbstract ancestor for instrument suppliers.classAbstractInteractiveArrayProviderAncestor for interactive sources that can provide the output as an array or one-by-one.classAbstractInteractiveSourceAncestor for source actors that interact with the user.classAbstractListTablesAncestor for sources that list tables from a database.classAbstractPythonExecutionAncestor for sources that execute a Python executable.classAbstractScriptAncestor for source script actors.classAbstractSelectObjectsAncestor for sources that promp the user to select a number of objects to be broadcasted as tokens.classAbstractSimpleDbSourceAncestor for simple sources that use the database.classAbstractSimpleSourceAncestor for sources that just output a single token.classAbstractSimpleSourceWithPropertiesUpdatingAncestor for simple sources that allow changing the object's properties using variables.classAbstractSourceAncestor of all flow items that act as sources of tokens.classAbstractSpreadSheetDbReaderAncestor for spreadsheet database readers.classAbstractWekaSetupGenerator<T>Abstract ancestor for setup generator sources.classAutogeneratedSourceEncapsulates a sequence of auto-generated actors, with the last one generating the output for this meta-source.
Can be removed with the adams.flow.processor.RemoveAutogeneratedActors processor.classCallableSourceBroadcasts the generated output tokens from the source.classColorProviderUses the configured color provider to generate a number of colors.classCombineArraysCombines the storage items representing arrays into a single array.
When not supplying an array class the type of the first array is used.classCombineCollectionsclassCombineStorageOutputs the expanded string generated from the specified combination expression (variables and storage placeholders).classCombineVariablesOutputs the expanded string generated from the specified combination expression.classCommandRuns an external system command and broadcasts the generated output (stdout and/or stderr) continuously, opposed to adams.flow.source.Exec which waits for the command to finish.
See also:
adams.flow.source.Exec
Input/output:
- generates:
java.lang.String
classCopyCallableSourceBroadcasts the generated output tokens from the copied callable source.classCounterOutputs the specified counter as spreadsheet, with two columns: 'Key' and 'Count'.classCurrentFlowOutputs the current flow, i.e., itself.classCurrentTimeclassDatabaseConnectionValidclassDatabaseMetaDataOutputs the meta-data of the current database connection.classDeQueuePolls the specified queue in internal storage for an item, blocks till an item is available.
NB: The user needs to stop the flow as the DeQueue source will never stop, as it assumes that there will be more data coming through.classDirectoryListerReturns the contents of a directory (files/dirs).classDirectorySupplierSupplies directories.classDumpStorageOutputs the storage names and the string representation of their associated values in the specified format.classDumpVariablesOutputs the variable names and their associated values in the specified format.classEnterManyValuesPops up a dialog, prompting the user to enter one or more values.classEnterValuePops up a dialog, prompting the user to enter a value.classExecRuns an external system command and broadcasts the generated output (stdout or stderr).
See also:
adams.flow.source.Exec
Input/output:
- generates:
java.lang.String
classExternalSourceSource that executes an external source actor stored on disk.classFilenameGeneratorUses the specified filename generator to output a filename.
NB: Generators that require an object to pass through won't work with this source.
See also:
adams.flow.transformer.FilenameGenerator
Input/output:
- generates:
java.lang.String
classFileSupplierSupplies files.classFileSystemSearchUses the specified search algorithm to perform a file system search and returns the located items.classForLoopEmulates the following for-loop for integer IDs:
- positive step size:
for (int i = lower; i <= upper; i += step)
- negative step size:
for (int i = upper; i >= lower; i += step)
The integers can be output as a single array as well.classGetEnvironmentVariableOutputs the value of the specified environment variable.classGetSystemPropertyOutputs the value of the specified Java system property.classGroovyA source that uses a Groovy script for generating the token(s).classHashSetOutputs the specified hashset as spreadsheet, with one column called 'Value' by default.classHttpRequestSubmits the (optional) form parameters to the specified URL and forwards the retrieved HTML as text.
Cookies can be retrieved and stored in internal storage, to be re-used with the next request.classIdleSimulates an endless loop, which only exits if the flow is stopped.
Essentially blocking any following actors, never outputs anything.classIMAPOperationExecutes the specified IMAP operation and forwards the generated output.classInactiveSourceEncapsulates a sequence of flow items, with the last one generating the output for this meta-source.
Can be removed with the adams.flow.processor.ReactivateActors processor.classIncludeExternalSourceIncludes an external source.classInputStreamGeneratorUses the specified generator to instantiate an input stream instance.
See also:
adams.flow.sink.CloseInputStream
Input/output:
- generates:
java.io.InputStream
classIntegerRangeOutputs the integers defined by the range expression.classLargeObjectDbReaderAllows reading of large objects from a SQL database.classListCallableActorsclassListEnvironmentVariablesOutputs the names of the currently set environment variables.classListStorageNamesOutputs the names of the currently available storage items.classListSystemPropertiesOutputs the names of the currently set Java system properties.classListTablesLists tables of the current database connection.classListVariablesOutputs the names of the currently available variables.classLookUpForwards the value associated with the given key, using the specified lookup table from internal storage.classLookUpTableOutputs the specified lookup table as spreadsheet, containing to columns: Key with the keys and Value with the associated values.classMakeContainerAssembles a container with data obtained from either callable actors or storage items.classMathExpressionEvaluates a mathematical expression.
Variables are supported as well, e.g.: pow(X,@{exp}) with '@{exp}' being a variable available at execution time.
The following grammar is used for the expressions:
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr !classMemoryUsageOutputs the memory usage.
The generated map has the following keys:
- init_heap
- max_heap
- used_heap
- committed_heap
- init_non_heap
- max_non_heap
- used_non_heap
- committed_non_heap
Input/output:
- generates:
java.util.Map
classModuleInfoOutputs a spreadsheet with information about modules available.classNewArchiveInitializes the archive and forwards the data structure.
See also:
adams.flow.transformer.AppendArchive
adams.flow.sink.CloseArchive
Input/output:
- generates:
adams.core.io.ArchiveManager
classNewArrayGenerates a new array of the specified class with the given dimensions.
Dimensions are given as follows: [x], with x being the number of elements.classNewCollectionGenerates a new (and empty) collection of the specified type.classNewDOMDocumentCreates a new DOM document, e.g., for assembling XML files.classNewFlowOutputs the flow generated by the specified template.classNewImageGenerates an empty image with the specified dimensions (Type: RGB or ARBG).classNewJsonStructureGenerates an empty JSON data structure of the specified type.classNewListGenerates a list string based on the items produced by the generator and the specified separator.classNewMapGenerates a new java.util.Map object using the specified implementation class.classNewMat5FileCreates an empty Mat5File object.classNewMat5MatrixCreates a new Matlab matrix.classNewMat5StructclassNewPropertiesGenerates a new Properties object.classNewRemoteCommandConfigures and forwards a remote command.classNewReportGenerates a new instance of the specified report class.classNewSpreadSheetGenerates an empty spreadsheet.classNewTempFileclassNullDummy source, generates no output.classOpenCVDeviceFrameGrabberGrabs frames from the specified device and forwards them as image containers.classOptionProducerGenerates string output from the current flow using the specified option producer.classOptionTraverserTraverses the options of the flow at run-time.
Used for debugging purposes.classPasteFromClipboardPops up a dialog, prompting the user to accept content from clipboard.classPDFNewDocumentCreates an empty PDF document.
Needs to be finalized with adams.flow.sink.PDFCloseDocument.
The output of this source can be processed by adams.flow.transformer.PDFAppendDocument.
See also:
adams.flow.transformer.PDFAppendDocument
adams.flow.sink.PDFCloseDocument
Input/output:
- generates:
adams.flow.transformer.pdfproclet.PDFGenerator
classPipExecExecutes pip with the specified options and broadcasts the generated output (stdout and/or stderr) continuously.classPythonExecExecutes the specified Python script with the specified options and broadcasts the generated output (stdout and/or stderr) continuously.classPythonVenvExecExecutes the specified executable in a Python virtual environment with the specified options and broadcasts the generated output (stdout and/or stderr) continuously.
Fails if the specified environment does not contain any 'activate' scripts typically found in such directories.classRandomNumberGeneratorRandom number generator.classReaderGeneratorUses the specified generator to instantiate a reader instance.
See also:
adams.flow.sink.CloseReader
Input/output:
- generates:
java.io.InputStream
classRSyncSupports synchronization using rsync.
In case of an error, the stderr output is forwarded, otherwise stdout output.classRsync4jRsyncBinaryOutputs the rsync binary used by the rsync4j library.classRsync4jSshBinaryOutputs the ssh binary used by the rsync4j library.classScriptedA source that uses an external script for generating the token(s).classSelectCharsetPrompts the user to select a character set.classSelectDateTimePops up a dialog, prompting the user to select a date/time, date or time value.classSelectDirectoryPops up a directory chooser dialog, prompting the user to select a directory.classSelectFilePops up a file chooser dialog, prompting the user to select one or more files.classSelectObjectsAllows the user to select an arbitrary number of objects from the specified class hierarchy using the GenericObjectArray.
It is possible to use this dialog for other objects as well that don't belong to a class hierarchy, e.g., adams.core.base.BaseString.classSequenceSourceEncapsulates a sequence of flow items, with the last one generating the output for this meta-source.classSimpleRSyncAn rsync wrapper with a reduced set of options.classSocketListens on the specified port for incoming data.
Can either output raw byte arrays or strings (using the specified encoding).
See also:
adams.flow.sink.Socket
Input/output:
- generates:
byte[]
classSpecifiedActorOutputs the actor identified by the actor path.classSpreadSheetDbReaderReturns a spreadsheet object generated from an SQL query.
To optimize memory consumption, you can return the result of the query in chunks of a specified size.classSQLIdSupplierExecutes an SQL statement for generating the IDs.
Variables are automatically expanded.classSSHExecRuns a system command via ssh on a remote machine and broadcasts the generated output (stdout or stderr).
For more information see:
(2011).classStartOutputs merely a NullToken.classStorageForLoopEmulates the following for-loop:
- positive step size:
for (int i = lower; i <= upper; i += step)
- negative step size:
for (int i = upper; i >= lower; i += step)
In each iteration, the specified variable gets updated with the current value of the for-loop variable.classStorageValueOutputs the value associated with the specified name from temporary storage.
Does nothing if the storage value isn't present.
By supplying a cache name, the value can be obtained from a LRU cache instead of the regular storage.classStorageValuesArrayOutputs the values associated with the specified names from temporary storage as an array.classStringConstantsA source for strings.classStringExpressionEvaluates a string expression.
Variables are supported as well, e.g.: pow(X,@{exp}) with '@{exp}' being a variable available at execution time.
The following grammar is used for the expressions:
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr !classSwitchedSourceclassTemplateSourceBroadcasts the generated output tokens from the (template) source.classTimedSourceEncapsulates a sequence of flow items, with the last one generating the output for this meta-source.
Times how long the sub-source execution takes and sends the time in milli-seconds (as double) in a adams.flow.container.TimingContainer container to the specified callable actor.classTimeseriesDbReaderOutputs timeseries containers generated from an SQL SELECT statement.
A new container is started, whenever the value of the ID column changes (hence you need to ensure that the data is ordered on this column).classURLSupplierSupplies multiple URLs (uniform resource locators).classVariableOutputs the string value of the specified variable.
Does nothing if the variable hasn't been set.classVariablesArrayOutputs the values associated with the specified variable names as a string array.classWekaAssociatorSetupOutputs an instance of the specified associator.classWekaClassifierGeneratorGenerates multiple classifier setups.classWekaClassifierSetupOutputs an instance of the specified classifier.classWekaClustererGeneratorGenerates multiple clusterer setups.classWekaClustererSetupOutputs an instance of the specified clusterer.classWekaDatabaseReaderExecutes a query and returns the data either in batch or incremental mode.classWekaDataGeneratorGenerates artificial data using a Weka data generator.classWekaFilterGeneratorGenerates multiple filter setups.classWekaForecasterSetupOutputs a configured instance of a Weka Forecaster.classWekaForecastingUses a serialized model to perform predictions on the data being passed through.
The model can also be obtained from a callable actor, if the model file is pointing to a directory.classWekaNewExperimentGenerates a new ADAMS experiment setup.classWekaNewInstancesGenerates an empty dataset, based on the attribute types and names specified.
Nominal attributes are generated with an empty set of labels.classWekaPackageManagerActionExecutes the specified action and forwards the generated output.classWekaSelectDatasetPops up a file chooser dialog, prompting the user to select one or more datasets.classWekaSelectObjectsAllows the user to select an arbitrary number of Weka objects from the specified class hierarchy using the GenericObjectArray.classZipArraysAligns the corresponding elements of the storage arrays into row-based arrays. -
Uses of AdditionalInformationHandler in adams.flow.standalone
Subinterfaces of AdditionalInformationHandler in adams.flow.standalone Modifier and Type Interface Description interfaceAbstractDatabaseConnectionProviderInterface for database connection providers.interfaceDatabaseConnectionProviderInterface for database connection providers.interfaceStandaloneGroup<T extends Actor>Interface for a group of standalones.interfaceStandaloneGroupItem<T extends Actor>The element of a standalone group.interfaceStandaloneMutableGroup<T extends Actor>Interface for a mutable group of standalones.Classes in adams.flow.standalone that implement AdditionalInformationHandler Modifier and Type Class Description classAbstractCallableDatabaseConnectionAncestor for callable database connection standalones.classAbstractDatabaseCheckAncestor for standalone actors that check project-specific database connections.classAbstractDatabaseConnectionAncestor for standalone actors providing a database connection different from the system-wide one.classAbstractDbStandaloneAncestor for standalones that use the database.classAbstractMultiViewAncestor for graphical actors that display multiple views.static classAbstractMultiView.ViewWrapperA wrapper for the actual actors.classAbstractMutableActorDaemonEvent<E,P>Ancestor for daemon events that handle sub-actors.classAbstractMutableStandaloneGroupItem<T extends Actor>Ancestor for group items that can contain other actors.classAbstractScriptAncestor for singleton script actors.classAbstractStandaloneAncestor for all flow items that neither generate nor process tokens.classAbstractStandaloneGroup<T extends Actor>Ancestor for fixed-sized groups.classAbstractStandaloneGroupItem<T extends StandaloneGroup>Ancestor of a standalone group item.classAbstractStandaloneGroupItemGroup<S extends Actor,E extends Actor>Ancestor for group items that form a group themselves.classAbstractStandaloneGroupItemMutableGroup<S extends Actor,E extends Actor>Ancestor for group items that form a group themselves.classAbstractStandaloneMutableGroup<T extends Actor>Ancestor for mutable groups of standalones.classAutogeneratedStandaloneContainer for auto-generated standalone actors.
Can be removed with the adams.flow.processor.RemoveAutogeneratedActors processor.classCallableActorsContainer for actors that need to be accessed via their name.classCallableDatabaseConnectionReferences a database connection provider of type adams.flow.standalone.DatabaseConnectionProvider.classConditionalStandalonesExecutes the sub-actors only when the boolean condition evaluates to 'true'.classConsoleWindowDisplays the messages that are output in the system's 'Console window'.classCopyCallableStandaloneExecutes the copied callable standalone.classCounterInitCreates an empty counter in internal storage under the specified name.classCronExecutes an actor according to a pre-defined schedule.
Note: since the actor merely starts the cron scheduler in the background, the actor finishes the execution pretty much immediately.classDatabaseCheckFirst, the actor checks whether the connection to the database is established.classDatabaseConnectionFor initializing an ADAMS database connection that differs from the system-wide one.classDelayedEventExecutes its sub-flow after a predefined number of milli-seconds.classDeleteDirDeletes the dirs that match the regular expression below the specified directory.classDeleteFileDeletes the files that match the regular expression below the specified directory.classDeleteStorageValueRemoves the specified value (or the ones that match the regular expression) from temporary storage.
By supplying a cache name, the value can be removed from a LRU cache instead of the regular storage.classDeleteVariableRemoves a variable by name or the variables that match the regular expression.classDeserializeToStorageDeserializes a model from a file with the specified object reader and stores it directly in storage.
It is also possible to define multiple storage name / file name pairs, to make the deserialization of large amounts of files more efficient.classDirWatchclassEventsContainer for event actors.classExecSQLExecutes a SQL statement, which does not return a result set, like INSERT, UPDATE, DELETE, CREATE.classExternalFlowAllows to execute a complete external Flow rather than just an external actor.classExternalStandaloneStandalone that executes an external standalone actor stored on disk.
For executing whole flows, use the adams.flow.standalone.ExternalFlow standalone actor instead.
See also:
adams.flow.standalone.ExternalFlow
classGridViewDisplays multiple graphical actors in a grid.classGroovyA standalone that executes a Groovy script.classHashSetInitCreates an empty hashset in internal storage under the specified name.
Initial string values can be supplied as well, which can be transformed using the specified conversion.
See also:
adams.flow.transformer.HashSetInit
adams.flow.transformer.HashSetAdd
adams.flow.source.HashSet
adams.flow.condition.bool.HashSet
classIMAPConnectionIMAP server setup.classInactiveStandaloneContainer for inactive standalone actors.
Can be activated with the adams.flow.processor.ReactivateActors processor.classIncludeExternalStandaloneIncludes an external standalone.classInitPublishSubscribeInitializes a publish/subscribe data structure in internal storage.classInitStorageCacheAdds a LRU cache in the responsible storage handler (usually the Flow actor).classJavaCalls the main method of a Java class.classJavaExecForks off a new JVM with the same classpath by default.classJobRunnerInstanceActs as job execution pool for classes implementing adams.multiprocess.JobRunnerSupporter.
See also:
adams.multiprocess.JobRunnerSupporter
classJobRunnerSetupDefines the job runner setup to use for parallel/distributed computation.classLogEventListens to the global log record handler and processes records that passed the specified filter(s).
This allows, for instance, the output of log messages into a log file.
By default, log records are only processed if the sub-actors are not currently being executed.classLookUpInitInitializes an empty look up table in storage.
See also:
adams.flow.transformer.LookUpAdd
classMakeDirCreates the user-supplied directory if not already existing.classMemoryMonitorMonitors the memory (used/committed heap vs maximum heap).Every number of seconds ('sampleInterval'), the memory consumption, i.e., 'heap used', is sampled, keeping the specified number of latest samples ('numSamples').
Once the specified number of samples have been reached, it is checked whether the specified percentage of samples ('coverage') reaches or exceeds the threshold percentage of the maximum heap has been exceeded ('threshold').classNullDummy standalone, does nothing.classPythonEnvironmentDefines what Python executables to use within this context.
On Linux, you can enforce using the system-wide Python 3 executables by supplying '3' as suffix, which gets appended to the executables.classQueueEventExecutes its sub-flow after a predefined number of milli-seconds.classQueueInitCreates an empty queue in internal storage under the specified name.classRegisterFlowSimply registers the flow with the running flows registry.classRemoteScriptingEngineStarts/stops a scripting engine for remote commands.classScriptedA standalone that executes an external script.classSetManyVariablesSets the values of the variables.
Optionally, the specified values can be expanded, in case it is made up of variables itself.
Grammar for mathematical expressions (value type 'MATH_EXPRESSION, MATH_EXPRESSION_ROUND'):
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr !classSetPropertyDeprecated.classSetVariableSets the value of a variable.
Optionally, the specified value can be expanded, in case it is made up of variables itself.
It is also possible to override the variable value with the value obtained from an environment variable.
Grammar for mathematical expressions (value type 'MATH_EXPRESSION, MATH_EXPRESSION_ROUND'):
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr !classSMBConnectionProvides access to a remote host via SMB.classSMTPConnectionSMTP server setup for overriding default parameters.classSSHConnectionProvides access to a remote host via SSH.
For more information see:
(2011).classStandalonesContainer for standalone actors.classStopwatchStops the execution time of the flow, till either the user stops the flow or the flow finishes by itself
Valid options are:classSubProcessEventExecutes its sub-flow after a predefined number of milli-seconds.classTableCleanUpRuns a table cleaner.classTabViewDisplays multiple graphical actors in a tabbed pane.classTemplateStandaloneGenerates a standalone actor/sub-flow from a template.classTesseractConfigurationSetup parameters for tesseract.
For more information see:
https://github.com/tesseract-ocr/tesseract
Valid options are:classToolRuns a tool.classTriggerCallableStandaloneTriggers the specified callable actor.classVariableChangedEventListens to a any changes to the specified variable.
This allows, for instance, the monitoring of a variable.
Enable the 'noDiscard' property to process all change events - NB: this can slow down the system significantly.classWeakExternalStandaloneclassWebSocketServerStarts and runs a websocket server.classWekaInitializeScriptedClassifiersInitializes the specified scripted classifiers in storage for prediction.classWekaPackageManagerActionExecutes the specified action and forwards the generated output. -
Uses of AdditionalInformationHandler in adams.flow.template
Subinterfaces of AdditionalInformationHandler in adams.flow.template Modifier and Type Interface Description interfaceActorTemplateUserInterface for actors that make use for actor templates. -
Uses of AdditionalInformationHandler in adams.flow.transformer
Subinterfaces of AdditionalInformationHandler in adams.flow.transformer Modifier and Type Interface Description interfaceDataContainerDbReader<T extends DataContainer>Interface for actors that read containers from the database.interfaceDataContainerDbWriter<T extends DataContainer & DatabaseIDHandler>Interface for actors that import data containers into the database.interfaceFeatureGenerator<T>General interface for feature generating actors.interfaceSpreadSheetMergeActorIndicator interface for actors that merge spreadsheets.interfaceWekaMergeInstancesActorInterface for transformers that merge Weka Instances.Classes in adams.flow.transformer that implement AdditionalInformationHandler Modifier and Type Class Description classAbstractArrayProviderAncestor for transformer actors that can output items one by one or as a single array.classAbstractCallableWekaClassifierEvaluatorAncestor for classifier evaluators that make use of a callable classifier.classAbstractCallableWekaClustererEvaluatorAncestor for clusterer evaluators that make use of a callable clusterer.classAbstractContainerValueExtractorAncestor for transformers that extract values from a container.classAbstractDataContainerAdd<T extends DataContainer>Ancestor for transformers that superimpose the incoming data container on one available from storage (or if not available, put the current one in storage) and forward the combined data container.classAbstractDataContainerAppend<T extends DataContainer>Ancestor for transformers that append the incoming data container to one available from storage (or if not available, put the current one in storage) and forward the combined data container.classAbstractDataContainerDbReader<T extends DataContainer>Ancestor for transformers that read containers from the database.classAbstractDataContainerDbWriter<T extends DataContainer & DatabaseIDHandler>Abstract ancestor for actors that import data containers into the database.classAbstractDataContainerFileImport<T extends DataContainer>Abstract ancestor for actors that import data containers.classAbstractDataContainerFileReader<T extends DataContainer>Abstract ancestor for actors that read data containers from disk.classAbstractDataContainerFileWriter<T extends DataContainer>Abstract ancestor for transformer actors that write data containers to disk.classAbstractDataContainerTransformerAncestor for actors that transform data containers.classAbstractDataProcessorAbstract ancestor for classes that process data on disk.classAbstractDbArrayProviderAncestor for array providers that use the database.classAbstractDbDataProcessorAbstract ancestor for data processors that use a database.classAbstractDbTransformerAbstract ancestor for transformers that query a database.classAbstractDeleteDataContainer<T extends DataContainer>Ancestor for transformers that delete containers from the database.classAbstractDeleteDbReportValue<T extends Report>Ancestor for transformers that delete values from a report in the database whenever a token passes through.classAbstractDeleteReportValueAncestor for transformers that delete values from a report.classAbstractDeleteReportValueByExpressionAncestor for transformers that delete field/value from a report if the boolean expression evaluates to true.classAbstractFilterAncestor for domain-specific filter transformers.classAbstractGetReportValueAncestor for transformers that retrieve a value from a report.classAbstractInPlaceSpreadSheetTransformerAncestor for spreadsheet transformers that allow the processing to happen in-place, rather than on a copy of the data.classAbstractInstanceGenerator<T extends DataContainer>Ancestor for transformers that turn data containers into WEKA Instance objects.classAbstractInteractiveTransformerAncestor for transformers that interact with the user.classAbstractInteractiveTransformerDialogAncestor for graphical actors that are interactive.classAbstractMultiCompressAbstract ancestor for compression algorithms that allow the compression of multiple files (incl directory structure).classAbstractMultiDecompressAncestor for compression schemes that manage archives with multiple files (incl directory structure) like zip archives.classAbstractProcessWekaInstanceWithModel<T>Ancestor for transformers that user models for processing Instance objects, e.g., classifiers making predictions.classAbstractReportDbReader<T extends Report,I>Abstract ancestor for actors that load reports from the database.classAbstractReportDbUpdaterAncestor for transformers that updateReportobjects or reports that are part of aMutableReportHandlerobject.classAbstractReportDbWriter<T extends Report,I>Abstract ancestor for actors that write reports to the database.classAbstractReportDbWriterByDBID<T extends Report>Abstract ancestor for actors that write reports to the database.classAbstractReportDbWriterByID<T extends Report>Abstract ancestor for actors that write reports to the database.classAbstractReportFileImport<T extends Report>Abstract ancestor for report import actors.classAbstractReportFileReader<T extends Report>Abstract ancestor for report file reader transformers.classAbstractReportFileWriter<T extends Report>Abstract ancestor for actors that write reports to disk.classAbstractReportValueDbWriter<T extends Report>Abstract ancestor for actors that write report values to the database.classAbstractScriptAncestor for transformer script actors.classAbstractSetReportValueAncestor for transformers that update the value of field in a report.classAbstractSingleCompressAncestor for compression algorithms that only take a single file, like gzip.classAbstractSingleDecompressAncestor for decompression algorithms that only work with archives that consists of a single file, like gunzip.classAbstractSpreadSheetTransformerAncestor for transformers that work on spreadsheets and also output spreadsheets again.classAbstractStringOperationAncestor for transformers that perform operations on strings.classAbstractTransformerAncestor for all flow items that process an input token and generate an output token.classAbstractTransformerWithPropertiesUpdatingAncestor for transformers that allow changing the object's properties using variables.classAbstractWekaClassifierEvaluatorAncestor for transformers that evaluate classifiers.classAbstractWekaModelReaderAncestor for actors that deserialize models.classAbstractWekaPredictionsTransformerAncestor for transformers that convert the predictions stored in an Evaluation object into a different format.classAccessDatabaseInfoOutputs information on a MS Access database.classAddDOMAttributeAdds a new attribute to the incoming org.w3c.dom.Node and forwards the new updated node.classAddDOMNodeAdds a new node below the incoming org.w3c.dom.Node and forwards the new node.
In case of an incoming org.w3c.dom.Document, the node gets added below the root node.classAddNoteAdds a note to the notes handler passing through.
Pre-defined note types:
- ERROR:
- WARNING:
- PROCESS INFORMATION
Input/output:
- accepts:
adams.data.NotesHandler
- generates:
adams.data.NotesHandler
classAppendArchiveAppends the file or storage item to the archive passing through.
See also:
adams.flow.source.NewArchive
adams.flow.sink.CloseArchive
Input/output:
- accepts:
adams.core.io.ArchiveManager
- generates:
adams.core.io.ArchiveManager
classAppendNameAppends the suffix to the file/directory being passed through.
By default, the appropriate separator (forward slash or backslash) gets inserted between the file/directory and suffix.classArrayCombinationsTurns an array of any type into a sequence of array combinations of given size.classArrayHistogramRangesOutputs the ranges generated by adams.data.statistics.ArrayHistogram using the incoming double array or matrix.
In case of an array, the data-type and location are ignored.classArrayLengthDetermines the length of an array.classArrayReverseReverses the order of the elements in the array.classArrayStatisticGenerates statistics from a double array or matrix.classArraySubsetGenerates a subset of the array, using the specified array elements.classArraySubsetGenerationclassArrayToChunksSplits an array into chunks of a specified size.classArrayToCollectionTurns an array into a collection.
See also:
adams.flow.transformer.CollectionToArray
Input/output:
- accepts:
adams.flow.core.Unknown[]
- generates:
java.util.Collection
classArrayToSequenceTurns an array of any type into a sequence of tokens.classArrayToVariablesclassAutogeneratedTransformerEncapsulates a sequence of auto-generated actors.classBaseNameExtracts the name of the file/directory passing through, i.e., any preceding directory gets stripped.classBinaryFileReaderReads a binary file and forwards the content byte by byte or as byte array.classBoofCVDetectLinesDetects lines in images (Hough line detector based on polar parametrization).classBoofCVDetectLineSegmentsDetects line segments in images (line RANSAC).classBoofCVFeatureGeneratorApplies a BoofCV feature generator to the incoming image and outputs the generated features.classBoofCVMultiImageOperationApplies a BoofCV multi-image operation to the incoming image(s) and outputs the generated image(s).classBoofCVTransformerApplies a BoofCV transformation to the incoming image and outputs the generated image(s).classBufferedImageFeatureGeneratorApplies an JAI flattener to the incoming image and outputs the generated features.classBufferedImageMultiImageOperationApplies a BufferedImage multi-image operation to the incoming image(s) and outputs the generated image(s).classBufferedImageTransformerApplies a BufferedImage transformation to the incoming image and outputs the generated image(s).classBzip2Creates a bzip2 archive from a single file.classCallableTransformerFeeds tokens into a callable transformer and broadcasts the generated output tokens.classChangeImageObjectPrefixUses the specified object finder to locate objects and then applies the object filter to the located objects.classChangeReportFieldPrefixesReplaces the specified old prefixes with the new one.classClassSelectorSets (or unsets) the class index/indices.classCollectionAppendAppends the elements of the incoming collection to the one in storage.
If there is none in storage yet, a copy of the incoming collection will simply get stored in storage.
The combined collection is then forwarded.classCollectionInsertInserts an object in the collection using the specified position.
The object can be retrieved from a callable actor or from storage.
If the collection does not implement the java.util.List interface and the insertion is not at the end, the insertion will fail.
See also:
adams.flow.transformer.StorageCollectionInsert
Input/output:
- accepts:
java.util.Collection
- generates:
java.util.Collection
classCollectionSizeclassCollectionSubsetGenerates a subset of the collection, using the specified elements.classCollectionToArrayTurns a collection of any type into an array.
See also:
adams.flow.transformer.ArrayToCollection
Input/output:
- accepts:
java.util.Collection
- generates:
adams.flow.core.Unknown
classCollectionToSequenceTurns a collection of any type into a sequence of tokens.classColorProviderOutputs a color for each token passing through.
If the color provider implements adams.gui.visualization.core.ColorProviderWithNameSupport then the color associated with the incoming string token is forwarded.
The color provider can be reset using the specified variable.classCompareObjectLocationsVisualizes object locations (annotations and predicted) for the incoming image side-by-side.
Only forwards the image container when accepted.classCompareObjectsCompares two objects using the specified compare algorithm and forwards the output of the comparison.classCompareObjectTypesCompares the object types between objects from the two reports.
The first report is considered 'ground truth'.classConfirmationDialogPops up a confirmation dialog, prompting the user to select 'yes', 'no' or 'cancel'.
If no custom tokens are used, the current token is only forwarded when the user selects 'yes'.classConfusionMatrixGenerates a confusion matrix from the specified actual and predicted columns containing class labels.
Can take a probability column (of prediction) into account for generating weighted counts.classContainerToStorageExtracts the specified values from the container passing through and makes them available as storage items.classContainerToVariablesExtracts the specified values from the container passing through and makes them available as variables.classControlChartApplies a control chart algorithm to the data.classConvertConverts data from one format into another.classConvertFeaturesTurns the raw features generated by a feature converter (stored in a adams.flow.container.FeatureConverterContainer) into a specific format using the user-defined feature converter.
If an array of containers is received, the get merged first, i.e., placed side-by-side.classCopyCreates copies of the tokens being passed through.classCopyCallableTransformerFeeds tokens into the copy of a callable transformer and broadcasts the generated output tokens.classCopyFileCopies the file received on its input port to the target directory if it matches the provided regular expression.
In case of a directory, the directory gets copied recursively.
If required, you can also provide a new filename (just the name, no path).
The generated target file/directory gets forwarded in the flow.classCopyToClipboardCopies the data in this token to the system's clipboard using the specified clipboard manager.classCounterAddPasses a value through the specified counter.classCounterInitCreates a counter from a column in a spreadsheet or an array.classCountObjectsInPolygonCounts the objects in the report passing through that fall into the defined region.
Partial hits can be counted as well, using their percentage in overlap as count.classCountObjectsInRegionCounts the objects in the report passing through that fall into the defined region.
Partial hits can be counted as well, using their percentage in overlap as count.classCreateEmailActor for creating emails to be sent.classDatasetFilterApplies the batch filter to the dataset.classDatasetRowFilterApplies the stream filter to the rows.classDateTimeTypeDifferenceComputes the difference between the two date/time types of the incoming array (of length 2) by subtracting the second element from the first one.classDecodeBarcodeDecodes the data in a barcode using the specified decoder.classDeleteFileDeletes the file/directory (or files/directories) received on its input port if it matches the provided regular expression.
In case of directories, deletion is performed recursively (if a directory matches, then the content gets deleted regardless whether it matches the regular expression or not).classDeleteJsonValueclassDeleteMapValueDeletes the specified key/value pair from the map passing through.classDeleteOverlappingImageObjectsCleans up overlapping objects, e.g., multiple predicted bounding boxes per object.classDeletePropertyValueDeletes the specified property from the Properties object passing through.classDeleteReportValueDeletes values from a report.classDeleteReportValueByExpressionclassDeleteStorageValueRemoves the specified value (or the ones that match the regular expression) from temporary storage whenever a token passes through.
By supplying a cache name, the value can be removed from a LRU cache instead of the regular storage.classDeleteVariableRemoves a variable by name or the variables that match the regular expression.classDeserializeDeserializes a previously serialized Java object from a file.classDetermineOverlappingAreasclassDetermineOverlappingObjectsComputes the overlap of objects with the specified report from storage (or itself) using the specified algorithm.classDiffCompares two files or two string arrays and generates a diff representation.
In case of BRIEF, the output is whether the two files/arrays are different.classDirNameExtracts the directory part of the file/directory passing through, i.e., any trailing name part gets stripped.
See also:
adams.flow.transformer.AppendName
adams.flow.transformer.PrependDir
adams.flow.transformer.RelativeDir
adams.flow.transformer.BaseName
adams.flow.transformer.FileExtension
Input/output:
- accepts:
java.lang.String
java.lang.String[]
java.io.File
java.io.File[]
- generates:
java.lang.String
java.lang.String[]
java.io.File
java.io.File[]
classDownloadContentDownloads the raw, textual content from a URL and forwards it.Also handles basic authentication when using URLs like this:
http://user:pass@domain.com/url
Input/output:
- accepts:
java.lang.String
adams.core.base.BaseURL
java.net.URL
- generates:
java.lang.String
classDrawPerforms a draw operation on an image.classEmailFileReaderReads email(s) from a file.classEncodeBarcode
classExecuteActorExecutes the actor passing through and forwards it once finished.
If the actor is an instance of adams.flow.execution.FlowExecutionListeningSupporter and flow execution listening enabled, then the specified flow execution listener gets attached.classExecuteJobsExecutes the incoming jobs.classExecuteRemoteCommandExecutes the incoming commands.classExifTagOperationPerforms the specified EXIF operation on the incoming data.classExpandStorageExpands all the storage items (using their string representation) and variables in the string(s) passing through.
A string can consist of arbitrary strings and the following special placeholders:
- variables: @{...}
- storage placeholders: %{...}
Input/output:
- accepts:
java.lang.String
java.lang.String[]
- generates:
java.lang.String
java.lang.String[]
classExpandVariablesExpands all the variables in the string(s) passing through.A string can consist of arbitrary strings and the following special placeholder for variables:
@{...}classExternalTransformerTransformer that executes an external transformer actor stored on disk.classExtractGroupExtracts the group from the object and forwards it.classExtractIDclassFileChangedChecks whether the input file has changed using the specified monitor.
Must be initialized once with the same file.classFileExtensionExtracts the file extension from the file (the part after the '.').
If no dot is in the file name, then an empty string gets forwarded.
See also:
adams.flow.transformer.AppendName
adams.flow.transformer.PrependDir
adams.flow.transformer.RelativeDir
adams.flow.transformer.DirName
adams.flow.transformer.BaseName
Input/output:
- accepts:
java.lang.String
java.lang.String[]
java.io.File
java.io.File[]
- generates:
java.lang.String
java.lang.String[]
classFileInfoOutputs information for a path (file/directory).classFilenameGeneratorPasses the incoming token through the generator to generate and forward a filename.
See also:
adams.flow.source.FilenameGenerator
Input/output:
- accepts:
adams.flow.core.Unknown
- generates:
java.lang.String
classFileTailerMonitors a text file for data being appended, e.g., log files.classFilterMapApplies the specified filter to the map object passing through.classFindInFileSearches the incoming (text) file for the specified search string, output the boolean search result.classFlowFileReaderReads the flow file and outputs the actor(s).
A custom reader can be specified in case of reading from files, but must be specified when reading from java.io.Reader or java.io.InputStream objects.classGenerateFileBasedDatasetApplies the specified generator to the incoming dataset container.
See also:
adams.flow.control.SetContainerValue
adams.flow.transformer.PrepareFileBasedDataset
Input/output:
- accepts:
adams.flow.container.FileBasedDatasetContainer
- generates:
java.lang.String
Container information:
- adams.flow.container.FileBasedDatasetContainer: Train, Test, Validation, Negative
classGetArrayElementPicks an element from an array and forwards only this element.classGetDatabaseIDReturns the database ID of the database ID handler passing through.classGetIDReturns the ID of the ID handler passing through.classGetImageObjectIndicesUses the specified object finder to locate objects and forwards the indices.classGetImageObjectMetaDataRetrieves the meta-data of the incoming adams.flow.transformer.locateobjects.LocatedObject object.classGetImageObjectsUses the specified object finder to locate objects and forwards the objects.classGetJsonKeysOutputs all the keys of the JSON Object passing through.classGetJsonValueObtains the value associated with the specified key from the JSON object passing through.
Null values are only forwarded if requested.classGetListElementPicks an element from a list and forwards only this element.classGetMapKeysForwards all the sorted (string) keys of the map.classGetMapKeyValuePairsclassGetMapValueObtains the value associated with the specified key from Map object received as input and forwards it.classGetNotesReturns the notes of the notes handler passing through.classGetObjectPropertyRetrieves a value from an object's property using a bean property path.
A bean property consists usually of a get and set method, e.gclassGetPropertiesOutputs the names of all Java Bean properties of the incoming object.classGetPropertyObtains the current property value of the object passing through.classGetPropertyNamesOutputs all the keys of the properties object passing through.classGetPropertyValueObtains the value(s) associated with the keys that match the specified regular expression from the Properties object passing through.
Null values are only forwarded if requested.classGetRemoteCommandPayloadReturns the underlying payload objects (if any) from the incoming remote command.
Depending on request/response flag, it outputs the corresponding payload objects.
Does not forward anything if the array is empty.classGetReportReturns the report of the report handler passing through.classGetReportValueRetrieves a value from a report.classGetStorageValueRetrieves a value from internal storage using the incoming string token as name.classGroovyA transformer that uses a Groovy script for processing the token(s).classGroupByRegExpGroups the incoming strings into sub-groups.classGUNZIPDecompresses an archive that was compressed with gzip.classGZIPCreates a GZIP archive from a single file.classHashSetAddAdds a value to the specified hashset.classHashSetInitCreates a hashset from a column in a spreadsheet or an array.classHashSetRemoveRemoves a value from the specified hashset.classHexReplaceAllows to find and replace characters in hex notation.classHttpPostFileUploads the incoming file via HTTP POST to the specified URL as 'multipart/form-data'.
Additional form fields can be supplied as well.classHttpRequestSends the incoming text/bytes payload to the specified URL (with optional HTTP headers) and forwards the retrieved HTML as text.classIDGeneratorGenerates IDs from the objects it receives on its input and forwards the generated IDs.classImageAnnotatorAllows the user to label objects located on the image and pass on this enriched meta-data.classImageFileReaderReads any file format that the specified image reader supports.
If meta-data is associated with the image, then this can be loaded as well.classImageInfoObtains information from the picture passing through.classImageLabelerAllows the user to label images, setting a report field in the meta-data.
Any logged interaction will get added as JSON under interaction-log in the report.classImageMetaDataReturns any EXIF or IPTC and basic image information as a spreadsheet.classImageObjectAnnotatorUser interface for annotating objects in images.classImageObjectFilterUses the specified object finder to locate objects and then applies the object filter to the located objects.classImageObjectIndexOffsetOffsets the object index.classImageObjectInfoOutputs the requested type of information for either the incoming adams.flow.transformer.locateobjects.LocatedObject or the specified image object in the report.classImageObjectOverlapComputes the overlap of objects with the specified report from storage.
It stores the overlap percentage of the highest overlap found (overlap_highest) and the total number of overlaps greater than the specified minimum (overlap_count).
If a label key (located object meta-data) has been supplied, then the label of the object with the highest overlap gets stored as well (overlap_label_highest) and whether the labels match (overlap_label_highest_match)
Input/output:
- accepts:
adams.data.image.AbstractImageContainer
adams.data.report.Report
adams.data.report.ReportHandler
- generates:
adams.data.image.AbstractImageContainer
adams.data.report.Report
adams.data.report.ReportHandler
classImageObjectOverlapMatrixGenerates a matrix of overlapping image objects (annotations vs predictions) and their labels.
When outputting not just overlaps, a separate column 'Overlap' is output as well, indicating whether this row represents an overlap ('yes') or not ('no')
Input/output:
- accepts:
adams.data.image.AbstractImageContainer
adams.data.report.Report
adams.data.report.ReportHandler
- generates:
adams.data.spreadsheet.SpreadSheet
classImageObjectToVariablesConverts the parameters of an image object into variables.
Meta-data can be turned into variables as well.classImagePreparationPreprocesses an image.classImageSegmentationAnnotatorUser interface for annotating images for image segmentation.classImageSegmentationContainerFilterApplies a Image Segmentation container filter to the incoming container(s) and outputs the generated data.classImageSegmentationContainerOperationApplies a Image Segmentation container operation to the incoming container(s) and outputs the generated data.classImageSegmentationFileReaderReads image segmentation file formats using the specified reader and forwards a container with the data.classImageSharpnessDetermines whether images are in focus ('sharp') using the specified algorithm.classIMAPOperationExecutes the specified IMAP operation and forwards the generated output.classInactiveTransformerEncapsulates a sequence of inactive actors.classIncludeExternalTransformerIncludes an external transformer.classIncStorageValueIncrements the value of a storage value by either an integer or double increment.
If the storage value has not been set yet, it will get set to 0.
If the storage value contains a non-numerical value, no increment will be performed.
It is also possible to directly output the updated storage value (while discarding the input token).classIncVariableIncrements the value of a variable by either an integer or double increment.
If the variable has not been set yet, it will get set to 0.
If the variable contains a non-numerical value, no increment will be performed.
It is also possible to directly output the updated variable (while discarding the input token).classIndexedSplitsRunsEvaluationUses the specified evaluation for evaluating the incoming data.classIndexedSplitsRunsGeneratorUses the specified generator for generating indexed splits from the incoming data.classIndexedSplitsRunsPredictionsUses the specified generator for generating predictions from indexed splits for the incoming data.classIndexedSplitsRunsReaderReads indexed splits runs from disk using the specified reader.classIntersectOverUnionComputes the Intersect Over Union (IOU) of objects with the specified report from storage.
It stores the highest IOU found (iou_highest) and the total number of iou greater than the specified minimum (iou_count).
If a label key (located object meta-data) has been supplied, then the label of the object with the highest iou gets stored as well (iou_label_highest) and whether the labels match (iou_label_highest_match)
Input/output:
- accepts:
adams.data.image.AbstractImageContainer
adams.data.report.Report
adams.data.report.ReportHandler
- generates:
adams.data.image.AbstractImageContainer
adams.data.report.Report
adams.data.report.ReportHandler
classJsonFileReaderReads a JSON file and forwards the parsed JSON object.
If it is know beforehand, whether the JSON file contains an object or an array, the output type can be specified.classLocateObjectsLocates objects in an image and forwards an image per located object, cropped around the object.classLookUpForwards the value associated with the key that the actor gets as input, using the specified lookup table from internal storage.classLookUpAddAdds key-value pairs to the specified lookup table.
The input can either an array or a spreadsheet.
If the input is an array, it must have length 2, with the first element the key and the second one the value.classLookUpInitCreates a lookup table from a spreadsheet, using one column as key and another one as value.classLookUpRemoveRemoves a key/value pair from the specified lookup table.classLookUpUpdateUpdates the lookup table (in form of a spreadsheet) that passes through using the specified rules.
The rules can contain variables.
The rules use the following grammar:
expr_list ::= expr_list expr_part | expr_part
expr_part ::= conditional | assignment
conditional ::= if expr then assignments end
| if expr then assignments else assignments end
assignments ::= assignments assignment | assignment
assignment ::=
VARIABLE := expr;
| all ( "regexp" ) := expr;
expr ::= ( expr )
| NUMBER
| STRING
| BOOLEAN
| VARIABLE
| true
| false
| -expr
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr !classLzfCreates a LZF archive from a single file.classLzmaCreates a LZMA (7zip) archive from a single file.classMakeDirCreates the directory accepted on the input port if not already existing.classMakeForecastPlotContainerCreates a named containers for the SequencePlotter actor using the incoming forecasts.classMakeJFreeChartDatasetGenerates a JFreeChart dataset from the incoming spreadsheet.classMakeLogEntryCreates a log entry from the incoming token.classMakePlotContainerCreates a named container for the SequencePlotter actor.
In case of Double arrays arriving at the input, they must have length 2 for X and Y, 4 for X/Y/Y-Error (low/high) or 6 X/Y/X-Error (low-high)/Y-Error (low-high).
Integer arrays can only have the length 2.
It is also possible, depending on the plotter sink setup, to use strings for x and/or y.
In order to force an update of the plot, overriding the current plot-updater setup, you can create a special plot container of type UPDATE and send that to the plot (can be triggered with a null-token, e.g., from a adams.flow.source.Start source).classMakeXChartDatasetGenerates a XChart dataset from the incoming spreadsheet.classMapToStorageValuesStores the map content in internal storage.
Only the map keys that match the regular expression are turned into storage values.classMapToVariablesTurns the map content into variables.
Only the map keys that match the regular expression are turned into variables.classMapVariableIteratorIterates over the keys of the incoming map and sets variables for current key and variable.classMat5ArrayInfoProvides information on a Matlab5 array.classMat5ArraySubsetOutputs either a single value (all dimensions in index specified) from an array or a subset (if one or more dimensions left empty).
Only arrays of type us.hebi.matlab.mat.types.Matrix are currently supported.classMat5FileAddArrayAdds an array to the matlab file object using the specified name.
The array can be retrieved from a callable actor or from storage.classMat5FileAddMapAdds the elements of a map to the matlab file object using the names from the map.
The map can be retrieved from a callable actor or from storage.classMat5FileGetArrayRetrieves the specified array from the mat file object.classMat5FileInfoProvides information from a .mat file.classMat5FileReaderLoads a Matlab file in mat5 format.classMat5GetMatrixElementRetrieves the specified matrix element.classMat5GetStructFieldRetrieves the specified struct field.classMat5SetMatrixElementSets the specified element in the matrix passing through.
The value gets parsed automatically according to the element type.classMat5SetStructFieldSets obtained array under the specified field name.classMat5StructInfoProvides information from a Matlab struct object.classMatchReportFieldsOutputs all fields that match the regular expression.classMathExpressionEvaluates a mathematical expression.
The input value (double or integer) can be accessed via 'X'.
Variables are supported as well, e.g.: pow(X,@{exp}) with '@{exp}' being a variable available at execution time.
The following grammar is used for the expressions:
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr !classMaxReturns the maximum value from a double/int array or the index of the maximum value.classMergeObjectLocationsMerges the object locations in the report of the container passing through with the one obtained from storage.
The 'overlap action' determines what to do if objects overlap.
With the 'check type' you can still trigger a 'skip' if the type values of the two overlapping objects differ.
For simply merging all objects, choose a minOverlapRatio of 0.0 and the OverlapAction of KEEP.classMergeReportAllows the report (or the report of a report handler) passing through to to be merged with another one.classMergeReportFromMapMerges the passing through report handler/report objects with the referenced map of report objects in storage.classMessageDigestGenerates a message digest and forwards that.classMimeTypeDetermines the mime type of a file.classMinReturns the minimum value from a double/int array or the index of the minimum value.classMoveFileMoves a file to a different location (or just renames it).
Source and target can be swapped as well.
Simply forwards the input token if moving was successful.classMultiMapOperationApplies the specified operation the incoming map array.classMultiMat5MatrixOperationApplies a multi-matrix operation to the incoming matrix(s) and outputs the generated matrix(s).classMultiSpreadSheetOperationApplies the specified operation the incoming spreadsheet array.classNegativeRegionsUses the specified generator for generating negative regions for the image passing through.classObjectArrayToPrimitiveArrayTurns an object array into an primitive one.classOpenCVFeatureGeneratorApplies a OpenCV feature generator to the incoming image and outputs the generated features.classOpenCVMultiImageOperationApplies a BoofCV multi-image operation to the incoming image(s) and outputs the generated image(s).classOpenCVTransformerApplies a OpenCV transformation to the incoming image and outputs the generated image(s).classOptionProducerGenerates string output from the object passing through using the specified option producer.classOutlierDetectorApplies the outlier detector and either outputs the updated data container or a flow container with the data and the detection results.classPassThroughDummy transformer that passes tokens through.classPDFAppendDocumentModifies the incoming PDF document generated by adams.flow.source.PDFNewDocument using the PDF processors on either the specified input file or storage item.
Needs to be finalized with adams.flow.sink.PDFCloseDocument.
If a file name is received as input, it is assumed that this is an existing PDF file and gets appended.
See also:
adams.flow.source.PDFNewDocument
adams.flow.sink.PDFCloseDocument
Input/output:
- accepts:
adams.flow.transformer.pdfproclet.PDFGenerator
java.lang.String
java.io.File
- generates:
adams.flow.transformer.pdfproclet.PDFGenerator
classPDFCreateActor for generating PDF files.classPDFExtractActor for extracting a range of pages from a PDF file.classPDFExtractImagesActor for extracting the images from a PDF file.classPDFExtractTextActor for extracting the text of a range of pages from a PDF file.classPDFGenerateclassPDFInfoOutputs information on a PDF file.classPDFMergeActor for merging multiple PDF files.
Forwards the name of the generated file.classPDFMetaDataActor for extracting the meta-data from a PDF.classPDFPageCountActor for extracting the page count from a PDF file.classPDFRenderPagesActor for rendering pages of a PDF file as images.classPDFStampActor for stamping pages in a PDF with a custom overlay.classPixelSelectorAllows the user to select pixels.classPredictionEccentricityTreats the predictions from a regressor as an image and computes the 'eccentricity' of the actual vs predicted plot.classPrepareFileBasedDatasetProcesses the incoming files and generates a dataset container.
See also:
adams.flow.control.SetContainerValue
adams.flow.transformer.GenerateFileBasedDataset
Input/output:
- accepts:
java.lang.String[]
- generates:
adams.flow.container.FileBasedDatasetContainer
Container information:
- adams.flow.container.FileBasedDatasetContainer: Train, Test, Validation, Negative
classPrependDirPrepends the prefix to the file/directory being passed through.
By default, the appropriate separator (forward slash or backslash) gets inserted between the file/directory and prefix.classPrimitiveArrayToObjectArrayTurns a primitive array into an object one.classProcessActorApplies the specified processor to the incoming actor and forwards the result.
For processors implementing adams.flow.processor.ModifyingProcessor the modified actor is forwarded (or, if not modified, the original one), all others just forward the incoming actor.
If the processor should implement adams.flow.processor.ListingProcessor then any generated list gets stored as string array in the outgoing container as well.
Processors implementing adams.flow.processor.GraphicalOutputProducingProcessor can optionall display the graphical output as well (off by default).classProgrammaticTokenListenerTransformer that allows other, non-flow code to 'listen on the wire' of the data being processed.
Typically used for flows that are executed as background jobs in the user interface.
Listeners get removed once the flow finishes (wrapUp method).classPropertiesFileReaderReads a Java Properties file.classPropertiesToVariablesTurns the properties into variables.
Only the property keys that match the regular expression are turned into variables.classPythonExpandScriptLoads the Python script received as input, expands any variables and placeholders, saves it to the specified output file and forwards the output file name.classRelativeDirRemoves the prefix from the file/directory being passed through to turn them into relative ones.
See also:
adams.flow.transformer.BaseName
adams.flow.transformer.DirName
adams.flow.transformer.AppendName
adams.flow.transformer.PrependDir
adams.flow.transformer.FileExtension
Input/output:
- accepts:
java.lang.String
java.lang.String[]
java.io.File
java.io.File[]
- generates:
java.lang.String
java.lang.String[]
java.io.File
java.io.File[]
classRemoteCommandReaderLoads the remote command from the incoming file.classRemoveImageObjectRemoves the specified image object.classRemoveOverlappingImageObjectsCleans up overlapping objects, e.g., multiple predicted bounding boxes per object.classReportDbUpdaterAdds all the data to the report (or reporthandler's report) passing through that the SQL statement returns.
The {ID} placeholder can be used in the SQL statement to represent the current handler's ID.
The following types of SQL statements are supported:
- multiple rows of key-value pairs.
- single row, with the key being the column name.
Input/output:
- accepts:
adams.data.report.Report
adams.data.report.MutableReportHandler
- generates:
adams.data.report.Report
adams.data.report.MutableReportHandler
classReportFieldReturns all the fields in a report or the report from a report handling object that match the provided regular expression.classReportFileReaderLoads a file containing a report from disk with a specified reader and passes it on.classReportFileWriterSaves a report to disk with the specified writer and passes the absolute filename on.
As filename/directory name (depending on the writer) the database ID of the report is used (below the specified output directory).classReportMathExpressionEvaluates a mathematical expression based on report values.
Either outputs the updated report or the report handler if that allows updating the report.classReportToStorageStores all report fields that match the provided regular expression in internal storage.classReportToVariablesTurns all report fields that match the provided regular expression into variables.classRoundPerforms 'round', 'ceiling' or 'floor' on double tokens and generates integers.classSaveEmailAttachmentsSaves attachments of emails passing through in the specified folder and forwards the full paths to the files.classScaleReportObjectsScales the objects in the report using the provided scale factors.
Processes the following suffixes of all the report fields that match the provided prefix:
- .x
- .y
- .width
- .height
Input/output:
- accepts:
adams.data.report.Report
adams.data.report.ReportHandler
- generates:
adams.data.report.Report
adams.data.report.ReportHandler
classScpFromDownloads a remote file and forwards the local file name using secure copy (SCP).
For more information see:
(2011).classScpToUploads a file to a remote directory using secure copy (SCP).
The file name of a successful upload gets forwarded.
For more information see:
(2011).classScriptedA transformer that uses an external script for processing the token(s).classSelectArraySubsetAllows the user to select a subset of the incoming array to be forwarded in the flow.classSequenceToArrayTurns a sequence of tokens into arrays with a specified length.
In case of unspecified length (ie -1), an array containing all elements collected so far is output each time a token arrives, i.e., the internal buffer never gets reset.
See also:
adams.flow.transformer.ArrayToSequence
Input/output:
- accepts:
adams.flow.core.Unknown
- generates:
adams.flow.core.Unknown[]
classSequenceToCollectionTurns a sequence of tokens into a collection.
In case of unspecified length (ie -1), a collection containing all elements collected so far is output each time a token arrives, i.e., the internal buffer never gets reset.classSetArrayElementSets an element of an array and forwards the updated array.classSetDatabaseIDUpdates the database ID of the database ID handler passing through with the provided 'ID' value.classSetIDUpdates the ID of the ID handler passing through with the provided 'ID' value.classSetImageObjectMetaDataSets meta-data in the incoming adams.flow.transformer.locateobjects.LocatedObject object.classSetJsonValueSets a value in a JSON object, using the specified path.
The value can be either supplied as string using the 'value' property, obtained from a callable actor (property 'source') or from a storage item (property 'storage').classSetManyVariablesSets the values of the variables whenever a token passes through, but does not use the token's value.
Optionally, the specified values can be expanded, in case it is made up of variables itself.
Grammar for mathematical expressions (value type 'MATH_EXPRESSION, MATH_EXPRESSION_ROUND'):
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr !classSetMapValueSets a value in a java.util.Map object.
The value can be either supplied as string using the 'value' property, obtained from a callable actor (property 'source') or from a storage item (property 'storage').classSetPlotContainerValueUpdates a value of a plot container before it is being displayed in the SequencePlotter sink.classSetPropertySets the property of a callable actor whenever a token passes through.
Note: this actor just sets the value, but performs no re-initialization or similar of the modified object.
The transformer just forwards tokens that it receives after the property has been set.classSetPropertyValueSets a property in a properties object.classSetReportFromFileLoads a report from disk and replaces the current one in the token passing through.classSetReportFromSourceObtains a report from a callable source and replaces the current one in the token passing through.classSetReportValueSets a value in a report.classSetStorageFlagStores the flag value in storage using the specified name whenever a token passes through.classSetStorageValueStores the payload of the token passing through under the specified name in temporary storage.classSetSystemPropertySets a Java system property when it is executed.classSetVariableSets the value of a variable.classSFTPDeleteDeletes a remote file via secure FTP (SFTP) and forwards the deleted file name.
For more information see:
(2011).classSFTPGetDownloads a remote file and forwards the local file name via secure FTP (SFTP).
For more information see:
(2011).classSFTPSendUploads a file to a remote directory using secure FTP (SFTP).
The file name of a successful upload gets forwarded.
For more information see:
(2011).classSimpleStringReplacePerforms a string replacement, using String.replace(.., ...).
If the 'replace' string contains both, variables and placeholders, then first all variables are expanded and then the placeholders.classSMBGetDownloads a remote file and forwards the local file name (SMB, Windows share).
Host and remote directory can be left empty if the incoming filename consists of a fully qualified URL, e.g.: smb://host/share/dir/file.txt
Input/output:
- accepts:
java.lang.String
- generates:
java.lang.String
classSMBSendUploads a file to a remote directory (SMB, Windows share).
The file name of a successful upload gets forwarded.
Input/output:
- accepts:
java.lang.String
- generates:
java.lang.String
classSortActor for sorting arrays.classSplitFileSplits the file into several smaller files using the specified splitter algorithm.classSpreadSheetAggregateAggregates rows (min, max, avg, etc) in a spreadsheet using key columns.
All numeric columns in the specified aggregrate range (excluding the key columns) get aggregated.classSpreadSheetAnonymizeAnonymizes a range of columns in a spreadsheet.classSpreadSheetAppendAppends the incoming spreadsheet to one in storage.
If there is none in storage yet, the incoming spreadsheet will simply get stored in storage.
The spreadsheets need not have the same structure, but it is assumed that column names are unique within a spreadsheet.
The combined spreadsheet is then forwarded.classSpreadSheetAppendCommentsAppends the comments of the spreadsheet.classSpreadSheetCellFinderOutputs the cell locations that the cell finder located.classSpreadSheetCellSelectorLets the user highlight cells in a spreadsheet which get output:
- spreadsheet with coordinates (1-based row and column) and the associated value of the selected cell
- spreadsheet with all un-selected cells set to missing
Usage:
You select cells by left-clicking on them and/or holding the left mouse button and moving the mouse over the cells that you want to select.
You can unselect cells in the same fashion, by holding the shift key in addition.classSpreadSheetCollapseUses the specified key columns to identify groups of rows.classSpreadSheetColumnFilterFilters spreadsheets using the specified column finder.
The output contains all the columns that the specified finder selected.classSpreadSheetColumnIteratorIterates through all columns of a spreadsheet and outputs the names.
The columns can be limited with the range parameter and furthermore with the regular expression applied to the names.
Instead of outputting the names, it is also possible to output the 1-based indices.classSpreadSheetColumnsByNameCreates a new spreadsheet with the columns that matched the regular expression.classSpreadSheetColumnStatisticGenerates statistics for a chosen colunm.classSpreadSheetCommonIDsExtracts the common IDs from two or more spreadsheets.
Matching sense can be inverted, i.e., the IDs not in common are output.classSpreadSheetConvertCellsFinds cells in a spreadsheet and converts them with a conversion scheme.
If the conversion scheme generates a adams.data.spreadsheet.SpreadSheet object itself, this will get merged with the enclosing one: any additional columns get added and the content of the first row gets added to the row the converted cell belongs to.classSpreadSheetConvertHeaderCellsConverts the header cells of a spreadsheet with a conversion scheme.classSpreadSheetCopyColumnsCopies a range of columns to a specific position in the spreadsheets coming through.classSpreadSheetCopyRowsCopies a range of columnrows to a specific position in the spreadsheets coming through.classSpreadSheetDifferenceComputes the difference of the numeric cells between two spreadsheets.
The values of the second spreadsheet are subtracted from the first one.
If no 'key' columns are defined, the current order of rows is used for comparison.classSpreadSheetExtractArrayExtracts a column or row of data from a SpreadSheet object.classSpreadSheetFileReaderReads a spreadsheet file and forwards the content.classSpreadSheetFilterApplies the specified spreadsheet filter to the data.classSpreadSheetGetCellExtracts one or more values from a spreadsheet.classSpreadSheetGetColumnIndexObtain the 1-based indices of columns that match a user-specified regular expression.classSpreadSheetGetHeaderCellExtracts a single value from a spreadsheet's header.classSpreadSheetHistogramRangesOutputs the ranges generated by adams.data.statistics.ArrayHistogram using the incoming adams.data.spreadsheet.SpreadSheet object.
If cells aren't numeric or missing, a default value of zero is used.classSpreadSheetInfoOutputs statistics of a SpreadSheet object.classSpreadSheetInsertColumnInserts a column at a specific position into spreadsheets coming through.
The cells are initialized with a pre-defined value.classSpreadSheetInsertRowInserts a row at a specific position into spreadsheets coming through.
The cells are initialized with a pre-defined value.classSpreadSheetInsertRowScoreInserts a score column at a specific position into spreadsheets coming through.classSpreadSheetMatrixStatisticGenerates statistics for the spreadsheet.classSpreadSheetMergeMerges two or more spreadsheets.classSpreadSheetMethodMergeMerges 2 or more spreadsheets into a single spreadsheet, using a selectable merge method.classSpreadSheetPlotGeneratorOutputs plot containers generated from a spreadsheet.classSpreadSheetQueryApplies a query (SELECT, UPDATE, DELETE) on a spreadsheet.
Variables are supported as well, e.g., : SELECT * WHERE Blah = @{val} with 'val' being a variable available at execution time.
The following grammar is used for the query:
expr_list ::= expr_list expr_part | expr_part;
expr_part ::= select | update | delete;
select ::= SELECT col_list [limit]
| SELECT col_list WHERE cond_list [limit]
| SELECT col_list ORDER BY order_list [limit]
| SELECT col_list WHERE cond_list ORDER BY order_list [limit]
| SELECT agg_list
| SELECT agg_list GROUP BY col_list
| SELECT agg_list HAVING cond_list
| SELECT agg_list GROUP BY col_list HAVING cond_list
;
update ::= UPDATE SET upd_list
| UPDATE SET upd_list WHERE cond_list
;
delete ::= DELETE WHERE cond_list
;
col_list ::= col_list COMMA col
| col
| SELECT NUMBER [subsample: <1 = percent; >= 1 number of rows]
;
col ::= *
| COLUMN
| COLUMN AS COLUMN
;
upd_list ::= upd_list COMMA upd | upd;
upd ::= COLUMN = value
;
order_list::= order_list COMMA order | order;
order ::= COLUMN
| COLUMN ASC
| COLUMN DESC
;
cond_list ::= cond_list cond
| cond
;
cond ::= COLUMN < value
| COLUMN <= value
| COLUMN = value
| COLUMN <> value
| COLUMN >= value
| COLUMN > value
| COLUMN REGEXP STRING
| COLUMN IS NULL
| CELLTYPE ( COLUMN ) = "numeric|long|double|boolean|string|time|date|datetime|timestamp|object|missing"
| ( cond )
| cond:c1 AND cond:c2
| cond:c1 OR cond:c2
| NOT cond
;
value ::= NUMBER
| STRING
| PARSE ( "number" , STRING )
| PARSE ( "date" , STRING )
| PARSE ( "time" , STRING )
| PARSE ( "timestamp" , STRING )
;
limit ::= LIMIT NUMBER:max
| LIMIT NUMBER:offset , NUMBER:max
;
agg_list ::= agg_list COMMA agg
| agg
;
agg ::= COUNT [(*)] [AS COLUMN]
| MIN ( COLUMN ) [AS COLUMN]
| MAX ( COLUMN ) [AS COLUMN]
| RANGE ( COLUMN ) [AS COLUMN] (= MIN - MAX)
| MEAN ( COLUMN ) [AS COLUMN]
| AVERAGE ( COLUMN ) [AS COLUMN]
| STDEV ( COLUMN ) [AS COLUMN]
| STDEVP ( COLUMN ) [AS COLUMN]
| SUM ( COLUMN ) [AS COLUMN]
| IQR ( COLUMN ) [AS COLUMN]
| INTERQUARTILE ( COLUMN ) [AS COLUMN]
Notes:
- time format: 'HH:mm'
- date format: 'yyyy-MM-dd'
- timestamp format: 'yyyy-MM-dd HH:mm'
- STRING is referring to characters enclosed by double quotes
- COLUMN is either a string with no blanks (consisting of letters, numbers, hyphen or underscore; eg 'MyCol-1') or a bracket enclosed string when containing blanks (eg '[Some other col]')
- columns used in the ORDER BY clause must be present in the SELECT part; also, any alias given to them in SELECT must be used instead of original column name
Input/output:
- accepts:
adams.data.spreadsheet.SpreadSheet
- generates:
adams.data.spreadsheet.SpreadSheet
classSpreadSheetRandomSystematicSamplePerforms random systematic sampling on the rows of the incoming spreadsheet.
Divides the rows into N blocks with N being the sample size.classSpreadSheetRemoveColumnRemoves the column(s) at the specific position from spreadsheets coming through.classSpreadSheetRemoveRowRemoves one or more rows at the specific position from spreadsheets coming through.classSpreadSheetReorderColumnsReorders the columns in a spreadsheet according to a user-supplied order.classSpreadSheetReorderRowsReorders the rows in a spreadsheet according to a user-supplied order.classSpreadSheetReplaceCellValueReplaces cell values that match a regular expression with a predefined value.classSpreadSheetRowBinningApplies a binning algorithm to the values from the specified binning column to filter the rows into specific bins.
A new column is then added containing the corresponding bin index.classSpreadSheetRowBufferCan act in two different ways:
1.classSpreadSheetRowFilterFilters spreadsheets using the specified row finder.
The output contains all the rows that the specified finder selected.classSpreadSheetRowStatisticGenerates statistics for a chosen row.classSpreadSheetRowToTimeseriesTurns a spreadsheet row into a timeseries.
Columns for timestamps and values are extracted using the regular expressions, the timestamp columns are optional.classSpreadSheetSelectSubsetAllows the user to select a subset of the incoming spreadsheet to be forwarded in the flow.classSpreadSheetSetCellSets the value of the specified cells in a spreadsheet.classSpreadSheetSetHeaderCellSets a single header cell value in a spreadsheet.classSpreadSheetSortSorts the rows of the spreadsheet according to the selected column indices and sort order (ascending/descending).classSpreadSheetSortColumnsReorders a user-defined subset of columns by name using the specified comparator.classSpreadSheetStatisticGenerates statistics from a SpreadSheet object.
If cells aren't numeric or missing, a default value of zero is used.classSpreadSheetStorageRowIteratorIterates through a defined range of rows.classSpreadSheetSubsetExtracts a subset of rows/columns from a spreadsheet.classSpreadSheetSubsetByValueGenerates subsets from a spreadsheet, grouped by the same string value in the specified column.
For instance, if a spreadsheet has 3 unique values (A, B, C) in column 2, then 3 subsheets will generated, each containing the rows that have the value A, B or C.classSpreadSheetSubsetFromGroupSplits the spreadsheet into subsets using the supplied column and then returns the specified range of rows from each generated subset.
The spreadsheet is expected to be sorted on the grouping column.classSpreadSheetToTimeseriesExtracts one or more timeseries from a spreadsheet.
It uses one column ('ID') to identify all the rows that belong to a single timeseries.classSpreadSheetTransformCellsFinds cells in a spreadsheet and transforms them with a callable transformer.
In case of transformers having Object or Unknown in their types of classes that they accept, no proper type can be inferred automatically.classSpreadSheetTransformHeaderCellsTransforms header cells with a callable transformer.
In case of transformers having Object or Unknown in their types of classes that they accept, no proper type can be inferred automatically.classSpreadSheetVariableRowIteratorIterates through a defined range of rows.classStorageCollectionInsertInserts the object passing through to the collection in storage at the specified position.
After inserting the object successfully, just forwards the object.
If the collection does not implement the java.util.List interface and the insertion is not at the end, the insertion will fail.
See also:
adams.flow.transformer.CollectionInsert
Input/output:
- accepts:
adams.flow.core.Unknown
- generates:
adams.flow.core.Unknown
classStorageJFreeChartAddSeriesGenerates a series from the incoming spreadsheet and adds it to the specified JFreeChart dataset in storage.
After inserting the object successfully, just forwards the object.classStorageXChartAddDatasetGenerates datasets from the incoming spreadsheet and adds them to the specified XChart datasets in storage.
After inserting the object successfully, just forwards the object.classStringArraySplitUses a regular expression to identify the string that triggers one or more splits in a string array, resulting in smaller arrays being output.
What is done with the string triggering the split, is defined in the split handling option, e.g., discard it.
Useful actor for splitting a log file into individual entry chunks.classStringCutCuts out a part of a string.classStringExpressionEvaluates a string expression.
The input string can be accessed via 'X'.
Variables are supported as well, e.g.: pow(X,@{exp}) with '@{exp}' being a variable available at execution time.
The following grammar is used for the expressions:
expr_list ::= '=' expr_list expr_part | expr_part ;
expr_part ::= expr ;
expr ::= ( expr )
# data types
| number
| string
| boolean
| date
# constants
| true
| false
| pi
| e
| now()
| today()
# negating numeric value
| -expr
# comparisons
| expr < expr
| expr <= expr
| expr > expr
| expr >= expr
| expr = expr
| expr !classStringIndentIndents the string with the specified character.
Splits multi-line strings first and processes each line separately.classStringIndexOfDetermines the position of a substring in the string passing through.
The generated index is 1-based, with 0 indicating that the substring could not be located.classStringInsertInserts a user-specified string at a specific position into tokens coming through.
The actor is most useful when attaching a variable to the 'value' option, which allows the value to change dynamically then.classStringJoinCreates a single string out of an array of strings.classStringLengthDetermines the length of a string.classStringMatcherLets string tokens only pass if they match the regular expression.classStringRangeCutCuts out a parts of a string.classStringReplacePerforms a string replacement, using either String.replaceFirst(...) or String.replaceAll(...).classStringSanitizerRemoves all characters that haven't been specified as 'acceptable' characters.classStringSplitSplits a string using a regular expression.classStringTrimTrims strings, i.e., removes leading/trailing whitespaces.classSubStringCountDetermines the position of a substring in the string passing through.
The generated index is 1-based, with 0 indicating that the substring could not be located.classSummaryStatisticsCalculates the selected summary statistics and outputs a spreadsheet.classSwapVariablesSwaps the values of the two variables around, whenever a token passes through.classTarCreates a Tar file containing one or more files.classTemplateTransformerFeeds tokens into an actor generated from a template and broadcasts the generated output tokens.classTesseractOCRApplies OCR to the incoming image file using Tesseract.
In case of successful OCR, either the file names of the generated files are broadcast or the combined text of the files.
NB: The actor deletes all files that have the same prefix as the specified output base.classTextFileReaderReads a text file and forwards the content.
This actor takes the file to read as input.classTextRendererTurns incoming objects into their textual representation, either automatic detection based on their data type or by explicitly specifying a renderer.classTimeseriesAddAppends the incoming timeseries to the one available from storage.
If none yet available from storage, then the current one simply put into storage.
If the timeseries already contains elements with the same timestamp, then these will get replaced by the current ones.classTimeseriesAppendAppends the incoming timeseries to the one available from storage.
If none yet available from storage, then the current one simply put into storage.
If the timeseries already contains elements with the same timestamp, then these will get replaced by the current ones.classTimeseriesDbReaderOutputs timeseries containers generated from an SQL SELECT statement.
A new container is started, whenever the value of the ID column changes (hence you need to ensure that the data is ordered on this column).classTimeseriesFeatureGeneratorApplies a timeseries feature generator to the incoming timeseries and outputs the generated features.classTimeseriesFileReaderLoads a file/directory containing timeseries containers from disk with a specified reader and passes them on.classTimeseriesFileWriterSaves a spectrum to disk with the specified writer and passes the absolute filename on.
As filename/directory name (depending on the writer) the database ID of the spectrum is used (below the specified output directory).classTimeseriesFilterFilters data using the specified filter.classTimeseriesInfoOutputs information for a timeseries.classTimeseriesReportDbUpdaterAdds all the data to the report of the timeseries passing through that the SQL statement returns.
The {ID} placeholder can be used in the SQL statement to represent the current timeseries' ID.
The following types of SQL statements are supported:
- multiple rows of key-value pairs.
- single row, with the key being the column name.
Input/output:
- accepts:
adams.data.timeseries.Timeseries
- generates:
adams.data.timeseries.Timeseries
classTimeseriesSplitSplits the incoming timeseries into sub-series using the specified splitter algorithm.classTimestampCreates a timestamp string whenever it receives an input token.classToolRuns a tool.classTouchLike the Unix 'touch' command, updates the 'last modified' timestamp of the file coming through.
By default, it creates the file if it doesn't exist.classUnBzip2Decompresses an archive that was compressed with bzip2.classUniqueIDEnsures that all passing through tokens that implement adams.data.id.MutableIDHandler have a unique ID.
All other tokens are just forwarded as is.classUnLzfDecompresses an archive that was compressed with LZF.classUnLzmaDecompresses an archive that was compressed with LZMA (7zip).classUnRARUnrars a RAR archive and broadcasts the full file names of the extracted files.classUnTarDecompresses a Tar archive and broadcasts the full file names of the extracted files.classUnXzDecompresses an archive that was compressed with XZ.classUnZIPUnzips a ZIP archive and broadcasts the full file names of the extracted files.classUnZstdDecompresses an archive that was compressed with Zstd.classUpdateGroupUpdates the group of the object passing through.classUpdateIDclassUpdatePropertyUpdates the property of the object passing through with the specified value.classViaAnnotationsToReportsConverts the JSON object passing through to Reports.classWaitForFileWaits for the file passing through to become available, i.e., not in use by another process.classWekaAccumulatedErrorGenerates plot containers from an evaluation object's predictions.classWekaAggregateEvaluationsAggregates incoming weka.classifiers.Evaluation objects and forwards the current aggregated state.classWekaAttributeIteratorIterates through all attributes of a dataset and outputs the names.
The attributes can be limited with the range parameter and furthermore with the regular expression applied to the names.
Instead of outputting the names, it is also possible to output the 1-based indices.classWekaAttributeSelectionPerforms attribute selection on the incoming data.
In case of input in form of a class adams.flow.container.WekaTrainTestSetContainer object, the train and test sets stored in the container are being used.
NB: In case of cross-validation no reduced or transformed data can get generated!classWekaAttributeSelectionSummaryOutputs a summary string of the attribute selection.classWekaBootstrappingPerforms bootstrapping on the incoming evaluation and outputs a spreadsheet where each row represents the results from bootstrapping sub-sample.classWekaChooseAttributesLets the user select attributes interactively to use down the track.
Internally, a weka.filters.unsupervised.attribute.Remove WEKA filter is constructed from the selection, to remove the attributes that the user didn't select.classWekaClassifierInfoOutputs information of a trained weka.classifiers.Classifier object.classWekaClassifierOptimizerEvaluates a classifier optimizer on an incoming dataset.classWekaClassifierRankerPerforms a quick evaluation using cross-validation on a single dataset (or evaluation on a separate test set if the number of folds is less than 2) to rank the classifiers received on the input and forwarding the x best ones.classWekaClassifierSetupProcessorApplies the specified processor to the incoming array of classifiers, e.g., for generating new or filtered setups.classWekaClassifyingUses a serialized model to perform predictions on the data being passed through.
The following order is used to obtain the model (when using AUTO):
1. model file present?classWekaClassSelectorSets the class index.classWekaClusterAssignmentsOutputs the cluster assignments from the evaluation.classWekaClustererInfoOutputs information of a trained weka.clusterers.Clusterer object.classWekaClustererPostProcessorApplies the specified post-processor to the cluster container (adams.flow.container.WekaModelContainer)
See also:
adams.flow.transformer.WekaTrainClusterer
Input/output:
- accepts:
adams.flow.container.WekaModelContainer
- generates:
adams.flow.container.WekaModelContainer
Container information:
- adams.flow.container.WekaModelContainer: Model, Header, Dataset
classWekaClusterEvaluationSummaryGenerates a summary string of the weka.clusterers.ClusterEvaluation objects that it receives.classWekaClusteringUses a serialized model to cluster data being passed through.
The following order is used to obtain the model (when using AUTO):
1. model file present?classWekaCrossValidationClustererEvaluatorCross-validates a clusterer on an incoming dataset.classWekaCrossValidationEvaluatorCross-validates a classifier on an incoming dataset.classWekaCrossValidationSplitGenerates train/test pairs like during a cross-validation run.classWekaDatasetsMergeMerges 2 or more datasets into a single dataset, under a selectable merge method.classWekaDatasetSplitSplits the incoming dataset into sub-sets using the specified splitter.classWekaEnsembleGeneratorUses the specified generator to create ensembles from the incoming data.classWekaEvaluationInfoOutputs information about a Weka weka.classifiers.Evaluation object.classWekaEvaluationPostProcessorApplies the specified post-processor to the incoming Evaluation data.classWekaEvaluationSummaryGenerates a summary string of the weka.classifiers.Evaluation objects that it receives.classWekaEvaluationValuePickerPicks a specific value from an evaluation object.classWekaEvaluationValuesGenerates a spreadsheet from statistics of an Evaluation object.classWekaExperimentRepresents a Weka experiment, stored in a file.classWekaExperimentEvaluationGenerates evaluation output of an experiment that was run previously.classWekaExperimentExecutionExecutes an experiment.classWekaExperimentFileReaderLoads an experiment file.classWekaExtractArrayExtracts a column or row of data from a weka.core.Instances or SpreadSheet object.
Only numeric columns can be returned.classWekaExtractPLSMatrixTransformer that allows the extraction of internal PLS filter/classifier matrices, forwarding them as spreadsheets.classWekaFileReaderReads any file format that Weka's converters can handle and returns the full dataset or single weka.core.Instance objects.classWekaFilterFilters Instances/Instance objects using the specified filter.
When re-using a trained filter, ensure that 'initializeOnce' is checked.
The following order is used to obtain the model (when using AUTO):
1. model file present?classWekaGenericPLSMatrixAccessTransformer that allows the extraction of internal PLS filter/classifier matrices, forwarding them as spreadsheets.
See the respective PLS implementation for details on available matrix names (derived from: weka.filters.supervised.attribute.pls.AbstractPLS)
Input/output:
- accepts:
weka.classifiers.Classifier
weka.filters.Filter
weka.core.GenericPLSMatrixAccess
adams.flow.container.WekaModelContainer
- generates:
adams.data.spreadsheet.SpreadSheet
Container information:
- adams.flow.container.WekaModelContainer: Model, Header, Dataset
classWekaGeneticAlgorithmApplies the genetic algorithm to the incoming dataset.
Forwards the best setup(s) after the algorithm finishes.
A callable sink can be specified for receiving intermediate performance results.classWekaGeneticAlgorithmInitializerPopulates a adams.flow.container.WekaGeneticAlgorithmInitializationContainer container from the data obtained from the incoming setup (in properties format, can be gzip compressed).classWekaGetCapabilitiesRetrieves the capabilities of a weka.core.CapabilitiesHandler (eg filter or classifier) and forwards them.classWekaGetInstancesValueRetrieves a value from a WEKA Instances object.
Notes:
- date and relational values are forwarded as strings
- missing values are output as '?'classWekaGetInstanceValueRetrieves a value from a WEKA Instance object.
Notes:
- date and relational values are forwarded as strings
- missing values are output as '?'classWekaInstanceBufferCan act in two different ways:
1.classWekaInstanceDumperDumps weka.core.Instance objects into an ARFF file.classWekaInstanceEvaluatorAdds a new attribute to the data being passed through (normally 'evaluation') and sets the value to the evaluation value returned by the chosen evaluator scheme.classWekaInstanceFileReaderLoads a WEKA dataset from disk with a specified reader and passes on the adams.core.instance.Instance objects.classWekaInstancesAppendCreates one large dataset by appending all one after the other.classWekaInstancesHistogramRangesOutputs the ranges generated by adams.data.statistics.ArrayHistogram using the incoming weka.core.Instances object.
The actor just uses the internal format (double array) and does not check whether the attributes are actually numeric.classWekaInstancesInfoOutputs statistics of a weka.core.Instances object.
FULL_ATTRIBUTE and FULL_CLASS output a spreadsheet with detailed attribute statistics.classWekaInstancesMergeMerges multiple datasets, either from file or using Instances/Instance objects.
If no 'ID' attribute is named, then all datasets must contain the same number of rows.
Attributes can be excluded from ending up in the final dataset via a regular expression.classWekaInstancesStatisticGenerates statistics from a weka.core.Instances object.
The actor just uses the internal format (double array) and does not check whether the attributes are actually numeric.classWekaInstanceStreamPlotGeneratorGenerates plot containers from a range of attributes of the weka.core.Instance objects being passed through.
The generator merely uses the internal data representation for generating the Y value of the plot container.classWekaModelReaderActor for loading a model (classifier or clusterer).classWekaMultiLabelSplitterSplits a dataset containing multiple class attributes ('multi-label') into separate datasets with only a single class attribute.classWekaNearestNeighborSearchOutputs the specified number of nearest neighbors for the incoming Weka Instance.
The data used for the nearest neighbor search is either obtained from storage.classWekaNewInstanceCreates a new weka.core.Instance-derived object, with all values marked as missing.
The class implementing the weka.core.Instance interface needs to have a constructor that takes the number of attributes as sole parameter.classWekaPackageManagerActionApplies the selected Weka Package Manager action to the incoming data and forwards the generated output.classWekaPredictionsToInstancesGenerates weka.core.Instances from the predictions of an Evaluation object.classWekaPredictionsToSpreadSheetGenerates a SpreadSheet object from the predictions of an Evaluation object.
See also:
adams.flow.transformer.WekaSpreadSheetToPredictions
Input/output:
- accepts:
weka.classifiers.Evaluation
adams.flow.container.WekaEvaluationContainer
- generates:
adams.data.spreadsheet.SpreadSheet
Container information:
- adams.flow.container.WekaEvaluationContainer: Evaluation, Model, Prediction output, Original indices, Test data
classWekaPrimeForecasterPrimes a forecaster with the incoming data and outputs the updated forecaster alongside the training header (in a model container).classWekaPrincipalComponentsPerforms principal components analysis on the incoming data and outputs the loadings and the transformed data as spreadsheet array.
Automatically filters out attributes that cannot be handled by PCA.classWekaRandomSplitSplits a dataset into a training and test set according to a specified split percentage.classWekaRegexToRangeProduces a range string from a regular expression describing attributes.classWekaRelationNameDeprecated.classWekaRenameRelationModifies relation names.classWekaReorderAttributesToReferenceReorders the attributes of the Instance/Instances passing through according to the provided reference dataset (callable actor or reference file).
This ensures that the generated data always has the same structure as the reference dataset.classWekaRepeatedCrossValidationEvaluatorPerforms repeated cross-validation a classifier on an incoming dataset.classWekaRepeatedCrossValidationOutputGenerates output from the incoming repeated cross-validation data.classWekaSetInstancesValueSets a value in a WEKA Instances object.
Notes:
- relational values cannot be set
- '?'classWekaSetInstanceValueSets a value in a WEKA Instance.
Notes:
- relational values cannot be set
- '?'classWekaSplitGeneratorclassWekaSpreadSheetToPredictionsTurns the predictions stored in the incoming spreadsheet (actual and predicted) into a Weka weka.classifiers.Evaluation object.
For recreating the predictions of a nominal class, the class distributions must be present in the spreadsheet as well.
See also:
adams.flow.transformer.WekaPredictionsToSpreadSheet
Input/output:
- accepts:
adams.data.spreadsheet.SpreadSheet
- generates:
weka.classifiers.Evaluation
classWekaStoreInstanceAppends the incoming weka.core.Instance to the dataset in storage.classWekaStreamEvaluatorEvaluates an incremental classifier on a data stream using prequential evaluation (first evaluate, then train).classWekaStreamFilterFilters Instance objects using the specified filter.classWekaSubsetsSplits the dataset based on the unique values of the specified attribute: all rows with the same unique value form a subset.classWekaTestSetClustererEvaluatorEvaluates a trained clusterer (obtained from input) on the dataset obtained from the callable actor.
If a class attribute is set, a classes-to-clusters evaluation is performed automatically
Input/output:
- accepts:
weka.clusterers.Clusterer
adams.flow.container.WekaModelContainer
- generates:
adams.flow.container.WekaClusterEvaluationContainer
Container information:
- adams.flow.container.WekaModelContainer: Model, Header, Dataset
- adams.flow.container.WekaClusterEvaluationContainer: Evaluation, Model, Log-likelohood
classWekaTestSetEvaluatorEvaluates a trained classifier (obtained from input) on the dataset obtained from the callable actor.classWekaTextDirectoryReaderLoads all text files in a directory and uses the subdirectory names as class labels.classWekaTrainAssociatorTrains an associator based on the incoming dataset and outputs the built associator alongside the training header and rules (in a model container)..classWekaTrainClassifierTrains a classifier based on the incoming dataset and outputs the built classifier alongside the training header (in a model container).
Incremental training is performed, if the input are weka.core.Instance objects and the classifier implements weka.classifiers.UpdateableClassifier.classWekaTrainClustererTrains a clusterer based on the incoming dataset and output the built clusterer alongside the training header (in a model container).
Incremental training is performed, if the input are weka.core.Instance objects and the clusterer implements weka.clusterers.UpdateableClusterer.classWekaTrainForecasterTrains a forecaster based on the incoming dataset and outputs the built model alongside the training header (in a model container).classWekaTrainTestSetClustererEvaluatorTrains a clusterer on an incoming training dataset (from a container) and then evaluates it on the test set (also from a container).
The clusterer setup being used in the evaluation is a callable 'Clusterer' actor.
If a class attribute is set, a classes-to-clusters evaluation is performed automatically
Input/output:
- accepts:
adams.flow.container.WekaTrainTestSetContainer
- generates:
adams.flow.container.WekaClusterEvaluationContainer
Container information:
- adams.flow.container.WekaTrainTestSetContainer: Train, Test, Seed, FoldNumber, FoldCount
- adams.flow.container.WekaClusterEvaluationContainer: Evaluation, Model, Log-likelohood
classWekaTrainTestSetEvaluatorTrains a classifier on an incoming training dataset (from a container) and then evaluates it on the test set (also from a container).
The classifier setup being used in the evaluation is a callable 'Classifier' actor.classXMLFileReaderReads an XML file and forwards the parsed org.w3c.dom.Document object.classXPathApplies XPath to the DOM document object.classXSLTApplies an XSLT stylesheet to the DOM document object.classXzCreates a XZ archive from a single file.classYamlFileReaderReads a YAML file and forwards the generated Map object.
http://yaml.org/
Input/output:
- accepts:
java.lang.String
java.io.File
- generates:
java.util.Map
classZIPCreates a ZIP file containing one or more files.classZstdCreates a Zstd archive from a single file. -
Uses of AdditionalInformationHandler in adams.flow.transformer.wekaclusterer
Classes in adams.flow.transformer.wekaclusterer that implement AdditionalInformationHandler Modifier and Type Class Description classAbstractClustererPostProcessorAncestor for post-processors for output that the WekaClusterer transformer produces.classAbstractClusterMembershipPostProcessorAncestor for post-processors that require a built clusterer and the dataset that was used to build the clusterer to be present in the model container.classAddClusterJust adds the predicted cluster (or distribution) to the original dataset.
Stored in container under: Clustered dataset
classAverageSilhouetteCoefficientComputes the average Silhouette coefficient for the clusters.classClusterCentersComputes the cluster centers for the provided dataset.classClusterCountsCreates an overview of how many instances get clustered into each cluster.
Stored in container under: Clustered dataset
classClusterStatisticsComputes cluster statistics (min/max/mean/stdev) for the provided dataset.classMultiClustererPostProcessorApplies the specified post-processors sequentially.classPassThroughDummy post-processor that just returns the model container as it is. -
Uses of AdditionalInformationHandler in adams.gui.core
Classes in adams.gui.core that implement AdditionalInformationHandler Modifier and Type Class Description classBooleanExpressionEditorPanelText editor pane with syntax highlighting for boolean expressions.classLookUpUpdateEditorPanelText editor pane with syntax highlighting for lookup updates.classMathematicalExpressionEditorPanelText editor pane with syntax highlighting for mathematical expressions.classSpreadSheetFormulaEditorPanelText editor pane with syntax highlighting for spreadsheet formula.classSpreadSheetQueryEditorPanelText editor pane with syntax highlighting for spreadsheet formula.classStringExpressionEditorPanelText editor pane with syntax highlighting for boolean expressions. -
Uses of AdditionalInformationHandler in adams.gui.flow.tree
Classes in adams.gui.flow.tree that implement AdditionalInformationHandler Modifier and Type Class Description classClipboardActorContainerA simple container for multiple actors, for easy copying to and retrieving from the clipboard.
-