GPKGContentsIdExtension
Objective-C
@interface GPKGContentsIdExtension : GPKGBaseExtension
Swift
class GPKGContentsIdExtension : GPKGBaseExtension
This extension assigns a unique integer identifier to tables defined in the contents. Allows foreign key referencing to a contents (text based primary key) by an integer identifier.
http://ngageoint.github.io/GeoPackage/docs/extensions/contents-id.html
-
Initialize
Declaration
Objective-C
- (instancetype)initWithGeoPackage:(GPKGGeoPackage *)geoPackage;
Swift
init!(geoPackage: GPKGGeoPackage!)
Parameters
geoPackage
GeoPackage
Return Value
new contents id extension
-
Get the Contents Id DAO
Return Value
contents id dao
-
Get the extension name
Declaration
Objective-C
- (NSString *)extensionName;
Swift
func extensionName() -> String!
Return Value
extension name
-
Get the extension definition
Declaration
Objective-C
- (NSString *)extensionDefinition;
Swift
func extensionDefinition() -> String!
Return Value
extension definition
-
Determine if the GeoPackage has the extension
Declaration
Objective-C
- (BOOL)has;
Swift
func has() -> Bool
Return Value
true if has extension
-
Get the contents id for the current result in the result set
Declaration
Objective-C
- (GPKGContentsId *)contentsId:(GPKGResultSet *)results;
Swift
func contentsId(_ results: GPKGResultSet!) -> GPKGContentsId!
Parameters
results
result set
Return Value
contents id
-
Get the contents id object
Declaration
Objective-C
- (GPKGContentsId *)forContents:(GPKGContents *)contents;
Swift
func forContents(_ contents: GPKGContents!) -> GPKGContentsId!
Parameters
contents
contents
Return Value
contents id or null
-
Get the contents id object
Declaration
Objective-C
- (GPKGContentsId *)forTableName:(NSString *)tableName;
Swift
func forTableName(_ tableName: String!) -> GPKGContentsId!
Parameters
tableName
table name
Return Value
contents id or null
-
Get the contents id
Declaration
Objective-C
- (NSNumber *)idForContents:(GPKGContents *)contents;
Swift
func id(for contents: GPKGContents!) -> NSNumber!
Parameters
contents
contents
Return Value
contents id or null
-
Get the contents id
Declaration
Objective-C
- (NSNumber *)idForTableName:(NSString *)tableName;
Swift
func id(forTableName tableName: String!) -> NSNumber!
Parameters
tableName
table name
Return Value
contents id or null
-
Create a contents id
Declaration
Objective-C
- (GPKGContentsId *)createForContents:(GPKGContents *)contents;
Swift
func create(for contents: GPKGContents!) -> GPKGContentsId!
Parameters
contents
contents
Return Value
new contents id
-
Create a contents id
Declaration
Objective-C
- (GPKGContentsId *)createForTableName:(NSString *)tableName;
Swift
func create(forTableName tableName: String!) -> GPKGContentsId!
Parameters
tableName
table name
Return Value
new contents id
-
Create a contents id
Declaration
Objective-C
- (NSNumber *)createIdForContents:(GPKGContents *)contents;
Swift
func createId(for contents: GPKGContents!) -> NSNumber!
Parameters
contents
contents
Return Value
new contents id
-
Create a contents id
Declaration
Objective-C
- (NSNumber *)createIdForTableName:(NSString *)tableName;
Swift
func createId(forTableName tableName: String!) -> NSNumber!
Parameters
tableName
table name
Return Value
new contents id
-
Get or create a contents id
Declaration
Objective-C
- (GPKGContentsId *)createGetForContents:(GPKGContents *)contents;
Swift
func createGet(for contents: GPKGContents!) -> GPKGContentsId!
Parameters
contents
contents
Return Value
new or existing contents id
-
Get or create a contents id
Declaration
Objective-C
- (GPKGContentsId *)createGetForTableName:(NSString *)tableName;
Swift
func createGet(forTableName tableName: String!) -> GPKGContentsId!
Parameters
tableName
table name
Return Value
new or existing contents id
-
Get or create a contents id
Declaration
Objective-C
- (NSNumber *)createGetIdForContents:(GPKGContents *)contents;
Swift
func createGetId(for contents: GPKGContents!) -> NSNumber!
Parameters
contents
contents
Return Value
new or existing contents id
-
Get or create a contents id
Declaration
Objective-C
- (NSNumber *)createGetIdForTableName:(NSString *)tableName;
Swift
func createGetId(forTableName tableName: String!) -> NSNumber!
Parameters
tableName
table name
Return Value
new or existing contents id
-
Delete the contents id for the contents
Declaration
Objective-C
- (BOOL)deleteForContents:(GPKGContents *)contents;
Swift
func delete(for contents: GPKGContents!) -> Bool
Parameters
contents
contents
Return Value
true if deleted
-
Delete the contents id for the table
Declaration
Objective-C
- (BOOL)deleteForTableName:(NSString *)tableName;
Swift
func delete(forTableName tableName: String!) -> Bool
Parameters
tableName
table name
Return Value
true if deleted
-
Create contents ids for contents currently without
Declaration
Objective-C
- (int)createIds;
Swift
func createIds() -> Int32
Return Value
newly created contents ids count
-
Create contents ids for contents of the data type and currently without
Declaration
Objective-C
- (int)createIdsForType:(enum GPKGContentsDataType)type;
Swift
func createIds(for type: GPKGContentsDataType) -> Int32
Parameters
type
contents data type
Return Value
newly created contents ids count
-
Create contents ids for contents of the data type and currently without
Declaration
Objective-C
- (int)createIdsForTypeName:(NSString *)type;
Swift
func createIds(forTypeName type: String!) -> Int32
Parameters
type
contents data type
Return Value
newly created contents ids count
-
Delete all contents ids
Declaration
Objective-C
- (int)deleteIds;
Swift
func deleteIds() -> Int32
Return Value
deleted contents ids count
-
Delete contents ids for contents of the data type
Declaration
Objective-C
- (int)deleteIdsForType:(enum GPKGContentsDataType)type;
Swift
func deleteIds(for type: GPKGContentsDataType) -> Int32
Parameters
type
contents data type
Return Value
deleted contents ids count
-
Delete contents ids for contents of the data type
Declaration
Objective-C
- (int)deleteIdsForTypeName:(NSString *)type;
Swift
func deleteIds(forTypeName type: String!) -> Int32
Parameters
type
contents data type
Return Value
deleted contents ids count
-
Get all contents ids
Return Value
contents ids
-
Get the count of contents ids
Declaration
Objective-C
- (int)count;
Swift
func count() -> Int32
Return Value
count
-
Get by contents data type
Declaration
Objective-C
- (GPKGResultSet *)idsForType:(enum GPKGContentsDataType)type;
Swift
func ids(for type: GPKGContentsDataType) -> GPKGResultSet!
Parameters
type
contents data type
Return Value
contents ids
-
Get by contents data type
Declaration
Objective-C
- (GPKGResultSet *)idsForTypeName:(NSString *)type;
Swift
func ids(forTypeName type: String!) -> GPKGResultSet!
Parameters
type
contents data type
Return Value
contents ids
-
Get contents without contents ids
Declaration
Objective-C
- (NSArray<NSString *> *)missing;
Swift
func missing() -> [String]!
Return Value
table names without contents ids
-
Get contents by data type without contents ids
Declaration
Objective-C
- (NSArray<NSString *> *)missingForType:(enum GPKGContentsDataType)type;
Swift
func missing(for type: GPKGContentsDataType) -> [String]!
Parameters
type
contents data type
Return Value
table names without contents ids
-
Get contents by data type without contents ids
Declaration
Objective-C
- (NSArray<NSString *> *)missingForTypeName:(NSString *)type;
Swift
func missing(forTypeName type: String!) -> [String]!
Parameters
type
contents data type
Return Value
table names without contents ids
-
Get or create if needed the extension
Declaration
Objective-C
- (GPKGExtensions *)extensionCreate;
Swift
func extensionCreate() -> GPKGExtensions!
Return Value
extensions object
-
Get the extension
Return Value
extensions object or null if one does not exist
-
Remove all trace of the extension
Declaration
Objective-C
- (void)removeExtension;
Swift
func removeExtension()
-
Get a Contents Id DAO
Declaration
Objective-C
- (GPKGContentsIdDao *)contentsIdDao;
Swift
func contentsIdDao() -> GPKGContentsIdDao!
Return Value
contents id dao
-
Get a Contents Id DAO
Declaration
Objective-C
+ (GPKGContentsIdDao *)contentsIdDaoWithGeoPackage:(GPKGGeoPackage *)geoPackage;
Swift
class func contentsIdDao(with geoPackage: GPKGGeoPackage!) -> GPKGContentsIdDao!
Parameters
geoPackage
GeoPackage
Return Value
contents id dao
-
Get a Contents Id DAO
Declaration
Objective-C
+ (GPKGContentsIdDao *)contentsIdDaoWithDatabase:(GPKGConnection *)database;
Swift
class func contentsIdDao(withDatabase database: GPKGConnection!) -> GPKGContentsIdDao!
Parameters
database
database connection
Return Value
contents id dao
-
Create the Contents Id Table if it does not exist
Declaration
Objective-C
- (BOOL)createContentsIdTable;
Swift
func createContentsIdTable() -> Bool
Return Value
true if created