Class PropertiesManager

Properties Manager Core using the Properties Extension on a group of cached GeoPackages

Hierarchy

PropertiesManager

Constructors

`Protected` constructor

new PropertiesManager(): PropertiesManager
Constructor

Returns PropertiesManager
- Defined in lib/extension/nga/properties/propertiesManager.ts:15
new PropertiesManager(geoPackage: GeoPackage): PropertiesManager
Constructor
Parameters
- geoPackage: GeoPackage
Returns PropertiesManager
- Defined in lib/extension/nga/properties/propertiesManager.ts:16
new PropertiesManager(geoPackages: GeoPackage[]): PropertiesManager
Constructor
Parameters
- geoPackages: GeoPackage[]
Returns PropertiesManager
- Defined in lib/extension/nga/properties/propertiesManager.ts:17

Methods

addGeoPackage

addGeoPackage(geoPackage: GeoPackage): void
Add GeoPackage
Parameters
- geoPackage: GeoPackage
  
  GeoPackage
Returns void
- Defined in lib/extension/nga/properties/propertiesManager.ts:110

addGeoPackages

addGeoPackages(geoPackages: GeoPackage[]): void
Add a collection of GeoPackages
Parameters
- geoPackages: GeoPackage[]
  
  GeoPackages
Returns void
- Defined in lib/extension/nga/properties/propertiesManager.ts:98

addValue

addValue(property: string, value: string): number
Add a property value to all GeoPackages

Returns
number of GeoPackages added to
Parameters
- property: string
  
  property name
- value: string
  
  value
Returns number
- Defined in lib/extension/nga/properties/propertiesManager.ts:341

addValueToGeoPackage

addValueToGeoPackage(geoPackage: string, property: string, value: string): boolean
Add a property value to a specified GeoPackage

Returns
true if added
Parameters
- geoPackage: string
  
  GeoPackage name
- property: string
  
  property name
- value: string
  
  value
Returns boolean
- Defined in lib/extension/nga/properties/propertiesManager.ts:362

clearGeoPackages

clearGeoPackages(): void
Clears all cached GeoPackages but does not close them

Returns void
- Defined in lib/extension/nga/properties/propertiesManager.ts:144

closeGeoPackage

closeGeoPackage(name: string): boolean
Close the GeoPackage with name

Returns
true if found and closed
Parameters
- name: string
  
  GeoPackage name
Returns boolean
- Defined in lib/extension/nga/properties/propertiesManager.ts:167

closeGeoPackages

closeGeoPackages(): void
Close all GeoPackages in the manager

Returns void
- Defined in lib/extension/nga/properties/propertiesManager.ts:117

closeGeoPackagesWithNames

closeGeoPackagesWithNames(names: string[]): void
Close GeoPackages with names
Parameters
- names: string[]
  
  GeoPackage names
Returns void
- Defined in lib/extension/nga/properties/propertiesManager.ts:199

closeRetaWithGeoPackages

closeRetaWithGeoPackages(retain: string[]): void
Close GeoPackages not specified in the retain GeoPackage names
Parameters
- retain: string[]
  
  GeoPackages to retain
Returns void
- Defined in lib/extension/nga/properties/propertiesManager.ts:181

deleteAll

deleteAll(): number
Delete all properties and values from all GeoPackages

Returns
number of GeoPackages deleted from

Returns number
- Defined in lib/extension/nga/properties/propertiesManager.ts:447

deleteAllWithGeoPackage

deleteAllWithGeoPackage(geoPackage: string): boolean
Delete all properties and values from a specified GeoPackage

Returns
true if any deleted
Parameters
- geoPackage: string
  
  GeoPackage name
Returns boolean
- Defined in lib/extension/nga/properties/propertiesManager.ts:464

deleteProperty

deleteProperty(property: string): number
Delete the property and values from all GeoPackages

Returns
number of GeoPackages deleted from
Parameters
- property: string
  
  property name
Returns number
- Defined in lib/extension/nga/properties/propertiesManager.ts:378

deletePropertyWithGeoPackage

deletePropertyWithGeoPackage(geoPackage: string, property: string): boolean
Delete the property and values from a specified GeoPackage

Returns
true if deleted
Parameters
- geoPackage: string
  
  GeoPackage name
- property: string
  
  property name
Returns boolean
- Defined in lib/extension/nga/properties/propertiesManager.ts:394

deleteValue

deleteValue(property: string, value: string): number
Delete the property value from all GeoPackages

Returns
number of GeoPackages deleted from
Parameters
- property: string
  
  property name
- value: string
  
  property value
Returns number
- Defined in lib/extension/nga/properties/propertiesManager.ts:412

deleteValueWithGeoPackage

deleteValueWithGeoPackage(geoPackage: string, property: string, value: string): boolean
Delete the property value from a specified GeoPackage

Returns
true if deleted
Parameters
- geoPackage: string
  
  GeoPackage name
- property: string
  
  property name
- value: string
  
  property value
Returns boolean
- Defined in lib/extension/nga/properties/propertiesManager.ts:433

getGeoPackage

getGeoPackage(name: string): GeoPackage
Get the GeoPackage for the GeoPackage name

Returns
GeoPackage
Parameters
- name: string
  
  GeoPackage name
Returns GeoPackage
- Defined in lib/extension/nga/properties/propertiesManager.ts:83

getGeoPackageNames

getGeoPackageNames(): string[]
Get the GeoPackage names

Returns
names

Returns string[]
- Defined in lib/extension/nga/properties/propertiesManager.ts:39

getGeoPackages

