パッケージ org.nkjmlab.sorm4j

インタフェース Sorm

public interface Sorm

An interface of executing object-relation mapping.

作成者:

nkjm

フィールドの概要

フィールド

修飾子とタイプ	フィールド	説明
static SormConfig	INITIAL_DEFAULT_CONFIG_STORE

メソッドの概要

修飾子とタイプ	メソッド	説明
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.
void	acceptTransactionHandler(ConsumerHandler<OrmTransaction> handler)	Accepts a OrmTransaction handler for a task with object-relation mapping.
<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.
<R> R	applyTransactionHandler(FunctionHandler<OrmTransaction,R> handler)	Applies a OrmTransaction handler for a task with object-relation mapping and gets the result.
static Sorm	create(String jdbcUrl, String user, String password)	Create a Sorm object which uses DriverManager.
static Sorm	create(String jdbcUrl, String user, String password, SormConfig config)
static Sorm	create(DataSource dataSource)	Create a Sorm object which uses DataSource.
static Sorm	create(DataSource dataSource, SormConfig config)
static DataSource	createDriverManagerDataSource(String jdbcUrl, String username, String password)	Creates a DataSource which simply wraps DriverManager
SormConfig	getConfig()	Gets the config of this object.
DataSource	getDataSource()	Gets DataSource.
Connection	getJdbcConnection()	Gets JDBC Connection.
Orm	getOrm()	Gets a Orm object.
Map<String,String>	getTableMappingStatusMap()	Gets map of the table mapping status.
OrmConnection	openConnection()	Open OrmConnection.
OrmTransaction	openTransaction()	Open OrmTransaction.
static OrmConnection	toOrmConnection(Connection connection)	Create a OrmConnection wrapping the given JDBC Connection
static OrmConnection	toOrmConnection(Connection connection, SormConfig sormConfig)

フィールドの詳細

INITIAL_DEFAULT_CONFIG_STORE

static final SormConfig INITIAL_DEFAULT_CONFIG_STORE

メソッドの詳細

create

static Sorm create(DataSource dataSource)

Create a Sorm object which uses DataSource.

パラメータ:

dataSource -

戻り値:

create

static Sorm create(DataSource dataSource,
                   SormConfig config)

create

static Sorm create(String jdbcUrl,
                   String user,
                   String password)

Create a Sorm object which uses DriverManager.

パラメータ:

jdbcUrl -

user -

password -

戻り値:

create

static Sorm create(String jdbcUrl,
                   String user,
                   String password,
                   SormConfig config)

createDriverManagerDataSource

static DataSource createDriverManagerDataSource(String jdbcUrl,
                                                String username,
                                                String password)

Creates a DataSource which simply wraps DriverManager

パラメータ:

jdbcUrl -

username -

password -

戻り値:

toOrmConnection

static OrmConnection toOrmConnection(Connection connection)

Create a OrmConnection wrapping the given JDBC Connection

パラメータ:

connection -

戻り値:

toOrmConnection

static OrmConnection toOrmConnection(Connection connection,
                                     SormConfig sormConfig)

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

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

<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

<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 -

戻り値:

getConfig

SormConfig getConfig()

Gets the config of this object.

戻り値:

getDataSource

DataSource getDataSource()

Gets DataSource.

戻り値:

getJdbcConnection

Connection getJdbcConnection()

Gets JDBC Connection.

戻り値:

getOrm

Orm getOrm()

Gets a Orm object.

戻り値:

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) .

戻り値:

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.

戻り値: