org.knime.core.data.convert.datacell

Interface JavaToDataCellConverterFactory<S>

Type Parameters:

S - Java type which can be converted by the JavaToDataCellConverters created by this factory

All Known Implementing Classes:

ArrayToCollectionConverterFactory, FactoryMethodToDataCellConverterFactory, SimpleJavaToDataCellConverterFactory

public interface JavaToDataCellConverterFactory<S>

Interface for all factory classes which create JavaToDataCellConverters. You may extend this class and register the derived class under the extension point "org.knime.core.JavaToDataCellConverter". It is recommended that you extend SimpleJavaToDataCellConverterFactory if possible.

Since:

3.2

Author:

Jonathan Hale, KNIME, Konstanz, Germany

See Also:

org.knime.core.data.convert, JavaToDataCellConverter, JavaToDataCellConverterRegistry

Method Summary

Modifier and Type	Method and Description
JavaToDataCellConverter<S>	create(ExecutionContext context) Create an instance of a JavaToDataCellConverter which is able to convert instances of S into DataCells with the DataType returned by getDestinationType().
DataType	getDestinationType() Get the DataType (the type of data cells) which converters created by this factory are able to convert into
String	getIdentifier() Get the identifier for this factory.
default String	getName() A human readable name for this converter factory to be displayed in user interfaces for example.
Class<S>	getSourceType() Get the Class of the type which converters created by this factory are able to convert

Method Detail

create

JavaToDataCellConverter<S> create(ExecutionContext context)

Create an instance of a JavaToDataCellConverter which is able to convert instances of S into DataCells with the DataType returned by getDestinationType().

Parameters:

context - ExecutionContext which may be used for creating CellFactorys.

Returns:

a JavaToDataCellConverter instances

getDestinationType

DataType getDestinationType()

Get the DataType (the type of data cells) which converters created by this factory are able to convert into

Returns:

DataType of the DataCell created by the JavaToDataCellConverters produced by this factory.

getSourceType

Class<S> getSourceType()

Get the Class of the type which converters created by this factory are able to convert

Returns:

type which the created DataCellToJavaConverters can convert

getName

default String getName()

A human readable name for this converter factory to be displayed in user interfaces for example. Should contain at least the simple type name of the java type from which the data cell is created.

Examples: "InputStream", "Integer", "XML String", "SDF String"

s

Returns:

the name of this converter factory

getIdentifier

String getIdentifier()

Get the identifier for this factory. The identifier is a unique string used to unambiguously reference this converter factory. Since this identifier is used for persistence, it is required that the identifier is the same every runtime. If the identifier is not unique, the factory may not be loaded from the extension point.

Examples:

"org.mypackage.MyConverterFactory<MyType>"

Returns:

a unique identifier for this factory