Class TileTable

TileTable models tile pyramid user tables.

Hierarchy

UserTable<TileColumn>
- TileTable

Index

Constructors

Properties

columns constraints contents COLUMN_ID COLUMN_TILE_COLUMN COLUMN_TILE_DATA COLUMN_TILE_ROW COLUMN_ZOOM_LEVEL DEFAULT_AUTOINCREMENT DEFAULT_PK_NOT_NULL

Methods

addColumn addConstraint addConstraints addConstraintsWithConstraints alterColumn clearConstraints clearConstraintsByType columnCount columnsOfType copy createUserColumns createUserColumnsFromColumnNames dropColumn dropColumnWithIndex dropColumnWithName getColumn getColumnForIndex getColumnIndex getColumnName getColumnNames getColumns getColumnsForColumnNames getConstraints getConstraintsByType getContents getDataType getDataTypeOrDefault getPkColumn getPkColumnIndex getPkColumnName getTableName getTileColumnColumn getTileColumnColumnIndex getTileDataColumn getTileDataColumnIndex getTileRowColumn getTileRowColumnIndex getUserColumns getZoomLevelColumn getZoomLevelColumnIndex hasColumn hasConstraints hasConstraintsForType hasPkColumn isPkModifiable isValueValidation renameColumn renameColumnWithIndex renameColumnWithName setContents setPkModifiable setTableName setValueValidation validateContents createRequiredColumns

Constructors

constructor

new TileTable(tableName: string, columns: TileColumn[]): TileTable
Constructor
Parameters
- tableName: string
  
  table name
- columns: TileColumn[]
  
  columns
Returns TileTable
Overrides UserTable.constructor
- Defined in lib/tiles/user/tileTable.ts:44

Properties

columns

columns: UserColumns<TileColumn>

Columns

constraints

constraints: Constraints = ...

Constraints

contents: Contents

Foreign key to Contents

`Static` COLUMN_ID

COLUMN_ID: string = TileColumns.ID

Id column name, Requirement 52

`Static` COLUMN_TILE_COLUMN

COLUMN_TILE_COLUMN: string = TileColumns.TILE_COLUMN

Tile column column name, Requirement 54

`Static` COLUMN_TILE_DATA

COLUMN_TILE_DATA: string = TileColumns.TILE_DATA

Tile ID column name, implied requirement

`Static` COLUMN_TILE_ROW

COLUMN_TILE_ROW: string = TileColumns.TILE_ROW

Tile row column name, Requirement 55

`Static` COLUMN_ZOOM_LEVEL

COLUMN_ZOOM_LEVEL: string = TileColumns.ZOOM_LEVEL

Zoom level column name, Requirement 53

`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: TileColumn): void
Add a new column
Parameters
- column: TileColumn
  
  new column
Returns void
Inherited from UserTable.addColumn
- Defined in lib/user/userTable.ts:442

addConstraint

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

addConstraints

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

addConstraintsWithConstraints

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

alterColumn

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

clearConstraints

clearConstraints(): Constraint[]
Clear the constraints

Returns
cleared constraints

Returns Constraint[]
Inherited from UserTable.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 UserTable.clearConstraintsByType
- Defined in lib/user/userTable.ts:353

columnCount

columnCount(): number
Get the column count

Returns
column count

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

columnsOfType

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

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

copy

copy(): TileTable
Copy the table

Returns
copied table

Returns TileTable
Overrides UserTable.copy
- Defined in lib/tiles/user/tileTable.ts:60

createUserColumns

createUserColumns(columns: TileColumn[]): TileColumns
Create user columns for a subset of table columns

Returns
user columns
Parameters
- columns: TileColumn[]
  
  columns
Returns TileColumns
Overrides UserTable.createUserColumns
- Defined in lib/tiles/user/tileTable.ts:81

createUserColumnsFromColumnNames

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

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

dropColumn

dropColumn(column: TileColumn): void
Drop a column
Parameters
- column: TileColumn
  
  column to drop
Returns void
Inherited from UserTable.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 UserTable.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 UserTable.dropColumnWithName
- Defined in lib/user/userTable.ts:498

getColumn

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

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

getColumnForIndex

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

Returns
column
Parameters
- index: number
  
  column index
Returns TileColumn
Inherited from UserTable.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 UserTable.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 UserTable.getColumnName
- Defined in lib/user/userTable.ts:149

getColumnNames

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

Returns
column names

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

getColumns

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

Returns
columns

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

getColumnsForColumnNames

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

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

getConstraints

getConstraints(): Constraints
Get the constraints

Returns
constraints

Returns Constraints
Inherited from UserTable.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 UserTable.getConstraintsByType
- Defined in lib/user/userTable.ts:333

getContents

getContents(): Contents
Get the contents

Returns
contents

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

getDataType

getDataType(): string
Get the contents data type

Returns
data type

Returns string
Overrides UserTable.getDataType
- Defined in lib/tiles/user/tileTable.ts:67

`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 UserTable.getDataTypeOrDefault
- Defined in lib/user/userTable.ts:92

getPkColumn

getPkColumn(): TileColumn
Get the primary key column

Returns
primary key column

