| DataDictionaryTable Class |
[This is preliminary documentation and is subject to change.]
Meta-data for one table in data dictionary
(corresponding to one physical database table)
Inheritance HierarchySystemObject
CSC.SC.TOPICA4.DynamicDataDataDictionaryTable
CSC.SC.TOPICA4.DynamicDataDataDictionaryTable
Namespace: CSC.SC.TOPICA4.DynamicData
Assembly: CSC.SC.TOPICA4.DynamicData (in CSC.SC.TOPICA4.DynamicData.dll) Version: 4.30.6239.27195
SyntaxC#
public class DataDictionaryTable : IEvaluatable
The DataDictionaryTable type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DataDictionaryTable(DataDictionary, DataTable) |
Construct DataDictionaryTable from DataTable
|
| DataDictionaryTable(Database, DataRow, DataDictionary) |
Construct DataDictionaryTable by reading from database
|
Methods| Name | Description | |
|---|---|---|
| AddExternalRelation | |
| AddField(DataDictionary, DataDictionaryField) |
Add field
|
| AddField(DataDictionary, DataDictionaryField, Boolean, String, String, Boolean, NullableInt32, NullableDouble, String, NullableInt32, Boolean) |
Add field (constructed from parameters)
|
| AddField(DataDictionary, DataDictionaryField, Boolean, String, String, Boolean, NullableInt32, NullableDouble, String, NullableInt32, Boolean, ProgressCollection, String) |
Add field (constructed from parameters)
|
| AddFields |
Add collection of fields
|
| AddTableField |
Add DataDictionaryTableField
|
| AsString |
String representation
|
| CacheAdd |
Add object to cache
|
| CacheClear |
Clear cache
|
| CacheGet |
Get object from cache
|
| CheckForCompatibility |
Checks for compatibility.
|
| CheckTable |
Compare actual database tables to this DataDictionaryTable (in RAM only - no metadata in database!)
|
| CountFieldsByCaption |
Get # fields matching caption |
| DebugPrint |
Debug print
|
| DebugPrint(String) |
Debug print
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Evaluate |
Ealuate a TOPICA basic 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.) |
| FindFieldByFieldName |
Find field by field name
|
| FindFieldDateStart |
Find DateStart field
|
| FindFieldDateStop |
Returns datadictionaryfield containing dateStop
|
| FindFieldsByCaption |
Find all fields matching caption |
| GetAncestorTables |
Get all tables that are ancestors to this
|
| GetAncestorTableSelect |
Get the (closest) ancestor table where OrgUnitRelation == OrgUnitRelation.Select
|
| GetChildArrayTables |
Get child tables that are created for ArrayTable template items
|
| GetChildRelations |
Get all child relations, i.e. relations where this is parent.
|
| GetChildRelations(Boolean, Boolean) |
Get all child relations, i.e. relations where this is parent.
Optionally skip hidden realtions/tabls and/or relation to property form.
|
| GetChildTables |
Get all tables referred by child relations.
|
| GetChildTables(Boolean) |
Get tables referred by child relations - optionally onlye those with 1:1 cardinality
|
| GetChildTablesNotHidden |
Get all tables referred by child relations.
|
| GetComputation |
Get the computation with name = parameter name |
| GetComputationExpression |
Get the computation with name = parameter name |
| GetDescendantTables |
Get all tables that are descendants to this, optionally only those with 1:1 relation
|
| GetEnabledComputation |
Get the enabled computation with name = parameter name |
| GetExternalRelationsByTable |
Get external relations by table
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetOrgUnitInherited |
????
|
| GetOrgUnitRelations |
Get relations to table OrgUnit
|
| GetParentRelations |
Get all parent relations, i.e. relations where this is child
|
| GetParentTable |
Get parent table
|
| GetParentTables |
Get all tables referred by parent relations
|
| GetPhraseFields |
Get all fields in this table, that have phrases enabled
|
| GetSQL |
Returns SQL-statement based on supplied whereClause and orderBy
|
| GetSQLAll |
Returns SQL-statement to select all records from database
|
| GetTextAreaFields |
Get all fields in this table of type TexArea (or RichTextArea)
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsDefaultForm |
Compute whether this table is marked as DefaultForm
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SetComputation |
Set the computation with name = parameter name to expression |
| ToString |
String representation - for debugging etc.
(Overrides ObjectToString.) |
Properties| Name | Description | |
|---|---|---|
 | AccessModeDenied |
