パッケージ org.nkjmlab.sorm4j

インタフェース Sorm

public interface Sorm

An interface of executing object-relation mapping.

作成者:

nkjm

メソッドの概要

修飾子とタイプ	メソッド	説明
<T> void	accept(Class<T> objectClass, ConsumerHandler<TypedOrmConnection<T>> handler)	Accepts a TypedOrmConnection handler for a task with object-relation mapping.
void	accept(ConsumerHandler<OrmConnection> handler)	Accepts a OrmConnection handler for a task with object-relation mapping.
void	acceptJdbcConnectionHandler(ConsumerHandler<Connection> handler)	Accepts a Connection handler for a task with object-relation mapping.
<T> void	acceptTransactionHandler(Class<T> objectClass, ConsumerHandler<TypedOrmTransaction<T>> handler)	Accepts a TypedOrmTransaction handler for a task with object-relation mapping.
void	acceptTransactionHandler(ConsumerHandler<OrmTransaction> handler)	Accepts a OrmTransaction handler for a task with object-relation mapping.
<T,R> R	apply(Class<T> objectClass, FunctionHandler<TypedOrmConnection<T>,R> handler)	Applies a TypedOrmConnection handler for a task with object-relation mapping and gets the result.
<R> R	apply(FunctionHandler<OrmConnection,R> handler)	Applies a OrmConnection handler for a task with object-relation mapping and gets the result.
<R> R	applyJdbcConnectionHandler(FunctionHandler<Connection,R> handler)	Applies a Connection handler for a task with object-relation mapping and gets the result.
<T,R> R	applyTransactionHandler(Class<T> objectClass, FunctionHandler<TypedOrmTransaction<T>,R> handler)	Applies a TypedOrmTransaction handler for a task with object-relation mapping and gets the result.
<R> R	applyTransactionHandler(FunctionHandler<OrmTransaction,R> handler)	Applies a OrmTransaction handler for a task with object-relation mapping and gets the result.
Sorm	createWith(String configName)	Creates a Sorm object with the given config name.
String	getConfigName()	Get the config name of this object.
String	getConfigString()	Get the string of the config of this object.
DataSource	getDataSource()	Gets DataSource.
Connection	getJdbcConnection()	Gets JDBC Connection.
Map<String,String>	getTableMappingStatusMap()	Gets map of the table mapping status.
OrmConnection	openConnection()	Open OrmConnection.
<T> TypedOrmConnection<T>	openConnection(Class<T> objectClass)	Open TypedOrmConnection.
OrmTransaction	openTransaction()	Open OrmTransaction.
<T> TypedOrmTransaction<T>	openTransaction(Class<T> objectClass)	Open TypedOrmTransaction.

メソッドの詳細

accept

<T> void accept(Class<T> objectClass,
                ConsumerHandler<TypedOrmConnection<T>> handler)

Accepts a TypedOrmConnection handler for a task with object-relation mapping. The connection will be closed after the process of handler.

型パラメータ:

T -

パラメータ:

objectClass -

handler -

accept

void accept(ConsumerHandler<OrmConnection> handler)

Accepts a OrmConnection handler for a task with object-relation mapping. The connection will be closed after the process of handler.

パラメータ:

handler -

acceptJdbcConnectionHandler

void acceptJdbcConnectionHandler(ConsumerHandler<Connection> handler)

Accepts a Connection handler for a task with object-relation mapping. The connection will be closed after the process of handler.

パラメータ:

handler -

acceptTransactionHandler

<T> void acceptTransactionHandler(Class<T> objectClass,
                                  ConsumerHandler<TypedOrmTransaction<T>> handler)

Accepts a TypedOrmTransaction handler for a task with object-relation mapping. The transaction will be closed after the process of handler. The transaction will be committed and the connection will be closed after the process of handler. When the transaction throws a exception, the transaction will be rollback.

型パラメータ:

T -

パラメータ:

objectClass -

handler -

acceptTransactionHandler

void acceptTransactionHandler(ConsumerHandler<OrmTransaction> handler)

