GPKGPropertiesManager

Objective-C

@interface GPKGPropertiesManager : NSObject

/**
 *  Initialize
 *
 *  @return new properties manager
 */
-(instancetype) init;

/**
 *  Initialize
 *
 *  @param geoPackage GeoPackage
 *
 *  @return new properties manager
 */
-(instancetype) initWithGeoPackage: (GPKGGeoPackage *) geoPackage;

/**
 *  Initialize
 *
 *  @param geoPackages array of GeoPackages
 *
 *  @return new properties manager
 */
-(instancetype) initWithGeoPackages: (NSArray<GPKGGeoPackage *> *) geoPackages;

/**
 *  Initialize
 *
 *  @param cache GeoPackage cache
 *
 *  @return new properties manager
 */
-(instancetype) initWithCache: (GPKGGeoPackageCache *) cache;

/**
 * Create a properties extension from the GeoPackage
 *
 * @param geoPackage
 *            GeoPackage
 * @return properties extension
 */
-(GPKGPropertiesExtension *) propertiesExtensionWithGeoPackage: (GPKGGeoPackage *) geoPackage;

/**
 * Get the GeoPackage names
 *
 * @return names
 */
-(NSSet<NSString *> *) geoPackageNames;

/**
 * Get the number of GeoPackages
 *
 * @return GeoPackage count
 */
-(int) numGeoPackages;

/**
 * Get the GeoPackages
 *
 * @return collection of GeoPackages
 */
-(NSArray<GPKGGeoPackage *> *) geoPackages;

/**
 * Checks if the GeoPackage name exists
 *
 * @param name
 *            GeoPackage name
 * @return true if exists
 */
-(BOOL) hasGeoPackageWithName: (NSString *) name;

/**
 * Get the GeoPackage for the GeoPackage name
 *
 * @param name
 *            GeoPackage name
 * @return GeoPackage
 */
-(GPKGGeoPackage *) geoPackageWithName: (NSString *) name;

/**
 * Add a collection of GeoPackages
 *
 * @param geoPackages
 *            GeoPackages
 */
-(void) addGeoPackages: (NSArray<GPKGGeoPackage *> *) geoPackages;

/**
 * Add GeoPackage
 *
 * @param geoPackage
 *            GeoPackage
 */
-(void) addGeoPackage: (GPKGGeoPackage *) geoPackage;

/**
 * Close all GeoPackages in the manager
 */
-(void) closeGeoPackages;

/**
 * Remove the GeoPackage with the name but does not close it
 *
 * @param name
 *            GeoPackage name
 * @return removed GeoPackage
 */
-(GPKGGeoPackage *) removeGeoPackageWithName: (NSString *) name;

/**
 * Clears all cached GeoPackages but does not close them
 */
-(void) clearGeoPackages;

/**
 * Remove and close the GeoPackage with name, same as
 * {@link #closeGeoPackage(String)}
 *
 * @param name
 *            GeoPackage name
 * @return true if found, removed, and closed
 */
-(BOOL) removeAndCloseGeoPackageWithName: (NSString *) name;

/**
 * Close the GeoPackage with name
 *
 * @param name
 *            GeoPackage name
 * @return true if found and closed
 */
-(BOOL) closeGeoPackageWithName: (NSString *) name;

/**
 * Close GeoPackages not specified in the retain GeoPackage names
 *
 * @param retain
 *            GeoPackages to retain
 */
-(void) closeRetainGeoPackages: (NSArray<NSString *> *) retain;

/**
 * Close GeoPackages with names
 *
 * @param names
 *            GeoPackage names
 */
-(void) closeGeoPackages: (NSArray<NSString *> *) names;

/**
 * Get the number of unique properties
 *
 * @return property count
 */
-(int) numProperties;

/**
 * Get the unique properties
 *
 * @return set of properties
 */
-(NSSet<NSString *> *) properties;

/**
 * Get the GeoPackages with the property name
 *
 * @param property
 *            property name
 * @return GeoPackages
 */
-(NSArray<GPKGGeoPackage *> *) hasProperty: (NSString *) property;

/**
 * Get the GeoPackages missing the property name
 *
 * @param property
 *            property name
 * @return GeoPackages
 */
-(NSArray<GPKGGeoPackage *> *) missingProperty: (NSString *) property;

/**
 * Get the number of unique values for the property
 *
 * @param property
 *            property name
 * @return number of values
 */
-(int) numValuesOfProperty: (NSString *) property;

/**
 * Check if the property has any values
 *
 * @param property
 *            property name
 * @return true if has any values
 */
-(BOOL) hasValuesWithProperty: (NSString *) property;

/**
 * Get the unique values for the property
 *
 * @param property
 *            property name
 * @return set of values
 */
