SCConfigRecord.h

Go to the documentation of this file.

//
//  SCConfigRecord.h
//  sclmac
//
//  Created by Viacheslav Smolensky on 06.06.14.
//  Copyright (c) 2007 - 2014 by Samond Development Corporation. All rights reserved.
//

#import <scl/SCServiceObject.h>
#import <scl/SCTypes.h>
#import <scl/SCStrings.h>

#define SCConfigRecordClass @"SCConfigRecord"         ///< SCConfigRecord class name

#pragma mark -
#pragma mark Configuration record type support types

enum _SCConfigRecordType {
        SCConfigRecordGeneric   =  0,   
        SCConfigRecordString    =  1,   
        SCConfigRecordNumber    =  2,   
        SCConfigRecordBool              =  3,   
        SCConfigRecordDate              =  4,   
        SCConfigRecordConfig    = 11,   
};

typedef enum _SCConfigRecordType SCConfigRecordType;

@class SCConfig;

#pragma mark -

@interface SCConfigRecord : SCServiceObject {
        NSString                   *fKey;               // Record key
        id                                      fValue;         // Record value
        SCConfigRecordType      fType;          // Record type
        SCStrings                  *fComments;  // Record comments
}
#pragma mark -
#pragma mark Class properties
#if (__MAC_OS_X_VERSION_MIN_REQUIRED > 1040) || IOS_TARGET

// Record key property
@property (retain, getter=key, setter=setKey:) NSString *key;
// Record value property
@property (retain, getter=value, setter=setValue:) id value;
// Record type property
@property (assign, getter=type, setter=setType:) SCConfigRecordType type;
// String record value
@property (retain, getter=stringValue, setter=setStringValue:) NSString *stringValue;
// Number record value
@property (retain, getter=numberValue, setter=setNumberValue:) NSNumber *numberValue;
// Boolean record value
@property (assign, getter=boolValue, setter=setBoolValue:) BOOL boolValue;
// Date and time record value
@property (retain, getter=dateValue, setter=setDateValue:) NSDate *dateValue;
// Config record value property
@property (retain, getter=configValue, setter=setConfigValue:) SCConfig *configValue;
// Record comments property
@property (retain, getter=comments, setter=setComments:) SCStrings *comments;

#endif

#pragma mark -
#pragma mark Creating and Initializing Configuration Record

+ (SCConfigRecord *)recordWithDataDictionary:(NSDictionary *)dictionary;

+ (SCConfigRecord *)recordWithDataDictionaryFromFile:(NSString *)path;

+ (SCConfigRecord *)recordWithCoder:(NSCoder *)coder;

+ (SCConfigRecord *)recordWithContentsOfSerializedFile:(NSString *)path;

+ (SCConfigRecord *)recordWithStream:(SCStream *)stream;

+ (SCConfigRecord *)recordWithFileStream:(NSString *)path;

+ (SCConfigRecord *)recordWithKey:(NSString *)key value:(id)value type:(SCConfigRecordType)type;

+ (SCConfigRecord *)recordWithKey:(NSString *)key value:(id)value;

+ (SCConfigRecord *)recordWithRecord:(SCConfigRecord *)record;

+ (SCConfigRecord *)recordWithString:(NSString *)string;

+ (SCConfigRecord *)record;

+ (SCConfigRecord *)recordWithKey:(NSString *)key stringValue:(NSString *)stringValue;

+ (SCConfigRecord *)recordWithKey:(NSString *)key numberValue:(NSNumber *)numberValue;

+ (SCConfigRecord *)recordWithKey:(NSString *)key boolValue:(BOOL)boolValue;

+ (SCConfigRecord *)recordWithKey:(NSString *)key dateValue:(NSDate *)dateValue;

+ (SCConfigRecord *)recordWithKey:(NSString *)key configValue:(SCConfig *)configValue;

- (id)initWithKey:(NSString *)key value:(id)value type:(SCConfigRecordType)type;

- (id)initWithKey:(NSString *)key value:(id)value;

- (id)initWithRecord:(SCConfigRecord *)record;

- (id)initWithString:(NSString *)string;

- (id)init;

- (id)initWithKey:(NSString *)key stringValue:(NSString *)stringValue;

- (id)initWithKey:(NSString *)key numberValue:(NSNumber *)numberValue;

- (id)initWithKey:(NSString *)key boolValue:(BOOL)boolValue;

- (id)initWithKey:(NSString *)key dateValue:(NSDate *)dateValue;

- (id)initWithKey:(NSString *)key configValue:(SCConfig *)configValue;

#pragma mark -
#pragma mark Setting and Copying Configuration Records

- (void)setWithRecord:(SCConfigRecord *)record;

- (void)setWithString:(NSString *)string;

#pragma mark -
#pragma mark Getting and Setting Configuration Record Properties

- (NSString *)key;

- (id)value;

- (NSString *)stringValue;

- (NSNumber *)numberValue;

- (BOOL)boolValue;

- (NSDate *)dateValue;

- (SCConfig *)configValue;

- (SCConfigRecordType)type;

- (SCStrings *)comments;

- (NSString *)description;

- (void)setKey:(NSString *)key;

- (void)setValue:(id)value;

- (void)setStringValue:(NSString *)stringValue;

- (void)setNumberValue:(NSNumber *)numberValue;

- (void)setBoolValue:(BOOL)boolValue;

- (void)setDateValue:(NSDate *)dateValue;

- (void)setConfigValue:(SCConfig *)configValue;

- (void)setType:(SCConfigRecordType)type;

- (void)setComments:(SCStrings *)comments;

- (BOOL)isStringRecord;

- (BOOL)isNumberRecord;

- (BOOL)isBoolRecord;

- (BOOL)isDateRecord;

- (BOOL)isConfigRecord;

- (BOOL)isEmpty;

- (BOOL)isKeyEmpty;

- (BOOL)isValueEmpty;

#pragma mark -
#pragma mark Comparing Configuration Records

- (BOOL)isEqualToRecord:(SCConfigRecord *)record caseInsenstivie:(BOOL)caseInsensitive;

- (BOOL)isEqualToRecord:(SCConfigRecord *)record;

- (BOOL)isEqual:(id)object;

- (BOOL)isEqualToString:(NSString *)string caseInsensitive:(BOOL)caseInsensitive;

- (BOOL)isEqualToString:(NSString *)string;

- (BOOL)isEqualToKey:(NSString *)key caseInsensitive:(BOOL)caseInsensitive;

- (BOOL)isEqualToKey:(NSString *)key;

#pragma mark -
#pragma mark Record comments controls

- (void)addComment:(NSString *)comment;

- (void)addComments:(SCStrings *)comments;

- (void)setComment:(NSString *)comment;

- (void)removeComment:(NSString *)comment;

- (void)removeComments;

- (void)replaceComment:(NSString *)comment withComment:(NSString *)newComment;

- (BOOL)haveComments;

#pragma mark -
#pragma mark Getting record type names

+ (NSString *)nameWithType:(SCConfigRecordType)type;

@end