Class ExtendedRelation

Describes the relationships between a base table, a related data table, and a mapping table

Hierarchy

ExtendedRelation

Constructors

constructor

new ExtendedRelation(): ExtendedRelation
Default Constructor

Returns ExtendedRelation
- Defined in lib/extension/related/extendedRelation.ts:86
new ExtendedRelation(extendedRelation: ExtendedRelation): ExtendedRelation
Copy Constructor
Parameters
- extendedRelation: ExtendedRelation
  
  extended relation to copy
Returns ExtendedRelation
- Defined in lib/extension/related/extendedRelation.ts:92

Properties

`Static` `Readonly` COLUMN_BASE_PRIMARY_COLUMN

COLUMN_BASE_PRIMARY_COLUMN: "base_primary_column" = 'base_primary_column'

base_primary_column field name

`Static` `Readonly` COLUMN_BASE_TABLE_NAME

COLUMN_BASE_TABLE_NAME: "base_table_name" = 'base_table_name'

base_table_name field name

`Static` `Readonly` COLUMN_ID

COLUMN_ID: "id" = 'id'

id field name

`Static` `Readonly` COLUMN_MAPPING_TABLE_NAME

COLUMN_MAPPING_TABLE_NAME: "mapping_table_name" = 'mapping_table_name'

mapping_table_name field name

`Static` `Readonly` COLUMN_RELATED_PRIMARY_COLUMN

COLUMN_RELATED_PRIMARY_COLUMN: "related_primary_column" = 'related_primary_column'

related_primary_column field name

`Static` `Readonly` COLUMN_RELATED_TABLE_NAME

COLUMN_RELATED_TABLE_NAME: "related_table_name" = 'related_table_name'

related_table_name field name

`Static` `Readonly` COLUMN_RELATION_NAME

COLUMN_RELATION_NAME: "relation_name" = 'relation_name'

relation_name field name

`Static` `Readonly` TABLE_NAME

TABLE_NAME: "gpkgext_relations" = 'gpkgext_relations'

Table name

Methods

getBasePrimaryColumn

getBasePrimaryColumn(): string
Getter

Returns
the name of the primary column of the base table

Returns string
- Defined in lib/extension/related/extendedRelation.ts:161

getBaseTableName

getBaseTableName(): string
Getter

Returns
the base table name

Returns string
- Defined in lib/extension/related/extendedRelation.ts:142

getId

getId(): number
Getter

Returns
the id

Returns number
- Defined in lib/extension/related/extendedRelation.ts:116

getMappingTableName

getMappingTableName(): string
Getter

Returns
the mapping table name

Returns string
- Defined in lib/extension/related/extendedRelation.ts:246

getRelatedPrimaryColumn

getRelatedPrimaryColumn(): string
Getter

Returns
the name of the primary column of the related table

Returns string
- Defined in lib/extension/related/extendedRelation.ts:199

getRelatedTableName

getRelatedTableName(): string
Getter

Returns
the name of the related table

Returns string
- Defined in lib/extension/related/extendedRelation.ts:180

getRelationName

getRelationName(): string
Getter

Returns
the relation name

Returns string
- Defined in lib/extension/related/extendedRelation.ts:218

getRelationType

getRelationType(): RelationType
Get the relation type for pre-known types

Returns
relation type or null

Returns RelationType
- Defined in lib/extension/related/extendedRelation.ts:227

resetId

resetId(): void
Reset the id so the row can be inserted as new

Returns void
- Defined in lib/extension/related/extendedRelation.ts:133

setBasePrimaryColumn

setBasePrimaryColumn(basePrimaryColumn: string): void
Setter
Parameters
- basePrimaryColumn: string
  
  base primary column
Returns void
- Defined in lib/extension/related/extendedRelation.ts:171

setBaseTableName

setBaseTableName(baseTableName: string): void
Setter
Parameters
- baseTableName: string
  
  base table name
Returns void
- Defined in lib/extension/related/extendedRelation.ts:152

setId

setId(id: number): void
Setter
Parameters
- id: number
  
  id
Returns void
- Defined in lib/extension/related/extendedRelation.ts:126

setMappingTableName

setMappingTableName(mappingTableName: string): void
Setter
Parameters
- mappingTableName: string
  
  mapping table name
Returns void
- Defined in lib/extension/related/extendedRelation.ts:256

setRelatedPrimaryColumn

setRelatedPrimaryColumn(relatedPrimaryColumn: string): void
Setter
Parameters
- relatedPrimaryColumn: string
  
  related primary column
Returns void
- Defined in lib/extension/related/extendedRelation.ts:209

setRelatedTableName

setRelatedTableName(relatedTableName: string): void
Setter
Parameters
- relatedTableName: string
  
  related table name
Returns void
- Defined in lib/extension/related/extendedRelation.ts:190

setRelationName

setRelationName(relationName: string): void
Setter
Parameters
- relationName: string
  
  relation name
Returns void
- Defined in lib/extension/related/extendedRelation.ts:237

Class ExtendedRelation

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ExtendedRelation

Parameters

extendedRelation: ExtendedRelation

Returns ExtendedRelation

Properties

Static Readonly COLUMN_BASE_PRIMARY_COLUMN

Static Readonly COLUMN_BASE_TABLE_NAME

Static Readonly COLUMN_ID

Static Readonly COLUMN_MAPPING_TABLE_NAME

Static Readonly COLUMN_RELATED_PRIMARY_COLUMN

Static Readonly COLUMN_RELATED_TABLE_NAME

Static Readonly COLUMN_RELATION_NAME

Static Readonly TABLE_NAME

Methods

getBasePrimaryColumn

Returns

Returns string

getBaseTableName

Returns

Returns string

getId

Returns

Returns number

getMappingTableName

Returns

Returns string

getRelatedPrimaryColumn

Returns

Returns string

getRelatedTableName

Returns

Returns string

getRelationName

Returns

Returns string

getRelationType

Returns

Returns RelationType

resetId

Returns void

setBasePrimaryColumn

Parameters

basePrimaryColumn: string

Returns void

setBaseTableName

Parameters

baseTableName: string

Returns void

setId

Parameters

id: number

Returns void

setMappingTableName

Parameters

mappingTableName: string

Returns void

setRelatedPrimaryColumn

Parameters

relatedPrimaryColumn: string

Returns void

setRelatedTableName

Parameters

relatedTableName: string

Returns void

setRelationName

Parameters

relationName: string

Returns void

Settings

Member Visibility

Theme

`Static` `Readonly` COLUMN_BASE_PRIMARY_COLUMN

`Static` `Readonly` COLUMN_BASE_TABLE_NAME

`Static` `Readonly` COLUMN_ID

`Static` `Readonly` COLUMN_MAPPING_TABLE_NAME

`Static` `Readonly` COLUMN_RELATED_PRIMARY_COLUMN

`Static` `Readonly` COLUMN_RELATED_TABLE_NAME

`Static` `Readonly` COLUMN_RELATION_NAME

`Static` `Readonly` TABLE_NAME