mirror of
https://github.com/zhigang1992/RestKit.git
synced 2026-01-12 22:51:50 +08:00
4c39918fdb
* Metadata mapping is implemented via an `NSProxy` object that stands in for the `sourceObject` of each `RKMappingOperation` * Key paths that are prefixed with `@metadata.` are mapped against the `metadata` dictionary of the operation, else they hit the `sourceObject`. * Metadata is implemented by merging a dictionary of data in from `RKObjectRequestOperation`, through to `RKResponseMapperOperation`, into `RKMapperOperation`, and all the way down into the `RKMappingOperation`, where it is available to each object. By convention, metdata is namespaced into subdictionaries.
68 lines
2.7 KiB
Objective-C
68 lines
2.7 KiB
Objective-C
//
|
|
// RKPropertyMapping.h
|
|
// RestKit
|
|
//
|
|
// Created by Blake Watters on 8/27/12.
|
|
// Copyright (c) 2009-2012 RestKit. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
@class RKObjectMapping;
|
|
|
|
/**
|
|
`RKPropertyMapping` is an abstract class for describing the properties being mapped within an `RKObjectMapping` or `RKEntityMapping` object. It defines the common interface for its concrete subclasses `RKAttributeMapping` and `RKRelationshipMapping`. Each property mapping defines a single transformation from a source key path (often in the deserialized representation of a JSON or XML document) to a destination key path (typically on a target object).
|
|
*/
|
|
@interface RKPropertyMapping : NSObject <NSCopying>
|
|
|
|
///------------------------------------------
|
|
/// @name Accessing the Parent Object Mapping
|
|
///------------------------------------------
|
|
|
|
/**
|
|
Returns the object mapping the receiver is added to.
|
|
*/
|
|
@property (nonatomic, weak, readonly) RKObjectMapping *objectMapping;
|
|
|
|
///-----------------------------------------------------
|
|
/// @name Accessing the Source and Destination Key Paths
|
|
///-----------------------------------------------------
|
|
|
|
/**
|
|
A key path on the source object from which to get information that is to be mapped onto the destination object.
|
|
*/
|
|
@property (nonatomic, copy, readonly) NSString *sourceKeyPath;
|
|
|
|
/**
|
|
A key path on the destination object on which to set information that has been mapped from the source object.
|
|
*/
|
|
@property (nonatomic, copy, readonly) NSString *destinationKeyPath;
|
|
|
|
///----------------------------------
|
|
/// @name Comparing Property Mappings
|
|
///----------------------------------
|
|
|
|
/**
|
|
Compares the receiving property mapping to another property mapping.
|
|
|
|
Two property mappings are equal if they are of the same type (i.e. an `RKAttributeMapping` or an `RKRelatiobshipMapping` object) and specify a mapping from the same source key path to the same destination key path.
|
|
|
|
@param otherMapping The property mapping object with which to compare the receiver.
|
|
@return `YES` if `otherMapping` specifies the same mapping as the receiver, otherwise `NO`.
|
|
*/
|
|
- (BOOL)isEqualToMapping:(RKPropertyMapping *)otherMapping;
|
|
|
|
@end
|