ULTemplate.h

/*
   Project: ULFramework

   Copyright (C) 2007 Michael Johnston & Jordi Villˆ--Freixa

   Author: Michael Johnston 

   This application is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This application 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 General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA.
*/

#ifndef _ULTEMPLATE_
#define _ULTEMPLATE_
#include <Foundation/Foundation.h>
#include <AdunKernel/AdunKernel.h>
#include "ULFramework/ULIOManager.h"
#include "ULFramework/ULFrameworkDefinitions.h"

@interface ULTemplate: AdModelObject <NSCopying, NSMutableCopying>
{
        NSMutableDictionary* objectTemplates;
        NSMutableDictionary* sections;
        NSMutableDictionary* classNumberTracker;
        NSMutableDictionary* externalReferenceTypes;
        NSMutableArray* externalReferences;
}
+ (NSArray*) systemObjectTemplates;
+ (NSArray*) forceFieldObjectTemplates;
+ (NSArray*) configurationGenerationObjectTemplates;
+ (NSArray*) controllerTemplates;
+ (NSArray*) allObjectTemplates;
+ (NSArray*) miscellaneousObjectTemplates;
- (id) initWithObjectTemplates: (NSDictionary*) templates;
- (id) initWithCoreRepresentation: (NSDictionary*) aDict;
- (NSMutableDictionary*) coreRepresentation;
- (NSDictionary*) objectTemplates;
- (NSDictionary*) objectTemplatesInSection: (NSString*) aString;
- (NSDictionary*) objectTemplateWithName: (NSString*) aString;
- (NSDictionary*) objectTemplatesOfClass: (NSString*) className;
- (NSArray*) externalReferences;
- (NSDictionary*) externalReferenceTypes;
- (void) setValues: (NSDictionary*) aDictionary forObjectTemplateWithName: (NSString*) name;
- (NSDictionary*) valuesForObjectTemplateWithName: (NSString*) name;
- (BOOL) validateTemplate: (NSError**) error;
@end


@interface ULMutableTemplate: ULTemplate
{
}
- (NSString*) addObjectTemplate: (NSDictionary*) aDictionary 
                toSection: (NSString*) stringTwo; 
- (NSString*) addObjectTemplate: (NSDictionary*) aDictionary;
- (void) removeObjectTemplateWithName: (NSString*) aString;
@end

@interface NSDictionary (ULObjectTemplateExtensions)
+ (BOOL) isValidTemplate: (NSDictionary*) aDict;
+ (id) templateForClass: (NSString*) className;
+ (id) templateForDisplayName: (NSString*) displayName;
+ (id) templateFromCoreRepresentation: (NSDictionary*) dict;
- (BOOL) validate: (NSError**) error;
- (NSArray*) typesForKey: (NSString*) aKey;
- (BOOL) validateType: (NSString*) type forKey: (NSString*) aKey;
- (NSString*) displayName;
- (NSString*) templateClass;
- (NSArray*) templateKeys;
- (NSString*) templateDescription;
- (NSString*) descriptionForKey: (NSString*) key;
- (id) valueForTemplateKey: (NSString*) aKey;
- (NSMutableDictionary*) valuesForTemplateKeys;
- (NSMutableDictionary*) coreTemplateRepresentation;
- (BOOL) isPropertyListKey: (NSString*) key;
- (BOOL) isOptionalKey: (NSString*) aKey;
- (NSArray*) propertyListKeys;
- (NSArray*) referenceKeys;
- (NSArray*) referenceContainerKeys;
- (BOOL) isSimpleKey: (NSString*) aKey;
@end

@interface NSMutableDictionary (ULMutableObjectTemplateExtensions)
- (void) setValue: (id) value forTemplateKey: (NSString*) aKey;
@end


#endif