Accepts a OrmTransaction handler for a task with object-relation mapping. The transaction will be committed and the connection will be closed after the process of handler. When the transaction throws a exception, the transaction will be rollback.

パラメータ:

handler -

apply

<T,R> R apply(Class<T> objectClass,
                    FunctionHandler<TypedOrmConnection<T>,R> handler)

Applies a TypedOrmConnection handler for a task with object-relation mapping and gets the result. The connection will be closed after the process of handler.

型パラメータ:

T -

R -

パラメータ:

objectClass -

handler -

戻り値:

apply

<R> R apply(FunctionHandler<OrmConnection,R> handler)

Applies a OrmConnection handler for a task with object-relation mapping and gets the result. The connection will be closed after the process of handler.

型パラメータ:

R -

パラメータ:

handler -

戻り値:

applyJdbcConnectionHandler

<R> R applyJdbcConnectionHandler(FunctionHandler<Connection,R> handler)

Applies a Connection handler for a task with object-relation mapping and gets the result. The connection will be closed after the process of handler.

型パラメータ:

R -

パラメータ:

handler -

戻り値:

applyTransactionHandler

<T,R> R applyTransactionHandler(Class<T> objectClass,
                                      FunctionHandler<TypedOrmTransaction<T>,R> handler)

Applies a TypedOrmTransaction handler for a task with object-relation mapping and gets the result. The transaction will be committed and the connection will be closed after the process of handler. When the transaction throws a exception, the transaction will be rollback.

型パラメータ:

T -

R -

パラメータ:

objectClass -

handler -

戻り値:

applyTransactionHandler

<R> R applyTransactionHandler(FunctionHandler<OrmTransaction,R> handler)

Applies a OrmTransaction handler for a task with object-relation mapping and gets the result. The transaction will be committed and the connection will be closed after the process of handler. When the transaction throws a exception, the transaction will be rollback.

型パラメータ:

R -

パラメータ:

handler -

戻り値:

createWith

Sorm createWith(String configName)

Creates a Sorm object with the given config name. The config name should be registered by SormFactory.registerConfig(String, java.util.function.Consumer) or SormFactory.registerModifiedConfig(String, String, java.util.function.Consumer)

パラメータ:

configName -

戻り値:

getConfigName

String getConfigName()

Get the config name of this object.

戻り値:

getConfigString

String getConfigString()

Get the string of the config of this object.

戻り値:

getDataSource

DataSource getDataSource()

Gets DataSource.

戻り値:

getJdbcConnection

Connection getJdbcConnection()

Gets JDBC Connection.

戻り値:

getTableMappingStatusMap

Map<String,String> getTableMappingStatusMap()

Gets map of the table mapping status. The keys are table names in lower case.

戻り値:

openConnection

OrmConnection openConnection()

Open OrmConnection. You should always use try-with-resources to ensure the database connection is released. We recommend using accept(ConsumerHandler) or apply(FunctionHandler) .

戻り値:

openConnection

<T> TypedOrmConnection<T> openConnection(Class<T> objectClass)

Open TypedOrmConnection. You should always use try-with-resources to ensure the database connection is released. We recommend using accept(Class, ConsumerHandler) or apply(Class, FunctionHandler) .

戻り値:

openTransaction

OrmTransaction openTransaction()

Open OrmTransaction. You should always use try-with-resources to ensure the database connection is released. We recommend using acceptTransactionHandler(ConsumerHandler) or applyTransactionHandler(FunctionHandler). Default transaction level is Connection.TRANSACTION_READ_COMMITTED. Note: the transaction is automatically rollback if the transaction is not committed.

戻り値:

openTransaction

<T> TypedOrmTransaction<T> openTransaction(Class<T> objectClass)

Open TypedOrmTransaction. You should always use try-with-resources to ensure the database connection is released. We recommend using acceptTransactionHandler(Class, ConsumerHandler) or applyTransactionHandler(Class, FunctionHandler). Default transaction level is Connection.TRANSACTION_READ_COMMITTED. Note: the transaction is automatically rollback if the transaction is not committed.

型パラメータ:

T -

パラメータ:

objectClass -

戻り値: