CBLModel.h

Go to the documentation of this file.

//
//  CBLModel.h
//  CouchbaseLite
//
//  Created by Jens Alfke on 8/26/11.
//  Copyright (c) 2011-2013 Couchbase, Inc. All rights reserved.
//

#import "CBLDynamicObject.h"
#import "CBLDocument.h"

NS_ASSUME_NONNULL_BEGIN
@class CBLAttachment, CBLDatabase;


NS_REQUIRES_PROPERTY_DEFINITIONS  // Don't let compiler auto-synthesize properties in subclasses
@interface CBLModel : CBLDynamicObject <CBLDocumentModel>

+ (nullable instancetype) modelForDocument: (CBLDocument*)document;

+ (instancetype) modelForNewDocumentInDatabase: (CBLDatabase*)database;

// You cannot create CBLModel instances with -init. Use the factory class methods instead.
- (instancetype) init NS_UNAVAILABLE;

@property (readonly, strong, nullable) CBLDocument* document;

@property (retain, nullable) CBLDatabase* database;

@property (readonly) bool isNew;

#pragma mark - SAVING:

- (BOOL) save: (NSError**)outError;

@property (nonatomic) bool autosaves;

@property (readonly) NSTimeInterval autosaveDelay;

@property (readonly) bool needsSave;

- (NSDictionary*) propertiesToSave;

- (void) revertChanges;

- (BOOL) deleteDocument: (NSError**)outError;

@property (readonly) NSTimeInterval timeSinceExternallyChanged;

+ (BOOL) saveModels: (CBLArrayOf(CBLModel*)*)models
              error: (NSError**)outError;

- (void) markExternallyChanged;

#pragma mark - PROPERTIES & ATTACHMENTS:

- (nullable id) getValueOfProperty: (NSString*)property;

- (BOOL) setValue: (nullable id)value
       ofProperty: (NSString*)property;


- (CBLArrayOf(CBLModel*)*) findInverseOfRelation: (NSString*)relation
                                       fromClass: (nullable Class)fromClass;


@property (readonly, nullable) CBLArrayOf(NSString*)* attachmentNames;

- (nullable CBLAttachment*) attachmentNamed: (NSString*)name;

- (void) setAttachmentNamed: (NSString*)name
            withContentType: (NSString*)mimeType
                    content: (NSData*)content;

- (void) setAttachmentNamed: (NSString*)name
            withContentType: (NSString*)mimeType
                 contentURL: (NSURL*)fileURL;

- (void) removeAttachmentNamed: (NSString*)name;


#pragma mark - PROTECTED (FOR SUBCLASSES TO OVERRIDE)


/* Called when the model's initializer is called when the model object is created. You should override this if you need to initialize
   any ivars or perform custom initialization when the model object is created.
 */
- (void)awakeFromInitializer;

- (nullable NSString*) idForNewDocumentInDatabase: (CBLDatabase*)db;

- (void) didLoadFromDocument;

- (CBLDatabase*) databaseForModelProperty: (NSString*)propertyName;

- (void) markNeedsSave;

- (void) willSave: (nullable NSSet*)changedPropertyNames;

- (NSDictionary*) propertiesToSaveForDeletion;

+ (nullable Class) itemClassForArrayProperty: (NSString*)property;

+ (nullable NSString*) inverseRelationForArrayProperty: (NSString*)property;

@property (copy, nonatomic, nullable) NSString* type;

@end



@interface CBLDatabase (CBLModel)

@property (readonly, nullable) CBLArrayOf(CBLModel*)* unsavedModels;

- (BOOL) saveAllModels: (NSError**)outError;

- (BOOL) autosaveAllModels: (NSError**)outError;

@end


NS_ASSUME_NONNULL_END