パッケージ org.springframework.batch.item.database

インターフェース PagingQueryProvider

すべての既知の実装クラス:
AbstractSqlPagingQueryProvider、Db2PagingQueryProvider、DerbyPagingQueryProvider、H2PagingQueryProvider、HanaPagingQueryProvider、HsqlPagingQueryProvider、MariaDBPagingQueryProvider、MySqlPagingQueryProvider、OraclePagingQueryProvider、PostgresPagingQueryProvider、SqlitePagingQueryProvider、SqlServerPagingQueryProvider、SqlWindowingPagingQueryProvider、SybasePagingQueryProvider
public interface PagingQueryProvider
ページングアイテムリーダーで使用するページングクエリを生成するために提供される機能を定義するインターフェース。
導入:
2.0
作成者:
Thomas Risberg, Michael Minella

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    StringSE
    generateFirstPageQuery(int pageSize)
    ページサイズによって制限された最初のページを提供するクエリを生成します。
    StringSE
    generateRemainingPagesQuery(int pageSize)
    ページサイズによって制限された最初のページを提供するクエリを生成します。
    int
    getParameterCount()
    クエリで宣言されているパラメーターの数
    StringSE
    getSortKeyPlaceHolder(StringSE keyName)
    （列名に基づいて）ソートキー値の名前付きプレースホルダーとして使用される文字列、または？ 名前のないパラメーターの場合。
    MapSE<StringSE,Order>
    getSortKeys()
    ソートキー。
    MapSE<StringSE,Order>
    getSortKeysWithoutAliases()
    エイリアスのない並べ替えキー（一意の単一列名）。
    void
    init(DataSourceSE dataSource)
    必要に応じて、提供された DataSourceSE を使用してクエリプロバイダーを初期化します。
    boolean
    isUsingNamedParameters()
    生成されたクエリが名前付きパラメーター構文を使用するかどうかを示します。

  • メソッドの詳細

    • init

      void init(DataSourceSE dataSource) throws ExceptionSE
      必要に応じて、提供された DataSourceSE を使用してクエリプロバイダーを初期化します。
      パラメーター:
      dataSource - 初期化に使用する DataSource
      例外:
      ExceptionSE - 初期化時のエラー

    • generateFirstPageQuery

      StringSE generateFirstPageQuery(int pageSize)
      ページサイズによって制限された最初のページを提供するクエリを生成します。
      パラメーター:
      pageSize - 各ページの読み取り行数
      戻り値:
      生成されたクエリ

    • generateRemainingPagesQuery

      StringSE generateRemainingPagesQuery(int pageSize)
      ページサイズによって制限された最初のページを提供するクエリを生成します。
      パラメーター:
      pageSize - 各ページの読み取り行数
      戻り値:
      生成されたクエリ

    • getParameterCount

      int getParameterCount()
      クエリで宣言されているパラメーターの数
      戻り値:
      パラメーター数

    • isUsingNamedParameters

      boolean isUsingNamedParameters()
      生成されたクエリが名前付きパラメーター構文を使用するかどうかを示します。
      戻り値:
      名前付きパラメーター構文が使用されている場合は true

    • getSortKeys

      MapSE<StringSE,Order> getSortKeys()
      ソートキー。キーを構成する列のマップと、昇順または降順を示すブール値（昇順 = true）。
      戻り値:
      クエリの順序付けに使用されるソートキー

    • getSortKeyPlaceHolder

      StringSE getSortKeyPlaceHolder(StringSE keyName)
      （列名に基づいて）ソートキー値の名前付きプレースホルダーとして使用される文字列、または？ 名前のないパラメーターの場合。
      パラメーター:
      keyName - ソートキー名
      戻り値:
      パラメーター化されたクエリに使用される文字列。

    • getSortKeysWithoutAliases

      MapSE<StringSE,Order> getSortKeysWithoutAliases()
      エイリアスのない並べ替えキー（一意の単一列名）。
      戻り値:
      クエリの順序付けに使用される並べ替えキー (エイリアスなし)