Class FeatureTableMetadata

Feature Table Metadata for defining table creation information

Hierarchy

UserTableMetadata<FeatureColumn>
- FeatureTableMetadata

Constructors

constructor

new FeatureTableMetadata(): FeatureTableMetadata
Constructor

Returns FeatureTableMetadata
Overrides UserTableMetadata.constructor
- Defined in lib/features/user/featureTableMetadata.ts:138
new FeatureTableMetadata(dataType: string, geometryColumns: GeometryColumns, idColumnName: string, additionalColumns: FeatureColumn[], boundingBox: BoundingBox, autoincrement: boolean): FeatureTableMetadata
Constructor
Parameters
- dataType: string
  
  data type
- geometryColumns: GeometryColumns
  
  table name
- idColumnName: string
  
  id column name
- additionalColumns: FeatureColumn[]
  
  additional columns
- boundingBox: BoundingBox
  
  constraints
- autoincrement: boolean
  
  autoincrement ids
Returns FeatureTableMetadata
Overrides UserTableMetadata<FeatureColumn>.constructor
- Defined in lib/features/user/featureTableMetadata.ts:150

Properties

`Protected` additionalColumns

additionalColumns: FeatureColumn[]

Additional table columns

`Protected` autoincrement

autoincrement: boolean = UserTable.DEFAULT_AUTOINCREMENT

ID autoincrement flag

`Protected` boundingBox

boundingBox: BoundingBox

Bounding box

`Protected` columns

columns: FeatureColumn[]

Table columns

`Protected` dataType

dataType: string

Data type

`Protected` geometryColumns

geometryColumns: GeometryColumns

Geometry columns

`Protected` idColumnName

idColumnName: string

ID column name

`Protected` tableName

tableName: string

Table name

`Static` `Readonly` DEFAULT_COLUMN_NAME

DEFAULT_COLUMN_NAME: "geometry" = 'geometry'

Default geometry column name

`Static` `Readonly` DEFAULT_DATA_TYPE

DEFAULT_DATA_TYPE: string = ...

Default data type

`Static` `Readonly` DEFAULT_GEOMETRY_TYPE

DEFAULT_GEOMETRY_TYPE: GEOMETRY = GeometryType.GEOMETRY

Default geometry type

Methods

buildColumns

buildColumns(): FeatureColumn[]
Build the table columns

Returns
table columns

Returns FeatureColumn[]
Overrides UserTableMetadata.buildColumns
- Defined in lib/features/user/featureTableMetadata.ts:184

getAdditionalColumns

getAdditionalColumns(): FeatureColumn[]
Get the additional table columns

Returns
columns

Returns FeatureColumn[]
Inherited from UserTableMetadata.getAdditionalColumns
- Defined in lib/user/userTableMetadata.ts:143

getBoundingBox

getBoundingBox(): BoundingBox
Get the bounding box

Returns
bounding box

Returns BoundingBox
- Defined in lib/features/user/featureTableMetadata.ts:220

getColumnName

getColumnName(): string
Get the column name

Returns
column name

Returns string
- Defined in lib/features/user/featureTableMetadata.ts:255

getColumns

getColumns(): FeatureColumn[]
Get the table columns

Returns
columns

Returns FeatureColumn[]
Inherited from UserTableMetadata.getColumns
- Defined in lib/user/userTableMetadata.ts:162

getDataType

getDataType(): string
Get the data type

Returns
data type

Returns string
Inherited from UserTableMetadata.getDataType
- Defined in lib/user/userTableMetadata.ts:86

getDefaultDataType

getDefaultDataType(): string
Get the default data type

Returns
default data type

Returns string
Overrides UserTableMetadata.getDefaultDataType
- Defined in lib/features/user/featureTableMetadata.ts:177

getGeometryColumns

getGeometryColumns(): GeometryColumns
Get the geometry columns

Returns
geometry columns

Returns GeometryColumns
- Defined in lib/features/user/featureTableMetadata.ts:239

getGeometryType

getGeometryType(): GeometryType
Get the geometry typ

Returns
geometry type

Returns GeometryType
- Defined in lib/features/user/featureTableMetadata.ts:273

getIdColumnName

getIdColumnName(): string
Get the id column name

Returns
id column name

Returns string
Inherited from UserTableMetadata.getIdColumnName
- Defined in lib/user/userTableMetadata.ts:105

getTableName

getTableName(): string
Get the table name

Returns
table name

Returns string
Overrides UserTableMetadata.getTableName
- Defined in lib/features/user/featureTableMetadata.ts:201

isAutoincrement

isAutoincrement(): boolean
Is id autocincrement enabled?

Returns
autoincrement flag

Returns boolean
Inherited from UserTableMetadata.isAutoincrement
- Defined in lib/user/userTableMetadata.ts:124

setAdditionalColumns

setAdditionalColumns(additionalColumns: FeatureColumn[]): void
Set the additional table columns
Parameters
- additionalColumns: FeatureColumn[]
  
  columns
Returns void
Inherited from UserTableMetadata.setAdditionalColumns
- Defined in lib/user/userTableMetadata.ts:153

setAutoincrement

setAutoincrement(autoincrement: boolean): void
Set the id autoincrement flag
Parameters
- autoincrement: boolean
  
  autoincrement flag
Returns void
Inherited from UserTableMetadata.setAutoincrement
- Defined in lib/user/userTableMetadata.ts:134

setBoundingBox

setBoundingBox(boundingBox: BoundingBox): void
Set the bounding box
Parameters
- boundingBox: BoundingBox
  
  bounding box
Returns void
- Defined in lib/features/user/featureTableMetadata.ts:230

setColumns

setColumns(columns: FeatureColumn[]): void
Set the table columns
Parameters
- columns: FeatureColumn[]
  
  columns
Returns void
Inherited from UserTableMetadata.setColumns
- Defined in lib/user/userTableMetadata.ts:172

setDataType

setDataType(dataType: string): void
Set the data type
Parameters
- dataType: string
  
  data type
Returns void
Inherited from UserTableMetadata.setDataType
- Defined in lib/user/userTableMetadata.ts:96

setGeometryColumns

setGeometryColumns(geometryColumns: GeometryColumns): void
Set the geometry columns
Parameters
- geometryColumns: GeometryColumns
  
  geometry columns
Returns void
- Defined in lib/features/user/featureTableMetadata.ts:247

setIdColumnName

setIdColumnName(idColumnName: string): void
Set the id column name
Parameters
- idColumnName: string
  
  id column name
Returns void
Inherited from UserTableMetadata.setIdColumnName
- Defined in lib/user/userTableMetadata.ts:115

setTableName

setTableName(tableName: string): void
Set the table name
Parameters
- tableName: string
  
  table name
Returns void
Inherited from UserTableMetadata.setTableName
- Defined in lib/user/userTableMetadata.ts:77

`Static` create

create(geometryColumns: GeometryColumns, additionalColumns?: FeatureColumn[], idColumnName?: string, boundingBox?: BoundingBox, autoincrement?: boolean): FeatureTableMetadata
Create metadata
Parameters
- geometryColumns: GeometryColumns
- Optional additionalColumns: FeatureColumn[]
- Optional idColumnName: string
- Optional boundingBox: BoundingBox
- Optional autoincrement: boolean
Returns FeatureTableMetadata
- Defined in lib/features/user/featureTableMetadata.ts:36

`Static` createTyped

createTyped(dataType: string, geometryColumns: GeometryColumns, boundingBox?: BoundingBox, additionalColumns?: FeatureColumn[], idColumnName?: string, autoincrement?: boolean): FeatureTableMetadata
Create metadata
Parameters
- dataType: string
- geometryColumns: GeometryColumns
- Optional boundingBox: BoundingBox
- Optional additionalColumns: FeatureColumn[]
- Optional idColumnName: string
- Optional autoincrement: boolean
Returns FeatureTableMetadata
- Defined in lib/features/user/featureTableMetadata.ts:80

