mirror of
https://github.com/zhigang1992/RestKit.git
synced 2026-04-02 17:57:22 +08:00
670234b775
Other changes include: * Eliminated the RKObjectFactory protocol and implementations. Object mapping instances themselves are now responsible for instantiating target objects for mapping. * Introduced RKObjectAbstractMapping superclass for RKObjectMapping and RKObjectPolymorphicMapping. * Updated example applications to use block object loaders (RKTwitter and RKTwitterCoreData) * Refactored method signatures of RKObjectMapper, RKObjectMapping, and RKObjectMappingProvider to reflect the existence of abstract mapping types. This was necessary to make polymorphic mappings integrate cleanly. * Fixed overlap in RestKit error domains between network and object mapping. fixes #208
136 lines
5.1 KiB
Objective-C
136 lines
5.1 KiB
Objective-C
//
|
|
// RKObjectMappingProvider.h
|
|
// RestKit
|
|
//
|
|
// Created by Jeremy Ellison on 5/6/11.
|
|
// Copyright 2011 Two Toasters. All rights reserved.
|
|
//
|
|
|
|
#import "RKObjectMapping.h"
|
|
#import "RKObjectPolymorphicMapping.h"
|
|
|
|
/**
|
|
Responsible for providing object mappings to an instance of the object mapper
|
|
by evaluating the current keyPath being operated on
|
|
*/
|
|
@interface RKObjectMappingProvider : NSObject {
|
|
NSMutableArray* _objectMappings;
|
|
NSMutableDictionary* _mappingsByKeyPath;
|
|
NSMutableDictionary* _serializationMappings;
|
|
}
|
|
|
|
/**
|
|
Instructs the mapping provider to use the mapping provided when it encounters content at the specified
|
|
key path
|
|
*/
|
|
- (void)setMapping:(RKObjectAbstractMapping*)objectOrPolymorphicMapping forKeyPath:(NSString*)keyPath;
|
|
|
|
/**
|
|
Returns the RKObjectMapping or RKObjectPolymorphic mapping configured for use
|
|
when mappable content is encountered at keyPath
|
|
*/
|
|
- (RKObjectAbstractMapping*)mappingForKeyPath:(NSString*)keyPath;
|
|
|
|
/**
|
|
Returns a dictionary where the keys are mappable keyPaths and the values are the RKObjectMapping
|
|
or RKObjectPolymorphic mappings to use for mappable data that appears at the keyPath.
|
|
*/
|
|
- (NSDictionary*)mappingsByKeyPath;
|
|
|
|
/**
|
|
Registers an object mapping as being rooted at a specific keyPath. The keyPath will be registered
|
|
and an inverse mapping for the object will be generated and used for serialization.
|
|
|
|
This is a shortcut for configuring a pair of object mappings that model a simple resource the same
|
|
way when going to and from the server.
|
|
|
|
For example, if we configure have a simple resource called 'person' that returns JSON in the following
|
|
format:
|
|
|
|
{ "person": { "first_name": "Blake", "last_name": "Watters } }
|
|
|
|
We might configure a mapping like so:
|
|
|
|
RKObjectMapping* mapping = [RKObjectMapping mappingForClass:[Person class]];
|
|
[mapping mapAttributes:@"first_name", @"last_name", nil];
|
|
|
|
If we want to parse the above JSON and serialize it such that using postObject: or putObject: use the same format,
|
|
we can auto-generate the serialization mapping and set the whole thing up in one shot:
|
|
|
|
[[RKObjectManager sharedManager].mappingProvider registerMapping:mapping withRootKeyPath:@"user"];
|
|
|
|
This will call setMapping:forKeyPath: for you, then generate a serialization mapping and set the root
|
|
keyPath as well.
|
|
|
|
If you want to manipulate the serialization mapping yourself, you can work with the mapping directly:
|
|
|
|
RKObjectMapping* serializationMappingForPerson = [personMapping inverseMapping];
|
|
// NOTE: Serialization mapping default to a nil root keyPath and will serialize to a flat dictionary
|
|
[[RKObjectManager sharedManager].mappingProvider setSerializationMapping:serializationMappingForPerson forClass:[Person class]];
|
|
*/
|
|
- (void)registerMapping:(RKObjectMapping*)objectMapping withRootKeyPath:(NSString*)keyPath;
|
|
|
|
/**
|
|
Adds an object mapping to the provider for later retrieval. The mapping is not bound to a particular keyPath and
|
|
must be explicitly set on an instance of RKObjectLoader or RKObjectMappingOperation to be applied. This is useful
|
|
in cases where the remote system does not namespace resources in a keyPath that can be used for disambiguation.
|
|
|
|
You can retrieve mappings added to the provider by invoking objectMappingsForClass: and objectMappingForClass:
|
|
|
|
@see objectMappingsForClass:
|
|
@see objectMappingForClass:
|
|
*/
|
|
- (void)addObjectMapping:(RKObjectMapping*)objectMapping;
|
|
|
|
/**
|
|
Returns all object mappings registered for a particular class on the provider. The collection of mappings is assembled
|
|
by searching for all mappings added via addObjctMapping: and then consulting those registered via objectMappingForKeyPath:
|
|
*/
|
|
- (NSArray*)objectMappingsForClass:(Class)theClass;
|
|
|
|
/**
|
|
Returns the first object mapping for a particular class in the provider. Mappings registered via addObjectMapping: take
|
|
precedence over those registered via setObjectMapping:forKeyPath:
|
|
*/
|
|
- (RKObjectMapping*)objectMappingForClass:(Class)theClass;
|
|
|
|
/**
|
|
Set a mapping to serialize objects of a specific class into a representation
|
|
suitable for transport over HTTP. Used by the object manager during postObject: and putObject:
|
|
*/
|
|
- (void)setSerializationMapping:(RKObjectMapping *)mapping forClass:(Class)objectClass;
|
|
|
|
/**
|
|
returns the serialization mapping for a specific object class
|
|
which has been previously registered.
|
|
*/
|
|
- (RKObjectMapping*)serializationMappingForClass:(Class)objectClass;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////
|
|
/// @name Deprecated Object Mapping Methods
|
|
|
|
/**
|
|
Configure an object mapping to handle data that appears at a particular keyPath in
|
|
a payload loaded from a
|
|
|
|
@deprecated
|
|
*/
|
|
- (void)setObjectMapping:(RKObjectMapping*)mapping forKeyPath:(NSString*)keyPath DEPRECATED_ATTRIBUTE;
|
|
|
|
/**
|
|
Returns the object mapping to use for mapping the specified keyPath into an object graph
|
|
|
|
@deprecated
|
|
*/
|
|
- (RKObjectMapping*)objectMappingForKeyPath:(NSString*)keyPath DEPRECATED_ATTRIBUTE;
|
|
|
|
/**
|
|
Returns a dictionary where the keys are mappable keyPaths and the values are the object
|
|
mapping to use for objects that appear at the keyPath.
|
|
|
|
@deprecated
|
|
*/
|
|
- (NSDictionary*)objectMappingsByKeyPath DEPRECATED_ATTRIBUTE;
|
|
|
|
@end
|