NbQuery (モバイルバックエンド基盤 Java / Android SDK リファレンス)

java.lang.Object
- com.nec.baas.object.NbQuery

```
public class NbQuery
extends java.lang.Object
```
オブジェクト検索クラス。
NbObjectBucket.query(NbQuery, NbCallback) などで使用する。

本クラスのインスタンスはスレッドセーフではない。

導入されたバージョン:

1.0

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

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

NbQuery()
Queryクラスのコンストラクタ。

コンストラクタ
コンストラクタと説明
`NbQuery()` Queryクラスのコンストラクタ。

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`NbQuery`	`addSortOrder(java.lang.String key, boolean isAsc)` ソート順序を追加する。
`boolean`	`equals(java.lang.Object o)`
`static NbQuery`	`fromJson(NbJSONObject queryJson)` NbJSONObject から NbQuery に変換する。
`NbClause`	`getClause()` 検索条件
`int`	`getCountQueryAsNum()` 設定された件数取得フラグ(数値)を取得する。
`int`	`getLimit()` 検索上限数。
`NbJSONObject`	`getProjection()` プロジェクション設定
`int`	`getSkipCount()` スキップカウント。
`java.util.LinkedHashMap<java.lang.String,java.lang.Boolean>`	`getSortOrder()` 非推奨です。 6.5.0 で廃止。`getSortOrders()` で置き換え。
`java.util.List<java.lang.String>`	`getSortOrders()` ソート順序を取得する。
`int`	`hashCode()`
`boolean`	`isCountQuery()` 件数取得フラグ (true なら取得する)。
`boolean`	`isDeleteMark()` 削除取得有無フラグ
`NbQuery`	`setClause(NbClause clause)` 検索条件を指定する。
`NbQuery`	`setCountQuery(boolean countQuery)` 検索条件に合致した件数を取得する。
`NbQuery`	`setDeleteMark(boolean isDeleteMark)` 削除データの取得有無を指定する。
`NbQuery`	`setLimit(int limit)` 検索上限数を設定する。
`NbQuery`	`setProjection(NbJSONObject projectionJson)` プロジェクションを設定する。
`NbQuery`	`setSkipCount(int skip)` スキップカウントを設定する。
`NbQuery`	`setSortOrder(java.lang.String key, boolean isAsc)` 非推奨です。 6.5.0 で廃止。`addSortOrder(String, boolean)` または `setSortOrders(String...)` で置き換え。
`NbQuery`	`setSortOrders(java.util.List<java.lang.String> orders)` ソート順序を指定する(List指定)。
`NbQuery`	`setSortOrders(java.lang.String... orders)` ソート順序を指定する。
`NbJSONObject`	`toJson()` Query から JSON に変換する

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

- コンストラクタの詳細
  - NbQuery
```
public NbQuery()
```
    Queryクラスのコンストラクタ。
    
    導入されたバージョン:
    
    1.0
- メソッドの詳細
  - setClause
```
public NbQuery setClause(NbClause clause)
```
    検索条件を指定する。 clauseにnullを指定した場合、すでに設定済みの検索条件をクリアする。
    
    パラメータ:
    
    clause - 指定する検索条件。
    
    関連項目:
    
    NbClause
  - setLimit
```
public NbQuery setLimit(int limit)
```
    検索上限数を設定する。 -1 を指定した場合は無制限。デフォルト値は -1(無制限)。
    
    パラメータ:
    
    limit - 設定する検索上限数。
    
    戻り値:
    
    this
    
    例外:
    
    java.lang.IllegalArgumentException - 値が範囲外
  - setSkipCount
```
public NbQuery setSkipCount(int skip)
```
    スキップカウントを設定する。スキップカウントの設定範囲は0以上の値。デフォルト値は0。
    
    パラメータ:
    
    skip - 設定するスキップカウント数。
    
    戻り値:
    
    this
    
    例外:
    
    java.lang.IllegalArgumentException - 値が範囲外
  - getSortOrders
```
public java.util.List<java.lang.String> getSortOrders()
```
    ソート順序を取得する。ソート順序はキー名の配列である。降順の場合は各キーの先頭に "-" が付与される。
    
    戻り値:
    
    ソート順序
    
    導入されたバージョン:
    
    6.5.0
  - setSortOrders
```
public NbQuery setSortOrders(java.lang.String... orders)
```
    ソート順序を指定する。
    例:
    new NbQuery().setSortOrders("name", "-age");
    
    パラメータ:
    
    orders - ソート順序。キーの配列。降順の場合はキーの先頭に "-" を付与する。
    
    戻り値:
    
    this
    
    導入されたバージョン:
    
    6.5.0
  - setSortOrders
