Class SimpleAttributesTable

Simple Attributes Requirements Class User-Defined Related Data Table

Hierarchy

UserRelatedTable
- SimpleAttributesTable

Index

Constructors

constructor

new SimpleAttributesTable(tableName: string, columns: UserCustomColumn[], idColumnName?: string): SimpleAttributesTable
Constructor
Parameters
- tableName: string
  
  table name
- columns: UserCustomColumn[]
  
  list of columns
- Optional idColumnName: string
  
  id column name
Returns SimpleAttributesTable
Overrides UserRelatedTable.constructor
- Defined in lib/extension/related/simple/simpleAttributesTable.ts:23
new SimpleAttributesTable(table: UserCustomTable): SimpleAttributesTable
Constructor
Parameters
- table: UserCustomTable
  
  user custom table
Returns SimpleAttributesTable
Overrides UserRelatedTable.constructor
- Defined in lib/extension/related/simple/simpleAttributesTable.ts:29

Properties

columns

columns: UserColumns<UserCustomColumn>

Columns

constraints

constraints: Constraints = ...

Constraints

contents: Contents

Foreign key to Contents

`Static` `Readonly` COLUMN_ID

COLUMN_ID: string = '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

`Static` `Readonly` RELATION_TYPE

RELATION_TYPE: RelationType = RelationType.SIMPLE_ATTRIBUTES

Accessors

tableType

get tableType(): string
Get the table type

Returns string
Inherited from UserRelatedTable.tableType
- Defined in lib/extension/related/userRelatedTable.ts:116

Methods

addColumn

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

addConstraint

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

addConstraints

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

addConstraintsWithConstraints

addConstraintsWithConstraints(constraints: Constraints): void
Add constraints
Parameters
- constraints: Constraints
  
  constraints
Returns void
Inherited from UserRelatedTable.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 UserRelatedTable.alterColumn
- Defined in lib/user/userTable.ts:518

clearConstraints

clearConstraints(): Constraint[]
Clear the constraints

Returns
cleared constraints

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

columnCount

columnCount(): number
Get the column count

Returns
column count

Returns number
Inherited from UserRelatedTable.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 UserRelatedTable.columnsOfType
- Defined in lib/user/userTable.ts:364

copy

copy(): UserCustomTable
Copy the UserCustomTable

Returns

Returns UserCustomTable
Inherited from UserRelatedTable.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 UserRelatedTable.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 UserRelatedTable.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 UserRelatedTable.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 UserRelatedTable.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 UserRelatedTable.dropColumnWithName
- Defined in lib/user/userTable.ts:498

getColumn

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

Returns
column
Parameters
- columnName: string
  
  column name
Returns UserCustomColumn
Inherited from UserRelatedTable.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 UserRelatedTable.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 UserRelatedTable.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 UserRelatedTable.getColumnName
- Defined in lib/user/userTable.ts:149

getColumnNames

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

Returns
column names

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

getColumns

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

Returns
columns

Returns UserCustomColumn[]
Inherited from UserRelatedTable.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 UserRelatedTable.getColumnsForColumnNames
- Defined in lib/user/userTable.ts:166

getConstraints

getConstraints(): Constraints
Get the constraints

Returns
constraints

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

getContents

getContents(): Contents
Get the contents

Returns
contents

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

getDataType

getDataType(): string
Get the data type

Returns string
Inherited from UserRelatedTable.getDataType
- Defined in lib/extension/related/userRelatedTable.ts:109

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

getPkColumn

getPkColumn(): UserCustomColumn
Get the primary key column

Returns
primary key column

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

getRelationName

getRelationName(): string
Get the relation name

Returns
relation name

Returns string
Inherited from UserRelatedTable.getRelationName
- Defined in lib/extension/related/userRelatedTable.ts:102

getRequiredColumns

getRequiredColumns(): string[]
Get the required columns

Returns
required columns

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

getTableName

getTableName(): string
Get the table name

Returns
table name

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

getUserColumns

getUserColumns(): UserCustomColumns
Get user columns

Returns

Returns UserCustomColumns
Inherited from UserRelatedTable.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 UserRelatedTable.hasColumn
- Defined in lib/user/userTable.ts:199

hasConstraints

hasConstraints(): boolean
Check if has constraints

Returns
true if has constraints

Returns boolean
Inherited from UserRelatedTable.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 UserRelatedTable.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 UserRelatedTable.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 UserRelatedTable.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 UserRelatedTable.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 UserRelatedTable.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 UserRelatedTable.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 UserRelatedTable.renameColumnWithName
- Defined in lib/user/userTable.ts:466

setContents

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

validateColumns

validateColumns(): boolean
Validate that Simple Attributes columns to verify at least one non id column exists and that all columns are simple data types

