TKEntity Class Reference
| Inherits from | NSObject |
| Declared in | TKEntity.h |
Tasks
-
sourceObjectproperty -
propertiesproperty -
groupsproperty -
defaultGroupproperty -
+ entityWithObject: -
– initWithObject: -
– initWithObject:propertyNames: -
– initWithJSONString:rootItemKeyPath: -
– initWithDataFromJSONResource:ofType:rootItemKeyPath: -
– initWithJSONFromURL:rootItemKeyPath:completion: -
– writeJSONToString -
– writeJSONToStream: -
– setSourceObject:withPropertyNames: -
– setSourceObject:withProperties: -
– propertyWithName: -
– objectForKeyedSubscript: -
– groupAtIndex: -
– groupWithName: -
– addGroupWithName:propertyNames: -
– addGroup: -
– insertGroup:atIndex: -
– removeGroupAtIndex: -
– removeGroup: -
– removeAllGroups -
– commit -
– validate
Properties
defaultGroup
The default property group that contains all properties without a group name.
@property (nonatomic, strong, readonly) TKEntityPropertyGroup *defaultGroupReturn Value
The default property group that contains all properties without a group name.
Declared In
TKEntity.hgroups
An array of TKEntityPropertyGroup objects.
@property (nonatomic, strong, readonly) NSArray *groupsReturn Value
An array of TKEntityPropertyGroup objects.
Declared In
TKEntity.hproperties
An array of TKEntityProperty objects containing all the properties from the bisuness object.
@property (nonatomic, strong, readonly) NSArray *propertiesReturn Value
An array of TKEntityProperty objects containing all the properties from the bisuness object.
Declared In
TKEntity.hInstance Methods
addGroup:
Adds a new group.
- (void)addGroup:(TKEntityPropertyGroup *)groupParameters
- group
The group instance.
Declared In
TKEntity.haddGroupWithName:propertyNames:
Creates a new group with the specified name and properties.
- (TKEntityPropertyGroup *)addGroupWithName:(NSString *)name propertyNames:(NSArray *)propertyNamesParameters
- name
The group name.
- propertyNames
a list with property names to include in the group.
Return Value
Declared In
TKEntity.hcommit
Commits the values of all properties to the bussiness object.
- (BOOL)commitDeclared In
TKEntity.hgroupAtIndex:
Returns the group at the specified index.
- (TKEntityPropertyGroup *)groupAtIndex:(NSUInteger)indexParameters
- index
The group index.
Return Value
Declared In
TKEntity.hgroupWithName:
Returns the group with the specified name.
- (TKEntityPropertyGroup *)groupWithName:(NSString *)groupNameParameters
- groupName
The group name.
Return Value
Declared In
TKEntity.hinitWithDataFromJSONResource:ofType:rootItemKeyPath:
Instantiates a TKEntity with data coming from a JSON formatted resource.
- (instancetype)initWithDataFromJSONResource:(NSString *)name ofType:(NSString *)type rootItemKeyPath:(NSString *)rootItemKeyPathParameters
- name
The file name.
- type
The file type.
- rootItemKeyPath
The key path to an item in the JSON.
Declared In
TKEntity.hinitWithJSONFromURL:rootItemKeyPath:completion:
Instantiates a TKEntity which object will be created from JSON fetched from web service.
- (instancetype)initWithJSONFromURL:(NSString *)url rootItemKeyPath:(NSString *)rootItemKeyPath completion:(void ( ^ ) ( NSError *error ))completionParameters
- url
The url where the JSON is located.
- rootItemKeyPath
The key path to an item in the JSON.
- completion
The block that is called after the data is loaded.
Declared In
TKEntity.hinitWithJSONString:rootItemKeyPath:
Instantiates a TKEntity with a JSON formatted string.
- (instancetype)initWithJSONString:(NSString *)str rootItemKeyPath:(NSString *)rootItemKeyPathParameters
- str
The string containing JSON formatted data.
- rootItemKeyPath
The key path to an item in the JSON.
Declared In
TKEntity.hinitWithObject:
Instantiates a TKEntity with an object.
- (instancetype)initWithObject:(NSObject *)sourceObjectParameters
- sourceObject
The source object.
Declared In
TKEntity.hinitWithObject:propertyNames:
Instantiates a TKEntity with an object and specific list of properties.
- (instancetype)initWithObject:(NSObject *)sourceObject propertyNames:(NSArray *)propertyNamesParameters
- sourceObject
The source object.
- propertyNames
The propery names.
Declared In
TKEntity.hinsertGroup:atIndex:
Inserts a new group at the specified index.
- (void)insertGroup:(TKEntityPropertyGroup *)group atIndex:(NSUInteger)indexParameters
- group
The group instance.
- index
The index where the group should be inserted.
Declared In
TKEntity.hobjectForKeyedSubscript:
The TKEntityProperty with the specified name.
- (TKEntityProperty *)objectForKeyedSubscript:(NSString *)propertyNameParameters
- propertyName
The name of the property that has to be returned.
Return Value
Declared In
TKEntity.hpropertyWithName:
The TKEntityProperty with the specified name.
- (TKEntityProperty *)propertyWithName:(NSString *)propertyNameParameters
- propertyName
The name of the property that has to be returned.
Return Value
Declared In
TKEntity.hremoveGroup:
Removes the specified group.
- (void)removeGroup:(TKEntityPropertyGroup *)groupParameters
- group
The group to remove.
Declared In
TKEntity.hremoveGroupAtIndex:
Removes the group at the specified index.
- (void)removeGroupAtIndex:(NSUInteger)indexParameters
- index
The index of the group to remove.
Declared In
TKEntity.hsetSourceObject:withProperties:
Sets a new source object and creates its model.
- (void)setSourceObject:(NSObject *)sourceObject withProperties:(NSArray *)propertiesParameters
- sourceObject
The object from which a model will be created.
- properties
A list containing valid TKEntityProperty objects.
Declared In
TKEntity.hsetSourceObject:withPropertyNames:
Sets a new source object and creates its model.
- (void)setSourceObject:(NSObject *)sourceObject withPropertyNames:(NSArray *)propertyNamesParameters
- sourceObject
The object from which a model will be created.
- propertyNames
The propery names.
Declared In
TKEntity.hvalidate
Validates all properties and returns an array with property names that did not pass validation.
- (NSArray *)validateDeclared In
TKEntity.hwriteJSONToStream:
Writes JSON to an output stream.
- (NSError *)writeJSONToStream:(NSOutputStream *)outputStreamParameters
- outputStream
The output stream where the JSON will be written.
Return Value
Nil if the writing is successfull, otherwise NSError object.
Declared In
TKEntity.hwriteJSONToString
Creates a JSON formatted string from the entity’s properties.
- (NSString *)writeJSONToStringReturn Value
JSON formatted string.
Declared In
TKEntity.h