com.asakusafw.windgate.core.resource

Interface SourceDriver<T>

Type Parameters:

T - the type of source data models

All Superinterfaces:

AutoCloseable, Closeable, Preparable

All Known Implementing Classes:

JdbcSourceDriver, ModelInputSourceDriver, StreamSourceDriver, VoidSourceDriver

public interface SourceDriver<T>
extends Preparable, Closeable

An abstract super interface of data source driver.

Since:

0.2.2

Method Summary

Modifier and Type	Method and Description
void	close() Disposes this object.
T	get() Gets the current data model object prepared by the next() method.
boolean	next() Returns true iff the next data model object exists, and then the get() method returns its object.
void	prepare() Prepares this driver to invoke next() method.

Method Detail

prepare

void prepare()
      throws IOException

Prepares this driver to invoke next() method. This method will be invoked before next() only once. This operation can execute only on the same thread as created this object.

Specified by:

prepare in interface Preparable

Throws:

IOException - if failed to begi

next

boolean next()
      throws IOException

Returns true iff the next data model object exists, and then the get() method returns its object. This operation can execute only on the same thread as created this object.

Returns:

true if the next data model object exists, otherwise false

Throws:

IOException - if failed to prepare the next data

get

T get()
throws IOException

Gets the current data model object prepared by the next() method. This operation can execute only on the same thread as created this object.

Returns:

the next data model object

Throws:

IOException - if failed to prepare the next data

IllegalStateException - if the next data model object does not exist

See Also:

next()

close

void close()
    throws IOException

Disposes this object. This operation can execute only on the same thread as created this object.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if failed to connect