mirror of
https://github.com/zhigang1992/RestKit.git
synced 2026-04-06 09:41:09 +08:00
92 lines
3.6 KiB
Objective-C
92 lines
3.6 KiB
Objective-C
//
|
|
// RKEntityCache.h
|
|
// RestKit
|
|
//
|
|
// Created by Blake Watters on 5/2/12.
|
|
// Copyright (c) 2012 RestKit. All rights reserved.
|
|
//
|
|
|
|
#import <CoreData/CoreData.h>
|
|
|
|
@class RKEntityByAttributeCache;
|
|
|
|
/**
|
|
Instances of RKInMemoryEntityCache provide an in-memory caching mechanism for
|
|
objects in a Core Data managed object context. Managed objects can be cached by
|
|
attribute for fast retrieval without repeatedly hitting the Core Data persistent store.
|
|
This can provide a substantial speed advantage over issuing fetch requests
|
|
in cases where repeated look-ups of the same data are performed using a small set
|
|
of attributes as the query key. Internally, the cache entries are maintained as
|
|
references to the NSManagedObjectID of corresponding cached objects.
|
|
*/
|
|
@interface RKEntityCache : NSObject
|
|
|
|
/// @name Initializing the Cache
|
|
|
|
/**
|
|
Initializes the receiver with a managed object context containing the entity instances to be cached.
|
|
|
|
@param context The managed object context containing objects to be cached.
|
|
@returns self, initialized with context.
|
|
*/
|
|
- (id)initWithManagedObjectContext:(NSManagedObjectContext *)context;
|
|
|
|
@property (nonatomic, retain, readonly) NSManagedObjectContext *managedObjectContext;
|
|
|
|
/// @name Caching Objects by Attribute
|
|
|
|
/**
|
|
Caches all instances of an entity using the value for an attribute as the cache key.
|
|
|
|
@param entity The entity to cache all instances of.
|
|
@param attributeName The attribute to cache the instances by.
|
|
*/
|
|
- (void)cacheObjectsForEntity:(NSEntityDescription *)entity byAttribute:(NSString *)attributeName;
|
|
|
|
/**
|
|
Returns a Boolean value indicating if all instances of an entity have been cached by a given attribute name.
|
|
|
|
@param entity The entity to check the cache status of.
|
|
@param attributeName The attribute to check the cache status with.
|
|
@return YES if the cache has been loaded with instances with the given attribute, else NO.
|
|
*/
|
|
- (BOOL)isEntity:(NSEntityDescription *)entity cachedByAttribute:(NSString *)attributeName;
|
|
|
|
/**
|
|
Retrieves the first cached instance of a given entity where the specified attribute matches the given value.
|
|
|
|
@param entity The entity to search the cache for instances of.
|
|
@param attributeName The attribute to search the cache for matches with.
|
|
@param attributeValue The value of the attribute to return a match for.
|
|
@return A matching managed object instance or nil.
|
|
@raise NSInvalidArgumentException Raised if instances of the entity and attribute have not been cached.
|
|
*/
|
|
- (NSManagedObject *)objectForEntity:(NSEntityDescription *)entity withAttribute:(NSString *)attributeName value:(id)attributeValue;
|
|
|
|
/**
|
|
Retrieves the all cached instances of a given entity where the specified attribute matches the given value.
|
|
|
|
@param entity The entity to search the cache for instances of.
|
|
@param attributeName The attribute to search the cache for matches with.
|
|
@param attributeValue The value of the attribute to return a match for.
|
|
@return All matching managed object instances or nil.
|
|
@raise NSInvalidArgumentException Raised if instances of the entity and attribute have not been cached.
|
|
*/
|
|
- (NSSet *)objectsForEntity:(NSEntityDescription *)entity withAttribute:(NSString *)attributeName value:(id)attributeValue;
|
|
|
|
// @name Accessing Underlying Caches
|
|
- (RKEntityByAttributeCache *)attributeCacheForEntity:(NSEntityDescription *)entity attribute:(NSString *)attributeName;
|
|
- (NSSet *)attributeCachesForEntity:(NSEntityDescription *)entity;
|
|
|
|
// @name Managing the Cache
|
|
|
|
/**
|
|
Empties the cache by releasing all cached objects.
|
|
*/
|
|
- (void)flush;
|
|
|
|
- (void)addObject:(NSManagedObject *)object;
|
|
- (void)removeObject:(NSManagedObject *)object;
|
|
|
|
@end
|