-(NSSet<NSString *> *) valuesOfProperty: (NSString *) property;

/**
 * Get the GeoPackages with the property name and value
 *
 * @param property
 *            property name
 * @param value
 *            property value
 * @return GeoPackages
 */
-(NSArray<GPKGGeoPackage *> *) hasValue: (NSString *) value withProperty: (NSString *) property;

/**
 * Get the GeoPackages missing the property name and value
 *
 * @param property
 *            property name
 * @param value
 *            property value
 * @return GeoPackages
 */
-(NSArray<GPKGGeoPackage *> *) missingValue: (NSString *) value withProperty: (NSString *) property;

/**
 * Add a property value to all GeoPackages
 *
 * @param property
 *            property name
 * @param value
 *            value
 * @return number of GeoPackages added to
 */
-(int) addValue: (NSString *) value withProperty: (NSString *) property;

/**
 * Add a property value to a specified GeoPackage
 *
 * @param geoPackage
 *            GeoPackage name
 * @param property
 *            property name
 * @param value
 *            value
 * @return true if added
 */
-(int) addValue: (NSString *) value withProperty: (NSString *) property inGeoPackage: (NSString *) geoPackage;

/**
 * Delete the property and values from all GeoPackages
 *
 * @param property
 *            property name
 * @return number of GeoPackages deleted from
 */
-(int) deleteProperty: (NSString *) property;

/**
 * Delete the property and values from a specified GeoPackage
 *
 * @param geoPackage
 *            GeoPackage name
 * @param property
 *            property name
 * @return true if deleted
 */
-(int) deleteProperty: (NSString *) property inGeoPackage: (NSString *) geoPackage;

/**
 * Delete the property value from all GeoPackages
 *
 * @param property
 *            property name
 * @param value
 *            property value
 * @return number of GeoPackages deleted from
 */
-(int) deleteValue: (NSString *) value withProperty: (NSString *) property;

/**
 * Delete the property value from a specified GeoPackage
 *
 * @param geoPackage
 *            GeoPackage name
 * @param property
 *            property name
 * @param value
 *            property value
 * @return true if deleted
 */
-(int) deleteValue: (NSString *) value withProperty: (NSString *) property inGeoPackage: (NSString *) geoPackage;

/**
 * Delete all properties and values from all GeoPackages
 *
 * @return number of GeoPackages deleted from
 */
-(int) deleteAll;

/**
 * Delete all properties and values from a specified GeoPackage
 *
 * @param geoPackage
 *            GeoPackage name
 * @return true if any deleted
 */
-(int) deleteAllInGeoPackage: (NSString *) geoPackage;

/**
 * Remove the extension from all GeoPackages
 */
-(void) removeExtension;

/**
 * Remove the extension from a specified GeoPackage
 *
 * @param geoPackage
 *            GeoPackage name
 */
-(void) removeExtensionInGeoPackage: (NSString *) geoPackage;

@end

Swift

class GPKGPropertiesManager : NSObject

