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

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

public class NbClause
extends java.lang.Object

オブジェクト検索条件クラス。

NbQuery の検索条件として使用する。 MongoDB のクエリ演算子と機能的にほぼ等価。各APIのObject型の引数に対してプリミティブ型の配列を指定した場合は例外が発生する。

使用例1:

 
 // AND条件は連結記述が可能
 NbClause clause = new NbClause().equals("key1", "xyz").greaterThan("key2", 100);
 NbQuery query = new NbQuery().setClause(clause);

使用例2:

 
 // OR 条件の場合
 NbClause clause = new NbClause().or(
 new NbClause().equals("key1", "xyz"),
 new NbClause().greaterThan("key2", 100),
 new NbClause().in("key3", "A", "B", "C");
 );
 NbQuery query = new NbQuery().setClause(clause);

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

導入されたバージョン:: 1.0

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static int`	`DOT_MATCH_NEWLINE` 正規表現の "."
`static int`	`EXTENDED` 拡張正規表現を使用する。
`static int`	`IGNORE_CASE` 大文字と小文字を区別しない。
`static int`	`MULTILINE` 文字列を複数行として扱う。

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

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

NbClause()
コンストラクタ

コンストラクタ
コンストラクタと説明
`NbClause()` コンストラクタ

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`NbClause`	`all(java.lang.String key, java.lang.Object... values)` keyで指定されたフィールドの値が、valuesで指定された値の全てと一致すること。
`NbClause`	`and(NbClause... clauses)` 引数で与えられた検索条件と保持している検索条件でandをとる。
`boolean`	`equals(java.lang.Object obj)`
`NbClause`	`equals(java.lang.String key, java.lang.Object value)` keyで指定されたフィールドの値が、valueで指定された値と等しいこと。
`NbClause`	`exists(java.lang.String key)` keyで指定されたフィールドの値が存在すること。
`NbClause`	`exists(java.lang.String key, java.lang.Boolean isExist)` 非推奨です。 `exists(String)` で置き換え
`static NbClause`	`fromJSONObject(NbJSONObject conditions)` MongoDB クエリ同等の JSONオブジェクトから NbClause を生成する
`static NbClause`	`fromJSONString(java.lang.String jsonString)` MongoDB クエリ同等のJSON文字列から NbClause を生成する
`NbJSONObject`	`getConditions()`
`NbClause`	`greaterThan(java.lang.String key, java.lang.Object value)` keyで指定されたフィールドの値が、valueで指定された値より大きいこと。
`NbClause`	`greaterThanOrEqual(java.lang.String key, java.lang.Object value)` keyで指定されたフィールドの値が、valueで指定された値以上であること。
`NbClause`	`in(java.lang.String key, java.lang.Object... values)` keyで指定されたフィールドの値が、valuesで指定された値の何れかと一致すること。
`NbClause`	`lessThan(java.lang.String key, java.lang.Object value)` keyで指定されたフィールドの値が、valueで指定された値より小さいこと。
`NbClause`	`lessThanOrEqual(java.lang.String key, java.lang.Object value)` keyで指定されたフィールドの値が、valueで指定された値以下であること。
`NbClause`	`not()` 非推奨です。 `not(String)` で置き換え。
`NbClause`	`not(java.lang.String key)` 指定したキーの条件を反転($not)する
`NbClause`	`notEqual(java.lang.String key, java.lang.Object value)` keyで指定されたフィールドの値が、valueで指定された値と等しくないこと。
`NbClause`	`notExist(java.lang.String key)` keyで指定されたフィールドの値が存在しないこと。
`NbClause`	`or(NbClause... clauses)` 引数で与えられた検索条件と保持している検索条件でorをとる。
`NbClause`	`regex(java.lang.String key, java.lang.String expression, int option)` keyで指定されたフィールドの値が正規表現で与えられた表記と一致すること。
`NbJSONObject`	`toJSONObject()` NbJSONObject 形式のクエリを返却する。

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

- フィールドの詳細
  - IGNORE_CASE
```
public static final int IGNORE_CASE
```
    大文字と小文字を区別しない。 regex()のオプションで使用する。
    
    関連項目:
    
    regex(String, String, int), 定数フィールド値
  - MULTILINE
```
public static final int MULTILINE
```
    文字列を複数行として扱う。正規表現の ^, $ は各行の行頭・行末にマッチする。 regex()のオプションで使用する。
    
    関連項目:
    
    regex(String, String, int), 定数フィールド値
  - EXTENDED
```
public static final int EXTENDED
```
    拡張正規表現を使用する。 regex()のオプションで使用する。
    
    関連項目:
    
    regex(String, String, int), 定数フィールド値
  - DOT_MATCH_NEWLINE
```
public static final int DOT_MATCH_NEWLINE
```
    正規表現の "." を改行(LF)にもマッチさせる。 regex()のオプションで使用する。
    
    関連項目:
    
    regex(String, String, int), 定数フィールド値
- コンストラクタの詳細
  - NbClause
```
public NbClause()
```
    コンストラクタ
- メソッドの詳細
  - fromJSONObject
```
public static NbClause fromJSONObject(NbJSONObject conditions)
```
    MongoDB クエリ同等の JSONオブジェクトから NbClause を生成する
    
    パラメータ:
    
    conditions - JSONオブジェクト
    
    戻り値:
    
    NbClause
  - fromJSONString
```
public static NbClause fromJSONString(java.lang.String jsonString)
```
    MongoDB クエリ同等のJSON文字列から NbClause を生成する
    
    パラメータ:
    
    jsonString - JSON文字列
    
    戻り値:
    
    NbClause
  - toJSONObject
```
public NbJSONObject toJSONObject()
```
    NbJSONObject 形式のクエリを返却する。内部 NbJSONObject のコピーが返却される。
    
    戻り値:
    
    NbJSONObjectのコピー
  - equals
```
public boolean equals(java.lang.Object obj)
```
    オーバーライド:
    
    equals クラス内 java.lang.Object
  - equals
```
public NbClause equals(java.lang.String key,
                       java.lang.Object value)
