TKDataSource Class Reference
| Inherits from | NSObject |
| Conforms to | NSURLConnectionDataDelegate NSURLConnectionDelegate TKAutoCompleteDataSource TKCalendarDataSource TKCalendarDelegate TKChartDataSource TKChartDelegate TKListViewDataSource TKListViewDelegate UICollectionViewDataSource UICollectionViewDelegate UITableViewDataSource UITableViewDelegate |
| Declared in | TKDataSource.h |
Overview
TKDataSource is an adapter that consumes data from various sources and has functionality for data manipulations. It implements various data source protocols and can be used as a data source for TKChart, TKCalendar, TKListView, UITableView and UICollectionView.
Tasks
-
itemSourceproperty -
itemsproperty -
currentItemproperty -
displayKeyproperty -
valueKeyproperty -
groupItemSourceKeyproperty -
settingsproperty -
formatterproperty -
allowItemsReorderproperty -
mapClassproperty -
propertyMapproperty -
mapCollectionsRecursivelyproperty -
– initWithItemSource: -
– initWithArray: -
– initWithArray:displayKey: -
– initWithArray:displayKey:valueKey: -
– initWithJSONString: -
– initWithDataFromURL:dataFormat:rootItemKeyPath:completion: -
– initWithDataFromJSONResource:ofType:rootItemKeyPath: -
– loadDataFromJSONString:rootItemKeyPath: -
– loadDataFromJSONResource:ofType:rootItemKeyPath: -
– loadDataFromURL:dataFormat:rootItemKeyPath:completion: -
filterDescriptorsproperty -
– addFilterDescriptor: -
– removeFilterDescriptor: -
– removeAllFilterDescriptors -
sortDescriptorsproperty -
– addSortDescriptor: -
– removeSortDescriptor: -
– removeAllSortDescriptors -
groupDescriptorsproperty -
– addGroupDescriptor: -
– removeGroupDescriptor: -
– removeAllGroupDescriptors -
– reloadData -
– map: -
– enumerate: -
– reduce:with: -
– filter: -
– filterWithQuery: -
– sort: -
– sortWithKey:ascending: -
– group: -
– group:comparator: -
– groupWithKey: -
– groupWithKey:comparator: -
– moveItemAtIndex:toIndex: -
– valueForItem:inGroup: -
– textFromItem:inGroup: -
– formatText:
Properties
allowItemsReorder
Determines whether items reordering is allowed or not.
@property (nonatomic) BOOL allowItemsReorderDeclared In
TKDataSource.hcurrentItem
The current item. It is syncronized among all consumers of this class.
@property (nonatomic, weak, null_unspecified) id currentItemDeclared In
TKDataSource.hdisplayKey
The display key used when extracting text from a single item.
@property (nonatomic, copy, nullable) NSString *displayKeyDeclared In
TKDataSource.hfilterDescriptors
Returns a list with filter descriptors that is applied after the itemSource propety is set.
@property (nonatomic, strong, readonly, nonnull) NSArray<__kindofTKDataSourceFilterDescriptor*> *filterDescriptorsDeclared In
TKDataSource.hformatter
A formatted that is applied when extracting text from an item by using the displayKey property.
@property (nonatomic, strong, nullable) NSFormatter *formatterDeclared In
TKDataSource.hgroupDescriptors
Returns a list with group descriptors that will be applied when the itemSource propety is set.
@property (nonatomic, strong, readonly, nonnull) NSArray<__kindofTKDataSourceGroupDescriptor*> *groupDescriptorsDeclared In
TKDataSource.hgroupItemSourceKey
The key used to extract items for specific group when grouping is applied. The key path is relative to the group object.
@property (nonatomic, copy, nullable) NSString *groupItemSourceKeyDeclared In
TKDataSource.hitemSource
The item source for this class. It can be a simple array with value types, complex objects or a dictionary.
@property (nonatomic, strong, nullable) id itemSourceDeclared In
TKDataSource.hitems
An array view of the items contained in the itemSource after applying sorting, grouping and filtering operations.
@property (nonatomic, readonly, nonnull) NSArray *itemsDeclared In
TKDataSource.hmapClass
When parsing data from JSON TKDataSource chaecks whether the mapClass property is set. If true it tries to create an instance of this class and initializes its properties with the JSON data.
@property (nonatomic, nullable) Class mapClassDeclared In
TKDataSource.hmapCollectionsRecursively
When set to YES TKDataSource tries to map NSArray value proerties with instances of mapClass.
@property (nonatomic) BOOL mapCollectionsRecursivelyDeclared In
TKDataSource.hpropertyMap
Used when initializing an instance of mapClass to map its properties against JSON data. The format is: <class-property-name>:<json-field-name>
@property (nonatomic, strong, nullable) NSDictionary *propertyMapDeclared In
TKDataSource.hsettings
Provides the ability to customize the appearance of TKDataSource consumers. e.g. TKChart, TKCalendar, UITableView, etc.
@property (nonatomic, strong, readonly, nonnull) TKDataSourceSettings *settingsDeclared In
TKDataSource.hsortDescriptors
Returns a list with sort descriptors that is applied after the itemSource propety is set.
@property (nonatomic, strong, readonly, nonnull) NSArray<__kindofTKDataSourceSortDescriptor*> *sortDescriptorsDeclared In
TKDataSource.hInstance Methods
addFilterDescriptor:
Adds a new filter descriptor.
- (void)addFilterDescriptor:(TKDataSourceFilterDescriptor *__nonnull)filterDescriptorParameters
- filterDescriptor
The filter descriptor to add.
Declared In
TKDataSource.haddGroupDescriptor:
Adds a new group descriptor.
- (void)addGroupDescriptor:(TKDataSourceGroupDescriptor *__nonnull)groupDescriptorParameters
- groupDescriptor
The group descriptor to be added.
Declared In
TKDataSource.haddSortDescriptor:
Adds a new sort descriptor.
- (void)addSortDescriptor:(TKDataSourceSortDescriptor *__nonnull)sortDescriptorParameters
- sortDescriptor
The sort descriptor to add.
Declared In
TKDataSource.henumerate:
Enumerates all items in the data source.
- (void)enumerate:(TKDataSourceEnumerator __nonnull)enumeratorBlockParameters
- enumeratorBlock
The block function that is called when enumerating data source items.
Declared In
TKDataSource.hfilter:
Filters the items in the data source.
- (void)filter:(TKDataSourceFilterBlock __nonnull)filterBlockParameters
- filterBlock
The block function that is used when filtering.
Declared In
TKDataSource.hfilterWithQuery:
Filters the items in the data source by using a query.
- (void)filterWithQuery:(NSString *__nonnull)filterQueryParameters
- filterQuery
The filter query that is used to filter the items.
Declared In
TKDataSource.hformatText:
Defines a textblock that is applied to get the text from an item when calling the textForItem method if specified.
- (void)formatText:(TKDataSourceFormatTextBlock __nonnull)formatTextBlockParameters
- formatTextBlock
The block function that gets text from an item.
Declared In
TKDataSource.hgroup:
Groups the items in the data source.
- (void)group:(TKDataSourceMapFunctionBlock __nonnull)keyForItemParameters
- keyForItem
The group block function that is used to get a group key.
Declared In
TKDataSource.hgroup:comparator:
Groups the items in the data source.
- (void)group:(TKDataSourceMapFunctionBlock __nonnull)keyForItem comparator:(NSComparator __nonnull)comparatorBlockParameters
- keyForItem
The group block function that is used to get a group key.
- comparatorBlock
The comparator to be used to sort groups.
Declared In
TKDataSource.hgroupWithKey:
Groups the items in the data source by using a property name.
- (void)groupWithKey:(NSString *__nonnull)propertyNameParameters
- propertyName
The property that is used to group the items.
Declared In
TKDataSource.hgroupWithKey:comparator:
Groups the items in the data source by using a property name.
- (void)groupWithKey:(NSString *__nonnull)propertyName comparator:(NSComparator __nonnull)comparatorBlockParameters
- propertyName
The property that is used to group the items.
- comparatorBlock
The comparator to be used to sort groups.
Declared In
TKDataSource.hinitWithArray:
Initializes the data source with an array of items.
- (instancetype __nonnull)initWithArray:(NSArray *__nonnull)itemsParameters
- items
The array that is assigned to the itemSource property.
Declared In
TKDataSource.hinitWithArray:displayKey:
Initializes the data source with an array of items and parameters.
- (instancetype __nonnull)initWithArray:(NSArray *__nonnull)items displayKey:(NSString *__nullable)displayKeyParameters
- items
The array that is assigned to the itemSource property.
- displayKey
The display key to use.
Declared In
TKDataSource.hinitWithArray:displayKey:valueKey:
Initializes the data source with an array of items and parameters.
- (instancetype __nonnull)initWithArray:(NSArray *__nonnull)items displayKey:(NSString *__nullable)displayKey valueKey:(NSString *__nullable)valueKeyParameters
- items
The array that is assigned to the itemSource property.
- displayKey
The display key to use.
- valueKey
The value key to use.
Declared In
TKDataSource.hinitWithDataFromJSONResource:ofType:rootItemKeyPath:
Initializes the data source with data coming from a JSON formatted resource.
- (instancetype __nonnull)initWithDataFromJSONResource:(NSString *__nonnull)name ofType:(NSString *__nonnull)type rootItemKeyPath:(NSString *__nullable)rootItemKeyPathParameters
- name
The file name.
- type
The file type.
- rootItemKeyPath
The key path to the item containing the items collection that will be used in this data source.
Declared In
TKDataSource.hinitWithDataFromURL:dataFormat:rootItemKeyPath:completion:
Initializes the data source with data coming from a web service.
- (instancetype __nonnull)initWithDataFromURL:(NSString *__nonnull)url dataFormat:(TKDataSourceDataFormat)dataFormat rootItemKeyPath:(NSString *__nullable)rootItemKeyPath completion:(void ( ^ __nullable ) ( NSError *__nullable error ))completionParameters
- url
The url where the data is located.
- dataFormat
The format of the data coming from the web service.
- rootItemKeyPath
The key path to the item containing the items collection that will be used in this data source.
- completion
The block that is called after the data is loaded.
Declared In
TKDataSource.hinitWithItemSource:
Initializes the data source with a value for the itemSource property.
- (instancetype __nonnull)initWithItemSource:(id __nonnull)itemSourceParameters
- itemSource
The value for the itemSource property.
Declared In
TKDataSource.hinitWithJSONString:
Initializes the data source with a JSON formatted string.
- (instancetype __nonnull)initWithJSONString:(NSString *__nonnull)strParameters
- str
The string containing JSON formatted data.
Declared In
TKDataSource.hloadDataFromJSONResource:ofType:rootItemKeyPath:
Reads a JSON formatted resource and loads the parsed data in the data source.
- (void)loadDataFromJSONResource:(NSString *__nonnull)name ofType:(NSString *__nonnull)type rootItemKeyPath:(NSString *__nullable)rootItemKeyPathParameters
- name
The file name.
- type
The file type.
- rootItemKeyPath
The key path to the item containing the items collection that is used in this data source.
Declared In
TKDataSource.hloadDataFromJSONString:rootItemKeyPath:
Reads a JSON formatted string and loads the parsed data in the data source.
- (void)loadDataFromJSONString:(NSString *__nonnull)string rootItemKeyPath:(NSString *__nullable)rootItemKeyPathParameters
- string
The string containing JSON formatted data.
- rootItemKeyPath
The key path to the item containing the items collection that is used in this data source.
Declared In
TKDataSource.hloadDataFromURL:dataFormat:rootItemKeyPath:completion:
Downloads data from a web service and initializes the data source with it.
- (void)loadDataFromURL:(NSString *__nonnull)url dataFormat:(TKDataSourceDataFormat)dataFormat rootItemKeyPath:(NSString *__nullable)rootItemKeyPath completion:(void ( ^ __nullable ) ( NSError *__nullable error ))completionParameters
- url
The url where the data is located.
- dataFormat
The format of the data coming from the web service.
- rootItemKeyPath
The key path to the item containing the items collection that is used in this data source.
- completion
A block that is called after the data is loaded.
Declared In
TKDataSource.hmap:
Apples the specified block to all items in the data source and allows changing their values.
- (void)map:(TKDataSourceMapFunctionBlock __nonnull)mapBlockParameters
- mapBlock
The block function that is applied to all items.
Declared In
TKDataSource.hmoveItemAtIndex:toIndex:
Moves an item. This method is applicable only when grouping is not applied.
- (void)moveItemAtIndex:(NSInteger)fromIndex toIndex:(NSInteger)toIndexParameters
- fromIndex
The old item index.
- toIndex
The new item index.
Declared In
TKDataSource.hreduce:with:
Reduces the items collection to a single value and returns it.
- (id __nonnull)reduce:(id __nonnull)initialValue with:(TKDataSourceReduceFunctionBlock __nonnull)reduceBlockParameters
- initialValue
The value to start with.
- reduceBlock
The block function that is called when reducing the items collection.
Declared In
TKDataSource.hreloadData
Reloads the data and applies again all descriptors. Call this method when the data has changed.
- (void)reloadDataDeclared In
TKDataSource.hremoveAllFilterDescriptors
Removes all filter descriptors.
- (void)removeAllFilterDescriptorsDeclared In
TKDataSource.hremoveAllGroupDescriptors
Removes all group descriptors.
- (void)removeAllGroupDescriptorsDeclared In
TKDataSource.hremoveAllSortDescriptors
Removes all sort descriptors.
- (void)removeAllSortDescriptorsDeclared In
TKDataSource.hremoveFilterDescriptor:
Removes a filter descriptor.
- (void)removeFilterDescriptor:(TKDataSourceFilterDescriptor *__nonnull)filterDescriptorParameters
- filterDescriptor
The filter descriptor to remove.
Declared In
TKDataSource.hremoveGroupDescriptor:
Removes a group descriptor.
- (void)removeGroupDescriptor:(TKDataSourceGroupDescriptor *__nonnull)groupDescriptorParameters
- groupDescriptor
The group descriptor to remove.
Declared In
TKDataSource.hremoveSortDescriptor:
Removes a sort descriptor.
- (void)removeSortDescriptor:(TKDataSourceSortDescriptor *__nonnull)sortDescriptorParameters
- sortDescriptor
The sort descriptor to remove.
Declared In
TKDataSource.hsort:
Sorts the items in the data source.
- (void)sort:(NSComparator __nonnull)comparatorBlockParameters
- comparatorBlock
The comparator block function that is used when sorting.
Declared In
TKDataSource.hsortWithKey:ascending:
Sorts the items in the data source by using a property name.
- (void)sortWithKey:(NSString *__nonnull)propertyName ascending:(BOOL)ascendingDeclared In
TKDataSource.htextFromItem:inGroup:
Returns the text for the item. Uses the displayKey property.
- (NSString *__nullable)textFromItem:(id __nonnull)item inGroup:(TKDataSourceGroup *__nullable)groupParameters
- item
The item.
- group
The group which owns this item. Can be nil if there is no grouping applied.
Declared In
TKDataSource.hvalueForItem:inGroup:
Returns the value of an item. Uses the valueKey property.
- (id __nullable)valueForItem:(id __nonnull)item inGroup:(TKDataSourceGroup *__nullable)groupParameters
- item
The item.
- group
The group which owns this item. Can be nil if there is no grouping applied.
Declared In
TKDataSource.h