Returns TileColumn
Inherited from UserTable.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 UserTable.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 UserTable.getPkColumnName
- Defined in lib/user/userTable.ts:263

getTableName

getTableName(): string
Get the table name

Returns
table name

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

getTileColumnColumn

getTileColumnColumn(): TileColumn
Get the tile column column

Returns
tile column

Returns TileColumn
- Defined in lib/tiles/user/tileTable.ts:113

getTileColumnColumnIndex

getTileColumnColumnIndex(): number
Get the tile column column index

Returns
tile column index

Returns number
- Defined in lib/tiles/user/tileTable.ts:105

getTileDataColumn

getTileDataColumn(): TileColumn
Get the tile data column

Returns
tile column

Returns TileColumn
- Defined in lib/tiles/user/tileTable.ts:145

getTileDataColumnIndex

getTileDataColumnIndex(): number
Get the tile data column index

Returns
tile data index

Returns number
- Defined in lib/tiles/user/tileTable.ts:137

getTileRowColumn

getTileRowColumn(): TileColumn
Get the tile row column

Returns
tile column

Returns TileColumn
- Defined in lib/tiles/user/tileTable.ts:129

getTileRowColumnIndex

getTileRowColumnIndex(): number
Get the tile row column index

Returns
tile row index

Returns number
- Defined in lib/tiles/user/tileTable.ts:121

getUserColumns

getUserColumns(): TileColumns
Get the user columns

Returns
user columns

Returns TileColumns
Overrides UserTable.getUserColumns
- Defined in lib/tiles/user/tileTable.ts:74

getZoomLevelColumn

getZoomLevelColumn(): TileColumn
Get the zoom level column

Returns
tile column

Returns TileColumn
- Defined in lib/tiles/user/tileTable.ts:97

getZoomLevelColumnIndex

getZoomLevelColumnIndex(): number
Get the zoom level column index

Returns
zoom level index

Returns number
- Defined in lib/tiles/user/tileTable.ts:89

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 UserTable.hasColumn
- Defined in lib/user/userTable.ts:199

hasConstraints

hasConstraints(): boolean
Check if has constraints

Returns
true if has constraints

Returns boolean
Inherited from UserTable.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 UserTable.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 UserTable.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 UserTable.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 UserTable.isValueValidation
- Defined in lib/user/userTable.ts:422

renameColumn

renameColumn(column: TileColumn, newColumnName: string): void
Rename a column
Parameters
- column: TileColumn
  
  column
- newColumnName: string
  
  new column name
Returns void
Inherited from UserTable.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 UserTable.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 UserTable.renameColumnWithName
- Defined in lib/user/userTable.ts:466

setContents

setContents(contents: Contents): void
Set the contents
Parameters
- contents: Contents
  
  contents
Returns void
Inherited from UserTable.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 UserTable.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 UserTable.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 UserTable.setValueValidation
- Defined in lib/user/userTable.ts:432

validateContents

validateContents(contents: Contents): void
Validate that the set contents are valid
Parameters
- contents: Contents
  
  contents
Returns void
Overrides UserTable.validateContents
- Defined in lib/tiles/user/tileTable.ts:168

`Static` createRequiredColumns

createRequiredColumns(autoincrement?: boolean): TileColumn[]
Create the required table columns, starting at the provided index

Returns
tile columns
Parameters
- autoincrement: boolean = false
  
  defaults to false
Returns TileColumn[]
- Defined in lib/tiles/user/tileTable.ts:155

Class TileTable

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

tableName: string

columns: TileColumn[]

Returns TileTable

Properties

columns

constraints

contents

Static COLUMN_ID

Static COLUMN_TILE_COLUMN

Static COLUMN_TILE_DATA

Static COLUMN_TILE_ROW

Static COLUMN_ZOOM_LEVEL

Static DEFAULT_AUTOINCREMENT

Static DEFAULT_PK_NOT_NULL

Methods

addColumn

Parameters

column: TileColumn

Returns void

addConstraint

Parameters

constraint: Constraint

Returns void

addConstraints

Parameters

constraints: Constraint[]

Returns void

addConstraintsWithConstraints

Parameters

constraints: Constraints

Returns void

alterColumn

Parameters

column: TileColumn

Returns void

clearConstraints

Returns

Returns Constraint[]

clearConstraintsByType

Returns

Parameters

type: ConstraintType

Returns Constraint[]

columnCount

Returns

Returns number

columnsOfType

Returns

Parameters

type: GeoPackageDataType

Returns TileColumn[]

copy

Returns

Returns TileTable

createUserColumns

Returns

Parameters

columns: TileColumn[]

Returns TileColumns

createUserColumnsFromColumnNames

Returns

Parameters

columnNames: string[]

Returns UserColumns<TileColumn>

dropColumn

Parameters

column: TileColumn

Returns void

dropColumnWithIndex

Parameters

index: number

`Static` COLUMN_ID

`Static` COLUMN_TILE_COLUMN

`Static` COLUMN_TILE_DATA

`Static` COLUMN_TILE_ROW

`Static` COLUMN_ZOOM_LEVEL

`Static` DEFAULT_AUTOINCREMENT

`Static` DEFAULT_PK_NOT_NULL

`Protected` getDataTypeOrDefault