Get/set access mode for handling data, where read access is denied (show or not...)
|
| AccessModeDeniedCheckInherited |
Get access mode for handling data, where read access is denied - check inherited
|
| AccessModeRead |
Get/set access mode for read operations
|
| AccessModeReadCheckInherited |
Get access mode for read operations - check inherited
|
| AccessModeWrite |
Access mode for write operations
|
| AccessModeWriteCheckInherited |
Get access mode for write operations - check inherited
|
| Approve |
Get/set Approve: specifies whether objects of this type must be approved
|
| AugmentedView |
Get set field that specifies whether this table should generate "augmented view"
|
| AutoCreate |
Get/set AutoCreate - deciding whether instances of this table should
be created automatically when parent table is created.
|
| Caption |
Display name
|
| Closable |
Get/set "closable" status - "close" checkbox only visible when Closable is true
|
| ComputationCount |
Return # of computations
|
| Computations |
Get/set collection of computations
|
| CreateOrgUnitList |
Generate one "create" command per legal data owner (use with caution!)
|
| CustomQueries |
Gets/sets customQueryCollection
|
| DataDictionary |
Get the DataDictionary this table is member of
|
| DataTable |
Get DataTable (including columns for history only)
|
| DataTableWithHistory |
Get DataTableWithHistory (including columns for history only)
|
| DataTableWithoutHistory |
Get DataTableWithoutHistory (excluding columns for history only)
|
| DefaultForm |
This form will be opened by default when creating (opening?) new patient
|
| DefaultLastPreviousPrompt |
Prompt for using data from last previous record
|
| DefaultLastPreviousSource |
Use data from last previous record as default value
|
| Description |
Internal description of table
|
| DraftMode |
Get/set "draft mode"
|
| ExternalRelationCollection |
Get ExternalRelationCollection
|
| ExternalRelationCount |
# of external relations
|
| FieldCount |
Number of fields in this table
|
| Filename |
Get/set Filename
|
| FlatView |
Get set field that specifies whether this table should generate "flat view"
|
| GenerateSQL |
true : generates table in database
false: does NOT generate table in database (used for root only)
|
| Hidden |
Hidden, i.e. table exists in database, but hidden in user interface
|
| HistoryTableName |
Get HistoryTableName : Name of history table
|
| ImageClosed |
Gets/Sets imageclosed
|
| ImageComplete |
Gets/sets imageComplete
|
| ImageFile |
Image file used for icon in user interface (tree view etc.)
|
| ImageIncomplete |
Gets/sets imageIncomplete
|
| ImagePlanned |
Gets/sets ImagePlanned
|
| IsArrayTable |
Is this DataDictionaryTable an ArrayTable
|
| IsRoot |
Table is root in hierarchy
|
| IsShared |
Data in this tables is shared among 2 or more forms
|
| Link |
Link (e.g. URL) to external description of table
|
| MergeByFieldName |
If set, use this field for merging:
- get value of this field
- lookup existing record having same value
- if lookup record found, use it in further merge of subrecords,
- otherwise create new record (by copying source record).
|
| MergeNewestFieldName |
In case of merge conflict (e.g. 1:1 relation on destination patient already contains record),
and merge conflict handling status (ConflictSurvivor) is "newest",
the field specified in this property is used to determine which record is newest.
Default value: use "lasted touched" date/time (create or updated date/time).
When specified the value must refer to a DateTime field in the current table!
|
| MergePatientLevel |
When merging with lookup by field name MergeByFieldName,
default behavior is to look up only in current parent record.
Set this property to true to lookup in all records (in requested table) on patient.
|
| OrgUnitConfigure |
true : table kan be configured (enabled) for each org. unit
|
| OrgUnitRelation |
Specifies how rows in this table are related to org.unit (= data owner)
|
| OrgUnitRelationFixed |
Get OrgUnitRelationFixed :
true : old relation system, where each table has 1 hardcoded relation to OrgUnit
false : new external relation systems - all external relations configurable
|
| PatientAccessMode |
Patient access mode
|
| PatientAccessModeCheckInherited |
Gets/sets PatientsAccessMode
|
| Plan |
Get/set Plan: specifies whether objects of this type may be planned
|
| Searchable |
Get/set "searchable" status
|
| SequenceNumber |
Sequence number - used to maintain sequence of tables
(necessary in order to drop tables in correct order when using referential integrity)
|
| SingleOpen | Obsolete.
Get/set "single open status" - if true, it is impossible to create new instance,
if open instance exist in current context.
|
| SingleOpenMode |
Get/set "single open mode"
|
| SortByField |
Field name used for sorting in user interface
|
| SortDescending |
Sort ascending (false) or descending (true)
|
| StructureType |
Type of structure element / table
|
| TableFieldCollection |
Relations to fields
|
| TableName |
Get TableName - name of table in database
|
| ViewName |
Get/Set ViewName (optional - if blank use autogenerated name)
|
See Also