mirror of
https://github.com/gnustep/libs-gdl2.git
synced 2025-02-19 17:50:47 +00:00
7331d77528
Install into GNUSTEP_SYSTEM_ROOT by default. * * Update email addresses for Mirko Viviani and David Ayers. git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gdl2/trunk@23510 72102866-910b-0410-8b05-ffd578937521
240 lines
6.7 KiB
Objective-C
240 lines
6.7 KiB
Objective-C
/* -*-objc-*-
|
|
EOClassDescription.h
|
|
|
|
Copyright (C) 2000,2002,2003,2004,2005 Free Software Foundation, Inc.
|
|
|
|
Author: Mirko Viviani <mirko.viviani@gmail.com>
|
|
Date: February 2000
|
|
|
|
This file is part of the GNUstep Database Library.
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Library General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Library General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Library General Public
|
|
License along with this library; see the file COPYING.LIB.
|
|
If not, write to the Free Software Foundation,
|
|
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef __EOClassDescription_h__
|
|
#define __EOClassDescription_h__
|
|
|
|
#ifdef GNUSTEP
|
|
#include <Foundation/NSArray.h>
|
|
#include <Foundation/NSException.h>
|
|
#include <Foundation/NSZone.h>
|
|
#else
|
|
#include <Foundation/Foundation.h>
|
|
#endif
|
|
|
|
#include <EOControl/EODefines.h>
|
|
|
|
@class NSDictionary;
|
|
@class NSFormatter;
|
|
@class EOEditingContext;
|
|
@class EOGlobalID;
|
|
@class EORelationship;
|
|
|
|
typedef enum
|
|
{
|
|
EODeleteRuleNullify = 0,
|
|
EODeleteRuleCascade,
|
|
EODeleteRuleDeny,
|
|
EODeleteRuleNoAction
|
|
} EODeleteRule;
|
|
|
|
|
|
@interface EOClassDescription : NSObject
|
|
|
|
+ (void)registerClassDescription: (EOClassDescription *)description
|
|
forClass: (Class)aClass;
|
|
|
|
+ (void)invalidateClassDescriptionCache;
|
|
|
|
+ (EOClassDescription *)classDescriptionForClass: (Class)aClass;
|
|
|
|
+ (EOClassDescription *)classDescriptionForEntityName: (NSString *)entityName;
|
|
|
|
+ (void)setClassDelegate: (id)delegate;
|
|
+ (id)classDelegate;
|
|
|
|
/*
|
|
* Subclass responsibility.
|
|
*/
|
|
- (NSString *)entityName;
|
|
|
|
- (id)createInstanceWithEditingContext: (EOEditingContext *)editingContext
|
|
globalID: (EOGlobalID *)globalID
|
|
zone: (NSZone *)zone;
|
|
|
|
- (void)awakeObject: (id)object
|
|
fromInsertionInEditingContext: (EOEditingContext *)editingContext;
|
|
|
|
- (void)awakeObject: (id)object
|
|
fromFetchInEditingContext: (EOEditingContext *)editingContext;
|
|
|
|
- (void)propagateDeleteForObject: (id)object
|
|
editingContext: (EOEditingContext *)editingContext;
|
|
|
|
- (NSArray *)attributeKeys;
|
|
- (NSArray *)toOneRelationshipKeys;
|
|
- (NSArray *)toManyRelationshipKeys;
|
|
|
|
/** returns a new autoreleased mutable dictionary to store properties **/
|
|
- (NSMutableDictionary *)dictionaryForInstanceProperties;
|
|
|
|
- (EORelationship *)relationshipNamed: (NSString *)relationshipName;
|
|
- (EORelationship *)anyRelationshipNamed: (NSString *)relationshipName;
|
|
|
|
- (NSString *)inverseForRelationshipKey: (NSString *)relationshipKey;
|
|
|
|
- (EODeleteRule)deleteRuleForRelationshipKey: (NSString *)relationshipKey;
|
|
|
|
- (BOOL)ownsDestinationObjectsForRelationshipKey: (NSString *)relationshipKey;
|
|
|
|
- (EOClassDescription *)classDescriptionForDestinationKey: (NSString *)detailKey;
|
|
|
|
- (NSFormatter *)defaultFormatterForKey: (NSString *)key;
|
|
|
|
- (NSString *)displayNameForKey: (NSString *)key;
|
|
|
|
- (NSString *)userPresentableDescriptionForObject: (id)object;
|
|
|
|
- (NSException *)validateValue: (id *)valueP forKey: (NSString *)key;
|
|
|
|
- (NSException *)validateObjectForSave: (id)object;
|
|
|
|
- (NSException *)validateObjectForDelete: (id)object;
|
|
|
|
@end
|
|
|
|
|
|
@interface NSObject (EOInitialization)
|
|
|
|
- (id)initWithEditingContext: (EOEditingContext *)editingContext
|
|
classDescription: (EOClassDescription *)classDescription
|
|
globalID: (EOGlobalID *)globalID;
|
|
|
|
@end
|
|
|
|
@interface NSObject (EOClassDescriptionPrimitives)
|
|
|
|
- (EOClassDescription *)classDescription;
|
|
|
|
- (NSString *)entityName;
|
|
- (NSArray *)attributeKeys;
|
|
- (NSArray *)toOneRelationshipKeys;
|
|
- (NSArray *)toManyRelationshipKeys;
|
|
- (NSString *)inverseForRelationshipKey: (NSString *)relationshipKey;
|
|
- (EODeleteRule)deleteRuleForRelationshipKey: (NSString *)relationshipKey;
|
|
- (BOOL)ownsDestinationObjectsForRelationshipKey: (NSString *)relationshipKey;
|
|
- (EOClassDescription *)classDescriptionForDestinationKey: (NSString *)detailKey;
|
|
|
|
- (NSString *)userPresentableDescription;
|
|
|
|
- (NSException *)validateValue: (id *)valueP forKey: (NSString *)key;
|
|
|
|
- (NSException *)validateForSave;
|
|
|
|
- (NSException *)validateForDelete;
|
|
|
|
- (void)awakeFromInsertionInEditingContext: (EOEditingContext *)editingContext;
|
|
|
|
- (void)awakeFromFetchInEditingContext: (EOEditingContext *)editingContext;
|
|
|
|
@end
|
|
|
|
GDL2CONTROL_EXPORT NSString *EOClassDescriptionNeededNotification;
|
|
GDL2CONTROL_EXPORT NSString *EOClassDescriptionNeededForClassNotification;
|
|
GDL2CONTROL_EXPORT NSString *EOClassDescriptionNeededForEntityNameNotification;
|
|
|
|
|
|
@interface NSArray (EOShallowCopy)
|
|
|
|
- (NSArray *)shallowCopy;
|
|
|
|
@end
|
|
|
|
@interface NSObject (EOClassDescriptionExtras)
|
|
|
|
- (NSDictionary *)snapshot;
|
|
|
|
- (void)updateFromSnapshot: (NSDictionary *)snapshot;
|
|
|
|
- (BOOL)isToManyKey: (NSString *)key;
|
|
|
|
- (NSException *)validateForInsert;
|
|
- (NSException *)validateForUpdate;
|
|
|
|
- (NSArray *)allPropertyKeys;
|
|
|
|
- (void)clearProperties;
|
|
|
|
- (void)propagateDeleteWithEditingContext: (EOEditingContext *)editingContext;
|
|
|
|
- (NSString *)eoShallowDescription;
|
|
- (NSString *)eoDescription;
|
|
|
|
@end
|
|
|
|
@interface NSObject (EOKeyRelationshipManipulation)
|
|
|
|
- (void)addObject: (id)object toPropertyWithKey: (NSString *)key;
|
|
|
|
- (void)removeObject: (id)object fromPropertyWithKey: (NSString *)key;
|
|
|
|
- (void)addObject: (id)object
|
|
toBothSidesOfRelationshipWithKey: (NSString *)key;
|
|
|
|
- (void)removeObject: (id)object
|
|
fromBothSidesOfRelationshipWithKey: (NSString *)key;
|
|
|
|
@end
|
|
|
|
/*
|
|
* Validation exceptions (with name EOValidationException)
|
|
*/
|
|
GDL2CONTROL_EXPORT NSString *EOValidationException;
|
|
GDL2CONTROL_EXPORT NSString *EOAdditionalExceptionsKey;
|
|
GDL2CONTROL_EXPORT NSString *EOValidatedObjectUserInfoKey;
|
|
GDL2CONTROL_EXPORT NSString *EOValidatedPropertyUserInfoKey;
|
|
|
|
@interface NSException (EOValidationError)
|
|
|
|
+ (NSException *)validationExceptionWithFormat: (NSString *)format, ...;
|
|
+ (NSException *)aggregateExceptionWithExceptions: (NSArray *)subexceptions;
|
|
- (NSException *)exceptionAddingEntriesToUserInfo: (NSDictionary *)additions;
|
|
|
|
@end
|
|
|
|
@interface NSObject (EOClassDescriptionClassDelegate)
|
|
|
|
- (BOOL)shouldPropagateDeleteForObject: (id)object
|
|
inEditingContext: (EOEditingContext *)editingContext
|
|
forRelationshipKey: (NSString *)key;
|
|
|
|
@end
|
|
|
|
|
|
@interface NSObject (_EOValueMerging)
|
|
|
|
- (void)mergeValue: (id)value forKey: (id)key;
|
|
- (void)mergeChangesFromDictionary: (NSDictionary *)changes;
|
|
- (NSDictionary *)changesFromSnapshot: (NSDictionary *)snapshot;
|
|
- (void)reapplyChangesFromSnapshot: (NSDictionary *)changes;
|
|
|
|
@end
|
|
|
|
@interface NSObject (_EOEditingContext)
|
|
- (EOEditingContext *)editingContext;
|
|
@end
|
|
|
|
#endif
|