Class StyleMappingTable

Contains style mapping table factory and utility methods

Hierarchy

UserMappingTable
- StyleMappingTable

Index

Constructors

Properties

columns constraints contents COLUMN_BASE_ID COLUMN_GEOMETRY_TYPE_NAME COLUMN_RELATED_ID DEFAULT_AUTOINCREMENT DEFAULT_PK_NOT_NULL

Methods

addColumn addConstraint addConstraints addConstraintsWithConstraints alterColumn clearConstraints clearConstraintsByType columnCount columnsOfType copy createUserColumns createUserColumnsFromColumnNames dropColumn dropColumnWithIndex dropColumnWithName getBaseIdColumn getColumn getColumnForIndex getColumnIndex getColumnName getColumnNames getColumns getColumnsForColumnNames getConstraints getConstraintsByType getContents getDataType getDataTypeOrDefault getGeometryTypeNameColumn getGeometryTypeNameColumnIndex getPkColumn getPkColumnIndex getPkColumnName getRelatedIdColumn getRequiredColumns getTableName getUserColumns hasColumn hasConstraints hasConstraintsForType hasPkColumn isPkModifiable isValueValidation renameColumn renameColumnWithIndex renameColumnWithName setContents setPkModifiable setTableName setValueValidation validateContents create createBaseIdColumn createBaseIdColumnWithIndex createColumns createRelatedIdColumn createRelatedIdColumnWithIndex createRequiredColumns createRequiredColumnsWithIndex numRequiredColumns requiredColumns

Constructors

constructor

new StyleMappingTable(tableName: string, columns: UserCustomTable[]): StyleMappingTable
Constructor
Parameters
- tableName: string
  
  table name
- columns: UserCustomTable[]
  
  list of columns
Returns StyleMappingTable
Inherited from UserMappingTable.constructor
- Defined in lib/user/custom/userCustomTable.ts:19
new StyleMappingTable(tableName: string, columns: UserCustomColumn[], requiredColumns: string[]): StyleMappingTable
Constructor
Parameters
- tableName: string
  
  table name
- columns: UserCustomColumn[]
  
  list of columns
- requiredColumns: string[]
  
  list of required columns
Returns StyleMappingTable
Inherited from UserMappingTable.constructor
- Defined in lib/user/custom/userCustomTable.ts:27
new StyleMappingTable(columns: UserCustomColumns): StyleMappingTable
Constructor
Parameters
- columns: UserCustomColumns
  
  columns
Returns StyleMappingTable
Inherited from UserMappingTable.constructor
- Defined in lib/user/custom/userCustomTable.ts:33
new StyleMappingTable(userCustomTable: UserCustomTable): StyleMappingTable
Copy Constructor
Parameters
- userCustomTable: UserCustomTable
  
  user custom table
Returns StyleMappingTable
Inherited from UserMappingTable.constructor
- Defined in lib/user/custom/userCustomTable.ts:39

Properties

columns

columns: UserColumns<UserCustomColumn>

Columns

constraints

constraints: Constraints = ...

Constraints

contents: Contents

Foreign key to Contents

`Static` `Readonly` COLUMN_BASE_ID

COLUMN_BASE_ID: string = 'base_id'

`Static` `Readonly` COLUMN_GEOMETRY_TYPE_NAME

COLUMN_GEOMETRY_TYPE_NAME: "geometry_type_name" = 'geometry_type_name'

`Static` `Readonly` COLUMN_RELATED_ID

COLUMN_RELATED_ID: string = 'related_id'

`Static` DEFAULT_AUTOINCREMENT

DEFAULT_AUTOINCREMENT: boolean = true

Default id autoincrement setting

`Static` DEFAULT_PK_NOT_NULL

DEFAULT_PK_NOT_NULL: boolean = true

Default primary key not null setting

Methods

addColumn

addColumn(column: UserCustomColumn): void
Add a new column
Parameters
- column: UserCustomColumn
  
  new column
Returns void
Inherited from UserMappingTable.addColumn
- Defined in lib/user/userTable.ts:442

addConstraint

addConstraint(constraint: Constraint): void
Add constraint
Parameters
- constraint: Constraint
  
  constraint
Returns void
Inherited from UserMappingTable.addConstraint
- Defined in lib/user/userTable.ts:273

addConstraints

