Class TableGroupSchema

A table group description is a JSON object that describes a group of tables.

Implements

CsvwTableGroupDescription

Index

Constructors

constructor

new TableGroupSchema(): TableGroupSchema
Returns TableGroupSchema

Properties

tables

tables: [TableSchema, ...TableSchema[]] = ...

An array property of table descriptions for the tables in the group, namely those listed in the tables annotation on the group of tables being described.

Methods

addTable

addTable(url: string, ...columns: string[]): TableSchema
Parameters
- url: string
- ...columns: string[]
Returns TableSchema
- Defined in packages/core/src/lib/rdf2csvw/schema/table-group-schema.ts:13

clone

clone(): TableGroupSchema
Returns TableGroupSchema
- Defined in packages/core/src/lib/rdf2csvw/schema/table-group-schema.ts:101

getTable

getTable(url: string): undefined | TableSchema
Parameters
- url: string
Returns undefined | TableSchema
- Defined in packages/core/src/lib/rdf2csvw/schema/table-group-schema.ts:23

lock

lock(): void
Locks the current tables, preventing them from being extended.

Returns void
- Defined in packages/core/src/lib/rdf2csvw/schema/table-group-schema.ts:113

moveTableCol

moveTableCol(fromTable: string, column: string, toTable: string): void
Parameters
- fromTable: string
- column: string
- toTable: string
Returns void
- Defined in packages/core/src/lib/rdf2csvw/schema/table-group-schema.ts:67

removeTable

removeTable(url: string): void
Parameters
- url: string
Returns void
- Defined in packages/core/src/lib/rdf2csvw/schema/table-group-schema.ts:43

removeTableCol

removeTableCol(table: string, name: string): void
Parameters
- table: string
- name: string
Returns void
- Defined in packages/core/src/lib/rdf2csvw/schema/table-group-schema.ts:62

renameTable

renameTable(oldUrl: string, newUrl: string): void
Parameters
- oldUrl: string
- newUrl: string
Returns void
- Defined in packages/core/src/lib/rdf2csvw/schema/table-group-schema.ts:27

renameTableCol

renameTableCol(table: string, name: string, newTitle: string): void
Parameters
- table: string
- name: string
- newTitle: string
Returns void
- Defined in packages/core/src/lib/rdf2csvw/schema/table-group-schema.ts:57

toDescriptor

toDescriptor(): CompactedCsvwDescriptor
Returns CompactedCsvwDescriptor
- Defined in packages/core/src/lib/rdf2csvw/schema/table-group-schema.ts:117

`Static`fromDescriptor

fromDescriptor(schema: CompactedCsvwDescriptor): TableGroupSchema
Parameters
- schema: CompactedCsvwDescriptor
Returns TableGroupSchema
- Defined in packages/core/src/lib/rdf2csvw/schema/table-group-schema.ts:126

Class TableGroupSchema

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns TableGroupSchema

Properties

tables

Methods

addTable

Parameters

Returns TableSchema

clone

Returns TableGroupSchema

getTable

Parameters

Returns undefined | TableSchema

lock

Returns void

moveTableCol

Parameters

Returns void

removeTable

Parameters

Returns void

removeTableCol

Parameters

Returns void

renameTable

Parameters

Returns void

renameTableCol

Parameters

Returns void

toDescriptor

Returns CompactedCsvwDescriptor

StaticfromDescriptor

Parameters

Returns TableGroupSchema

Settings

On This Page

`Static`fromDescriptor