Inherits from NSObject
Declared in APEntityManager.h
APEntityManager.m

Tasks

Other Methods

Other Methods

InternalMethods Methods

Class Methods

sharedInstance

Singleton object

+ (APEntityManager *)sharedInstance

Declared In

APEntityManager.h

Instance Methods

convertToObjectFromDictionary:ofClass:

Return an instance from response server @property dic, _class

- (id)convertToObjectFromDictionary:(NSDictionary *)dic ofClass:(Class)_class

Declared In

APEntityManager+InternalMethods.h

count:

指定してクラスのデータの件数を返す。Count number of row of class from local database @param _class

- (NSInteger)count:(Class)_class

Declared In

APEntityManager.h

decryptColumsAtTable:

Decrypt all columns of table @property tableName

- (void)decryptColumsAtTable:(NSString *)tableName

Declared In

APEntityManager+InternalMethods.h

decryptDataForColumn:atTable:

Decrypt value of column of table @property column, tableName

- (void)decryptDataForColumn:(NSString *)column atTable:(NSString *)tableName

Declared In

APEntityManager+InternalMethods.h

deleteAllDataFor:

指定したクラスの全てのデータを削除する。 @param _class

- (void)deleteAllDataFor:(Class)_class

Discussion

データストレージ内のデータが全て削除されるので使用には注意が必要。ローカルストレージでは物理削除、サーバー側では論理削除が行われる。

Declared In

APEntityManager.h

deleteInstance:error:

対象データオブジェクトを削除する。この処理は同期型で行われる。

- (BOOL)deleteInstance:(APObject *)instance error:(NSError **)error

Parameters

instance

削除するデータオブジェクト。

error

発生したエラーを格納するためのエラーオブジェクト

@discussion

Declared In

APEntityManager.h

deleteInstance:withBlock:

対象データオブジェクトを削除する。この処理は非同期型で行われる。 @property instance 削除するデータオブジェクト。

- (void)deleteInstance:(APObject *)instance withBlock:(APObjectResultBlock)block

Parameters

error

発生したエラーを格納するためのエラーオブジェクト

@discussion

Declared In

APEntityManager.h

deleteInstanceFromLocal:error:

ローカルストレージにあるデータを削除する。 @property instance

- (BOOL)deleteInstanceFromLocal:(APObject *)instance error:(NSError **)error

Declared In

APEntityManager+InternalMethods.h

deleteInstanceFromServer:error:

サーバーのストレージにあるデータを同期型で削除する。

- (BOOL)deleteInstanceFromServer:(APObject *)instance error:(NSError **)error

Parameters

instance

削除対象のデータオブジェクト

error

削除の際に発生したエラーを格納 @discussion

Declared In

APEntityManager+InternalMethods.h

deleteInstanceFromServer:withBlock:

サーバーのストレージにあるデータを期型で削除する。

- (void)deleteInstanceFromServer:(APObject *)instance withBlock:(APObjectResultBlock)block

Parameters

instance

削除対象のデータオブジェクト

error

削除の際に発生したエラーを格納 @discussion

Declared In

APEntityManager+InternalMethods.h

deleteListOfInstance:error:

対象データオブジェクトの一覧を削除する。この処理は同期型で行われる。 @property instance 削除するデータオブジェクト。

- (BOOL)deleteListOfInstance:(NSArray *)list error:(NSError **)error

Parameters

error

発生したエラーを格納するためのエラーオブジェクト

@discussion

Declared In

APEntityManager.h

encryptColumsAtTable:

Encrypt all columns of table @property tableName

- (void)encryptColumsAtTable:(NSString *)tableName

Declared In

APEntityManager+InternalMethods.h

encryptDataForColumn:atTable:

Encrypt value of column of table @property column, tableName

- (void)encryptDataForColumn:(NSString *)column atTable:(NSString *)tableName

Declared In

APEntityManager+InternalMethods.h

fetch:

Fetch all rows from local database @property _class

- (NSArray *)fetch:(Class)_class

Declared In

APEntityManager+InternalMethods.h

fetch:where:

Fetch rows from local database with condition @property _class

