Class TileColumns

TileColumn models columns in [user tile pyramid tables]TileTable.

Hierarchy

UserColumns<TileColumn>
- TileColumns

Index

Constructors

constructor

Properties

tileColumnIndex tileDataIndex tileRowIndex zoomLevelIndex ID TILE_COLUMN TILE_DATA TILE_ROW ZOOM_LEVEL

Constructors

constructor

new TileColumns(tableName: string, columns: TileColumn[], custom: boolean): TileColumns
Constructor
Parameters
- tableName: string
  
  table name
- columns: TileColumn[]
  
  columns
- custom: boolean
  
  custom column specification
Returns TileColumns
Overrides UserColumns.constructor
- Defined in lib/tiles/user/tileColumns.ts:60

Properties

tileColumnIndex

tileColumnIndex: number = -1

Tile column column index

tileDataIndex

tileDataIndex: number = -1

Tile data column index

tileRowIndex

tileRowIndex: number = -1

Tile row column index

zoomLevelIndex

zoomLevelIndex: number = -1

Zoom level column index

`Static` `Readonly` ID

ID: "id" = 'id'

Id column name, Requirement 52

`Static` `Readonly` TILE_COLUMN

TILE_COLUMN: "tile_column" = 'tile_column'

Tile column column name, Requirement 54

`Static` `Readonly` TILE_DATA

TILE_DATA: "tile_data" = 'tile_data'

Tile ID column name, implied requirement

`Static` `Readonly` TILE_ROW

TILE_ROW: "tile_row" = 'tile_row'

Tile row column name, Requirement 55

`Static` `Readonly` ZOOM_LEVEL

ZOOM_LEVEL: "zoom_level" = 'zoom_level'

Zoom level column name, Requirement 53

Methods

addColumn

addColumn(column: TileColumn): void
Add a new column
Parameters
- column: TileColumn
  
  new column
Returns void
Inherited from UserColumns.addColumn
- Defined in lib/user/userColumns.ts:446

alterColumn

alterColumn(column: TileColumn): void
Alter a column
Parameters
- column: TileColumn
  
  altered column
Returns void
Inherited from UserColumns.alterColumn
- Defined in lib/user/userColumns.ts:510

columnCount

columnCount(): number
Get the column count

Returns
column count

Returns number
Inherited from UserColumns.columnCount
- Defined in lib/user/userColumns.ts:361

columnsOfType

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

Returns
columns
Parameters
- type: GeoPackageDataType
  
  data type
Returns TileColumn[]
Inherited from UserColumns.columnsOfType
- Defined in lib/user/userColumns.ts:438

copy

copy(): TileColumns
Copy the user columns

Returns
copied user columns

Returns TileColumns
Overrides UserColumns.copy
- Defined in lib/tiles/user/tileColumns.ts:68

dropColumn

dropColumn(column: TileColumn): void
Drop a column
Parameters
- column: TileColumn
  
  column to drop
Returns void
Inherited from UserColumns.dropColumn
- Defined in lib/user/userColumns.ts:484

dropColumnWithIndex

dropColumnWithIndex(index: number): void
Drop a column
Parameters
- index: number
  
  column index
Returns void
Inherited from UserColumns.dropColumnWithIndex
- Defined in lib/user/userColumns.ts:500

dropColumnWithName

dropColumnWithName(columnName: string): void
Drop a column
Parameters
- columnName: string
  
  column name
Returns void
Inherited from UserColumns.dropColumnWithName
- Defined in lib/user/userColumns.ts:492

duplicateCheck

duplicateCheck(index: number, previousIndex: number, column: string): void
Check for duplicate column names
Parameters
- index: number
  
  index
- previousIndex: number
  
  previous index
- column: string
  
  column
Returns void
Inherited from UserColumns.duplicateCheck
- Defined in lib/user/userColumns.ts:225

getColumn

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

Returns
column
Parameters
- columnName: string
  
  column name
Returns TileColumn
Inherited from UserColumns.getColumn
- Defined in lib/user/userColumns.ts:344

getColumnForIndex

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

Returns
column
Parameters
- index: number
  
  column index
Returns TileColumn
Inherited from UserColumns.getColumnForIndex
- Defined in lib/user/userColumns.ts:335

getColumnIndex

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

Returns
column index
Parameters
- columnName: string
  
  column name
- required: boolean
  
  column existence is required
