SCDataStore Class Reference
| Inherits from | NSObject |
| Declared in | SCDataStore.h |
Overview
SCDataStore is an abstract base class that can encapsulate any kind of data storage, providing means for the SC framework to communicate with this storage to fetch, add, update and remove data.
Several SCDataStore subclasses have been implemented to enable the SC framework to communicate with Core Data, web services, iCloud storage, and even NSUserDefaults storage. Feel free to subclass SCDataStore to enable any kind of data storage not currently implemented by framework.
Sample use:
// Display all the TaskEntity objects
SCCoreDataStore *coreDataStore = [SCCoreDataStore storeWithManagedObjectContext:context defaultEntityDefinition:TaskEntityDef];
SCArrayOfObjectsSection *tasksSection = [SCArrayOfObjectsSection sectionWithHeaderTitle:@"Task Objects" dataStore:coreDataStore];
[self.tableViewModel addSection:tasksSection];
See also: SCMemoryStore, SCCoreDataStore, SCWebServiceStore, SCiCloudStore, SCUserDefaultsStore
Note: At initialization time, SCDataStore must be assigned at least one default SCDataDefinition that fully defines its stored data objects.
Warning: SCDataStore is an abstract base class and should not be directly instantiated.
Tasks
Creation and Initialization
-
+ storeWithDefaultDataDefinition:Allocated and returns an initialized SCDataStore given a default SCDataDefinition of the data stored.
-
– initWithDefaultDataDefinition:Returns an initialized SCDataStore given a default SCDataDefinition of the data stored.
Configuration
-
storeModeSpecifies the mode that the SC framework should use to communicate with the store. Set to SCStoreModeSynchronous to have the framework communicate synchronously, otherwise set to SCStoreModeAsynchronous for asynchronous communication.
property -
defaultDataDefinitionThe data store’s default data definition. To add more data definitions (other than the default one), use addDataDefinition:.
property -
– addDataDefinition:Adds a definition to dataDefinitions.
-
– definitionForObject:Returns the data definition for the given object.
Synchronous Data Access
-
– createNewObjectReturns a newly allocated and initialized object based on the store’s default data definition.
-
– createNewObjectWithDefinition:Returns a newly allocated and initialized object based on the given data definition.
-
– discardUninsertedObject:Discards the given uninserted object.
-
– insertObject:Inserts the given object into the data store.
-
– insertObject:atOrder:Inserts the given object into the data store at the specified order.
-
– changeOrderForObject:toOrder:Changes the order of the given object to the specified order.
-
– updateObject:Updates the given object in the data store.
-
– deleteObject:Deletes the given object from the data store.
-
– fetchObjectsWithOptions:Fetches objects from the data store that satisfy the given fetch options.
-
– valueForPropertyName:inObject:Returns the value for the given property name in the given object.
-
– stringValueForPropertyName:inObject:separateValuesUsingDelimiter:Returns the string value for the given property name in the given object.
-
– setValue:forPropertyName:inObject:Sets the value for the given property name in the given object.
Asynchronous Data Access
-
– asynchronousInsertObject:success:failure:Asynchronously inserts the given object into the data store.
-
– asynchronousUpdateObject:success:failure:Asynchronously updates the given object into the data store.
-
– asynchronousDeleteObject:success:failure:Asynchronously deletes the given object from the data store.
-
– asynchronousFetchObjectsWithOptions:success:failure:Asynchronously fetches objects from the data store that satisfy the given fetch options.
Data Validation
-
– validateInsertForObject:Returns TRUE if the given object can be inserted into the data store, otherwise returns FALSE.
-
– validateUpdateForObject:Returns TRUE if the given object can be updated into the data store, otherwise returns FALSE.
-
– validateDeleteForObject:Returns TRUE if the given object can be deleted from the data store, otherwise returns FALSE.
-
– validateOrderChangeForObject:Returns TRUE if the order of the given object can be changed in the data store, otherwise returns FALSE.
Data Management
-
– commitDataCommits the data store objects to the persistent store. This method is only applicable to data stores that store their objects in memory before persisting them to a permenant persistant storage.
Internal Properties & Methods (should only be used by the framework or when subclassing)
-
storedDataShould be used by subclasses to store their data when heap memory storage is needed.
property -
defaultsDictionaryShould be used by subclasses to store any default values needed.
property -
– bindStoreToPropertyName:forObject:withDefinition:Binds the store to a property name that will be used to fetch all the store’s data.
-
– forceDiscardAllUnaddedObjectsThis method is typically called internally by the framework when all unadded objects must be discarded. The method will issue the ‘SCDataStoreWillDiscardAllUnaddedObjectsNotification’ notification to inform all classes using the store that this will happen.
-
– applicationWillEnterForegroundMethod called when the application is about to leave the background state. Subclasses should override this method when any initialization is needed at this point.
Properties
defaultDataDefinition
The data store’s default data definition. To add more data definitions (other than the default one), use addDataDefinition:.
@property (nonatomic, strong) SCDataDefinition *defaultDataDefinitionDeclared In
SCDataStore.hdefaultsDictionary
Should be used by subclasses to store any default values needed.
@property (nonatomic, strong) NSDictionary *defaultsDictionaryDeclared In
SCDataStore.hstoreMode
Specifies the mode that the SC framework should use to communicate with the store. Set to SCStoreModeSynchronous to have the framework communicate synchronously, otherwise set to SCStoreModeAsynchronous for asynchronous communication.
@property (nonatomic, readwrite) SCStoreMode storeModeDeclared In
SCDataStore.hClass Methods
storeWithDefaultDataDefinition:
Allocated and returns an initialized SCDataStore given a default SCDataDefinition of the data stored.
+ (id)storeWithDefaultDataDefinition:(SCDataDefinition *)definitionDeclared In
SCDataStore.hInstance Methods
addDataDefinition:
Adds a definition to dataDefinitions.
- (void)addDataDefinition:(SCDataDefinition *)definitionDeclared In
SCDataStore.happlicationWillEnterForeground
Method called when the application is about to leave the background state. Subclasses should override this method when any initialization is needed at this point.
- (void)applicationWillEnterForegroundDeclared In
SCDataStore.hasynchronousDeleteObject:success:failure:
Asynchronously deletes the given object from the data store.
- (void)asynchronousDeleteObject:(NSObject *)object success:(SCDataStoreDeleteSuccess_Block)success_block failure:(SCDataStoreFailure_Block)failure_blockParameters
- object
The object to be deleted.
- success_block
The code block called after the object has been successfully deleted.
SCDataStoreDeleteSuccess_Block syntax:
{ // Your code here }
- failure_block
The code block called in case the object could not be deleted.
SCDataStoreFailure_Block syntax:
^(NSError *error) { // Your code here }
Declared In
SCDataStore.hasynchronousFetchObjectsWithOptions:success:failure:
Asynchronously fetches objects from the data store that satisfy the given fetch options.
- (void)asynchronousFetchObjectsWithOptions:(SCDataFetchOptions *)fetchOptions success:(SCDataStoreFetchSuccess_Block)success_block failure:(SCDataStoreFailure_Block)failure_blockParameters
- fetchOptions
The fetch options that the data store must satisfy when returning the objects.
- success_block
The code block called after the data has been successfully fetched.
SCDataStoreFetchSuccess_Block syntax:
^(NSArray *results) { // Your code here }Where ‘results’ is the fetched data array.
- failure_block
The code block called in case the data could not be fetched.
SCDataStoreFailure_Block syntax:
^(NSError *error) { // Your code here }
See Also
Declared In
SCDataStore.hasynchronousInsertObject:success:failure:
Asynchronously inserts the given object into the data store.
- (void)asynchronousInsertObject:(NSObject *)object success:(SCDataStoreInsertSuccess_Block)success_block failure:(SCDataStoreFailure_Block)failure_blockParameters
- object
The object to be inserted.
- success_block
The code block called after the object has been successfully inserted.
SCDataStoreInsertSuccess_Block syntax:
{ // Your code here }
- failure_block
The code block called in case the object could not be inserted.
SCDataStoreFailure_Block syntax:
^(NSError *error) { // Your code here }
Declared In
SCDataStore.hasynchronousUpdateObject:success:failure:
Asynchronously updates the given object into the data store.
- (void)asynchronousUpdateObject:(NSObject *)object success:(SCDataStoreUpdateSuccess_Block)success_block failure:(SCDataStoreFailure_Block)failure_blockParameters
- object
The object to be updated.
- success_block
The code block called after the object has been successfully updated.
SCDataStoreUpdateSuccess_Block syntax:
{ // Your code here }
- failure_block
The code block called in case the object could not be updated.
SCDataStoreFailure_Block syntax:
^(NSError *error) { // Your code here }
Declared In
SCDataStore.hbindStoreToPropertyName:forObject:withDefinition:
Binds the store to a property name that will be used to fetch all the store’s data.
- (void)bindStoreToPropertyName:(NSString *)propertyName forObject:(NSObject *)object withDefinition:(SCDataDefinition *)definitionDiscussion
Should only be used by the framework all must be implemented by all subclasses.
Declared In
SCDataStore.hchangeOrderForObject:toOrder:
Changes the order of the given object to the specified order.
- (BOOL)changeOrderForObject:(NSObject *)object toOrder:(NSUInteger)toOrderParameters
- object
The object that the order of will change.
- toOrder
The new order index of the object.
Return Value
Returns TRUE if successful.
Discussion
Note: Only applicable for data stores that maintain ordered object storage.
Declared In
SCDataStore.hcommitData
Commits the data store objects to the persistent store. This method is only applicable to data stores that store their objects in memory before persisting them to a permenant persistant storage.
- (void)commitDataDeclared In
SCDataStore.hcreateNewObject
Returns a newly allocated and initialized object based on the store’s default data definition.
- (NSObject *)createNewObjectReturn Value
The newly created object.
Discussion
Warning: Any newly created objects should be later either added to the data store using insertObject:, or discarded using discardUninsertedObject:.
Declared In
SCDataStore.hcreateNewObjectWithDefinition:
Returns a newly allocated and initialized object based on the given data definition.
- (NSObject *)createNewObjectWithDefinition:(SCDataDefinition *)definitionParameters
- definition
The data definition that describes the object to be created.
Return Value
The newly created object.
Discussion
Warning: Any newly created objects should be later either added to the data store using insertObject:, or discarded using discardUninsertedObject:.
Declared In
SCDataStore.hdefinitionForObject:
Returns the data definition for the given object.
- (SCDataDefinition *)definitionForObject:(NSObject *)objectDeclared In
SCDataStore.hdeleteObject:
Deletes the given object from the data store.
- (BOOL)deleteObject:(NSObject *)objectParameters
- object
The object to be deleted.
Return Value
Returns TRUE if successful.
Declared In
SCDataStore.hdiscardUninsertedObject:
Discards the given uninserted object.
- (BOOL)discardUninsertedObject:(NSObject *)objectParameters
- object
The uninserted newly created object to be discarded.
Return Value
Returns TRUE if successful.
Discussion
Any object created with createNewObject: or createNewObjectWithDefinition: and not later inserted to the store using insertObject: must be discarded using this method.
Declared In
SCDataStore.hfetchObjectsWithOptions:
Fetches objects from the data store that satisfy the given fetch options.
- (NSArray *)fetchObjectsWithOptions:(SCDataFetchOptions *)fetchOptionsParameters
- fetchOptions
The fetch options that the data store must satisfy when returning the objects.
Return Value
An array of the fetched objects.
See Also
Declared In
SCDataStore.hforceDiscardAllUnaddedObjects
This method is typically called internally by the framework when all unadded objects must be discarded. The method will issue the ‘SCDataStoreWillDiscardAllUnaddedObjectsNotification’ notification to inform all classes using the store that this will happen.
- (void)forceDiscardAllUnaddedObjectsDeclared In
SCDataStore.hinitWithDefaultDataDefinition:
Returns an initialized SCDataStore given a default SCDataDefinition of the data stored.
- (id)initWithDefaultDataDefinition:(SCDataDefinition *)definitionDeclared In
SCDataStore.hinsertObject:
Inserts the given object into the data store.
- (BOOL)insertObject:(NSObject *)objectParameters
- object
The object to be inserted.
Return Value
Returns TRUE if successful.
Declared In
SCDataStore.hinsertObject:atOrder:
Inserts the given object into the data store at the specified order.
- (BOOL)insertObject:(NSObject *)object atOrder:(NSUInteger)orderParameters
- object
The object to be inserted.
- order
The order index that the object should be inserted at.
Return Value
Returns TRUE if successful.
Discussion
Note: Only applicable for data stores that maintain ordered object storage.
Declared In
SCDataStore.hsetValue:forPropertyName:inObject:
Sets the value for the given property name in the given object.
- (void)setValue:(NSObject *)value forPropertyName:(NSString *)propertyName inObject:(NSObject *)objectParameters
- value
The value of the property.
- propertyName
The name of the property.
- object
The object containing propertyName.
Declared In
SCDataStore.hstringValueForPropertyName:inObject:separateValuesUsingDelimiter:
Returns the string value for the given property name in the given object.
- (NSString *)stringValueForPropertyName:(NSString *)propertyName inObject:(NSObject *)object separateValuesUsingDelimiter:(NSString *)delimiterParameters
- propertyName
The name of the property.
- object
The object containing propertyName.
- delimiter
If the property returns more than one value, this delimiter is used to separate the values in the returned string.
Return Value
The value for the given propertyName.
Declared In
SCDataStore.hupdateObject:
Updates the given object in the data store.
- (BOOL)updateObject:(NSObject *)objectParameters
- object
The object to be updated.
Return Value
Returns TRUE if successful.
Declared In
SCDataStore.hvalidateDeleteForObject:
Returns TRUE if the given object can be deleted from the data store, otherwise returns FALSE.
- (BOOL)validateDeleteForObject:(NSObject *)objectDeclared In
SCDataStore.hvalidateInsertForObject:
Returns TRUE if the given object can be inserted into the data store, otherwise returns FALSE.
- (BOOL)validateInsertForObject:(NSObject *)objectDeclared In
SCDataStore.hvalidateOrderChangeForObject:
Returns TRUE if the order of the given object can be changed in the data store, otherwise returns FALSE.
- (BOOL)validateOrderChangeForObject:(NSObject *)objectDeclared In
SCDataStore.hvalidateUpdateForObject:
Returns TRUE if the given object can be updated into the data store, otherwise returns FALSE.
- (BOOL)validateUpdateForObject:(NSObject *)objectDeclared In
SCDataStore.hvalueForPropertyName:inObject:
Returns the value for the given property name in the given object.
- (NSObject *)valueForPropertyName:(NSString *)propertyName inObject:(NSObject *)objectParameters
- propertyName
The name of the property.
- object
The object containing propertyName.
Return Value
The value for the given propertyName.
Declared In
SCDataStore.h