DefaultLimitRule (PEXA API Document)

java.lang.Object
- pexa.share.util.limit.DefaultLimitRule

すべての実装されたインタフェース:

java.io.Serializable, LimitRule
```
public class DefaultLimitRule
extends java.lang.Object
implements LimitRule, java.io.Serializable
```
検索結果に対する任意の制限条件を表すLimitRule実装です。
以下のようなケースで検索結果としてメモリに上げる対象を絞り込みを行いたい場合に使用します。
- 日付でソートした検索結果の最初の１件だけ取得したい。
- 検索結果の０件目から５０行取得した。
バージョン:

$Revision: 9120 $ $Date:: 2018-09-03 14:57:52 #$

作成者:

morishita

関連項目:

直列化された形式

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

DefaultLimitRule(long offset, long limit, boolean proxyOnly)
コンストラクタ

コンストラクタ
コンストラクタと説明
`DefaultLimitRule(long offset, long limit, boolean proxyOnly)` コンストラクタ

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`long`	`getLimitNumber()`
`long`	`getOffsetNumber()`
`java.util.List`	`getResult(java.util.List original)` 制限ルールに従って引数で渡されたリストから条件に合致する要素を抽出する
`boolean`	`hasLimit()`
`boolean`	`hasOffset()`
`boolean`	`isProxyOnly()` 検索結果リストをProxyのみで取得するかを返す
`boolean`	`reachLimit(long count)` 件数制限条件に達しているかを返す
`boolean`	`reachOffset(long cursor)` 開始オフセットに達しているかを返す
`java.lang.String`	`toString()` 文字列表現を返す

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- コンストラクタの詳細
  - DefaultLimitRule
```
public DefaultLimitRule(long offset,
                        long limit,
                        boolean proxyOnly)
```
    コンストラクタ
    
    パラメータ:
    
    offset - 絞り込みの開始位置(1スタート)
    
    limit - 絞り込み件数(制限しない場合は-1)
- メソッドの詳細
  - isProxyOnly
```
public boolean isProxyOnly()
```
    検索結果リストをProxyのみで取得するかを返す
    
    定義:
    
    isProxyOnly インタフェース内 LimitRule
    
    戻り値:
    
    Proxyのみで取得するならtrue、データモデルとして返すならfalse
  - getLimitNumber
```
public long getLimitNumber()
```
    定義:
    
    getLimitNumber インタフェース内 LimitRule
  - getOffsetNumber
```
public long getOffsetNumber()
```
    定義:
    
    getOffsetNumber インタフェース内 LimitRule
  - hasOffset
```
public boolean hasOffset()
```
    定義:
    
    hasOffset インタフェース内 LimitRule
  - hasLimit
```
public boolean hasLimit()
```
    定義:
    
    hasLimit インタフェース内 LimitRule
  - reachOffset
```
public boolean reachOffset(long cursor)
```
    開始オフセットに達しているかを返す
    
    定義:
    
    reachOffset インタフェース内 LimitRule
    
    パラメータ:
    
    cursor - カーソル現在位置
    
    戻り値:
    
    適合していればtrue、していなければfalse
  - reachLimit
```
public boolean reachLimit(long count)
```
    件数制限条件に達しているかを返す
    
    定義:
    
    reachLimit インタフェース内 LimitRule
    
    パラメータ:
    
    count - 現在件数
    
    戻り値:
    
    件数制限をオーバーしていればtrue、していなければfalse
  - getResult
```
public java.util.List getResult(java.util.List original)
```
    制限ルールに従って引数で渡されたリストから条件に合致する要素を抽出する
    
    定義:
    
    getResult インタフェース内 LimitRule
    
    パラメータ:
    
    original - 抽出元のList
    
    戻り値:
    
    ルールに従って制限抽出された結果のList
  - toString
```
public java.lang.String toString()
```
    文字列表現を返す
    
    オーバーライド:
    
    toString クラス内 java.lang.Object
    
    戻り値:
    
    LimitRuleの文字列表現

クラス DefaultLimitRule

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

DefaultLimitRule

メソッドの詳細

isProxyOnly

getLimitNumber

getOffsetNumber

hasOffset

hasLimit

reachOffset

reachLimit

getResult

toString