パッケージ org.nkjmlab.sorm4j

インタフェース OrmReader

既知のサブインタフェースのリスト:

OrmConnection, OrmTransaction

public interface OrmReader

The interface of reading functions of object-relation mapping.

作成者:

nkjm

メソッドの概要

修飾子とタイプ	メソッド	説明
<T> List<T>	readAll(Class<T> objectClass)	Reads all rows from the table indicated by object class.
<T> LazyResultSet<T>	readAllLazy(Class<T> objectClass)	Returns LazyResultSet represents all rows from the table indicated by object class.
<T> T	readByPrimaryKey(Class<T> objectClass, Object... primaryKeyValues)	Reads an object by its primary keys from the table indicated by object class.
<T> T	readByPrimaryKeyOf(T object)
<T> T	readFirst(Class<T> objectClass, String sql, Object... parameters)	Reads an object from the database.
<T> T	readFirst(Class<T> objectClass, ParameterizedSql sql)	Reads an object from the database.
<T> LazyResultSet<T>	readLazy(Class<T> objectClass, String sql, Object... parameters)	Returns an LazyResultSet.
<T> LazyResultSet<T>	readLazy(Class<T> objectClass, ParameterizedSql sql)	Returns an LazyResultSet.
<T> List<T>	readList(Class<T> objectClass, String sql, Object... parameters)	Reads a list of objects from the database by mapping the results of the parameterized SQL query into instances of the given object class.
<T> List<T>	readList(Class<T> objectClass, ParameterizedSql sql)	Reads a list of objects from the database by mapping the results of the parameterized SQL query into instances of the given object class.
<T> T	readOne(Class<T> objectClass, String sql, Object... parameters)	Reads only one object from the database.
<T> T	readOne(Class<T> objectClass, ParameterizedSql sql)	Reads only one object from the database.
<T1,T2,T3> List<Tuple3<T1,T2,T3>>	readTupleList(Class<T1> t1, Class<T2> t2, Class<T3> t3, String sql, Object... parameters)	Reads results as List of Tuple3 for reading JOIN SQL results typically.
<T1,T2,T3> List<Tuple3<T1,T2,T3>>	readTupleList(Class<T1> t1, Class<T2> t2, Class<T3> t3, ParameterizedSql sql)	Reads results as List of Tuple3 for reading JOIN SQL results typically.
<T1,T2> List<Tuple2<T1,T2>>	readTupleList(Class<T1> t1, Class<T2> t2, String sql, Object... parameters)	Reads results as List of Tuple2 for reading JOIN SQL results typically.
<T1,T2> List<Tuple2<T1,T2>>	readTupleList(Class<T1> t1, Class<T2> t2, ParameterizedSql sql)	Reads results as List of Tuple2 for reading JOIN SQL results typically.

メソッドの詳細

readAll

<T> List<T> readAll(Class<T> objectClass)

Reads all rows from the table indicated by object class.

型パラメータ:

T -

パラメータ:

objectClass -

戻り値:

readAllLazy

<T> LazyResultSet<T> readAllLazy(Class<T> objectClass)

Returns LazyResultSet represents all rows from the table indicated by object class.

型パラメータ:

T -

パラメータ:

objectClass -

戻り値:

readByPrimaryKey

<T> T readByPrimaryKey(Class<T> objectClass,
                       Object... primaryKeyValues)

Reads an object by its primary keys from the table indicated by object class.

型パラメータ:

T -

パラメータ:

objectClass -

primaryKeyValues -

戻り値:

readByPrimaryKeyOf

<T> T readByPrimaryKeyOf(T object)

型パラメータ:

T -

パラメータ:

object -

戻り値:

readFirst

<T> T readFirst(Class<T> objectClass,
                ParameterizedSql sql)

Reads an object from the database.

型パラメータ:

T -

パラメータ:

objectClass -

sql -

戻り値:

readFirst

<T> T readFirst(Class<T> objectClass,
                String sql,
                Object... parameters)

Reads an object from the database.

型パラメータ:

T -

パラメータ:

objectClass -

sql - with ordered parameter. The other type parameters (e.g. named parameter, list parameter) could not be used.

parameters - are ordered parameter.

戻り値:

readLazy

<T> LazyResultSet<T> readLazy(Class<T> objectClass,
                              ParameterizedSql sql)

Returns an LazyResultSet. It is able to convert to Stream, List, and so on.

型パラメータ:

T -

パラメータ:

objectClass -

sql -

戻り値:

readLazy

<T> LazyResultSet<T> readLazy(Class<T> objectClass,
                              String sql,
                              Object... parameters)

Returns an LazyResultSet. It is able to convert to Stream, List, and so on.

Parameters will be set according with the correspondence defined in SqlParametersSetter.setParameters(SormOptions,PreparedStatement, Object[])

readList

<T> List<T> readList(Class<T> objectClass,
                     ParameterizedSql sql)

Reads a list of objects from the database by mapping the results of the parameterized SQL query into instances of the given object class. Only the columns returned from the SQL query will be set into the object instance.

型パラメータ:

T -

パラメータ:

objectClass -

sql -

戻り値:

readList

<T> List<T> readList(Class<T> objectClass,
                     String sql,
                     Object... parameters)

Reads a list of objects from the database by mapping the results of the parameterized SQL query into instances of the given object class. Only the columns returned from the SQL query will be set into the object instance.

Parameters will be set according with the correspondence defined in SqlParametersSetter.setParameters(SormOptions, PreparedStatement, Object[])

readOne

<T> T readOne(Class<T> objectClass,
              ParameterizedSql sql)

Reads only one object from the database.

型パラメータ:

T -

パラメータ:

objectClass -

sql -

戻り値:

readOne

<T> T readOne(Class<T> objectClass,
              String sql,
              Object... parameters)

Reads only one object from the database.

型パラメータ:

T -

パラメータ:

objectClass -

sql - with ordered parameter. The other type parameters (e.g. named parameter, list parameter) could not be used.

parameters - are ordered parameter.

戻り値:

readTupleList

<T1,T2> List<Tuple2<T1,T2>> readTupleList(Class<T1> t1,
                                                      Class<T2> t2,
                                                      String sql,
                                                      Object... parameters)

Reads results as List of Tuple2 for reading JOIN SQL results typically.

型パラメータ:

T1 -

T2 -

パラメータ:

t1 -

t2 -

sql -

parameters -

戻り値:

readTupleList

<T1,T2> List<Tuple2<T1,T2>> readTupleList(Class<T1> t1,
                                                      Class<T2> t2,
                                                      ParameterizedSql sql)

Reads results as List of Tuple2 for reading JOIN SQL results typically.

型パラメータ:

T1 -

T2 -

パラメータ:

t1 -

t2 -

sql -

戻り値:

readTupleList

<T1,T2,T3> List<Tuple3<T1,T2,T3>> readTupleList(Class<T1> t1,
                                                                        Class<T2> t2,
                                                                        Class<T3> t3,
                                                                        String sql,
                                                                        Object... parameters)

Reads results as List of Tuple3 for reading JOIN SQL results typically.

型パラメータ:

T1 -

T2 -

パラメータ:

t1 -

t2 -

sql -

parameters -

戻り値:

readTupleList

<T1,T2,T3> List<Tuple3<T1,T2,T3>> readTupleList(Class<T1> t1,
                                                                        Class<T2> t2,
                                                                        Class<T3> t3,
                                                                        ParameterizedSql sql)

Reads results as List of Tuple3 for reading JOIN SQL results typically.

型パラメータ:

T1 -

T2 -

T3 -

パラメータ:

t1 -

t2 -

t3 -

sql -

戻り値: