Class MetadataExtension

Metadata extension

Hierarchy

BaseExtension
- MetadataExtension

Constructors

constructor

new MetadataExtension(geoPackage: GeoPackage): MetadataExtension
Parameters
- geoPackage: GeoPackage
Returns MetadataExtension
Overrides BaseExtension.constructor
- Defined in lib/extension/metadata/metadataExtension.ts:18

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` EXTENSION_Metadata_AUTHOR

EXTENSION_Metadata_AUTHOR: string = 'gpkg'

`Static` `Readonly` EXTENSION_Metadata_DEFINITION

EXTENSION_Metadata_DEFINITION: string = 'http://www.geopackage.org/spec/#extension_metadata'

`Static` `Readonly` EXTENSION_Metadata_NAME_NO_AUTHOR

EXTENSION_Metadata_NAME_NO_AUTHOR: string = 'metadata'

`Static` `Readonly` EXTENSION_NAME

EXTENSION_NAME: string = 'gpkg_metadata'

Methods

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

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

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
Inherited from BaseExtension.getGeoPackage
- Defined in lib/extension/baseExtension.ts:52

getOrCreate

getOrCreate(extensionName: string, tableName: string, columnName: string, definition: string, scopeType: ExtensionScopeType): Extensions
Get the extension or create as needed

Returns
Parameters
- extensionName: string
  
  extension name
- tableName: string
  
  table name
- columnName: string
  
  column name
- definition: string
  
  extension definition
- scopeType: ExtensionScopeType
  
  extension scope type
Returns Extensions
Inherited from BaseExtension.getOrCreate
- Defined in lib/extension/baseExtension.ts:65

getOrCreateExtension

getOrCreateExtension(): Extensions
Get or create the metadata extension

Returns Extensions
- Defined in lib/extension/metadata/metadataExtension.ts:26

has

has(): boolean
Returns boolean
- Defined in lib/extension/metadata/metadataExtension.ts:30

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

removeExtension

removeExtension(): void
Returns void
- Defined in lib/extension/metadata/metadataExtension.ts:34

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 MetadataExtension

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

geoPackage: GeoPackage

Returns MetadataExtension

Properties

Protected Readonly connection

extensionDefinition

extensionName

Readonly extensionsDao

Readonly geoPackage

tableName

Static Readonly EXTENSION_Metadata_AUTHOR

Static Readonly EXTENSION_Metadata_DEFINITION

Static Readonly EXTENSION_Metadata_NAME_NO_AUTHOR

Static Readonly EXTENSION_NAME

Methods

createExtension

Parameters

extensionName: string

tableName: string

columnName: string

definition: string

scopeType: string

Returns number

get

Returns

Parameters

extensionName: string

Optional tableName: string

Optional columnName: string

Returns Extensions

getExtension

Returns

Parameters

extensionName: string

Optional tableName: string

Optional columnName: string

Returns Extensions[]

getGeoPackage

Returns GeoPackage

getOrCreate

Returns

Parameters

extensionName: string

tableName: string

columnName: string

definition: string

scopeType: ExtensionScopeType

Returns Extensions

getOrCreateExtension

Returns Extensions

has

Returns boolean

hasExtension

Returns

Parameters

extensionName: string

tableName: string

columnName: string

Returns boolean

hasExtensions

Parameters

extensionName: string

Returns boolean

removeExtension

Returns void

verifyWritable

Returns void

Settings

Member Visibility

Theme

`Protected` `Readonly` connection

`Readonly` extensionsDao

`Readonly` geoPackage

`Static` `Readonly` EXTENSION_Metadata_AUTHOR

`Static` `Readonly` EXTENSION_Metadata_DEFINITION

`Static` `Readonly` EXTENSION_Metadata_NAME_NO_AUTHOR

`Static` `Readonly` EXTENSION_NAME

`Optional` tableName: string

`Optional` columnName: string

`Optional` tableName: string

`Optional` columnName: string