Undocumented

  • Initialize

    Declaration

    Objective-C

    - (instancetype)init;

    Swift

    init!()

    Return Value

    new properties manager

  • Initialize

    Declaration

    Objective-C

    - (instancetype)initWithGeoPackage:(GPKGGeoPackage *)geoPackage;

    Swift

    init!(geoPackage: GPKGGeoPackage!)

    Parameters

    geoPackage

    GeoPackage

    Return Value

    new properties manager

  • Initialize

    Declaration

    Objective-C

    - (instancetype)initWithGeoPackages:(NSArray<GPKGGeoPackage *> *)geoPackages;

    Swift

    init!(geoPackages: [GPKGGeoPackage]!)

    Parameters

    geoPackages

    array of GeoPackages

    Return Value

    new properties manager

  • Initialize

    Declaration

    Objective-C

    - (instancetype)initWithCache:(GPKGGeoPackageCache *)cache;

    Swift

    init!(cache: GPKGGeoPackageCache!)

    Parameters

    cache

    GeoPackage cache

    Return Value

    new properties manager

  • Create a properties extension from the GeoPackage

    Declaration

    Objective-C

    - (GPKGPropertiesExtension *)propertiesExtensionWithGeoPackage:
        (GPKGGeoPackage *)geoPackage;

    Swift

    func propertiesExtension(with geoPackage: GPKGGeoPackage!) -> GPKGPropertiesExtension!

    Parameters

    geoPackage

    GeoPackage

    Return Value

    properties extension

  • Get the GeoPackage names

    Declaration

    Objective-C

    - (NSSet<NSString *> *)geoPackageNames;

    Swift

    func geoPackageNames() -> Set<String>!

    Return Value

    names

  • Get the number of GeoPackages

    Declaration

    Objective-C

    - (int)numGeoPackages;

    Swift

    func numGeoPackages() -> Int32

    Return Value

    GeoPackage count

  • Get the GeoPackages

    Declaration

    Objective-C

    - (NSArray<GPKGGeoPackage *> *)geoPackages;

    Swift

    func geoPackages() -> [GPKGGeoPackage]!

    Return Value

    collection of GeoPackages

  • Checks if the GeoPackage name exists

    Declaration

    Objective-C

    - (BOOL)hasGeoPackageWithName:(NSString *)name;

    Swift

    func hasGeoPackage(withName name: String!) -> Bool

    Parameters

    name

    GeoPackage name

    Return Value

    true if exists

  • Get the GeoPackage for the GeoPackage name

    Declaration

    Objective-C

    - (GPKGGeoPackage *)geoPackageWithName:(NSString *)name;

    Swift

    func geoPackage(withName name: String!) -> GPKGGeoPackage!

    Parameters

    name

    GeoPackage name

    Return Value

    GeoPackage

  • Add a collection of GeoPackages

    Declaration

    Objective-C

    - (void)addGeoPackages:(NSArray<GPKGGeoPackage *> *)geoPackages;

    Swift

    func addGeoPackages(_ geoPackages: [GPKGGeoPackage]!)

    Parameters

    geoPackages

    GeoPackages

  • Add GeoPackage

    Declaration

    Objective-C

    - (void)addGeoPackage:(GPKGGeoPackage *)geoPackage;

    Swift

    func addGeoPackage(_ geoPackage: GPKGGeoPackage!)

    Parameters

    geoPackage

    GeoPackage

  • Close all GeoPackages in the manager

    Declaration

    Objective-C

    - (void)closeGeoPackages;

    Swift

    func closeGeoPackages()
  • Remove the GeoPackage with the name but does not close it

    Declaration

    Objective-C

    - (GPKGGeoPackage *)removeGeoPackageWithName:(NSString *)name;

    Swift

    func removeGeoPackage(withName name: String!) -> GPKGGeoPackage!

    Parameters

    name

    GeoPackage name

    Return Value

    removed GeoPackage

  • Clears all cached GeoPackages but does not close them

    Declaration

    Objective-C

    - (void)clearGeoPackages;

    Swift

    func clearGeoPackages()
  • Remove and close the GeoPackage with name, same as {@link #closeGeoPackage(String)}

    Declaration

    Objective-C

    - (BOOL)removeAndCloseGeoPackageWithName:(NSString *)name;

    Swift

    func removeAndCloseGeoPackage(withName name: String!) -> Bool

    Return Value

    true if found, removed, and closed

  • Close the GeoPackage with name

    Declaration

    Objective-C

    - (BOOL)closeGeoPackageWithName:(NSString *)name;

    Swift

    func closeGeoPackage(withName name: String!) -> Bool

    Parameters

    name

    GeoPackage name

    Return Value

    true if found and closed

  • Close GeoPackages not specified in the retain GeoPackage names

    Declaration

    Objective-C

    - (void)closeRetainGeoPackages:(NSArray<NSString *> *)retain;

    Swift

    func closeRetainGeoPackages(_ retain: [String]!)

    Parameters

    retain

    GeoPackages to retain

  • Close GeoPackages with names

    Declaration

    Objective-C

    - (void)closeGeoPackages:(NSArray<NSString *> *)names;

    Swift

    func closeGeoPackages(_ names: [String]!)

    Parameters

    names

    GeoPackage names

  • Get the number of unique properties

    Declaration

    Objective-C

    - (int)numProperties;

    Swift

    func numProperties() -> Int32

    Return Value

    property count

  • Get the unique properties

    Declaration

    Objective-C

    - (NSSet<NSString *> *)properties;

    Swift

    func properties() -> Set<String>!

    Return Value

    set of properties

  • Get the GeoPackages with the property name

    Declaration

    Objective-C

    - (NSArray<GPKGGeoPackage *> *)hasProperty:(NSString *)property;

    Swift

    func hasProperty(_ property: String!) -> [GPKGGeoPackage]!

    Parameters

    property

    property name

    Return Value

    GeoPackages

  • Get the GeoPackages missing the property name

    Declaration

    Objective-C

    - (NSArray<GPKGGeoPackage *> *)missingProperty:(NSString *)property;

    Swift

    func missingProperty(_ property: String!) -> [GPKGGeoPackage]!

    Parameters

    property

    property name

    Return Value

    GeoPackages

  • Get the number of unique values for the property

    Declaration

    Objective-C

    - (int)numValuesOfProperty:(NSString *)property;

    Swift

    func numValues(ofProperty property: String!) -> Int32

    Parameters

    property

    property name

    Return Value

    number of values

  • Check if the property has any values

    Declaration

    Objective-C

    - (BOOL)hasValuesWithProperty:(NSString *)property;

    Swift

    func hasValues(withProperty property: String!) -> Bool

    Parameters

    property

    property name

    Return Value

    true if has any values

  • Get the unique values for the property

    Declaration

    Objective-C

    - (NSSet<NSString *> *)valuesOfProperty:(NSString *)property;

    Swift

    func values(ofProperty property: String!) -> Set<String>!

    Parameters

    property

    property name

    Return Value

    set of values

  • Get the GeoPackages with the property name and value

    Declaration

    Objective-C

    - (NSArray<GPKGGeoPackage *> *)hasValue:(NSString *)value
                               withProperty:(NSString *)property;

    Swift

    func hasValue(_ value: String!, withProperty property: String!) -> [GPKGGeoPackage]!

    Parameters

    property

    property name

    value

    property value

    Return Value

    GeoPackages

  • Get the GeoPackages missing the property name and value

    Declaration

    Objective-C

    - (NSArray<GPKGGeoPackage *> *)missingValue:(NSString *)value
                                   withProperty:(NSString *)property;

    Swift

    func missingValue(_ value: String!, withProperty property: String!) -> [GPKGGeoPackage]!

    Parameters

    property

    property name

    value

    property value

    Return Value

    GeoPackages

  • Add a property value to all GeoPackages

    Declaration

    Objective-C

    - (int)addValue:(NSString *)value withProperty:(NSString *)property;

    Swift

    func addValue(_ value: String!, withProperty property: String!) -> Int32

    Parameters

    property

    property name

    value

    value

    Return Value

    number of GeoPackages added to

  • Add a property value to a specified GeoPackage

    Declaration

    Objective-C

    - (int)addValue:(NSString *)value
        withProperty:(NSString *)property
        inGeoPackage:(NSString *)geoPackage;

    Swift

    func addValue(_ value: String!, withProperty property: String!, inGeoPackage geoPackage: String!) -> Int32

    Parameters

    geoPackage

    GeoPackage name

    property

    property name

    value

    value

    Return Value

    true if added

  • Delete the property and values from all GeoPackages

    Declaration

    Objective-C

    - (int)deleteProperty:(NSString *)property;

    Swift

    func deleteProperty(_ property: String!) -> Int32

    Parameters

    property

    property name

    Return Value

    number of GeoPackages deleted from

  • Delete the property and values from a specified GeoPackage

    Declaration

    Objective-C

    - (int)deleteProperty:(NSString *)property inGeoPackage:(NSString *)geoPackage;

    Swift

    func deleteProperty(_ property: String!, inGeoPackage geoPackage: String!) -> Int32

    Parameters

    geoPackage

    GeoPackage name

    property

    property name

    Return Value

    true if deleted

  • Delete the property value from all GeoPackages

    Declaration

    Objective-C

    - (int)deleteValue:(NSString *)value withProperty:(NSString *)property;

    Swift

    func deleteValue(_ value: String!, withProperty property: String!) -> Int32

    Parameters

    property

    property name

    value

    property value

    Return Value

    number of GeoPackages deleted from

  • Delete the property value from a specified GeoPackage

    Declaration

    Objective-C

    - (int)deleteValue:(NSString *)value
          withProperty:(NSString *)property
          inGeoPackage:(NSString *)geoPackage;

    Swift

    func deleteValue(_ value: String!, withProperty property: String!, inGeoPackage geoPackage: String!) -> Int32

    Parameters

    geoPackage

    GeoPackage name

    property

    property name

    value

    property value

    Return Value

    true if deleted

  • Delete all properties and values from all GeoPackages

    Declaration

    Objective-C

    - (int)deleteAll;

    Swift

    func deleteAll() -> Int32

    Return Value

    number of GeoPackages deleted from

  • Delete all properties and values from a specified GeoPackage

    Declaration

    Objective-C

    - (int)deleteAllInGeoPackage:(NSString *)geoPackage;

    Swift

    func deleteAll(inGeoPackage geoPackage: String!) -> Int32

    Parameters

    geoPackage

    GeoPackage name

    Return Value

    true if any deleted

  • Remove the extension from all GeoPackages

    Declaration

    Objective-C

    - (void)removeExtension;

    Swift

    func removeExtension()
  • Remove the extension from a specified GeoPackage

    Declaration

    Objective-C

    - (void)removeExtensionInGeoPackage:(NSString *)geoPackage;

    Swift

    func removeExtension(inGeoPackage geoPackage: String!)

    Parameters

    geoPackage

    GeoPackage name