`Static` createTypedWithTable

createTypedWithTable(dataType: string, geometryColumns: GeometryColumns, table: FeatureTable, idColumnName?: string, boundingBox?: BoundingBox, autoincrement?: boolean): FeatureTableMetadata
Create metadata
Parameters
- dataType: string
- geometryColumns: GeometryColumns
- table: FeatureTable
- Optional idColumnName: string
- Optional boundingBox: BoundingBox
- autoincrement: boolean = false
Returns FeatureTableMetadata
- Defined in lib/features/user/featureTableMetadata.ts:107

`Static` createWithTable

createWithTable(geometryColumns: GeometryColumns, table: FeatureTable, idColumnName?: string, boundingBox?: BoundingBox, autoincrement?: boolean): FeatureTableMetadata
Create metadata with Table
Parameters
- geometryColumns: GeometryColumns
- table: FeatureTable
- Optional idColumnName: string
- Optional boundingBox: BoundingBox
- Optional autoincrement: boolean
Returns FeatureTableMetadata
- Defined in lib/features/user/featureTableMetadata.ts:54

Class FeatureTableMetadata

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns FeatureTableMetadata

Parameters

dataType: string

geometryColumns: GeometryColumns

idColumnName: string

additionalColumns: FeatureColumn[]

boundingBox: BoundingBox

autoincrement: boolean

Returns FeatureTableMetadata

Properties

Protected additionalColumns

Protected autoincrement

Protected boundingBox

Protected columns

Protected dataType

Protected geometryColumns

Protected idColumnName

Protected tableName

Static Readonly DEFAULT_COLUMN_NAME

Static Readonly DEFAULT_DATA_TYPE

Static Readonly DEFAULT_GEOMETRY_TYPE

Methods

buildColumns

Returns

Returns FeatureColumn[]

getAdditionalColumns

Returns

Returns FeatureColumn[]

getBoundingBox

Returns

Returns BoundingBox

getColumnName

Returns

Returns string

getColumns

Returns

Returns FeatureColumn[]

getDataType

Returns

Returns string

getDefaultDataType

Returns

Returns string

getGeometryColumns

Returns

Returns GeometryColumns

getGeometryType

Returns

Returns GeometryType

getIdColumnName

Returns

Returns string

getTableName

Returns

Returns string

isAutoincrement

Returns

Returns boolean

setAdditionalColumns

Parameters

additionalColumns: FeatureColumn[]

Returns void

setAutoincrement

Parameters

autoincrement: boolean

Returns void

setBoundingBox

Parameters

boundingBox: BoundingBox

Returns void

setColumns

Parameters

`Protected` additionalColumns

`Protected` autoincrement

`Protected` boundingBox

`Protected` columns

`Protected` dataType

`Protected` geometryColumns

`Protected` idColumnName

`Protected` tableName

`Static` `Readonly` DEFAULT_COLUMN_NAME

`Static` `Readonly` DEFAULT_DATA_TYPE

`Static` `Readonly` DEFAULT_GEOMETRY_TYPE

`Static` create

`Optional` additionalColumns: FeatureColumn[]

`Optional` idColumnName: string

`Optional` boundingBox: BoundingBox

`Optional` autoincrement: boolean

`Static` createTyped

`Optional` boundingBox: BoundingBox

`Optional` additionalColumns: FeatureColumn[]

`Optional` idColumnName: string

`Optional` autoincrement: boolean

`Static` createTypedWithTable

`Optional` idColumnName: string

`Optional` boundingBox: BoundingBox

`Static` createWithTable

`Optional` idColumnName: string

`Optional` boundingBox: BoundingBox

`Optional` autoincrement: boolean