addConstraints(constraints: Constraint[]): void
Add constraints
Parameters
- constraints: Constraint[]
  
  constraints
Returns void
Inherited from UserMappingTable.addConstraints
- Defined in lib/user/userTable.ts:283

addConstraintsWithConstraints

addConstraintsWithConstraints(constraints: Constraints): void
Add constraints
Parameters
- constraints: Constraints
  
  constraints
Returns void
Inherited from UserMappingTable.addConstraintsWithConstraints
- Defined in lib/user/userTable.ts:293

alterColumn

alterColumn(column: UserCustomColumn): void
Alter a column
Parameters
- column: UserCustomColumn
  
  altered column
Returns void
Inherited from UserMappingTable.alterColumn
- Defined in lib/user/userTable.ts:518

clearConstraints

clearConstraints(): Constraint[]
Clear the constraints

Returns
cleared constraints

Returns Constraint[]
Inherited from UserMappingTable.clearConstraints
- Defined in lib/user/userTable.ts:342

clearConstraintsByType

clearConstraintsByType(type: ConstraintType): Constraint[]
Clear the constraints of the provided type

Returns
cleared constraints
Parameters
- type: ConstraintType
  
  constraint type
Returns Constraint[]
Inherited from UserMappingTable.clearConstraintsByType
- Defined in lib/user/userTable.ts:353

columnCount

columnCount(): number
Get the column count

Returns
column count

Returns number
Inherited from UserMappingTable.columnCount
- Defined in lib/user/userTable.ts:208

columnsOfType

columnsOfType(type: GeoPackageDataType): UserCustomColumn[]
Get the columns with the provided data type

Returns
columns
Parameters
- type: GeoPackageDataType
  
  data type
Returns UserCustomColumn[]
Inherited from UserMappingTable.columnsOfType
- Defined in lib/user/userTable.ts:364

copy

copy(): UserCustomTable
Copy the UserCustomTable

Returns

Returns UserCustomTable
Inherited from UserMappingTable.copy
- Defined in lib/user/custom/userCustomTable.ts:76

createUserColumns

createUserColumns(columns: UserCustomColumn[]): UserColumns<UserCustomColumn>
Create user columns
Parameters
- columns: UserCustomColumn[]
Returns UserColumns<UserCustomColumn>
Inherited from UserMappingTable.createUserColumns
- Defined in lib/user/custom/userCustomTable.ts:68

createUserColumnsFromColumnNames

createUserColumnsFromColumnNames(columnNames: string[]): UserColumns<UserCustomColumn>
Create user columns for a subset of table columns

Returns
user columns
Parameters
- columnNames: string[]
  
  column names
Returns UserColumns<UserCustomColumn>
Inherited from UserMappingTable.createUserColumnsFromColumnNames
- Defined in lib/user/userTable.ts:115

dropColumn

dropColumn(column: UserCustomColumn): void
Drop a column
Parameters
- column: UserCustomColumn
  
  column to drop
Returns void
Inherited from UserMappingTable.dropColumn
- Defined in lib/user/userTable.ts:488

dropColumnWithIndex

dropColumnWithIndex(index: number): void
Drop a column
Parameters
- index: number
  
  column index
Returns void
Inherited from UserMappingTable.dropColumnWithIndex
- Defined in lib/user/userTable.ts:508

dropColumnWithName

dropColumnWithName(columnName: string): void
Drop a column
Parameters
- columnName: string
  
  column name
Returns void
Inherited from UserMappingTable.dropColumnWithName
- Defined in lib/user/userTable.ts:498

getBaseIdColumn

getBaseIdColumn(): UserColumn
Get the base id column

Returns

Returns UserColumn
Inherited from UserMappingTable.getBaseIdColumn
- Defined in lib/extension/related/userMappingTable.ts:20

getColumn

getColumn(columnName: string): UserCustomColumn
Get the column of the column name

Returns
column
Parameters
- columnName: string
  
  column name
Returns UserCustomColumn
Inherited from UserMappingTable.getColumn
- Defined in lib/user/userTable.ts:188

getColumnForIndex

getColumnForIndex(index: number): UserCustomColumn
Get the column at the index

Returns
column
Parameters
- index: number
  
  column index
Returns UserCustomColumn
Inherited from UserMappingTable.getColumnForIndex
- Defined in lib/user/userTable.ts:179

