Package adams.data.conversion

Interface Conversion

All Superinterfaces:

CleanUpHandler, QuickInfoSupporter, Serializable, Stoppable

All Known Subinterfaces:

BufferedImageToOtherFormatConversion, ConversionFromString, ConversionToString, ConversionWithInitialization, OtherFormatToBufferedImageConversion

All Known Implementing Classes:

AbstractConversion, AbstractConversionFromString, AbstractConversionToString, AbstractImageToByteArray, AbstractInPlaceSpreadSheetConversion, AbstractMatchWekaInstanceAgainstHeader, AbstractMatrixToSpreadSheet, AbstractObjectToJson, AbstractScript, AbstractScriptedConversion, AbstractSpreadSheetColumnConverter, AbstractSpreadSheetConversion, AbstractSpreadSheetToMatrix, AbstractStringConversion, AbstractSwapObject, AbstractValidateString, AdamsInstanceToWekaInstance, AnyImageToByteArray, AnyImageToOpenCV, AnyToCommandline, AnyToString, ArrayToCollection, ArrayToJsonArray, ArrayToReport, ArrayToYamlString, BackQuote, Base64ToByteArray, Base64ToString, BaseDateTimeMsecToString, BaseDateTimeToString, BaseDateToString, BaseTimeToString, BlobContainerToByteArray, BoofCVToBufferedImage, BooleanToString, BreakUpString, BufferedImageBitmaskContainerToBufferedImages, BufferedImagesToBufferedImageBitmaskContainer, BufferedImageSupporterToBufferedImageContainer, BufferedImageToBoofCV, BufferedImageToBufferedImage, BufferedImageToByteArray, ByteArrayToBase64, ByteArrayToBlobContainer, ByteArrayToBufferedImage, ByteArrayToImageContainer, ByteArrayToJavaObject, ByteArrayToPrimitiveArray, ByteArrayToString, ByteToHex, ByteToInt, ByteToString, CharArrayToString, CollectionToArray, ColorToHex, CommandlineToAny, ContainerToSpreadSheet, ConvertDateTimeType, ConvertSpreadSheetRows, DateTimeTypeToString, DOMNodeListToArray, DOMNodeToString, DOMToProperties, DOMToString, DoubleMatrixToBufferedImage, DoubleMatrixToMat5Array, DoubleMatrixToSpreadSheet, DoubleToFloat, DoubleToInt, DoubleToLong, DoubleToString, EmailToPlainText, ExcelDoubleColumnToDate, ExcelDoubleColumnToDateTime, ExtractDateTimeField, ExtractSimpleContainerContent, FieldToString, FileToString, FloatToDouble, Groovy, HashCode, HexToByte, HexToColor, HexToInt, HtmlCharacterEntitiesToString, ImageContainerToByteArray, ImageContainerToSpreadSheet, InformativeStatistic, IntToByte, IntToDouble, IntToHex, IntToLong, IntToRoman, IntToString, JavaObjectToByteArray, JoinOptions, JsonArrayToArray, JsonArrayToList, JsonObjectToMap, JsonToReport, JsonToSpreadSheet, JsonToString, LeftPad, ListToJson, ListToJsonArray, ListToYamlString, LocatedObjectsToReport, LocatedObjectToRectangle, LongToDouble, LongToInt, LongToString, LowerCase, MapToJson, MapToKeyValuePairs, MapToMat5File, MapToMat5Struct, MapToReport, MapToSpreadSheet, MapToString, MapToWekaInstance, MapToYamlString, Mat5ArrayToDoubleMatrix, Mat5ArrayToSpreadSheet, Mat5ArrayToString, Mat5CharToString, Mat5FileToMap, Mat5StructToMap, MatchWekaInstanceAgainstFileHeader, MatchWekaInstanceAgainstStorageHeader, MathExpression, Maximum, Minimum, MovingAverage, MultiConversion, NotesSubset, NotesToSpreadSheet, NotesToString, NumberToByte, NumberToDouble, NumberToFloat, NumberToInt, NumberToLong, ObjectAnnotationsToImageSegmentationLayers, ObjectArrayToPrimitiveArray, ObjectContainerToObject, ObjectToObject, ObjectToObjectContainer, OpenCVToBufferedImage, PathSplit, Point2DToString, PrettyPrintXML, PrimitiveArrayToByteArray, PrimitiveArrayToObjectArray, PropertiesToKeyValuePairs, PropertiesToMap, PropertiesToSpreadSheet, PropertiesToString, QuadrilateralLocationCenter, QuadrilateralLocationToString, Quote, RectangleCenter, RectangleToString, RemoteCommandToString, RenameSpreadSheet, RenameSpreadSheetColumn, ReplaceFileExtension, ReportArrayToMap, ReportToJson, ReportToMap, ReportToSpreadSheet, ReportToString, ReportToWekaInstance, RightPad, RomanToInt, Round, RowArrayToSpreadSheet, Scripted, SideBySideDiffToString, SimpleAsciiToUnicode, SimpleUnicodeToAscii, SplitOptions, SpreadSheetAddFormulaColumn, SpreadSheetAddFormulaRow, SpreadSheetAddRowID, SpreadSheetAddSumColumn, SpreadSheetAddSumRow, SpreadSheetAnyColumnToString, SpreadSheetBinarize, SpreadSheetCellFinderToPositions, SpreadSheetCellLocationToCoordinates, SpreadSheetCellLocationToPosition, SpreadSheetColumnFinderToRange, SpreadSheetColumnsToReport, SpreadSheetDoubleColumnToLong, SpreadSheetDoubleColumnToString, SpreadSheetEscapeColumnName, SpreadSheetHeaderToMat5Array, SpreadSheetInsertCellLocation, SpreadSheetInsertColumnPosition, SpreadSheetJoinColumns, SpreadSheetLongColumnToDouble, SpreadSheetMaterializeFormulas, SpreadSheetObjectColumnToString, SpreadSheetRowFinderToRange, SpreadSheetRowsToReport, SpreadSheetSplitColumn, SpreadSheetStringColumnToBoolean, SpreadSheetStringColumnToDate, SpreadSheetStringColumnToDateTime, SpreadSheetStringColumnToDateTimeMsec, SpreadSheetStringColumnToDouble, SpreadSheetStringColumnToLong, SpreadSheetStringColumnToObject, SpreadSheetStringColumnToTime, SpreadSheetStringColumnToTimeMsec, SpreadSheetSupporterToSpreadSheet, SpreadSheetToCreateTableStatement, SpreadSheetToDataset, SpreadSheetToDoubleMatrix, SpreadSheetToJson, SpreadSheetToMap, SpreadSheetToMat5Array, SpreadSheetToNumeric, SpreadSheetToRowArray, SpreadSheetToString, SpreadSheetToStringMatrix, SpreadSheetToTimeseries, SpreadSheetToWekaInstances, SpreadSheetUnescapeColumnName, SpreadSheetUniqueColumnNames, SpreadSheetUseRowAsHeader, StringArrayToURLParameters, StringExpression, StringMatrixToSpreadSheet, StringToBase64, StringToBoolean, StringToByte, StringToByteArray, StringToCharArray, StringToCustomStringRepresentation, StringToDateTimeType, StringToDouble, StringToField, StringToFile, StringToHtmlCharacterEntities, StringToInt, StringToJson, StringToLong, StringToMat5Array, StringToPoint2D, StringToProperties, StringToQuadrilateralLocation, StringToRectangle, StringToRemoteCommand, StringToReport, StringToSpreadSheet, StringToString, StringToTextContainer, StringToURL, StringToValidFileName, StringToValidStorageName, StringToValidVariableName, SwapObjects, SwapPLS, TextContainerToString, TextRenderer, TimeseriesToArray, TimeseriesToSpreadSheet, TimeseriesToWekaInstances, TimeToString, TransposeSpreadSheet, UnBackQuote, UnknownToUnknown, UnQuote, UpperCase, URLDecode, URLEncode, URLParametersToStringArray, URLToString, UseForwardSlashes, WekaCapabilitiesToInstances, WekaCapabilitiesToSpreadSheet, WekaCommandToCode, WekaDrawableToString, WekaEvaluationToCostCurve, WekaEvaluationToMarginCurve, WekaEvaluationToThresholdCurve, WekaForecastContainerToArray, WekaForecastContainerToTimeseries, WekaInstancesToSpreadSheet, WekaInstancesToTimeseries, WekaInstanceToAdamsInstance, WekaInstanceToMap, WekaPackageToMap, WekaPredictionContainerToSpreadSheet, XMLToDOM, YamlStringToList, YamlStringToMap

