Class PropertiesExtension

GeoPackage properties core extension for defining GeoPackage specific properties, attributes, and metadata

Hierarchy

BaseExtension
- PropertiesExtension

Constructors

constructor

new PropertiesExtension(geoPackage: GeoPackage): PropertiesExtension
Constructor
Parameters
- geoPackage: GeoPackage
  
  GeoPackage
Returns PropertiesExtension
Overrides BaseExtension.constructor
- Defined in lib/extension/nga/properties/propertiesExtension.ts:68

Properties

`Protected` `Readonly` connection

connection: GeoPackageConnection

Connection to the GeoPackage

extensionDefinition

extensionDefinition: string

Definition for the extension

extensionName

extensionName: string

Name of the extension

`Readonly` extensionsDao

extensionsDao: ExtensionsDao

ExtensionDao

`Readonly` geoPackage

geoPackage: GeoPackage

GeoPackage

tableName

tableName: string

extension table name

`Static` `Readonly` COLUMN_PROPERTY

COLUMN_PROPERTY: string = 'property'

Property column

`Static` `Readonly` COLUMN_VALUE

COLUMN_VALUE: string = 'value'

Value column

`Static` `Readonly` EXTENSION_AUTHOR

EXTENSION_AUTHOR: string = NGAExtensionsConstants.EXTENSION_AUTHOR

Extension author

`Static` `Readonly` EXTENSION_DEFINITION

EXTENSION_DEFINITION: string = 'http://ngageoint.github.io/GeoPackage/docs/extensions/properties.html'

Extension definition URL

`Static` `Readonly` EXTENSION_NAME

EXTENSION_NAME: string = ...

Extension, with author and name

`Static` `Readonly` EXTENSION_NAME_NO_AUTHOR

EXTENSION_NAME_NO_AUTHOR: string = 'properties'

Extension name without the author

`Static` `Readonly` TABLE_NAME

TABLE_NAME: string = PropertiesExtension.EXTENSION_NAME

Table name

Methods

addValue

addValue(property: string, value: string): boolean
Add a property value, creating the extension if needed

Returns
true if added, false if already existed
Parameters
- property: string
  
  property name
- value: string
  
  value
Returns boolean
- Defined in lib/extension/nga/properties/propertiesExtension.ts:285

createExtension

createExtension(extensionName: string, tableName: string, columnName: string, definition: string, scopeType: string): number
Create the extension
Parameters
- extensionName: string
- tableName: string
- columnName: string
- definition: string
- scopeType: string
Returns number
Inherited from BaseExtension.createExtension
- Defined in lib/extension/baseExtension.ts:168

deleteAll

deleteAll(): number
Delete all properties and values

Returns
deleted values count

Returns number
- Defined in lib/extension/nga/properties/propertiesExtension.ts:339

deleteProperty

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

Returns
deleted values count
Parameters
- property: string
  
  property name
Returns number
- Defined in lib/extension/nga/properties/propertiesExtension.ts:305

deleteValue

deleteValue(property: string, value: string): number
Delete the property value

Returns
deleted values count
Parameters
- property: string
  
  property name
- value: string
  
  property value
Returns number
- Defined in lib/extension/nga/properties/propertiesExtension.ts:325

get

get(extensionName: string, tableName?: string, columnName?: string): Extensions
Get the extension for the name, table name and column name

Returns
Parameters
- extensionName: string
  
  extension name
- Optional tableName: string
  
  table name
- Optional columnName: string
  
  column name
Returns Extensions
Inherited from BaseExtension.get
- Defined in lib/extension/baseExtension.ts:110

`Protected` getDao

getDao(): AttributesDao
Protected
Get AttributesDao

Returns AttributesDao
- Defined in lib/extension/nga/properties/propertiesExtension.ts:129

getExtension

getExtension(extensionName: string, tableName?: string, columnName?: string): Extensions[]
Get the extension for the name, table name and column name

Returns
Parameters
- extensionName: string
  
  extension name
- Optional tableName: string
  
  table name
- Optional columnName: string
  
  column name
Returns Extensions[]
Inherited from BaseExtension.getExtension
- Defined in lib/extension/baseExtension.ts:132

getGeoPackage

getGeoPackage(): GeoPackage
Get the geopackage

Returns GeoPackage
Overrides BaseExtension.getGeoPackage
- Defined in lib/extension/nga/properties/propertiesExtension.ts:76

getOrCreate

getOrCreate(): Extensions
Get or create the extension

Returns
extension

Returns Extensions
Overrides BaseExtension.getOrCreate
- Defined in lib/extension/nga/properties/propertiesExtension.ts:84

getProperties

getProperties(): string[]
Get the properties

Returns
list of properties

Returns string[]
- Defined in lib/extension/nga/properties/propertiesExtension.ts:154

getValue

getValue(property: string): string
Get the first value for the property

