RKManagedObjectMapping Class Reference
| Inherits from | RKObjectMapping : NSObject |
| Declared in | RKManagedObjectMapping.h RKManagedObjectMapping.m |
Tasks
Other Methods
-
+ mappingForEntity:Creates a new object mapping targetting the specified Core Data entity
-
+ mappingForEntityWithName:Creates a new object mapping targetting the Core Data entity with the specified name. The entity description is fetched from the current managed object context
-
entityThe Core Data entity description used for this object mapping
property -
primaryKeyAttributeThe attribute containing the primary key value for the class. This is consulted by RestKit to uniquely identify objects within the store using the primary key in your remote backend system.
property -
relationshipsAndPrimaryKeyAttributesReturns a dictionary containing Core Data relationships and attribute pairs containing the primary key for
property -
– connectRelationship:withObjectForPrimaryKeyAttribute:Instructs RestKit to automatically connect a relationship of the object being mapped by looking up the related object by primary key.
-
– connectRelationshipsWithObjectsForPrimaryKeyAttributes:Connects relationships using the primary key values contained in the specified attribute. This method is a short-cut for repeated invocation of
connectRelationship:withObjectForPrimaryKeyAttribute:. -
– defaultValueForMissingAttribute:Returns the default value for the specified attribute as expressed in the Core Data entity definition. This value will be assigned if the object mapping is applied and a value for a missing attribute is not present in the payload.
Other Methods
-
+ mappingForClass:Returns an object mapping for the specified class that is ready for configuration
Other Methods
-
– mappableObjectForData:Returns an auto-released object that can be used to apply this object mapping given a set of mappable data. For transient objects, this generally returns an instance of the objectClass. For Core Data backed persistent objects, mappableData will be inspected to search for primary key data to lookup existing object instances.
Other Methods
-
– classForProperty:Returns the class of the attribute or relationship property of the target objectClass
Properties
entity
The Core Data entity description used for this object mapping
@property (nonatomic, readonly) NSEntityDescription *entityDeclared In
RKManagedObjectMapping.hprimaryKeyAttribute
The attribute containing the primary key value for the class. This is consulted by RestKit to uniquely identify objects within the store using the primary key in your remote backend system.
@property (nonatomic, retain) NSString *primaryKeyAttributeDeclared In
RKManagedObjectMapping.hClass Methods
mappingForClass:
Returns an object mapping for the specified class that is ready for configuration
+ (id)mappingForClass:(Class)objectClassDeclared In
RKObjectMapping.hmappingForEntity:
Creates a new object mapping targetting the specified Core Data entity
+ (RKManagedObjectMapping *)mappingForEntity:(NSEntityDescription *)entityDeclared In
RKManagedObjectMapping.hInstance Methods
classForProperty:
Returns the class of the attribute or relationship property of the target objectClass
- (Class)classForProperty:(NSString *)propertyNameParameters
- propertyName
The name of the property we would like to retrieve the type of
Discussion
Given the name of a string property, this will return an NSString, etc.
Declared In
RKObjectMapping.hconnectRelationship:withObjectForPrimaryKeyAttribute:
Instructs RestKit to automatically connect a relationship of the object being mapped by looking up the related object by primary key.
- (void)connectRelationship:(NSString *)relationshipName withObjectForPrimaryKeyAttribute:(NSString *)primaryKeyAttributeDiscussion
For example, given a Project object associated with a User, where the ‘user’ relationship is specified by a userID property on the managed object:
[mapping connectRelationship:@“user” withObjectForPrimaryKeyAttribute:@“userID”];
Will hydrate the ‘user’ association on the managed object with the object in the local object graph having the primary key specified in the managed object’s userID property.
In effect, this approach allows foreign key relationships between managed objects to be automatically maintained from the server to the underlying Core Data object graph.
Declared In
RKManagedObjectMapping.hconnectRelationshipsWithObjectsForPrimaryKeyAttributes:
Connects relationships using the primary key values contained in the specified attribute. This method is
a short-cut for repeated invocation of connectRelationship:withObjectForPrimaryKeyAttribute:.
- (void)connectRelationshipsWithObjectsForPrimaryKeyAttributes:(NSString *)firstRelationshipName, ...Declared In
RKManagedObjectMapping.hdefaultValueForMissingAttribute:
Returns the default value for the specified attribute as expressed in the Core Data entity definition. This value will be assigned if the object mapping is applied and a value for a missing attribute is not present in the payload.
- (id)defaultValueForMissingAttribute:(NSString *)attributeNameDeclared In
RKManagedObjectMapping.hmappableObjectForData:
Returns an auto-released object that can be used to apply this object mapping given a set of mappable data. For transient objects, this generally returns an instance of the objectClass. For Core Data backed persistent objects, mappableData will be inspected to search for primary key data to lookup existing object instances.
- (id)mappableObjectForData:(id)mappableDataDeclared In
RKObjectMapping.h