- (NSArray *)fetch:(Class)_class where:(APCondition)predicate

Declared In

APEntityManager+InternalMethods.h

fetch:withPredicate:

Fetch rows from local database with predicate @property _class

- (NSArray *)fetch:(Class)_class withPredicate:(NSPredicate *)predicate

Declared In

APEntityManager+InternalMethods.h

generateDataSchemaForAdd:

Generate JSON format from list of instances @property list

- (NSArray *)generateDataSchemaForAdd:(NSArray *)list

Declared In

APEntityManager+InternalMethods.h

generateDataSchemaForDelete:

Generate string from list of instances @property listOfRecord

- (NSString *)generateDataSchemaForDelete:(NSArray *)listOfRecord

Declared In

APEntityManager+InternalMethods.h

generateDataSchemaForSyncJSON:

Create a schema of table structure. @property tableName

- (NSDictionary *)generateDataSchemaForSyncJSON:(NSString *)tableName

Declared In

APEntityManager+InternalMethods.h

generateDataSchemaForUpdate:

Generate JSON format from list of instances @property list

- (NSArray *)generateDataSchemaForUpdate:(NSArray *)list

Declared In

APEntityManager+InternalMethods.h

generatePersistentStore:

Generate persistent store @property _class

- (void)generatePersistentStore:(Class)_class

Declared In

APEntityManager+InternalMethods.h

generateTableSchemaForAllClasses

Create a shema of database structure. @property

- (NSArray *)generateTableSchemaForAllClasses

Declared In

APEntityManager+InternalMethods.h

getPrimaryKeyValue:

Retrieve value of primary key of instance. @property instance

- (NSString *)getPrimaryKeyValue:(id)instance

Declared In

APEntityManager+InternalMethods.h

insertInstance:withBlock:

1件のデータをストレージに挿入する。 @param instance @param error

- (void)insertInstance:(APObject *)instance withBlock:(APObjectResultBlock)block

Declared In

APEntityManager+InternalMethods.h

insertInstanceToLocal:error:

一つのデータオブジェクトを同期でローカルストレージに生成する。

- (APObject *)insertInstanceToLocal:(APObject *)instance error:(NSError **)error

Parameters

instance

保存対象のデータオブジェクト

error

データの生成の際に発生したエラーを格納する

@discussion

Declared In

APEntityManager+InternalMethods.h

insertInstanceToServer:error:

一つのデータオブジェクトを同期でサーバー側に生成する。

- (APObject *)insertInstanceToServer:(APObject *)instance error:(NSError **)error

Parameters

instance

保存対象のデータオブジェクト

error

データの生成の際に発生したエラーを格納する

@discussion

Declared In

APEntityManager+InternalMethods.h

insertInstanceToServer:withBlock:

一つのデータオブジェクトを非同期でサーバー側に生成する。

- (void)insertInstanceToServer:(APObject *)instance withBlock:(APObjectResultBlock)block

Parameters

instance

保存対象のデータオブジェクト

block

データの生成の後に実行する処理

@discussion

Declared In

APEntityManager+InternalMethods.h

insertInstances:

複数のデータオブジェクトをストレージに保存する。

- (void)insertInstances:(NSArray *)instances

Parameters

instances

保存するデータオブジェクトの一覧。各データオブジェクトは異なる種類でもいい。

@discussion

Declared In

APEntityManager+InternalMethods.h

listOfTable

List of tables in local database @property array, table

- (NSArray *)listOfTable

Declared In

APEntityManager+InternalMethods.h

loadArrayWithClass:orderBy:andQuery:

Sort condititon

- (NSArray *)loadArrayWithClass:(Class)_class orderBy:(NSString *)oderBy andQuery:(NSString *)query, ...

Discussion

Sort condititon

Declared In

APEntityManager.m

objectForClass:withId:error:

主キー(objectId)を指定して一件のデータクラスを取得する。このメソッドは同期型で処理される。

- (APObject *)objectForClass:(Class)_class withId:(NSString *)objectId error:(NSError **)error

Parameters

_class

取得するデータの種別をクラスで指定

objectId

取得するデータの主キー

error