getGeoPackages(): GeoPackage[]
Get the GeoPackages

Returns
collection of GeoPackages

Returns GeoPackage[]
- Defined in lib/extension/nga/properties/propertiesManager.ts:61

getProperties

getProperties(): string[]
Get the unique properties

Returns
set of properties

Returns string[]
- Defined in lib/extension/nga/properties/propertiesManager.ts:219

getPropertiesExtension

getPropertiesExtension(geoPackage: GeoPackage): PropertiesExtension
Parameters
- geoPackage: GeoPackage
Returns PropertiesExtension
- Defined in lib/extension/nga/properties/propertiesManager.ts:31

getValues

getValues(property: string): string[]
Get the unique values for the property

Returns
set of values
Parameters
- property: string
  
  property name
Returns string[]
- Defined in lib/extension/nga/properties/propertiesManager.ts:284

hasGeoPackage

hasGeoPackage(name: string): boolean
Checks if the GeoPackage name exists

Returns
true if exists
Parameters
- name: string
  
  GeoPackage name
Returns boolean
- Defined in lib/extension/nga/properties/propertiesManager.ts:74

hasProperty

hasProperty(property: string): GeoPackage[]
Get the GeoPackages with the property name

Returns
GeoPackages
Parameters
- property: string
  
  property name
Returns GeoPackage[]
- Defined in lib/extension/nga/properties/propertiesManager.ts:235

hasValue

hasValue(property: string, value: string): GeoPackage[]
Get the GeoPackages with the property name and value

Returns
GeoPackages
Parameters
- property: string
  
  property name
- value: string
  
  property value
Returns GeoPackage[]
- Defined in lib/extension/nga/properties/propertiesManager.ts:303

hasValues

hasValues(property: string): boolean
Check if the property has any values

Returns
true if has any values
Parameters
- property: string
  
  property name
Returns boolean
- Defined in lib/extension/nga/properties/propertiesManager.ts:275

missingProperty

missingProperty(property: string): GeoPackage[]
Get the GeoPackages missing the property name

Returns
GeoPackages
Parameters
- property: string
  
  property name
Returns GeoPackage[]
- Defined in lib/extension/nga/properties/propertiesManager.ts:251

missingValue

missingValue(property: string, value: string): GeoPackage[]
Get the GeoPackages missing the property name and value

Returns
GeoPackages
Parameters
- property: string
  
  property name
- value: string
  
  property value
Returns GeoPackage[]
- Defined in lib/extension/nga/properties/propertiesManager.ts:322

numGeoPackages

numGeoPackages(): number
Get the number of GeoPackages

Returns
GeoPackage count

Returns number
- Defined in lib/extension/nga/properties/propertiesManager.ts:52

numProperties

numProperties(): number
Get the number of unique properties

Returns
property count

Returns number
- Defined in lib/extension/nga/properties/propertiesManager.ts:210

numValues

numValues(property: string): number
Get the number of unique values for the property

Returns
number of values
Parameters
- property: string
  
  property name
Returns number
- Defined in lib/extension/nga/properties/propertiesManager.ts:266

removeAndCloseGeoPackage

removeAndCloseGeoPackage(name: string): boolean
Remove and close the GeoPackage with name, same as #closeGeoPackage(String)

Returns
true if found, removed, and closed
Parameters
- name: string
  
  GeoPackage name
Returns boolean
- Defined in lib/extension/nga/properties/propertiesManager.ts:156

removeExtension

removeExtension(): void
Remove the extension from all GeoPackages

Returns void
- Defined in lib/extension/nga/properties/propertiesManager.ts:476

removeExtensionWithGeoPackage

removeExtensionWithGeoPackage(geoPackage: string): void
Remove the extension from a specified GeoPackage
Parameters
- geoPackage: string
  
  GeoPackage name
Returns void
- Defined in lib/extension/nga/properties/propertiesManager.ts:488

removeGeoPackage

removeGeoPackage(name: string): GeoPackage
Remove the GeoPackage with the name but does not close it

Returns
removed GeoPackage
Parameters
- name: string
  
  GeoPackage name
Returns GeoPackage
- Defined in lib/extension/nga/properties/propertiesManager.ts:131

Class PropertiesManager

Hierarchy

Index

Constructors

Methods

Constructors

Protected constructor

Returns PropertiesManager

Parameters

geoPackage: GeoPackage

Returns PropertiesManager

Parameters

geoPackages: GeoPackage[]

Returns PropertiesManager

Methods

addGeoPackage

Parameters

geoPackage: GeoPackage

Returns void

addGeoPackages

Parameters

geoPackages: GeoPackage[]

Returns void

addValue

Returns

Parameters

property: string

value: string

Returns number

addValueToGeoPackage

Returns

Parameters

geoPackage: string

property: string

value: string

Returns boolean

clearGeoPackages

Returns void

closeGeoPackage

Returns

Parameters

name: string

Returns boolean

closeGeoPackages

Returns void

closeGeoPackagesWithNames

Parameters

names: string[]

Returns void

closeRetaWithGeoPackages

Parameters

retain: string[]

Returns void

deleteAll

Returns

Returns number

deleteAllWithGeoPackage

Returns

Parameters

geoPackage: string

Returns boolean

deleteProperty

Returns

Parameters

property: string

Returns number

deletePropertyWithGeoPackage

Returns

Parameters

geoPackage: string

property: string

Returns boolean

deleteValue

Returns

Parameters

property: string

value: string

Returns number

deleteValueWithGeoPackage

Returns

`Protected` constructor