GPKGUserMappingTable
Objective-C
@interface GPKGUserMappingTable : GPKGUserCustomTable
Swift
class GPKGUserMappingTable : GPKGUserCustomTable
Contains user mapping table factory and utility methods
-
Create a user mapping table with the minimum required columns
Declaration
Objective-C
+ (GPKGUserMappingTable *)createWithName:(NSString *)tableName;
Swift
class func create(withName tableName: String!) -> GPKGUserMappingTable!
Parameters
tableName
table name
Return Value
user mapping table
-
Create a user mapping table with the minimum required columns followed by the additional columns
Declaration
Objective-C
+ (GPKGUserMappingTable *)createWithName:(NSString *)tableName andAdditionalColumns: (NSArray<GPKGUserCustomColumn *> *)additionalColumns;
Swift
class func create(withName tableName: String!, andAdditionalColumns additionalColumns: [GPKGUserCustomColumn]!) -> GPKGUserMappingTable!
Parameters
tableName
table name
additionalColumns
additional columns
Return Value
user mapping table
-
Create the required table columns
Declaration
Objective-C
+ (NSArray<GPKGUserCustomColumn *> *)createRequiredColumns;
Swift
class func createRequiredColumns() -> [GPKGUserCustomColumn]!
Return Value
user custom columns
-
Create the required table columns, starting at the provided index
Declaration
Objective-C
+ (NSArray<GPKGUserCustomColumn *> *)createRequiredColumnsWithIndex: (int)startingIndex;
Swift
class func createRequiredColumns(with startingIndex: Int32) -> [GPKGUserCustomColumn]!
Parameters
startingIndex
starting index
Return Value
user custom columns
-
Create a base id column
Declaration
Objective-C
+ (GPKGUserCustomColumn *)createBaseIdColumn;
Swift
class func createBaseIdColumn() -> GPKGUserCustomColumn!
Return Value
base id column
-
Create a base id column
Declaration
Objective-C
+ (GPKGUserCustomColumn *)createBaseIdColumnWithIndex:(int)index;
Swift
class func createBaseIdColumn(with index: Int32) -> GPKGUserCustomColumn!
Parameters
index
column index
Return Value
base id column
-
Create a related id column
Declaration
Objective-C
+ (GPKGUserCustomColumn *)createRelatedIdColumn;
Swift
class func createRelatedIdColumn() -> GPKGUserCustomColumn!
Return Value
related id column
-
Create a related id column
Declaration
Objective-C
+ (GPKGUserCustomColumn *)createRelatedIdColumnWithIndex:(int)index;
Swift
class func createRelatedIdColumn(with index: Int32) -> GPKGUserCustomColumn!
Parameters
index
column index
Return Value
related id column
-
Get the number of required columns
Declaration
Objective-C
+ (int)numRequiredColumns;
Swift
class func numRequiredColumns() -> Int32
Return Value
required columns count
-
Get the required columns
Declaration
Objective-C
+ (NSArray<NSString *> *)requiredColumns;
Swift
class func requiredColumns() -> [String]!
Return Value
required columns
-
Initialize
Declaration
Objective-C
- (instancetype)initWithTable:(NSString *)tableName andColumns:(NSArray *)columns;
Swift
init!(table tableName: String!, andColumns columns: [Any]!)
Parameters
tableName
table name
columns
list of columns
Return Value
new user mapping table
-
Initialize
Declaration
Objective-C
- (instancetype)initWithTable:(GPKGUserCustomTable *)table;
Swift
init!(table: GPKGUserCustomTable!)
Parameters
table
user custom table
Return Value
new user mapping table
-
Get the base id column index
Declaration
Objective-C
- (int)baseIdColumnIndex;
Swift
func baseIdColumnIndex() -> Int32
Return Value
base id column index
-
Get the base id column
Declaration
Objective-C
- (GPKGUserCustomColumn *)baseIdColumn;
Swift
func baseIdColumn() -> GPKGUserCustomColumn!
Return Value
base id column
-
Get the related id column index
Declaration
Objective-C
- (int)relatedIdColumnIndex;
Swift
func relatedIdColumnIndex() -> Int32
Return Value
related id column index
-
Get the related id column
Declaration
Objective-C
- (GPKGUserCustomColumn *)relatedIdColumn;
Swift
func relatedIdColumn() -> GPKGUserCustomColumn!
Return Value
related id column