com.nec.baas.object

インタフェース NbObjectBucket

すべてのスーパーインタフェース:

NbBaseBucket<NbObjectBucket>, NbBaseOfflineBucket, NbOfflineObjectBucket

public interface NbObjectBucket
extends NbBaseBucket<NbObjectBucket>, NbBaseOfflineBucket, NbOfflineObjectBucket

オブジェクトバケット

導入されたバージョン:

1.0

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	aggregate(NbJSONArray pipeline, NbJSONObject options, NbCallback<NbJSONArray> callback) 集計(Aggregation)を実行する。
NbJSONObject	createBatchRequest(NbObject object, NbBatchOperationType type) バッチ処理要求データを作成する。
void	deleteObjects(NbQuery query, boolean softDelete, NbCallback<java.lang.Integer> callback) 複数オブジェクトを一括削除する。
void	deleteObjects(NbQuery query, NbCallback<java.lang.Integer> callback) 複数オブジェクトを一括削除する。
void	executeBatchOperation(NbJSONArray batchList, java.lang.String requestToken, NbCallback<NbJSONArray> callback) バッチ処理要求を実行する。
void	executeBatchOperation(NbJSONObject requests, java.lang.String requestToken, NbCallback<NbJSONArray> callback) バッチ処理要求を実行する。
void	getObject(java.lang.String objectId, NbCallback<NbObject> callback) オブジェクトIDを指定してバケットからNbObjectを検索する。
void	getObject(java.lang.String objectId, NbObjectCallback callback) 非推奨です。 getObject(String, NbCallback) で置き換え
NbObject	newObject() このバケットに所属する新しいオブジェクトを生成する。
void	query(NbQuery query, NbCallback<java.util.List<NbObject>> callback) バケットに対しクエリを行う(全件数取得無し)。
void	query(NbQuery query, NbObjectCallback callback) 非推奨です。 queryWithCount(NbQuery, NbCountCallback) または query(NbQuery, NbCallback) で置き換え。
void	queryWithCount(NbQuery query, NbCountCallback<java.util.List<NbObject>> callback) バケットに対しクエリを行う(全件数取得付き)。
void	save(NbCallback<NbObjectBucket> callback) バケットの設定を保存する。

インタフェースから継承されたメソッド com.nec.baas.core.NbBaseBucket

getAcl, getBucketName, getContentAcl, getDescription, getMode, setAcl, setContentAcl, setDescription

インタフェースから継承されたメソッド com.nec.baas.core.NbBaseOfflineBucket

getLastSyncTime, getResolveConflictPolicy, setResolveConflictPolicy, setResolveConflictPolicy

インタフェースから継承されたメソッド com.nec.baas.object.NbOfflineObjectBucket

getIndexFromLocal, getSyncScope, registerSyncEventListener, removeCache, removeSyncScope, setIndexToLocal, setSyncScope, sync, unregisterSyncEventListener

メソッドの詳細

newObject

NbObject newObject()

このバケットに所属する新しいオブジェクトを生成する。
生成するオブジェクトのモードは、バケットと同じモードとなる。

戻り値:

オブジェクト

getObject

@Deprecated
void getObject(java.lang.String objectId,
                           NbObjectCallback callback)

非推奨です。 getObject(String, NbCallback) で置き換え

オブジェクトIDを指定してバケットからNbObjectを検索する。

getObject

void getObject(java.lang.String objectId,
               NbCallback<NbObject> callback)

オブジェクトIDを指定してバケットからNbObjectを検索する。

取得したオブジェクトは callback に渡される。該当するオブジェクトが存在しなかった場合は、 statusCode = 404 (Not Found) で NbBaseCallback.onFailure(int, NbErrorInfo) が呼び出される。

対象バケットと対象オブジェクトのread権限が必要となる。

オンラインモードの場合、サーバからデータの取得を実行する。
レプリカ・ローカルモードの場合、オフライン用データベースからデータの取得を実行する。

パラメータ:

objectId - 取得するオブジェクトのid。

callback - NbObjectを受け取るためのコールバック。

query

@Deprecated
void query(NbQuery query,
                       NbObjectCallback callback)

非推奨です。 queryWithCount(NbQuery, NbCountCallback) または query(NbQuery, NbCallback) で置き換え。

バケットに対しクエリを行う。

queryWithCount

void queryWithCount(NbQuery query,
                    NbCountCallback<java.util.List<NbObject>> callback)

バケットに対しクエリを行う(全件数取得付き)。

指定した検索条件でバケットに対しクエリを実行する。

オンラインモードの場合、サーバに対しクエリを実行する。 レプリカ・ローカルモードの場合、オフライン用データベースに対しクエリを実行する。

queryにlimitを指定しない場合、取得件数はデフォルトの100件で動作する。 queryがnullの場合も条件無しのデフォルト件数(100件)で動作する。

NbQuery.setCountQuery(boolean) を設定した場合、 callback のcount には検索条件に一致した全データ数を返却する。queryにskip/limitを指定した場合、 コールバック引数のcountは返却データ数と一致しないので注意すること。

また、本メソッドの制限事項として、返すオブジェクトのレンジも、実際のレンジとは 異なる場合がありうる。これは検索レンジ外のデータに関してクライアントでデータが 削除されていることがあるためである。