getColumnIndex

getColumnIndex(columnName: string): number
Get the column index of the column name

Returns
column index
Parameters
- columnName: string
  
  column name
Returns number
Inherited from UserMappingTable.getColumnIndex
- Defined in lib/user/userTable.ts:132

getColumnName

getColumnName(index: number): string
Get the column name at the index

Returns
column name
Parameters
- index: number
  
  column index
Returns string
Inherited from UserMappingTable.getColumnName
- Defined in lib/user/userTable.ts:149

getColumnNames

getColumnNames(): string[]
Get the array of column names

Returns
column names

Returns string[]
Inherited from UserMappingTable.getColumnNames
- Defined in lib/user/userTable.ts:140

getColumns

getColumns(): UserCustomColumn[]
Get the list of columns

Returns
columns

Returns UserCustomColumn[]
Inherited from UserMappingTable.getColumns
- Defined in lib/user/userTable.ts:157

getColumnsForColumnNames

getColumnsForColumnNames(columnNames: string[]): UserCustomColumn[]
Get the columns from the column names

Returns
columns
Parameters
- columnNames: string[]
  
  column names
Returns UserCustomColumn[]
Inherited from UserMappingTable.getColumnsForColumnNames
- Defined in lib/user/userTable.ts:166

getConstraints

getConstraints(): Constraints
Get the constraints

Returns
constraints

Returns Constraints
Inherited from UserMappingTable.getConstraints
- Defined in lib/user/userTable.ts:322

getConstraintsByType

getConstraintsByType(type: ConstraintType): Constraint[]
Get the constraints of the provided type

Returns
constraints
Parameters
- type: ConstraintType
  
  constraint type
Returns Constraint[]
Inherited from UserMappingTable.getConstraintsByType
- Defined in lib/user/userTable.ts:333

getContents

getContents(): Contents
Get the contents

Returns
contents

Returns Contents
Inherited from UserMappingTable.getContents
- Defined in lib/user/userTable.ts:373

getDataType

getDataType(): string
Get the data type

Returns

Returns string
Inherited from UserMappingTable.getDataType
- Defined in lib/user/custom/userCustomTable.ts:91

`Protected` getDataTypeOrDefault

getDataTypeOrDefault(defaultType: string): string
Get the contents data type from the contents or use the default

Returns
contents or default data type
Parameters
- defaultType: string
  
  default data type
Returns string
Inherited from UserMappingTable.getDataTypeOrDefault
- Defined in lib/user/userTable.ts:92

getGeometryTypeNameColumn

getGeometryTypeNameColumn(): UserColumn
Get the geometry type name column

Returns

Returns UserColumn
- Defined in lib/extension/nga/style/styleMappingTable.ts:23

getGeometryTypeNameColumnIndex

getGeometryTypeNameColumnIndex(): number
Get the geometry type name column index

Returns
int

Returns number
- Defined in lib/extension/nga/style/styleMappingTable.ts:16

getPkColumn

getPkColumn(): UserCustomColumn
Get the primary key column

Returns
primary key column

Returns UserCustomColumn
Inherited from UserMappingTable.getPkColumn
- Defined in lib/user/userTable.ts:254

getPkColumnIndex

getPkColumnIndex(): number
Get the primary key column index

Returns
primary key column index

Returns number
Inherited from UserMappingTable.getPkColumnIndex
- Defined in lib/user/userTable.ts:245

getPkColumnName

getPkColumnName(): string
Get the primary key column name

Returns
primary key column name

Returns string
Inherited from UserMappingTable.getPkColumnName
- Defined in lib/user/userTable.ts:263

getRelatedIdColumn

getRelatedIdColumn(): UserColumn
Get the related id column

Returns

Returns UserColumn
Inherited from UserMappingTable.getRelatedIdColumn
- Defined in lib/extension/related/userMappingTable.ts:27

getRequiredColumns

getRequiredColumns(): string[]
Get the required columns

Returns
required columns

Returns string[]
Inherited from UserMappingTable.getRequiredColumns
- Defined in lib/user/custom/userCustomTable.ts:108

getTableName

getTableName(): string
Get the table name

Returns
table name

Returns string
Inherited from UserMappingTable.getTableName
- Defined in lib/user/userTable.ts:217

getUserColumns