発生したエラーを収納するエラーオブジェクトを渡す。

@discussion

Declared In

APEntityManager.h

objectForClass:withId:withBlock:

主キー(objectId)を指定して一件のデータクラスを取得する。このメソッドは非同期型で処理される。

- (void)objectForClass:(Class)_class withId:(NSString *)objectId withBlock:(APObjectResultBlock)block

Parameters

_class

取得するデータの種別をクラスで指定

objectId

取得するデータの主キー

block

取得したデータや発生したエラーを処理するブロック

@discussion

Declared In

APEntityManager.h

objectFromLocalForClass:withCondition:

指定した条件に合致するデータをローカルストレージから同期型で取得する。

- (NSArray *)objectFromLocalForClass:(Class)_class withCondition:(NSDictionary *)condition

Parameters

_class

取得するデータクラス

condition

データを取得する条件 @discussion Return a list of instances of class based on the condition.

Declared In

APEntityManager+InternalMethods.h

objectFromLocalForClass:withId:

指定したIDに合致するデータをローカルストレージから同期型で取得する。

- (APObject *)objectFromLocalForClass:(Class)_class withId:(NSString *)objectId

Parameters

_class

取得するデータクラス

objectId

データのID @discussion Return a list of instances of class based on the condition.

Declared In

APEntityManager+InternalMethods.h

objectFromServerForClass:withObjectId:error:

指定したobjectIdに合致するデータを取得する。データが取得されるまで呼び出したメソッドは待機する。

- (APObject *)objectFromServerForClass:(Class)_class withObjectId:(NSString *)objectId error:(NSError **)error

Parameters

_class

取得するデータクラス

objectId

取得するデータのID

error

エラーが渡される。 @discussion このメソッドは同期型で処理されるため、データの件数やネットワークの状態等によっては呼び出し元のスレッドは長時間待たされることがあり得るので注意が必要。

Declared In

APEntityManager+InternalMethods.h

objectsForClass:withCondition:error:

指定した条件に合致するデータを取得する。データが取得されるまで呼び出したメソッドは待機する。

- (NSArray *)objectsForClass:(Class)_class withCondition:(NSDictionary *)condition error:(NSError **)error

Parameters

_class

取得するデータクラス

condition

データを取得する条件

error

エラーが渡される。 @discussion このメソッドは同期型で処理されるため、データの件数やネットワークの状態等によっては呼び出し元のスレッドは長時間待たされることがあり得るので注意が必要。

Declared In

APEntityManager+InternalMethods.h

objectsForClass:withCondition:withBlock:

指定した条件に合致するデータを取得する。呼び出したスレッドはそのまま処理を続行し、データが取得されると非同期でブロックのコードが実行される。

- (void)objectsForClass:(Class)_class withCondition:(NSDictionary *)condition withBlock:(APArrayResultBlock)block

Parameters

_class

取得するデータクラス

condition

データを取得する条件

block

APArrayResultBlock 取得したデータの一覧とエラーが渡される。 @discussion Return a list of instances of class based on the condition.

Declared In

APEntityManager+InternalMethods.h

objectsFromServerForClass:withCondition:error:

指定した条件に合致するデータを取得する。データが取得されるまで呼び出したメソッドは待機する。

- (NSArray *)objectsFromServerForClass:(Class)_class withCondition:(NSDictionary *)condition error:(NSError **)error

Parameters

_class

取得するデータクラス

condition

取得するデータの条件

error

エラーが渡される。 @discussion このメソッドは同期型で処理されるため、データの件数やネットワークの状態等によっては呼び出し元のスレッドは長時間待たされることがあり得るので注意が必要。

Declared In

APEntityManager+InternalMethods.h

registerValueObjects:isRecreate:withBlock:

アプリが使用するデータオブジェクトをSDKに登録する。Register Value Objects of App to AppPot SDK.

- (void)registerValueObjects:(NSArray *)classes isRecreate:(BOOL)isRecreateDatabase withBlock:(APErrorBlock)block

Parameters

classes

データオブジェクトののClass型の一覧。

block

