APEntityManager Class Reference
| Inherits from | NSObject |
| Declared in | APEntityManager.h APEntityManager.m |
Tasks
Other Methods
-
+ sharedInstance -
– registerValueObjects:isRecreate:withBlock: -
– objectForClass:withId:withBlock: -
– objectForClass:withId:error: -
– saveInstance:error: -
– saveInstance:withBlock: -
– saveListOfInstances:error: -
– deleteInstance:error: -
– deleteInstance:withBlock: -
– deleteListOfInstance:error: -
– deleteAllDataFor: -
– count:
Other Methods
-
– generateTableSchemaForAllClasses -
– generateDataSchemaForSyncJSON: -
– tableNameForInstance: -
– generateDataSchemaForAdd: -
– generateDataSchemaForUpdate: -
– generateDataSchemaForDelete: -
– generatePersistentStore: -
– objectFromServerForClass:withObjectId:error: -
– objectsFromServerForClass:withCondition:error: -
– objectsForClass:withCondition:error: -
– objectsForClass:withCondition:withBlock: -
– objectFromLocalForClass:withId: -
– objectFromLocalForClass:withCondition: -
– loadArrayWithClass:orderBy:andQuery: -
– updateInstanceToLocal:error: -
– updateInstanceToServer:error: -
– updateInstanceToServer:withBlock: -
– updateInstances: -
– deleteInstanceFromLocal:error: -
– deleteInstanceFromServer:error: -
– deleteInstanceFromServer:withBlock: -
– removeInstances: -
– insertInstance:withBlock: -
– insertInstanceToLocal:error: -
– insertInstanceToServer:error: -
– insertInstanceToServer:withBlock: -
– fetch: -
– fetch:where: -
– fetch:withPredicate: -
– getPrimaryKeyValue: -
– convertToObjectFromDictionary:ofClass: -
– swapObjects:object: -
– listOfTable -
– updateDatabaseFromResult:atTable: -
– updateDatabaseFromDeleteIds:atTable: -
– encryptDataForColumn:atTable: -
– decryptDataForColumn:atTable: -
– encryptColumsAtTable: -
– decryptColumsAtTable:
InternalMethods Methods
Instance Methods
convertToObjectFromDictionary:ofClass:
Return an instance from response server @property dic, _class
- (id)convertToObjectFromDictionary:(NSDictionary *)dic ofClass:(Class)_classDeclared In
APEntityManager+InternalMethods.hcount:
指定してクラスのデータの件数を返す。Count number of row of class from local database @param _class
- (NSInteger)count:(Class)_classDeclared In
APEntityManager.hdecryptColumsAtTable:
Decrypt all columns of table @property tableName
- (void)decryptColumsAtTable:(NSString *)tableNameDeclared In
APEntityManager+InternalMethods.hdecryptDataForColumn:atTable:
Decrypt value of column of table @property column, tableName
- (void)decryptDataForColumn:(NSString *)column atTable:(NSString *)tableNameDeclared In
APEntityManager+InternalMethods.hdeleteAllDataFor:
指定したクラスの全てのデータを削除する。 @param _class
- (void)deleteAllDataFor:(Class)_classDiscussion
データストレージ内のデータが全て削除されるので使用には注意が必要。ローカルストレージでは物理削除、サーバー側では論理削除が行われる。
Declared In
APEntityManager.hdeleteInstance:error:
対象データオブジェクトを削除する。この処理は同期型で行われる。
- (BOOL)deleteInstance:(APObject *)instance error:(NSError **)errorParameters
- instance
削除するデータオブジェクト。
- error
発生したエラーを格納するためのエラーオブジェクト
@discussion
Declared In
APEntityManager.hdeleteInstance:withBlock:
対象データオブジェクトを削除する。この処理は非同期型で行われる。 @property instance 削除するデータオブジェクト。
- (void)deleteInstance:(APObject *)instance withBlock:(APObjectResultBlock)blockParameters
- error
発生したエラーを格納するためのエラーオブジェクト
@discussion
Declared In
APEntityManager.hdeleteInstanceFromLocal:error:
ローカルストレージにあるデータを削除する。 @property instance
- (BOOL)deleteInstanceFromLocal:(APObject *)instance error:(NSError **)errorDeclared In
APEntityManager+InternalMethods.hdeleteInstanceFromServer:error:
サーバーのストレージにあるデータを同期型で削除する。
- (BOOL)deleteInstanceFromServer:(APObject *)instance error:(NSError **)errorParameters
- instance
削除対象のデータオブジェクト
- error
削除の際に発生したエラーを格納 @discussion
Declared In
APEntityManager+InternalMethods.hdeleteInstanceFromServer:withBlock:
サーバーのストレージにあるデータを期型で削除する。
- (void)deleteInstanceFromServer:(APObject *)instance withBlock:(APObjectResultBlock)blockParameters
- instance
削除対象のデータオブジェクト
- error
削除の際に発生したエラーを格納 @discussion
Declared In
APEntityManager+InternalMethods.hdeleteListOfInstance:error:
対象データオブジェクトの一覧を削除する。この処理は同期型で行われる。 @property instance 削除するデータオブジェクト。
- (BOOL)deleteListOfInstance:(NSArray *)list error:(NSError **)errorParameters
- error
発生したエラーを格納するためのエラーオブジェクト
@discussion
Declared In
APEntityManager.hencryptColumsAtTable:
Encrypt all columns of table @property tableName
- (void)encryptColumsAtTable:(NSString *)tableNameDeclared In
APEntityManager+InternalMethods.hencryptDataForColumn:atTable:
Encrypt value of column of table @property column, tableName
- (void)encryptDataForColumn:(NSString *)column atTable:(NSString *)tableNameDeclared In
APEntityManager+InternalMethods.hfetch:
Fetch all rows from local database @property _class
- (NSArray *)fetch:(Class)_classDeclared In
APEntityManager+InternalMethods.hfetch:where:
Fetch rows from local database with condition @property _class
- (NSArray *)fetch:(Class)_class where:(APCondition)predicateDeclared In
APEntityManager+InternalMethods.hfetch:withPredicate:
Fetch rows from local database with predicate @property _class
- (NSArray *)fetch:(Class)_class withPredicate:(NSPredicate *)predicateDeclared In
APEntityManager+InternalMethods.hgenerateDataSchemaForAdd:
Generate JSON format from list of instances @property list
- (NSArray *)generateDataSchemaForAdd:(NSArray *)listDeclared In
APEntityManager+InternalMethods.hgenerateDataSchemaForDelete:
Generate string from list of instances @property listOfRecord
- (NSString *)generateDataSchemaForDelete:(NSArray *)listOfRecordDeclared In
APEntityManager+InternalMethods.hgenerateDataSchemaForSyncJSON:
Create a schema of table structure. @property tableName
- (NSDictionary *)generateDataSchemaForSyncJSON:(NSString *)tableNameDeclared In
APEntityManager+InternalMethods.hgenerateDataSchemaForUpdate:
Generate JSON format from list of instances @property list
- (NSArray *)generateDataSchemaForUpdate:(NSArray *)listDeclared In
APEntityManager+InternalMethods.hgeneratePersistentStore:
Generate persistent store @property _class
- (void)generatePersistentStore:(Class)_classDeclared In
APEntityManager+InternalMethods.hgenerateTableSchemaForAllClasses
Create a shema of database structure. @property
- (NSArray *)generateTableSchemaForAllClassesDeclared In
APEntityManager+InternalMethods.hgetPrimaryKeyValue:
Retrieve value of primary key of instance. @property instance
- (NSString *)getPrimaryKeyValue:(id)instanceDeclared In
APEntityManager+InternalMethods.hinsertInstance:withBlock:
1件のデータをストレージに挿入する。 @param instance @param error
- (void)insertInstance:(APObject *)instance withBlock:(APObjectResultBlock)blockDeclared In
APEntityManager+InternalMethods.hinsertInstanceToLocal:error:
一つのデータオブジェクトを同期でローカルストレージに生成する。
- (APObject *)insertInstanceToLocal:(APObject *)instance error:(NSError **)errorParameters
- instance
保存対象のデータオブジェクト
- error
データの生成の際に発生したエラーを格納する
@discussion
Declared In
APEntityManager+InternalMethods.hinsertInstanceToServer:error:
一つのデータオブジェクトを同期でサーバー側に生成する。
- (APObject *)insertInstanceToServer:(APObject *)instance error:(NSError **)errorParameters
- instance
保存対象のデータオブジェクト
- error
データの生成の際に発生したエラーを格納する
@discussion
Declared In
APEntityManager+InternalMethods.hinsertInstanceToServer:withBlock:
一つのデータオブジェクトを非同期でサーバー側に生成する。
- (void)insertInstanceToServer:(APObject *)instance withBlock:(APObjectResultBlock)blockParameters
- instance
保存対象のデータオブジェクト
- block
データの生成の後に実行する処理
@discussion
Declared In
APEntityManager+InternalMethods.hinsertInstances:
複数のデータオブジェクトをストレージに保存する。
- (void)insertInstances:(NSArray *)instancesParameters
- instances
保存するデータオブジェクトの一覧。各データオブジェクトは異なる種類でもいい。
@discussion
Declared In
APEntityManager+InternalMethods.hlistOfTable
List of tables in local database @property array, table
- (NSArray *)listOfTableDeclared In
APEntityManager+InternalMethods.hloadArrayWithClass:orderBy:andQuery:
Sort condititon
- (NSArray *)loadArrayWithClass:(Class)_class orderBy:(NSString *)oderBy andQuery:(NSString *)query, ...Discussion
Sort condititon
Declared In
APEntityManager.mobjectForClass:withId:error:
主キー（objectId）を指定して一件のデータクラスを取得する。このメソッドは同期型で処理される。
- (APObject *)objectForClass:(Class)_class withId:(NSString *)objectId error:(NSError **)errorParameters
- _class
取得するデータの種別をクラスで指定
- objectId
取得するデータの主キー
- error
発生したエラーを収納するエラーオブジェクトを渡す。
@discussion
Declared In
APEntityManager.hobjectForClass:withId:withBlock:
主キー（objectId）を指定して一件のデータクラスを取得する。このメソッドは非同期型で処理される。
- (void)objectForClass:(Class)_class withId:(NSString *)objectId withBlock:(APObjectResultBlock)blockParameters
- _class
取得するデータの種別をクラスで指定
- objectId
取得するデータの主キー
- block
取得したデータや発生したエラーを処理するブロック
@discussion
Declared In
APEntityManager.hobjectFromLocalForClass:withCondition:
指定した条件に合致するデータをローカルストレージから同期型で取得する。
- (NSArray *)objectFromLocalForClass:(Class)_class withCondition:(NSDictionary *)conditionParameters
- _class
取得するデータクラス
- condition
データを取得する条件 @discussion Return a list of instances of class based on the condition.
Declared In
APEntityManager+InternalMethods.hobjectFromLocalForClass:withId:
指定したIDに合致するデータをローカルストレージから同期型で取得する。
- (APObject *)objectFromLocalForClass:(Class)_class withId:(NSString *)objectIdParameters
- _class
取得するデータクラス
- objectId
データのID @discussion Return a list of instances of class based on the condition.
Declared In
APEntityManager+InternalMethods.hobjectFromServerForClass:withObjectId:error:
指定したobjectIdに合致するデータを取得する。データが取得されるまで呼び出したメソッドは待機する。
- (APObject *)objectFromServerForClass:(Class)_class withObjectId:(NSString *)objectId error:(NSError **)errorParameters
- _class
取得するデータクラス
- objectId
取得するデータのID
- error
エラーが渡される。 @discussion このメソッドは同期型で処理されるため、データの件数やネットワークの状態等によっては呼び出し元のスレッドは長時間待たされることがあり得るので注意が必要。
Declared In
APEntityManager+InternalMethods.hobjectsForClass:withCondition:error:
指定した条件に合致するデータを取得する。データが取得されるまで呼び出したメソッドは待機する。
- (NSArray *)objectsForClass:(Class)_class withCondition:(NSDictionary *)condition error:(NSError **)errorParameters
- _class
取得するデータクラス
- condition
データを取得する条件
- error
エラーが渡される。 @discussion このメソッドは同期型で処理されるため、データの件数やネットワークの状態等によっては呼び出し元のスレッドは長時間待たされることがあり得るので注意が必要。
Declared In
APEntityManager+InternalMethods.hobjectsForClass:withCondition:withBlock:
指定した条件に合致するデータを取得する。呼び出したスレッドはそのまま処理を続行し、データが取得されると非同期でブロックのコードが実行される。
- (void)objectsForClass:(Class)_class withCondition:(NSDictionary *)condition withBlock:(APArrayResultBlock)blockParameters
- _class
取得するデータクラス
- condition
データを取得する条件
- block
APArrayResultBlock 取得したデータの一覧とエラーが渡される。 @discussion Return a list of instances of class based on the condition.
Declared In
APEntityManager+InternalMethods.hobjectsFromServerForClass:withCondition:error:
指定した条件に合致するデータを取得する。データが取得されるまで呼び出したメソッドは待機する。
- (NSArray *)objectsFromServerForClass:(Class)_class withCondition:(NSDictionary *)condition error:(NSError **)errorParameters
- _class
取得するデータクラス
- condition
取得するデータの条件
- error
エラーが渡される。 @discussion このメソッドは同期型で処理されるため、データの件数やネットワークの状態等によっては呼び出し元のスレッドは長時間待たされることがあり得るので注意が必要。
Declared In
APEntityManager+InternalMethods.hregisterValueObjects:isRecreate:withBlock:
アプリが使用するデータオブジェクトをSDKに登録する。Register Value Objects of App to AppPot SDK.
- (void)registerValueObjects:(NSArray *)classes isRecreate:(BOOL)isRecreateDatabase withBlock:(APErrorBlock)blockParameters
- classes
データオブジェクトののClass型の一覧。
- block
データのスキーマ作成に失敗した場合に実行する処理を記述するブロック。初期起動時、開発時にはアプリの稼働を中止することを推奨する。
Discussion
アプリケーションのデベロッパーはアプリで使う全てのデータクラスをAPObjectの子クラスとして定義、このメソッドを通してSDKに登録する。 この登録によってデバイス及びサーバー側のデータベースや各テーブルのスキーマが作成される。登録されなかったデータクラスはSDKによって管理されない。
Declared In
APEntityManager.hremoveInstances:
Remove instance of class from local database @property instance
- (void)removeInstances:(NSArray *)instancesDeclared In
APEntityManager+InternalMethods.hsaveInstance:error:
対象のデータオブジェクトを保存する。この処理は同期型で行われる。
- (APObject *)saveInstance:(APObject *)valueObject error:(NSError **)errorParameters
- valueObject
保存するデータオブジェクト。
- error
発生したエラーを格納するためのエラーオブジェクト
Discussion
対象データオブジェクトが新規の場合は新規データの追加、既存のものである場合は既存データの更新が行われる。正常時は更新が終わったデータオブジェクトを返す。
Declared In
APEntityManager.hsaveInstance:withBlock:
対象のデータオブジェクトを保存する。この処理は非同期型で行われる。
- (void)saveInstance:(APObject *)valueObject withBlock:(APObjectResultBlock)blockParameters
- valueObject
保存するデータオブジェクト。
- block
データの処理結果を取得しその後の処理を行うためのブロック
Discussion
対象データオブジェクトが新規の場合は新規データの追加、既存のものである場合は既存データの更新が行われる。正常時は更新が終わったデータオブジェクトを返す。
Declared In
APEntityManager.hsaveListOfInstances:error:
対象のデータオブジェクト一覧を保存する。この処理は同期型で行われる。
- (NSArray *)saveListOfInstances:(NSArray *)list error:(NSError **)errorParameters
- list
保存するデータオブジェクトの一覧。
- error
発生したエラーを格納するためのエラーオブジェクト
Discussion
対象データオブジェクトが新規の場合は新規データの追加、既存のものである場合は既存データの更新が行われる。正常時は更新が終わったデータオブジェクトを返す。
Declared In
APEntityManager.hswapObjects:object:
Swap 2 instances @property objOne, objTwo
- (void)swapObjects:(id)objOne object:(id)objTwoDeclared In
APEntityManager+InternalMethods.htableNameForInstance:
///For Data Access
- (NSString *)tableNameForInstance:(id)instanceDiscussion
///For Data Access
Declared In
APEntityManager.mupdateDatabaseFromDeleteIds:atTable:
Delete rows of table in local database @property array, table
- (void)updateDatabaseFromDeleteIds:(NSArray *)array atTable:(NSString *)tableDeclared In
APEntityManager+InternalMethods.hupdateDatabaseFromResult:atTable:
Update table of local database with list of row values. @property array, table
- (void)updateDatabaseFromResult:(NSArray *)array atTable:(NSString *)tableDeclared In
APEntityManager+InternalMethods.hupdateInstanceToLocal:error:
Update instance of class to local database @property instance
- (APObject *)updateInstanceToLocal:(APObject *)instance error:(NSError **)errorDeclared In
APEntityManager+InternalMethods.hupdateInstanceToServer:error:
一つのデータオブジェクトを同期でサーバー側に更新する。 @property instance 更新対象のデータオブジェクト
- (APObject *)updateInstanceToServer:(APObject *)instance error:(NSError **)errorParameters
- block
データ更新の際に発生したエラーを格納
@discussion
Declared In
APEntityManager+InternalMethods.h