getUserColumns(): UserCustomColumns
Get user columns

Returns

Returns UserCustomColumns
Inherited from UserMappingTable.getUserColumns
- Defined in lib/user/custom/userCustomTable.ts:99

hasColumn

hasColumn(columnName: string): boolean
Check if the table has the column

Returns
true if has the column
Parameters
- columnName: string
  
  column name
Returns boolean
Inherited from UserMappingTable.hasColumn
- Defined in lib/user/userTable.ts:199

hasConstraints

hasConstraints(): boolean
Check if has constraints

Returns
true if has constraints

Returns boolean
Inherited from UserMappingTable.hasConstraints
- Defined in lib/user/userTable.ts:302

hasConstraintsForType

hasConstraintsForType(type: ConstraintType): boolean
Check if has constraints of the provided type

Returns
true if has constraints
Parameters
- type: ConstraintType
  
  constraint type
Returns boolean
Inherited from UserMappingTable.hasConstraintsForType
- Defined in lib/user/userTable.ts:313

hasPkColumn

hasPkColumn(): boolean
Check if the table has a primary key column

Returns
true if has a primary key

Returns boolean
Inherited from UserMappingTable.hasPkColumn
- Defined in lib/user/userTable.ts:236

isPkModifiable

isPkModifiable(): boolean
Is the primary key modifiable

Returns
true if the primary key is modifiable

Returns boolean
Inherited from UserMappingTable.isPkModifiable
- Defined in lib/user/userTable.ts:403

isValueValidation

isValueValidation(): boolean
Is value validation against column types enabled

Returns
true if values are validated against column types

Returns boolean
Inherited from UserMappingTable.isValueValidation
- Defined in lib/user/userTable.ts:422

renameColumn

renameColumn(column: UserCustomColumn, newColumnName: string): void
Rename a column
Parameters
- column: UserCustomColumn
  
  column
- newColumnName: string
  
  new column name
Returns void
Inherited from UserMappingTable.renameColumn
- Defined in lib/user/userTable.ts:454

renameColumnWithIndex

renameColumnWithIndex(index: number, newColumnName: string): void
Rename a column
Parameters
- index: number
  
  column index
- newColumnName: string
  
  new column name
Returns void
Inherited from UserMappingTable.renameColumnWithIndex
- Defined in lib/user/userTable.ts:478

renameColumnWithName

renameColumnWithName(columnName: string, newColumnName: string): void
Rename a column
Parameters
- columnName: string
  
  column name
- newColumnName: string
  
  new column name
Returns void
Inherited from UserMappingTable.renameColumnWithName
- Defined in lib/user/userTable.ts:466

setContents

setContents(contents: Contents): void
Set the contents
Parameters
- contents: Contents
  
  contents
Returns void
Inherited from UserMappingTable.setContents
- Defined in lib/user/userTable.ts:383

setPkModifiable

setPkModifiable(pkModifiable: boolean): void
Set if the primary key can be modified
Parameters
- pkModifiable: boolean
  
  primary key modifiable flag
Returns void
Inherited from UserMappingTable.setPkModifiable
- Defined in lib/user/userTable.ts:413

setTableName

setTableName(tableName: string): void
Set the table name
Parameters
- tableName: string
  
  table name
Returns void
Inherited from UserMappingTable.setTableName
- Defined in lib/user/userTable.ts:227

setValueValidation

setValueValidation(valueValidation: boolean): void
Set if values should validated against column types
Parameters
- valueValidation: boolean
  
  value validation flag
Returns void
Inherited from UserMappingTable.setValueValidation
- Defined in lib/user/userTable.ts:432

`Protected` validateContents

validateContents(contents: Contents): void
Validate that the set contents are valid
Parameters
- contents: Contents
  
  contents
Returns void
Inherited from UserMappingTable.validateContents
- Defined in lib/user/userTable.ts:396

`Static` create

create(tableName: string): StyleMappingTable
Creates a user mapping table with the minimum required columns followed by the additional columns

Returns
Parameters
- tableName: string
  
  name of the table
Returns StyleMappingTable
Overrides UserMappingTable.create
- Defined in lib/extension/nga/style/styleMappingTable.ts:31

`Static` createBaseIdColumn

createBaseIdColumn(): UserColumn
Create the base id column

Returns