public interface Conversion
extends Serializable, CleanUpHandler, QuickInfoSupporter, Stoppable

Interface for conversion schemes.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
Class	accepts()	Returns the class that is accepted as input.
String	convert()	Performs the conversion.
Class	generates()	Returns the class that is generated as output.
Object	getInput()	The currently set input data to convert.
<T> T	getInput(Class<T> cls)	The currently set input data to convert.
Object	getOutput()	Returns the generated output.
<T> T	getOutput(Class<T> cls)	Returns the generated output.
Object	getOwner()	Returns the owner of this conversion.
void	setInput(Object value)	Sets the original data to convert.
void	setOwner(Object value)	Sets the owner of this conversion.

Methods inherited from interface adams.core.CleanUpHandler

cleanUp

Methods inherited from interface adams.core.QuickInfoSupporter

getQuickInfo

Methods inherited from interface adams.core.Stoppable

stopExecution

Method Detail

setOwner

void setOwner(Object value)

Sets the owner of this conversion.

Parameters:

value - the owner

getOwner

Object getOwner()

Returns the owner of this conversion.

Returns:

the owner, null if none set

setInput

void setInput(Object value)

Sets the original data to convert.

Parameters:

value - the data to convert

See Also:

StreamConversion

getInput

Object getInput()

The currently set input data to convert.

Returns:

the data to convert, can be null if not yet set

getInput

<T> T getInput(Class<T> cls)

The currently set input data to convert.

Parameters:

cls - for casting

Returns:

the data to convert, can be null if not yet set

accepts

Class accepts()

Returns the class that is accepted as input.

Returns:

the class

generates

Class generates()

Returns the class that is generated as output.

Returns:

the class

convert

String convert()

Performs the conversion.

Returns:

null if everything worked otherwise the error message

getOutput

Object getOutput()

Returns the generated output.

Returns:

the output, null if none produced yet

getOutput

<T> T getOutput(Class<T> cls)

Returns the generated output.

Returns:

the output, null if none produced yet