| DataDictionary Class |
[This is preliminary documentation and is subject to change.]
DataDictionary holds metadata about actual data model / database table structure
for the "dynamic" data.
The metadata consists of information on
tables (including descriptions)
fields (including descriptions)
enumerations : (number, string) pairs per field
relations between tables (parent / child relations, including cardinality )
Inheritance HierarchySystemObject
CSC.SC.TOPICA4.DynamicDataDataDictionary
CSC.SC.TOPICA4.DynamicDataDataDictionary
Namespace: CSC.SC.TOPICA4.DynamicData
Assembly: CSC.SC.TOPICA4.DynamicData (in CSC.SC.TOPICA4.DynamicData.dll) Version: 4.30.6239.27195
SyntaxC#
public class DataDictionary : IComputationMetaData, IEvaluatable
The DataDictionary type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DataDictionary |
Create new empty DataDictionary
|
| DataDictionary(Database) |
Create a DataDictionary from database db |
| DataDictionary(Database, DataRow) |
Create a datadictionary from database using database and datarow
|
Methods| Name | Description | |
|---|---|---|
| AddField |
Add new fields to field colelction
|
| AddNewField(String, String, String, String, DataType, Boolean) |
Add new field to fieldcollection and return it
|
| AddNewField(String, String, String, String, DataType, Int32, Boolean, Boolean, Boolean) |
Add new field to fieldcollection and return it
|
| AddNewTable |
Add new table to table collection
|
| AddRelation |
Add new relation to relationcollection and return it
|
| BuildAugmentedViews |
Generate "flat views" for tables - return number of views generated.
|
| BuildFlatViews |
Generate "flat views" for tables - return number of views generated.
|
| BuildLookUpViews |
Generate lookup views - return number of views generated.
|
| BuildOrphanViews1 |
Generate orphan views (one view per table) - return number of views generated.
|
| BuildOrphanViews2 |
Generate orphan views (one view per relation) - return number of views generated.
|
| CheckTable(Database, Boolean, DirectoryInfo, String, ProgressCollection) | Obsolete.
Compare actual database tables to this DataDictionary (in RAM only - no metadata in database!)
|
| CheckTable(Database, CommandTimeouts, Boolean, DirectoryInfo, String, ProgressCollection) |
Compare actual database tables to this DataDictionary (in RAM only - no metadata in database!)
Currently only used for very simple data dictionaries with 1 table.
|
| CreateTablesAndTriggers |
Create table(s) and optionally corresponding triggers.
History = false : Only one databse table is created per DataDictionary table.
History = true : Two databse tables are created per DataDictionary table (one for registration, and one for history) - and a trigger to automatically copy data from registration table to history table.
|
 | DBDelete |
Delete DataDictionary from database db |
| DBExists |
Check if database db contains a DataDictionary
|
| DBGet |
Get DataDictionary form database - return null it does not exist.
|
| DBInsert |
Insert into database db |
| DBLoad |
Loads data from specified database using supplied datarow into
Datatable and datafield collections
|
| DBRead |
Read from database db |
| DBUpdate |
Update the DataDictionary already in the table
|
| DebugPrint |
Print to debug listener
|
| DropTables |
Drop tables
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Evaluate |
Evaluate partical expression
|
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| FindField |
Find field by name
|
| FindRelation |
Find relation between parentTable and childTable |
| FindRelationByChildTable |
Find relation having childTable as child table
|
| FindTable |
Find table by name
|
| GetExternalRelations |
Get all external relations
|
| GetFieldsWhereDescriptionStartsWith |
Get fields where description starts with startsWith |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetOrgUnitConfigureTables |
Get tables that have 'OrgUnitConfigure' property set.
Used in datamodel >= 4.2 only!
|
| GetOrgUnitRelationTables |
Get tables that require relation to OrgUnit.
Used in datamodel >= 4.2 only!
|
| GetOrgUnitSelectTables |
Get tables that require selection of OrgUnit.
Used in datamodel >= 4.2 only!
|
| GetPhraseEnabledFields |
Get collection of phrase-enabled fields (as a DataDictionaryFieldCollection.
NB: because "phrase-enabled" is NOT stored in DataDictionary (yet), this method returns ALL text fields with size 0 -
e.g. all fields of type TextAraea and RichTextArea!
|
| GetPhraseEnabledFields(Database, String, DataType, Int32) |
Get fields where Description starts with startsWith
And DataType is Text And Fieldsize is 0 (TextAreas)
|
| GetPhraseEnabledTableFields |
Get collection of phrase-enabled fields (as a DataDictionaryTableFieldCollection.
NB: previously "phrase-enabled" was NOT stored in DataDictionary (yet).
If no phrase-enabled fields are found, return alle TextArea and RichTextArea fields.
|
| GetSearchableTables |
Get all searchable tables
|
| GetStructureTypes |
Gets the structure types.
|
| GetStructureTypesDataTable |
Gets the structure types data table.
|
| GetTablesByRelationTable |
Get all data dictionary tables that have one or more external relations to referencedTableName |
| GetTablesByStructureType |
Get all data dictionary tables with structureType |
| GetTablesWithPhraseEnabledFields |
Get collection of all tables containing one or more phrase-enabled fields.
NB: "phrase-enabled" was previously NOT stored in DataDictionary.
No tabls wiht phars-enabled fiels are found, return tables with TextArea or RichTextArea fields.
|
| GetTablesWithTextAreaFields |
Get all tables containing one or more TextArea or RichTextArea fields
|
| GetTextAreaFields |
Get all fields of type TexArea (or RichTextArea)
|
| GetTextAreaTableFields |
Get all table/fields of type TexArea (or RichTextArea)
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString |
String representation for debugging etc.
(Overrides ObjectToString.) |
| Update |
Update DataDictionary
|
| WriteStructure(TextWriter, String) |
Write contents of DataDictionary in human readable format to writer |
| WriteStructure(TextWriter, String, Int32, Int32) |
Write contents of DataDictionary in human readable format to writer |
Fields| Name | Description | |
|---|---|---|
 | GeneratedDateTime |
Get/set DataDictionary generation date/time
|
| History |
Get/set history status.
If true, maintain history tables and triggers.
|
| ReferentialIntegrity |
Get/set referential integrity status.
Not implemented yet!
|
| RequiredNotNull |
Get/set option to cotrol whether fields marked as "NotNull" generate NOT NULL option on databse fields
|
| RootKeyFieldnames |
Get/set RootKeyFieldnames
|
| RootTable |
Get/set root table
|
| Tabulator |
Constant for tabulator character as string.
TODO: move to StringLibrary.
|
| UseVarcharMax |
Controls how TextArea fields are implemented in SQL: False (default): TEXT - true: VARCHAR(MAX)
|
Properties| Name | Description | |
|---|---|---|
 | ActiveTables |
Get only active tables (those where GenerateSQL == true).
|
| DataSet |
Get Dataset
|
| FieldCollection |
Get Fieldcollection
|
| RelationCollection |
Get RelationCollection
|
| TableCollection |
Get TableCollection
|
| UseExternalRelations |
Checks whether external relations are defined
|
See Also