Returns
value or null
Parameters
- property: string
  
  property name
Returns string
- Defined in lib/extension/nga/properties/propertiesExtension.ts:239

getValues

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

Returns
list of values
Parameters
- property: string
  
  property name
Returns string[]
- Defined in lib/extension/nga/properties/propertiesExtension.ts:254

has

has(): boolean
Determine if the GeoPackage has the extension

Returns
true if has extension

Returns boolean
- Defined in lib/extension/nga/properties/propertiesExtension.ts:118

hasExtension

hasExtension(extensionName: string, tableName: string, columnName: string): boolean
Determine if the GeoPackage has the extension

Returns
if the extension exists
Parameters
- extensionName: string
  
  extension name
- tableName: string
  
  table name
- columnName: string
  
  column name
Returns boolean
Inherited from BaseExtension.hasExtension
- Defined in lib/extension/baseExtension.ts:145

hasExtensions

hasExtensions(extensionName: string): boolean
Parameters
- extensionName: string
Returns boolean
Inherited from BaseExtension.hasExtensions
- Defined in lib/extension/baseExtension.ts:149

hasProperty

hasProperty(property: string): boolean
Check if the property exists, same call as #hasValues(String)

Returns
true if has property
Parameters
- property: string
  
  property name
Returns boolean
- Defined in lib/extension/nga/properties/propertiesExtension.ts:174

hasSingleValue

hasSingleValue(property: string): boolean
Check if the property has a single value

Returns
true if has a single value
Parameters
- property: string
  
  property name
Returns boolean
- Defined in lib/extension/nga/properties/propertiesExtension.ts:218

hasValue

hasValue(property: string, value: string): boolean
Check if the property has the value

Returns
true if property has the value
Parameters
- property: string
  
  property name
- value: string
  
  property value
Returns boolean
- Defined in lib/extension/nga/properties/propertiesExtension.ts:267

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/propertiesExtension.ts:229

`Protected` newRow

newRow(): AttributesRow
Inherit Doc

Returns AttributesRow
- Defined in lib/extension/nga/properties/propertiesExtension.ts:136

numProperties

numProperties(): number
Get the number of properties

Returns
property count

Returns number
- Defined in lib/extension/nga/properties/propertiesExtension.ts:145

numValues

numValues(): number
Get the number of total values combined for all properties

Returns
number of total property values

Returns number
- Defined in lib/extension/nga/properties/propertiesExtension.ts:183

numValuesForProperty

numValuesForProperty(property: string): number
Get the number of values for the property

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

removeExtension

removeExtension(): void
Remove the extension

Returns void
- Defined in lib/extension/nga/properties/propertiesExtension.ts:350

verifyWritable

verifyWritable(): void
Verify the GeoPackage is writable and throw an exception if it is not

Returns void
Inherited from BaseExtension.verifyWritable
- Defined in lib/extension/baseExtension.ts:156

Class PropertiesExtension

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

geoPackage: GeoPackage

Returns PropertiesExtension

Properties

Protected Readonly connection

extensionDefinition

extensionName

Readonly extensionsDao

Readonly geoPackage

tableName

Static Readonly COLUMN_PROPERTY

Static Readonly COLUMN_VALUE

Static Readonly EXTENSION_AUTHOR

Static Readonly EXTENSION_DEFINITION

Static Readonly EXTENSION_NAME

Static Readonly EXTENSION_NAME_NO_AUTHOR

Static Readonly TABLE_NAME

Methods

addValue

Returns

Parameters

property: string

value: string

Returns boolean

createExtension

Parameters

extensionName: string

tableName: string

columnName: string

definition: string

scopeType: string

Returns number

deleteAll

Returns

Returns number

deleteProperty

Returns

Parameters

property: string

Returns number

deleteValue

Returns

Parameters

property: string

value: string

Returns number

get

Returns

Parameters

extensionName: string

Optional tableName: string

Optional columnName: string

Returns Extensions

Protected getDao

Returns AttributesDao

getExtension

Returns

Parameters

extensionName: string

Optional tableName: string

Optional columnName: string

Returns Extensions[]

getGeoPackage

Returns GeoPackage

getOrCreate

Returns

Returns Extensions

getProperties

Returns

Returns string[]

getValue

Returns

`Protected` `Readonly` connection

`Readonly` extensionsDao

`Readonly` geoPackage

`Static` `Readonly` COLUMN_PROPERTY

`Static` `Readonly` COLUMN_VALUE

`Static` `Readonly` EXTENSION_AUTHOR

`Static` `Readonly` EXTENSION_DEFINITION

`Static` `Readonly` EXTENSION_NAME

`Static` `Readonly` EXTENSION_NAME_NO_AUTHOR

`Static` `Readonly` TABLE_NAME

`Optional` tableName: string

`Optional` columnName: string

`Protected` getDao

`Optional` tableName: string

`Optional` columnName: string

`Protected` newRow