Returns boolean
- Defined in lib/extension/related/simple/simpleAttributesTable.ts:59

`Protected` validateContents

validateContents(contents: Contents): void
Validate that the set contents are valid
Parameters
- contents: Contents
  
  contents
Returns void
Inherited from UserRelatedTable.validateContents
- Defined in lib/extension/related/userRelatedTable.ts:123

`Static` create

create(tableName: string, additionalColumns?: UserColumn[]): SimpleAttributesTable
Create a simple attributes table with the columns

Returns
Parameters
- tableName: string
  
  name of the table
- Optional additionalColumns: UserColumn[]
  
  additional columns
Returns SimpleAttributesTable
- Defined in lib/extension/related/simple/simpleAttributesTable.ts:82

`Static` createIdColumn

createIdColumn(idColumnName: string, autoincrement?: boolean): UserColumn
Create the primary key id column

Returns
Parameters
- idColumnName: string
  
  name of the id column
- Optional autoincrement: boolean
Returns UserColumn
- Defined in lib/extension/related/simple/simpleAttributesTable.ts:148

`Static` createIdColumnWithIndex

createIdColumnWithIndex(index: number, idColumnName: string, autoincrement?: boolean): UserColumn
Create the primary key id column with a specified column index

Returns
Parameters
- index: number
  
  index of the column
- idColumnName: string
  
  name of the id column
- Optional autoincrement: boolean
Returns UserColumn
- Defined in lib/extension/related/simple/simpleAttributesTable.ts:159

`Static` createRequiredColumns

createRequiredColumns(idColumnName??: string, autoincrement?: boolean): UserColumn[]
Create the required columns

Returns
Parameters
- Optional idColumnName: string = SimpleAttributesTable.COLUMN_ID
  
  id column name
- Optional autoincrement: boolean
Returns UserColumn[]
- Defined in lib/extension/related/simple/simpleAttributesTable.ts:138

`Static` createRequiredColumnsWithIndex

createRequiredColumnsWithIndex(startingIndex??: number, idColumnName??: string, autoincrement?: boolean): UserColumn[]
Create the required columns with a specified starting column index

Returns
Parameters
- Optional startingIndex: number = 0
  
  starting index of the required columns
- Optional idColumnName: string = SimpleAttributesTable.COLUMN_ID
  
  id column name
- Optional autoincrement: boolean
Returns UserColumn[]
- Defined in lib/extension/related/simple/simpleAttributesTable.ts:124

`Static` createWithMetadata

createWithMetadata(metadata: SimpleAttributesTableMetadata): SimpleAttributesTable
Create a simple attributes table with the metadata

Returns
simple attributes table
Parameters
- metadata: SimpleAttributesTableMetadata
  
  simple attributes table metadata
Returns SimpleAttributesTable
- Defined in lib/extension/related/simple/simpleAttributesTable.ts:95

`Static` isSimple

isSimple(column: UserColumn): boolean
Determine if the column is a simple column

Returns
Parameters
- column: UserColumn
  
  column to check
Returns boolean
- Defined in lib/extension/related/simple/simpleAttributesTable.ts:168

`Static` isSimpleDataType

isSimpleDataType(dataType: GeoPackageDataType): boolean
Determine if the data type is a simple type: TEXT, INTEGER, or REAL

Returns
Parameters
- dataType: GeoPackageDataType
Returns boolean
- Defined in lib/extension/related/simple/simpleAttributesTable.ts:176

`Static` numRequiredColumns

numRequiredColumns(): number
Get the number of required columns

Returns

Returns number
- Defined in lib/extension/related/simple/simpleAttributesTable.ts:113

`Static` requiredColumns

requiredColumns(idColumnName??: string): string[]
Get the required columns

Returns
Parameters
- Optional idColumnName: string = SimpleAttributesTable.COLUMN_ID
  
  id column name
Returns string[]
- Defined in lib/extension/related/simple/simpleAttributesTable.ts:104

Class SimpleAttributesTable

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

tableName: string

columns: UserCustomColumn[]

Optional idColumnName: string

Returns SimpleAttributesTable

Parameters

table: UserCustomTable

Returns SimpleAttributesTable

Properties

columns

constraints

contents

Static Readonly COLUMN_ID

Static DEFAULT_AUTOINCREMENT

Static DEFAULT_PK_NOT_NULL

Static Readonly RELATION_TYPE

Accessors

tableType

Returns string

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[]

Returns UserColumns<UserCustomColumn>

dropColumn

Parameters

column: UserCustomColumn

`Optional` idColumnName: string

`Static` `Readonly` COLUMN_ID

`Static` DEFAULT_AUTOINCREMENT

`Static` DEFAULT_PK_NOT_NULL

`Static` `Readonly` RELATION_TYPE

`Protected` getDataTypeOrDefault