Returns number
Inherited from UserColumns.getColumnIndex
- Defined in lib/user/userColumns.ts:287

getColumnIndexForColumnName

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

Returns
column index
Parameters
- columnName: string
  
  column name
Returns number
Inherited from UserColumns.getColumnIndexForColumnName
- Defined in lib/user/userColumns.ts:277

getColumnName

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

Returns
column name
Parameters
- index: number
  
  column index
Returns string
Inherited from UserColumns.getColumnName
- Defined in lib/user/userColumns.ts:318

getColumnNames

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

Returns
column names

Returns string[]
Inherited from UserColumns.getColumnNames
- Defined in lib/user/userColumns.ts:309

getColumns

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

Returns
columns

Returns TileColumn[]
Inherited from UserColumns.getColumns
- Defined in lib/user/userColumns.ts:326

getPkColumn

getPkColumn(): TileColumn
Get the primary key column

Returns
primary key column

Returns TileColumn
Inherited from UserColumns.getPkColumn
- Defined in lib/user/userColumns.ts:417

getPkColumnIndex

getPkColumnIndex(): number
Get the primary key column index

Returns
primary key column index

Returns number
Inherited from UserColumns.getPkColumnIndex
- Defined in lib/user/userColumns.ts:409

getPkColumnName

getPkColumnName(): string
Get the primary key column name

Returns
primary key column name

Returns string
Inherited from UserColumns.getPkColumnName
- Defined in lib/user/userColumns.ts:429

getTableName

getTableName(): string
Get the table name

Returns
table name

Returns string
Inherited from UserColumns.getTableName
- Defined in lib/user/userColumns.ts:369

getTileColumnColumn

getTileColumnColumn(): TileColumn
Get the tile column column

Returns
tile column column

Returns TileColumn
- Defined in lib/tiles/user/tileColumns.ts:187

getTileColumnIndex

getTileColumnIndex(): number
Get the tile column index

Returns
tile column index

Returns number
- Defined in lib/tiles/user/tileColumns.ts:161

getTileDataColumn

getTileDataColumn(): TileColumn
Get the tile data column

Returns
tile data column

Returns TileColumn
- Defined in lib/tiles/user/tileColumns.ts:260

getTileDataIndex

getTileDataIndex(): number
Get the tile data index

Returns
tile data index

Returns number
- Defined in lib/tiles/user/tileColumns.ts:235

getTileRowColumn

getTileRowColumn(): TileColumn
Get the tile row column

Returns
tile row column

Returns TileColumn
- Defined in lib/tiles/user/tileColumns.ts:223

getTileRowIndex

getTileRowIndex(): number
Get the tile row index

Returns
tile row index

Returns number
- Defined in lib/tiles/user/tileColumns.ts:199

getZoomLevelColumn

getZoomLevelColumn(): TileColumn
Get the zoom level column

Returns
zoom level column

Returns TileColumn
- Defined in lib/tiles/user/tileColumns.ts:149

getZoomLevelIndex

getZoomLevelIndex(): number
Get the zoom level index

Returns
zoom level index

Returns number
- Defined in lib/tiles/user/tileColumns.ts:125

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 UserColumns.hasColumn
- Defined in lib/user/userColumns.ts:353

hasPkColumn

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

Returns
true if has a primary key

Returns boolean
Inherited from UserColumns.hasPkColumn
- Defined in lib/user/userColumns.ts:401

hasTileColumnColumn

hasTileColumnColumn(): boolean
Check if has a tile column column

Returns
true if has a tile column column

Returns boolean
- Defined in lib/tiles/user/tileColumns.ts:179

hasTileDataColumn

hasTileDataColumn(): boolean
Check if has a tile data column

Returns
true if has a tile data column

Returns boolean
- Defined in lib/tiles/user/tileColumns.ts:251

hasTileRowColumn

hasTileRowColumn(): boolean
Check if has a tile row column

Returns
true if has a tile row column

Returns boolean
- Defined in lib/tiles/user/tileColumns.ts:215

hasZoomLevelColumn

hasZoomLevelColumn(): boolean
Check if has a zoom level column

Returns
true if has a zoom level column

Returns boolean
- Defined in lib/tiles/user/tileColumns.ts:141

isCustom

isCustom(): boolean
Is custom column specification (partial and/or ordering)

Returns
custom flag

Returns boolean
Inherited from UserColumns.isCustom
- Defined in lib/user/userColumns.ts:385

isPkModifiable

