TDADataTableReference

Overview

The TDADataTableReference class represents the single server-side data table (TDADataTable class) or dataset (TDataSet class) that will be published by the server alongside the Data Tables defined in the Schema.

The collection of TDADataTableReference items is used in the DataAbstract service (TDataAbstractService object); the main aim of this collection is to allow the DataAbstract service to hold and publish data that does not necessarily come from the back-end database targeted by the schema and connection, but also from other sources (from a different database, loaded from a file on disk, or manually filled from code).

You do not need to use the TDADataTableReference class directly, but you can use the collection of TDADataTableReference items in the specified DataAbstract service.

Location


 

constructor Create  reintroduce

Creates a new instance.

constructor Create(aCollection: TDADataTableReferenceCollection)

Parameters:

Assign  override

Copies data from a given source.

procedure Assign(Source: TPersistent)

Parameters:

  • Source: Instance whose properties will be copied

Dataset

Represents the dataset that is related with the current TDADataTableReference object. This property is read-only.

This value can be changed by using the DataTable property. When the DataTable is set to the specified dataset, the Dataset property is autimatically set to the same dataset.

property Dataset: IDADataset read

DataTable

Represents the data table that is related with the current TDADataTableReference object. If the DataTable property is set to the specified dataset, not only the current property, but also the Dataset and LogicalName properties are automatically set. Otherwise, only the current DataTable property is set.

property DataTable: TComponent read write

GetDisplayName  protected override

Virtual protected function that returns the display name in LogicalName (Table.Name) format if the DataTable property is assigned or returns the value <No Reference> if the DataTable property is not assigned.

function GetDisplayName: string

IsValidReference

Represents the boolean value that defines whether the current reference data table is valid (value true) or not (value false). If the DataTable property is not assigned, the IsValidReference property is false, otherwise true. This property is read-only.

property IsValidReference: Boolean read

LogicalName

Defines the name of the data table. This name will be used to identify the table when retrieving data from or applying changes back to the server, and it will typically match the name of the table defined in the server-side schema.

property LogicalName: string read write

ReferenceCollection

Represents the collection of reference data tables that is the owner of the current TDADataTableReference item. This property is read-only.

property ReferenceCollection: TDADataTableReferenceCollection read

 

Dataset

Represents the dataset that is related with the current TDADataTableReference object. This property is read-only.

This value can be changed by using the DataTable property. When the DataTable is set to the specified dataset, the Dataset property is autimatically set to the same dataset.

property Dataset: IDADataset read

DataTable

Represents the data table that is related with the current TDADataTableReference object. If the DataTable property is set to the specified dataset, not only the current property, but also the Dataset and LogicalName properties are automatically set. Otherwise, only the current DataTable property is set.

property DataTable: TComponent read write

IsValidReference

Represents the boolean value that defines whether the current reference data table is valid (value true) or not (value false). If the DataTable property is not assigned, the IsValidReference property is false, otherwise true. This property is read-only.

property IsValidReference: Boolean read

LogicalName

Defines the name of the data table. This name will be used to identify the table when retrieving data from or applying changes back to the server, and it will typically match the name of the table defined in the server-side schema.

property LogicalName: string read write

ReferenceCollection

Represents the collection of reference data tables that is the owner of the current TDADataTableReference item. This property is read-only.

property ReferenceCollection: TDADataTableReferenceCollection read

 

constructor Create  reintroduce

Creates a new instance.

constructor Create(aCollection: TDADataTableReferenceCollection)

Parameters:

Assign  override

Copies data from a given source.

procedure Assign(Source: TPersistent)

Parameters:

  • Source: Instance whose properties will be copied

GetDisplayName  protected override

Virtual protected function that returns the display name in LogicalName (Table.Name) format if the DataTable property is assigned or returns the value <No Reference> if the DataTable property is not assigned.

function GetDisplayName: string