パラメータ:

query - クエリの検索条件。

callback - クエリ結果を受け取るコールバック。

導入されたバージョン:

6.5.0

関連項目:

NbQuery

query

void query(NbQuery query,
           NbCallback<java.util.List<NbObject>> callback)

バケットに対しクエリを行う(全件数取得無し)。

指定した検索条件でバケットに対しクエリを実行する。

オンラインモードの場合、サーバに対しクエリを実行する。 レプリカ・ローカルモードの場合、オフライン用データベースに対しクエリを実行する。

queryにlimitを指定しない場合、取得件数はデフォルトの100件で動作する。 queryがnullの場合も条件無しのデフォルト件数(100件)で動作する。

本APIでは全件数は取得できない。全件数を取得したい場合は queryWithCount(NbQuery, NbCountCallback) を使用すること。

また、本メソッドの制限事項として、返すオブジェクトのレンジも、実際のレンジとは 異なる場合がありうる。これは検索レンジ外のデータに関してクライアントでデータが 削除されていることがあるためである。

パラメータ:

query - クエリの検索条件。

callback - クエリ結果を受け取るコールバック。

導入されたバージョン:

6.5.0

関連項目:

NbQuery

save

void save(NbCallback<NbObjectBucket> callback)

バケットの設定を保存する。

ROOTバケットと本バケットのupdate権限が必要となる。
ACLの変更を行う際は本バケットのadmin権限が必要となる。
尚、本メソッドはレプリカモードでは使用はできない。

パラメータ:

callback - 保存したバケットを受け取るコールバック。

aggregate

void aggregate(NbJSONArray pipeline,
               NbJSONObject options,
               NbCallback<NbJSONArray> callback)

集計(Aggregation)を実行する。

集計結果は JSONArray で返される。
尚、本メソッドはオンラインモード以外のバケットモードでは使用はできない。

パラメータ:

pipeline - Aggregation Pipeline JSON配列

options - オプション

callback - 実行結果を受け取るコールバック

導入されたバージョン:

7.0.0

createBatchRequest

NbJSONObject createBatchRequest(NbObject object,
                                NbBatchOperationType type)

バッチ処理要求データを作成する。
指定のtypeに合わせてobjectからバッチ処理要求用のNbJSONObjectを作成する。
INSERT指定時は、オブジェクトの新規追加要求を作成する。
UPDATE指定時は、オブジェクトの上書き更新要求を作成する。
DELETE指定時は、オブジェクトの削除要求を作成する。
尚、本メソッドはオンラインモード以外のバケットモードでは使用はできない。

パラメータ:

object - 要求情報元オブジェクトデータ

type - 要求種別

戻り値:

バッチ処理要求データ

導入されたバージョン:

3.0.0

executeBatchOperation

void executeBatchOperation(NbJSONArray batchList,
                           java.lang.String requestToken,
                           NbCallback<NbJSONArray> callback)

バッチ処理要求を実行する。

バッチ処理要求データを用いてサーバへのバッチ処理要求を行う。 バッチ処理要求データは、NbJSONArrayに格納すること。

結果は JSONArray で返される。格納される各データの詳細は REST API リファレンスを参照。 dataキーにはNbObjectインスタンスが格納される

リクエストトークンを指定することで実行済みバッチ処理の結果を受けることが可能。
尚、本メソッドはオンラインモード以外のバケットモードでは使用はできない。

パラメータ:

batchList - バッチ処理要求データ一覧

requestToken - リクエストトークン

callback - 実行結果を受け取るコールバック

導入されたバージョン:

3.0.0

executeBatchOperation

void executeBatchOperation(NbJSONObject requests,
                           java.lang.String requestToken,
                           NbCallback<NbJSONArray> callback)

バッチ処理要求を実行する。

バッチ処理要求データを用いてサーバへのバッチ処理要求を行う。 バッチ処理要求データは、REST APIリファレンスに従った記載で格納すること。

結果は JSONArray で返される。格納される各データの詳細は REST API リファレンスを参照。 dataキーにはNbObjectインスタンスが格納される

リクエストトークンを指定することで実行済みバッチ処理の結果を受けることが可能。 尚、本メソッドはオンラインモード以外のバケットモードでは使用はできない。

パラメータ:

requests - バッチ処理要求データ一覧

requestToken - リクエストトークン

callback - 実行結果を受け取るコールバック

導入されたバージョン:

3.0.0

deleteObjects

void deleteObjects(NbQuery query,
                   NbCallback<java.lang.Integer> callback)

複数オブジェクトを一括削除する。オンラインバケットでのみ使用可能。 オブジェクトは論理削除される。

パラメータ:

query - クエリ条件

callback - コールバック。成功時は削除数が返却される。

導入されたバージョン:

6.5.0

deleteObjects

void deleteObjects(NbQuery query,
                   boolean softDelete,
                   NbCallback<java.lang.Integer> callback)

複数オブジェクトを一括削除する。オンラインバケットでのみ使用可能。

パラメータ:

query - クエリ条件

softDelete - true にした場合は論理削除、false 時は物理削除

callback - コールバック。成功時は削除数が返却される。

導入されたバージョン:

6.5.0