Inherits from NSObject
Declared in RKObjectMappingOperation.h
RKObjectMappingOperation.m

Overview

Performs an object mapping operation by mapping values from a dictinary of elements and setting the mapped values onto a target object.

Tasks

  •   sourceObject

    A dictionary of mappable elements containing simple values or nested object structures.

         property
  •   destinationObject

    The target object for this operation. Mappable values in elements will be applied to object using key-value coding.

         property
  •   objectMapping

    The object mapping defining how values contained in the source object should be transformed to the destination object via key-value coding

         property
  •   delegate

    The delegate to inform of interesting events during the mapping operation

         property
  •   queue

    An operation queue for deferring portions of the mapping process until later

         property
  • + mappingOperationFromObject:toObject:withMapping:

    Create a new mapping operation configured to transform the object representation in a source object to a new destination object according to an object mapping definition.
  • – initWithSourceObject:destinationObject:mapping:

    Initialize a mapping operation for an object and set of data at a particular key path with an object mapping definition
  • – performMapping:

    Process all mappable values from the mappable dictionary and assign them to the target object according to the rules expressed in the object mapping definition

Properties

delegate

The delegate to inform of interesting events during the mapping operation

@property (nonatomic, assign) id<> delegate

Declared In

RKObjectMappingOperation.h

destinationObject

The target object for this operation. Mappable values in elements will be applied to object using key-value coding.

@property (nonatomic, readonly) id destinationObject

Declared In

RKObjectMappingOperation.h

objectMapping

The object mapping defining how values contained in the source object should be transformed to the destination object via key-value coding

@property (nonatomic, readonly) RKObjectMapping *objectMapping

Declared In

RKObjectMappingOperation.h

queue

An operation queue for deferring portions of the mapping process until later

@property (nonatomic, retain) RKMappingOperationQueue *queue

Discussion

Defaults to nil. If this mapping operation was configured by an instance of RKObjectMapper, then an instance of the operation queue will be configured and assigned for use. If the queue is nil, the mapping operation will perform all its operations within the body of performMapping. If a queue is present, it may elect to defer portions of the mapping operation using the queue.

Declared In

RKObjectMappingOperation.h

sourceObject

A dictionary of mappable elements containing simple values or nested object structures.

@property (nonatomic, readonly) id sourceObject

Declared In

RKObjectMappingOperation.h

Class Methods

mappingOperationFromObject:toObject:withMapping:

Create a new mapping operation configured to transform the object representation in a source object to a new destination object according to an object mapping definition.

+ (id)mappingOperationFromObject:(id)sourceObject toObject:(id)destinationObject withMapping:(RKObjectMappingDefinition *)mapping

Return Value

An instance of RKObjectMappingOperation or RKManagedObjectMappingOperation for performing the mapping

Discussion

Note that if Core Data support is available, an instance of RKManagedObjectMappingOperation may be returned

Declared In

RKObjectMappingOperation.h

Instance Methods

initWithSourceObject:destinationObject:mapping:

Initialize a mapping operation for an object and set of data at a particular key path with an object mapping definition

- (id)initWithSourceObject:(id)sourceObject destinationObject:(id)destinationObject mapping:(RKObjectMappingDefinition *)mapping

Declared In

RKObjectMappingOperation.h

performMapping:

Process all mappable values from the mappable dictionary and assign them to the target object according to the rules expressed in the object mapping definition

- (BOOL)performMapping:(NSError **)error

Declared In

RKObjectMappingOperation.h