isPkModifiable(): boolean
Is the primary key modifiable

Returns
true if the primary key is modifiable

Returns boolean
Inherited from UserColumns.isPkModifiable
- Defined in lib/user/userColumns.ts:185

isValueValidation

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

Returns
true if values are validated against column types

Returns boolean
Inherited from UserColumns.isValueValidation
- Defined in lib/user/userColumns.ts:204

missingCheck

missingCheck(index: number, column: string): void
Check for missing columns
Parameters
- index: number
  
  column index
- column: string
  
  user column
Returns void
Inherited from UserColumns.missingCheck
- Defined in lib/user/userColumns.ts:266

renameColumn

renameColumn(column: TileColumn, newColumnName: string): void
Rename a column
Parameters
- column: TileColumn
  
  column
- newColumnName: string
  
  new column name
Returns void
Inherited from UserColumns.renameColumn
- Defined in lib/user/userColumns.ts:456

renameColumnWithIndex

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

renameColumnWithName

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

setCustom

setCustom(custom: boolean): void
Set the custom column specification flag
Parameters
- custom: boolean
  
  custom flag
Returns void
Inherited from UserColumns.setCustom
- Defined in lib/user/userColumns.ts:393

setPkModifiable

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

setTableName

setTableName(tableName: string): void
Set the table name
Parameters
- tableName: string
  
  table name
Returns void
Inherited from UserColumns.setTableName
- Defined in lib/user/userColumns.ts:377

setTileColumnIndex

setTileColumnIndex(tileColumnIndex: number): void
Set the tile column index
Parameters
- tileColumnIndex: number
  
  tile column index
Returns void
- Defined in lib/tiles/user/tileColumns.ts:171

setTileDataIndex

setTileDataIndex(tileDataIndex: number): void
Set the tile data index
Parameters
- tileDataIndex: number
  
  tile data index
Returns void
- Defined in lib/tiles/user/tileColumns.ts:243

setTileRowIndex

setTileRowIndex(tileRowIndex: number): void
Set the tile row index
Parameters
- tileRowIndex: number
  
  tile row index
Returns void
- Defined in lib/tiles/user/tileColumns.ts:207

setValueValidation

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

setZoomLevelIndex

setZoomLevelIndex(zoomLevelIndex: number): void
Set the zoom level index
Parameters
- zoomLevelIndex: number
  
  zoom level index
Returns void
- Defined in lib/tiles/user/tileColumns.ts:133

typeCheck

typeCheck(expected: GeoPackageDataType, column: TileColumn): void
Check for the expected data type
Parameters
- expected: GeoPackageDataType
  
  expected data type
- column: TileColumn
  
  user column
Returns void
Inherited from UserColumns.typeCheck
- Defined in lib/user/userColumns.ts:245

updateColumns

updateColumns(): void
Update the table columns

Returns void
Overrides UserColumns.updateColumns
- Defined in lib/tiles/user/tileColumns.ts:80

Class TileColumns

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

tableName: string

columns: TileColumn[]

custom: boolean

Returns TileColumns

Properties

tileColumnIndex

tileDataIndex

tileRowIndex

zoomLevelIndex

Static Readonly ID

Static Readonly TILE_COLUMN

Static Readonly TILE_DATA

Static Readonly TILE_ROW

Static Readonly ZOOM_LEVEL

Methods

addColumn

Parameters

column: TileColumn

Returns void

alterColumn

Parameters

column: TileColumn

Returns void

columnCount

Returns

Returns number

columnsOfType

Returns

Parameters

type: GeoPackageDataType

Returns TileColumn[]

copy

Returns

Returns TileColumns

dropColumn

Parameters

column: TileColumn

Returns void

dropColumnWithIndex

Parameters

index: number

Returns void

dropColumnWithName

Parameters

columnName: string

Returns void

duplicateCheck

Parameters

index: number

previousIndex: number

column: string

Returns void

getColumn

Returns

Parameters

columnName: string

Returns TileColumn

getColumnForIndex

Returns

Parameters

index: number

Returns TileColumn

getColumnIndex

Returns

Parameters

columnName: string

required: boolean

Returns number

getColumnIndexForColumnName

Returns

Parameters

`Static` `Readonly` ID

`Static` `Readonly` TILE_COLUMN

`Static` `Readonly` TILE_DATA

`Static` `Readonly` TILE_ROW

`Static` `Readonly` ZOOM_LEVEL