```
    keyで指定されたフィールドの値が、valueで指定された値と等しいこと。
    
    パラメータ:
    
    key - 演算対象のフィールド
    
    value - 閾値。
  - notEqual
```
public NbClause notEqual(java.lang.String key,
                         java.lang.Object value)
```
    keyで指定されたフィールドの値が、valueで指定された値と等しくないこと。
    
    パラメータ:
    
    key - 演算対象のフィールド
    
    value - 閾値。
  - lessThan
```
public NbClause lessThan(java.lang.String key,
                         java.lang.Object value)
```
    keyで指定されたフィールドの値が、valueで指定された値より小さいこと。
    
    パラメータ:
    
    key - 演算対象のフィールド
    
    value - 閾値。
  - lessThanOrEqual
```
public NbClause lessThanOrEqual(java.lang.String key,
                                java.lang.Object value)
```
    keyで指定されたフィールドの値が、valueで指定された値以下であること。
    
    パラメータ:
    
    key - 演算対象のフィールド
    
    value - 閾値。
  - greaterThan
```
public NbClause greaterThan(java.lang.String key,
                            java.lang.Object value)
```
    keyで指定されたフィールドの値が、valueで指定された値より大きいこと。
    
    パラメータ:
    
    key - 演算対象のフィールド
    
    value - 閾値。
  - greaterThanOrEqual
```
public NbClause greaterThanOrEqual(java.lang.String key,
                                   java.lang.Object value)
```
    keyで指定されたフィールドの値が、valueで指定された値以上であること。
    
    パラメータ:
    
    key - 演算対象のフィールド
    
    value - 閾値。
  - in
```
public NbClause in(java.lang.String key,
                   java.lang.Object... values)
```
    keyで指定されたフィールドの値が、valuesで指定された値の何れかと一致すること。
    
    パラメータ:
    
    key - 演算対象のフィールド
    
    values - 比較する値のリスト。
  - all
```
public NbClause all(java.lang.String key,
                    java.lang.Object... values)
```
    keyで指定されたフィールドの値が、valuesで指定された値の全てと一致すること。
    
    パラメータ:
    
    key - 演算対象のフィールド
    
    values - 比較する値のリスト。
  - exists
```
@Deprecated
public NbClause exists(java.lang.String key,
                                   java.lang.Boolean isExist)
```
    非推奨です。 exists(String) で置き換え
    
    keyで指定されたフィールドの値が存在するorしないこと。
    
    パラメータ:
    
    key - 演算対象のフィールド
    
    isExist - trueの場合存在すること、falseの場合存在しないこと。
  - exists
```
public NbClause exists(java.lang.String key)
```
    keyで指定されたフィールドの値が存在すること。
    
    パラメータ:
    
    key - 演算対象のフィールド
  - notExist
```
public NbClause notExist(java.lang.String key)
```
    keyで指定されたフィールドの値が存在しないこと。
    
    パラメータ:
    
    key - 演算対象のフィールド
  - regex
```
public NbClause regex(java.lang.String key,
                      java.lang.String expression,
                      int option)
```
    keyで指定されたフィールドの値が正規表現で与えられた表記と一致すること。
    optionを複数指定する場合は|でフラグを結合する。
    
    パラメータ:
    
    key - 演算対象のフィールド
    
    expression - 正規表現
    
    option - オプション
    
    関連項目:
    
    IGNORE_CASE, MULTILINE, EXTENDED, DOT_MATCH_NEWLINE
  - and
```
public NbClause and(NbClause... clauses)
```
    引数で与えられた検索条件と保持している検索条件でandをとる。
    
    パラメータ:
    
    clauses - 結合する検索条件
  - or
```
public NbClause or(NbClause... clauses)
```
    引数で与えられた検索条件と保持している検索条件でorをとる。
    
    パラメータ:
    
    clauses - 結合する検索条件
  - not
```
@Deprecated
public NbClause not()
```
    非推奨です。 not(String) で置き換え。
    
    保持している条件をすべて反転(not)する。
    
    戻り値:
    
    this
  - not
```
public NbClause not(java.lang.String key)
```
    指定したキーの条件を反転($not)する
    
    パラメータ:
    
    key - キー
    
    戻り値:
    
    this
  - getConditions
```
public NbJSONObject getConditions()
```

クラス NbClause

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

IGNORE_CASE

MULTILINE

EXTENDED

DOT_MATCH_NEWLINE

コンストラクタの詳細

NbClause

メソッドの詳細

fromJSONObject

fromJSONString

toJSONObject

equals

equals

notEqual

lessThan

lessThanOrEqual

greaterThan

greaterThanOrEqual

in

all

exists

exists

notExist

regex

and

or

not

not

getConditions