io.datafx.io

Interface Converter<U,T>

Type Parameters:

U - The format of the raw data, e.g. an InputStream, a ResultSet.

T - The type of the converted objects.

All Known Implementing Classes:

InputStreamConverter, JdbcConverter, JsonConverter, XmlConverter

public interface Converter<U,T>

A Converter is responsible for converting raw data (obtained from a data source) into one or more Java objects. Converters are used by implementations of DataReader. A converter instance is typically created by the application code, and passed to the datareader.

Method Summary

Modifier and Type	Method and Description
T	get() Get the next available data entity in the desired type
void	initialize(U input) Initialize the raw data.
boolean	next() Indicate whether or not more data can be expected from this converter.

Method Detail

initialize

void initialize(U input)
         throws java.io.IOException

Initialize the raw data. In many cases, some initialization is required on the raw data before the conversion to one or more objects can be performed. In the case of an XmlConverter, for example, the DOM-model is created in this method.

Parameters:

input - the raw input.

Throws:

java.io.IOException - in case the raw input can't be processed by this converter.

get

T get()

Get the next available data entity in the desired type

Returns:

the next available data

next

boolean next()

Indicate whether or not more data can be expected from this converter. It is up to the implementation to detect if we can deliver more data entities or not. If this method returns false a call to get() will fail.

Returns:

true if more data can be obtained from this converter, false otherwise