Class FeatureColumns

UserCustomColumns

Hierarchy

UserColumns<FeatureColumn>
- FeatureColumns

Constructors

constructor

new FeatureColumns(tableName: string, geometryColumn: string, columns: FeatureColumn[], custom: boolean): FeatureColumns
Parameters
- tableName: string
- geometryColumn: string
- columns: FeatureColumn[]
- custom: boolean
Returns FeatureColumns
Overrides UserColumns.constructor
- Defined in lib/features/user/featureColumns.ts:19

Properties

geometryColumn

geometryColumn: string

Geometry column

geometryIndex

geometryIndex: number = -1

Geometry column index

Methods

addColumn

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

alterColumn

alterColumn(column: FeatureColumn): void
Alter a column
Parameters
- column: FeatureColumn
  
  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): FeatureColumn[]
Get the columns with the provided data type

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

copy

copy(): FeatureColumns
Copy the user columns

Returns
copied user columns

Returns FeatureColumns
Overrides UserColumns.copy
- Defined in lib/features/user/featureColumns.ts:25

dropColumn

dropColumn(column: FeatureColumn): void
Drop a column
Parameters
- column: FeatureColumn
  
  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): FeatureColumn
Get the column of the column name

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

getColumnForIndex

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

Returns
column
Parameters
- index: number
  
  column index
Returns FeatureColumn
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(): FeatureColumn[]
Get the list of columns

Returns
columns

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

getGeometryColumn

getGeometryColumn(): FeatureColumn
Get the geometry column

Returns
geometry column

Returns FeatureColumn
- Defined in lib/features/user/featureColumns.ts:99

getGeometryColumnName

getGeometryColumnName(): string
Get the geometry column name

Returns
geometry column name

Returns string
- Defined in lib/features/user/featureColumns.ts:59

getGeometryIndex

getGeometryIndex(): number
Get the geometry index

Returns
geometry index

Returns number
- Defined in lib/features/user/featureColumns.ts:75

getPkColumn

getPkColumn(): FeatureColumn
Get the primary key column

Returns
primary key column

Returns FeatureColumn
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

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

hasGeometryColumn

hasGeometryColumn(): boolean
Check if the table has a geometry column

Returns
true if has a geometry column

Returns boolean
- Defined in lib/features/user/featureColumns.ts:91

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

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: FeatureColumn, newColumnName: string): void
Rename a column
Parameters
- column: FeatureColumn
  
  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

setGeometryColumnName

setGeometryColumnName(geometryColumn: string): void
Set the geometry column name
Parameters
- geometryColumn: string
  
  geometry column name
Returns void
- Defined in lib/features/user/featureColumns.ts:67

setGeometryIndex

setGeometryIndex(geometryIndex: number): void
Set the geometry index
Parameters
- geometryIndex: number
  
  geometry index
Returns void
- Defined in lib/features/user/featureColumns.ts:83

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

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

typeCheck

typeCheck(expected: GeoPackageDataType, column: FeatureColumn): void
Check for the expected data type
Parameters
- expected: GeoPackageDataType
  
  expected data type
- column: FeatureColumn
  
  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/features/user/featureColumns.ts:32

Generated using TypeDoc