データのスキーマ作成に失敗した場合に実行する処理を記述するブロック。初期起動時、開発時にはアプリの稼働を中止することを推奨する。

Discussion

アプリケーションのデベロッパーはアプリで使う全てのデータクラスをAPObjectの子クラスとして定義、このメソッドを通してSDKに登録する。 この登録によってデバイス及びサーバー側のデータベースや各テーブルのスキーマが作成される。登録されなかったデータクラスはSDKによって管理されない。

Declared In

APEntityManager.h

removeInstances:

Remove instance of class from local database @property instance

- (void)removeInstances:(NSArray *)instances

Declared In

APEntityManager+InternalMethods.h

saveInstance:error:

対象のデータオブジェクトを保存する。この処理は同期型で行われる。

- (APObject *)saveInstance:(APObject *)valueObject error:(NSError **)error

Parameters

valueObject

保存するデータオブジェクト。

error

発生したエラーを格納するためのエラーオブジェクト

Discussion

対象データオブジェクトが新規の場合は新規データの追加、既存のものである場合は既存データの更新が行われる。正常時は更新が終わったデータオブジェクトを返す。

Declared In

APEntityManager.h

saveInstance:withBlock:

対象のデータオブジェクトを保存する。この処理は非同期型で行われる。

- (void)saveInstance:(APObject *)valueObject withBlock:(APObjectResultBlock)block

Parameters

valueObject

保存するデータオブジェクト。

block

データの処理結果を取得しその後の処理を行うためのブロック

Discussion

対象データオブジェクトが新規の場合は新規データの追加、既存のものである場合は既存データの更新が行われる。正常時は更新が終わったデータオブジェクトを返す。

Declared In

APEntityManager.h

saveListOfInstances:error:

対象のデータオブジェクト一覧を保存する。この処理は同期型で行われる。

- (NSArray *)saveListOfInstances:(NSArray *)list error:(NSError **)error

Parameters

list

保存するデータオブジェクトの一覧。

error

発生したエラーを格納するためのエラーオブジェクト

Discussion

対象データオブジェクトが新規の場合は新規データの追加、既存のものである場合は既存データの更新が行われる。正常時は更新が終わったデータオブジェクトを返す。

Declared In

APEntityManager.h

swapObjects:object:

Swap 2 instances @property objOne, objTwo

- (void)swapObjects:(id)objOne object:(id)objTwo

Declared In

APEntityManager+InternalMethods.h

tableNameForInstance:

///For Data Access

- (NSString *)tableNameForInstance:(id)instance

Discussion

///For Data Access

Declared In

APEntityManager.m

updateDatabaseFromDeleteIds:atTable:

Delete rows of table in local database @property array, table

- (void)updateDatabaseFromDeleteIds:(NSArray *)array atTable:(NSString *)table

Declared In

APEntityManager+InternalMethods.h

updateDatabaseFromResult:atTable:

Update table of local database with list of row values. @property array, table

- (void)updateDatabaseFromResult:(NSArray *)array atTable:(NSString *)table

Declared In

APEntityManager+InternalMethods.h

updateInstanceToLocal:error:

Update instance of class to local database @property instance

- (APObject *)updateInstanceToLocal:(APObject *)instance error:(NSError **)error

Declared In

APEntityManager+InternalMethods.h

updateInstanceToServer:error:

一つのデータオブジェクトを同期でサーバー側に更新する。 @property instance 更新対象のデータオブジェクト

- (APObject *)updateInstanceToServer:(APObject *)instance error:(NSError **)error

Parameters

block

データ更新の際に発生したエラーを格納

@discussion

Declared In

APEntityManager+InternalMethods.h

updateInstanceToServer:withBlock:

一つのデータオブジェクトを非同期でサーバー側に更新する。 @property instance 保存対象のデータオブジェクト

- (void)updateInstanceToServer:(APObject *)instance withBlock:(APObjectResultBlock)block

Parameters

block

データ更新の後に実行する処理

@discussion

Declared In

APEntityManager+InternalMethods.h

updateInstances:

Update instance of class to local database @property instance

- (void)updateInstances:(NSArray *)instances

Declared In

APEntityManager+InternalMethods.h