Returns UserColumn
Inherited from UserMappingTable.createBaseIdColumn
- Defined in lib/extension/related/userMappingTable.ts:72

`Static` createBaseIdColumnWithIndex

createBaseIdColumnWithIndex(index: number): UserColumn
Create the base id column

Returns
Parameters
- index: number
  
  index of the column
Returns UserColumn
Inherited from UserMappingTable.createBaseIdColumnWithIndex
- Defined in lib/extension/related/userMappingTable.ts:80

`Static` createColumns

createColumns(): UserCustomColumn[]
Create the columns

Returns

Returns UserCustomColumn[]
- Defined in lib/extension/nga/style/styleMappingTable.ts:38

`Static` createRelatedIdColumn

createRelatedIdColumn(): UserColumn
Create the related id column

Returns

Returns UserColumn
Inherited from UserMappingTable.createRelatedIdColumn
- Defined in lib/extension/related/userMappingTable.ts:92

`Static` createRelatedIdColumnWithIndex

createRelatedIdColumnWithIndex(index?: number): UserColumn
Create the related id column

Returns
Parameters
- Optional index: number
  
  index of the column
Returns UserColumn
Inherited from UserMappingTable.createRelatedIdColumnWithIndex
- Defined in lib/extension/related/userMappingTable.ts:100

`Static` createRequiredColumns

createRequiredColumns(): UserColumn[]
Create the required columns

Returns

Returns UserColumn[]
Inherited from UserMappingTable.createRequiredColumns
- Defined in lib/extension/related/userMappingTable.ts:54

`Static` createRequiredColumnsWithIndex

createRequiredColumnsWithIndex(startingIndex??: number): UserColumn[]
Create the required columns with starting column index

Returns
Parameters
- Optional startingIndex: number = 0
  
  starting index of the required columns
Returns UserColumn[]
Inherited from UserMappingTable.createRequiredColumnsWithIndex
- Defined in lib/extension/related/userMappingTable.ts:62

`Static` numRequiredColumns

numRequiredColumns(): number
Get the number of required columns

Returns

Returns number
Inherited from UserMappingTable.numRequiredColumns
- Defined in lib/extension/related/userMappingTable.ts:47

`Static` requiredColumns

requiredColumns(): string[]
Get the required columns

Returns

Returns string[]
Inherited from UserMappingTable.requiredColumns
- Defined in lib/extension/related/userMappingTable.ts:112

Class StyleMappingTable

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

tableName: string

columns: UserCustomTable[]

Returns StyleMappingTable

Parameters

tableName: string

columns: UserCustomColumn[]

requiredColumns: string[]

Returns StyleMappingTable

Parameters

columns: UserCustomColumns

Returns StyleMappingTable

Parameters

userCustomTable: UserCustomTable

Returns StyleMappingTable

Properties

columns

constraints

contents

Static Readonly COLUMN_BASE_ID

Static Readonly COLUMN_GEOMETRY_TYPE_NAME

Static Readonly COLUMN_RELATED_ID

Static DEFAULT_AUTOINCREMENT

Static DEFAULT_PK_NOT_NULL

Methods

addColumn

Parameters

column: UserCustomColumn

Returns void

addConstraint

Parameters

constraint: Constraint

Returns void

addConstraints

Parameters

constraints: Constraint[]

Returns void

addConstraintsWithConstraints

Parameters

constraints: Constraints

Returns void

alterColumn

Parameters

column: UserCustomColumn

Returns void

clearConstraints

Returns

Returns Constraint[]

clearConstraintsByType

Returns

Parameters

type: ConstraintType

Returns Constraint[]

columnCount

Returns

Returns number

columnsOfType

Returns

Parameters

type: GeoPackageDataType

Returns UserCustomColumn[]

copy

Returns

Returns UserCustomTable

createUserColumns

Parameters

columns: UserCustomColumn[]

Returns UserColumns<UserCustomColumn>

createUserColumnsFromColumnNames

Returns

Parameters

columnNames: string[]

`Static` `Readonly` COLUMN_BASE_ID

`Static` `Readonly` COLUMN_GEOMETRY_TYPE_NAME

`Static` `Readonly` COLUMN_RELATED_ID

`Static` DEFAULT_AUTOINCREMENT

`Static` DEFAULT_PK_NOT_NULL

`Protected` getDataTypeOrDefault