```
public NbQuery setSortOrders(java.util.List<java.lang.String> orders)
```
    ソート順序を指定する(List指定)。
    例:
    new NbQuery().setSortOrders(Arrays.asList("name", "-age"));
    
    パラメータ:
    
    orders - ソート順序。キーの配列。降順の場合はキーの先頭に "-" を付与する。
    
    戻り値:
    
    this
    
    導入されたバージョン:
    
    6.5.0
  - addSortOrder
```
public NbQuery addSortOrder(java.lang.String key,
                            boolean isAsc)
```
    ソート順序を追加する。
    
    パラメータ:
    
    key - ソート対象フィールド。
    
    isAsc - trueの場合は昇順、falseの場合は降順でソート
    
    戻り値:
    
    this
    
    導入されたバージョン:
    
    6.5.0
  - setSortOrder
```
@Deprecated
public NbQuery setSortOrder(java.lang.String key,
                                        boolean isAsc)
```
    非推奨です。 6.5.0 で廃止。addSortOrder(String, boolean) または setSortOrders(String...) で置き換え。
    
    ソート順序を追加する。
    
    パラメータ:
    
    key - ソート対象フィールド。
    
    isAsc - trueの場合は昇順、falseの場合は降順でソート
    
    戻り値:
    
    this
  - getSortOrder
```
@Deprecated
public java.util.LinkedHashMap<java.lang.String,java.lang.Boolean> getSortOrder()
```
    非推奨です。 6.5.0 で廃止。getSortOrders() で置き換え。
    
    ソート順序を取得する。キー名・昇順フラグをエントリとする LinkedHashMap が返る。
    
    戻り値:
    
    ソート順序
  - getCountQueryAsNum
```
public int getCountQueryAsNum()
```
    設定された件数取得フラグ(数値)を取得する。
    
    戻り値:
    
    件数取得フラグ。取得する場合は 1、そうでなければ 0。
  - setCountQuery
```
public NbQuery setCountQuery(boolean countQuery)
```
    検索条件に合致した件数を取得する。デフォルトは false (取得しない)
    
    パラメータ:
    
    countQuery - true の場合は件数を取得する。
    
    戻り値:
    
    this
  - setDeleteMark
```
public NbQuery setDeleteMark(boolean isDeleteMark)
```
    削除データの取得有無を指定する。デフォルトは false。
    
    パラメータ:
    
    isDeleteMark - trueの場合は削除データ含む。falseの場合は削除データ除く。
    
    戻り値:
    
    this
  - setProjection
```
public NbQuery setProjection(NbJSONObject projectionJson)
```
    プロジェクションを設定する。
    projectionJsonにnull、又は空オブジェクトを指定した場合、すでに設定済みのプロジェクション設定をクリアする。
    
    パラメータ:
    
    projectionJson - プロジェクション設定
    
    戻り値:
    
    this
    
    導入されたバージョン:
    
    7.5.0
  - toJson
```
public NbJSONObject toJson()
```
    Query から JSON に変換する
    
    戻り値:
    
    JSON
  - fromJson
```
public static NbQuery fromJson(NbJSONObject queryJson)
```
    NbJSONObject から NbQuery に変換する。例外が発生した場合は null を返す。
    
    パラメータ:
    
    queryJson - NbJSONObject
    
    戻り値:
    
    NbQuery
  - getClause
```
public NbClause getClause()
```
    検索条件
  - getLimit
```
public int getLimit()
```
    検索上限数。デフォルトは -1(無制限)
  - getSkipCount
```
public int getSkipCount()
```
    スキップカウント。デフォルトは0。
  - isCountQuery
```
public boolean isCountQuery()
```
    件数取得フラグ (true なら取得する)。デフォルトは false。
  - isDeleteMark
```
public boolean isDeleteMark()
```
    削除取得有無フラグ
  - getProjection
```
public NbJSONObject getProjection()
```
    プロジェクション設定
    
    導入されたバージョン:
    
    7.5.0
  - equals
```
public boolean equals(java.lang.Object o)
```
    オーバーライド:
    
    equals クラス内 java.lang.Object
  - hashCode
```
public int hashCode()
```
    オーバーライド:
    
    hashCode クラス内 java.lang.Object

クラス NbQuery

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

メソッドのサマリー

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

コンストラクタの詳細

NbQuery

メソッドの詳細

setClause

setLimit

setSkipCount

getSortOrders

setSortOrders

setSortOrders

addSortOrder

setSortOrder

getSortOrder

getCountQueryAsNum

setCountQuery

setDeleteMark

setProjection

toJson

fromJson

getClause

getLimit

getSkipCount

isCountQuery

isDeleteMark

getProjection

equals

hashCode