|
The data dictionary is part of the documentation of the information model. It contains a list of table or entity names, an overview list of entities with attributes, and a list of detailed description of most attributes. The overview table is largely identical with the documentation which Microsoft Access would provide if a table is opened in design mode |
Appendix 3: Table of Contents
Main table of contents
Table names: Most of the project data reside in a set of 9 tables (see also the
overviews of
X_CHAR | definition of characters themselves, |
|
X_CHAR_Heading | definition of character headings (including item subheadings, identification groups), |
|
X_CHAR | definition of characters themselves, |
|
X_CS | definition of character states, |
|
X_MOD | the basic, project wide definition of modifiers, |
|
X_DEP | list of characters dependent of controlling character state, |
|
X_ITEM | item definition, esp. names, |
|
X_DESCR | descriptions/data for each item, and |
|
X_RSC | definition of media resources, esp. illustrations for characters, character states, or items |
Link tables: A few additional tables provide links in the case of n:m relations.
These are necessary for technical purposes of the information model alone:
X_CHAR_Heading_Link | definition of character groups for identification, each character may be member of several identification headings |
|
X_MOD_Link | the character specific association between modifiers and characters |
Accessory tables: (some are not always present)
X_PROPERTY | Project wide information, like author, copyright, import file/date, see Editing project properties |
|
X_ID_DESCR | Exists only after project is compiled for identification; special version of X_DESCR |
|
X_ID_TXT, |
Like X_ID_DESCR above; contain word-wise index for text (TXT attribute of _DESCR) and Notes, respectively |
|
X_CHAR_Subset |
Exists only for character subsets.: CIDs defining the subset |
List of entities and attributes
The following table contains the entities of the information model and their attributes. For further information not present in this overview (e.g. default value, lookup definition, validation rules) you can open the tables in design mode in Microsoft Access.
_ITEM |
Name |
Type |
Size |
Description |
Attributes |
IID |
Number (Long) |
4 |
Item ID |
ItemName |
Text |
255 |
Name or description of item (incl. taxon authors if necessary), link to taxonomic subsystem |
|
Notes |
Memo |
- |
Item notes |
|
Abundance |
Number (Single) |
4 |
Abundance, relative importance (or weight) of item, 1-10, default is 5 |
|
CollUnit |
Text |
255 |
Unit code in specimen collection, link into collection subsystem. NOT DEFINED IN DELTA! |
|
LitRef |
Text |
255 |
Literature reference (user-readable text form). NOT DEFINED IN DELTA! |
|
LitKey |
Number (Long) |
4 |
Literature reference (numeric link into literature reference subsystem). NOT DEFINED IN DELTA! |
|
LitRefDetail |
Text |
255 |
Reference detail, like page(s) of interest, specific figures, etc. |
|
Indexes |
Abundance |
Abundance, Ascending |
||
CollUnit |
CollUnit, Ascending |
Ignore Nulls |
||
IID |
IID, Ascending |
Primary key |
||
ItemName |
ItemName, Asc. |
|||
LitKey |
LitKey, Ascending |
Ignore Nulls |
||
LitRef |
LitRef, Ascending |
Ignore Nulls |
||
_DESCR |
Name |
Type |
Size |
Description |
Attributes |
IID |
Number (Long) |
4 |
Item ID |
CID |
Number (Integer) |
2 |
Character ID |
|
CS |
Text |
16 |
Character state of characters with defined character states |
|
Modifier |
Text |
255 |
Modifier phrase for categorical or numerical data, e.g. "mostly", "usually", "rarely" |
|
X |
Number (Double) |
8 |
Numeric value, defined by CS |
|
TXT |
Memo |
- |
Text data |
|
Notes |
Memo |
- |
Internal notes |
|
SEQ |
Number (Long) |
4 |
Sequence of character states for the item |
|
Indexes |
CID |
CID, Ascending |
||
CS |
CS, Ascending |
|||
IID |
IID, Ascending |
Primary key |
||
SEQ |
SEQ, Ascending |
|||
X |
X, Ascending |
Ignore Nulls |
||
_RSC |
Name |
Type |
Size |
Description |
Attributes |
IID |
Number (Long) |
4 |
ID of associated item (optional) |
CID |
Number (Integer) |
2 |
ID of associated character (optional) |
|
CS |
Text |
16 |
ID of associated character state (set to U or TE for text characters if resource belongs to char. in general) |
|
Resource |
Text |
255 |
Filename of illustration (photo/drawing/graph) or other media resources. See _HEADING properties MediaDefaultPath/MediaDefaultURL to set global paths |
|
Caption |
Memo |
- |
Caption for the resource, e.g. a text to display while showing an illustration or a video |
|
Notes |
Memo |
- |
Internal notes (perhaps also formatting commands for IntKey) |
|
ItemDefault |
Yes/No |
1 |
This image is a default image for the whole item, regardless of character association |
|
CharDefault |
Yes/No |
1 |
This image is a default image for the whole character, regardless of character state association |
|
MID |
AutoNumber (Long) |
Media ID (necessary, because either IID or CID may be missing) |
||
Indexes |
IID |
IID, Ascending |
Ignore Nulls |
|
CID |
CID, Ascending |
Ignore Nulls |
||
CS |
CS, Ascending |
Ignore Nulls |
||
Resource |
Resource, Asc. |
|||
MID |
MID, Ascending |
Primary key |
||
_CHAR |
Name |
Type |
Size |
Description |
Attributes |
CID |
Number (Integer) |
2 |
Character ID |
CharName |
Text |
255 |
Name or description of character |
|
Unit |
Text |
255 |
If the character is textual or numeric, an optional measurement unit may be given here |
|
Notes |
Memo |
- |
Character notes |
|
Type |
Text |
2 |
Type of character: Text, Ordered/unordered multistate, Integer/Real numeric, Picture/Illustration |
|
Mandatory |
Yes/No |
1 |
Setting this character is mandatory (required) |
|
MultiStateType |
Number (Byte) |
1 |
Are multiple states allowed and how are they interpreted? |
|
Reliability |
Number (Single) |
4 |
Reliability (or weight) of character for identification, 1-10, default is 5 |
|
Availability |
Number (Single) |
4 |
Availability (or accessibility) of character for identification, 1-10, default is 5. This is an extension to the Delta standard. |
|
Fuzziness |
Number (Single) |
4 |
For identification: Item descriptions where only a single value (e.g. mean) is given are converted to ranges using this value (RN/IN/OM only) |
|
Fuzziness IsPercent |
Yes/No |
1 |
'Fuzziness' is a percent value (e.g. Fuzziness=10 -> Range=mean +/- 10% instead of +/- 10) |
|
KeyStates |
Text |
255 |
For use in a key: combine multistate char, into new combinations or define ranges for numeric char. |
|
NumStates |
Number (Integer) |
2 |
Number of states for this character, default is 2 |
|
CharPhrase |
Text |
255 |
Wording to be used instead of CharName for natural language descriptions output, incl. special Delta formatting |
|
FormatString |
Text |
255 |
Define the formatting, esp. for numeric values (number of decimal places etc.). Standard Access formatting string |
|
OmitValues |
Text |
1 |
Natural language descript.: Omit lower ('-') or upper ('+') part of numeric character ranges |
|
NewParagraph |
Yes/No |
1 |
Natural language descript.: A new paragraph is inserted, starting with this character |
|
OmitFinal Comma |
Yes/No |
1 |
Natural language descript.: The final comma between character states is omitted ('1,2 and 3' instead of '1,2, and 3') |
|
SemicolonTo Comma |
Yes/No |
1 |
Natural language descript.: Linked characters in one char. group are separated by comma instead of semicolon |
|
CharHeading |
Number (Integer) |
2 |
Select a heading from picklist; inserted in char. def. output in front of the current character |
|
ItemSubheading |
Number (Integer) |
2 |
Select a heading from picklist; inserted in natural language descriptions in front of descriptions using this character |
|
LinkGroup |
Number (Long) |
4 |
Define linked characters, natural language output of each char. group occurs in single sentence |
|
Indexes |
CID |
CID, Ascending |
Primary key |
|
CharName |
CharName, Ascending |
Unique (= candidate key) |
||
Reliability |
Reliability, Ascending |
|||
Type |
Type, Ascending |
|||
CharHeading |
CharHeading, Asc. |
Ignore Nulls |
||
ItemSubheading |
ItemSubheading,Asc. |
Ignore Nulls |
||
LinkGroup |
LinkGroup, Asc. |
Ignore Nulls |
||
NumStates |
NumStates, Asc. |
[* necessity of index should be reevaluated! *] |
||
_CHAR _HEADING |
Name |
Type |
Size |
Description |
Attributes |
HID |
Number (Integer) |
2 |
Character heading ID; determines sequence of headings when used in identification; change number to change that sequence! |
HeadingName |
Text |
255 |
Heading name, used for CharHeadings and Named character groups (identification) |
|
HeadingPhrase |
Text |
255 |
Optional phrase; preferred over HeadingName as ItemSubheading in natural language output. |
|
Notes |
Memo |
- |
Internal notes (not exported to Delta format) |
|
AutoGroup |
Text |
255 |
Empty for user defined headings; else special code which is recognized during identification or a SQL query returning a set of character IDs. HeadingName may be changed as needed. |
|
Indexes |
HID |
HID, Ascending |
Primary key |
|
HeadingName |
HeadingName, Asc. |
Unique (= candidate key) |
||
_CHAR _HEADING _Link |
Name |
Type |
Size |
Description |
Attributes |
HID |
Number (Integer) |
2 |
Character heading ID to be linked |
CID |
Number (Integer) |
2 |
Character ID to which the identification heading is applicable |
|
Indexes |
HID |
HID, Ascending |
Primary key |
|
CID |
CID, Ascending |
|||
_CS |
Name |
Type |
Size |
Description |
Attributes |
CID |
Number (Integer) |
2 |
Character ID |
CS |
Text |
16 |
Character state code, usually positive integer number, special codes for variable/unknown and for statistics |
|
CharStateName |
Text |
255 |
Name or description of character state |
|
Notes |
Memo |
- |
Character state notes |
|
Implicit |
Yes/No |
1 |
Mark this state as a default which is automatically set |
|
CharStatePhrase |
Text |
255 |
Wording to be used instead of CharStateName for natural language descriptions output, incl. special Delta formatting |
|
Indexes |
CharStateName |
CharStateName,Asc. |
||
CID |
CID, Ascending |
|||
CS |
CS, Ascending |
|||
_DEP |
Name |
Type |
Size |
Description |
Attributes |
CID |
Number (Integer) |
2 |
Controlling character ID |
CS |
Text |
16 |
Controlling character state |
|
InapplicableCID |
Number (Integer) |
2 |
Dependent character, i.e. inapplicable for any item where CID/CS combination above is used |
|
Indexes |
CID |
CID, Ascending |
Primary key |
|
InapplicableCID |
InapplicableCID,Asc. |
|||
_Property |
Name |
Type |
Size |
Description |
Attributes |
PropertyName |
Text |
255 |
The name of the project property (do not change!) |
TextValue |
Memo |
- |
Text information. Use Shift F2 to zoom into larger window! |
|
DateTimeValue |
Date/Time |
8 |
Date or time information, e.g. of last update |
|
NumericValue |
Number (Double) |
8 |
Numerical information, stored as real number |
|
Indexes |
PropertyName |
PropertyName, Asc. |
Primary key |
|
NumericValue |
NumericValue, Asc. |
Ignore Nulls |
||
_ID_Descr |
Name |
Type |
Size |
Description |
Attributes |
IID |
Number (Long) |
4 |
Item ID |
CID |
Number (Integer) |
2 |
Character ID |
|
CS |
Text |
16 |
Character state of characters with defined character states |
|
X |
Number (Double) |
8 |
Numeric value, defined by CS |
|
Reliability |
Number (Byte) |
1 |
Combines character and modifier reliability |
|
Indexes |
IID |
IID, Ascending |
||
CID |
CID, Ascending |
Primary key |
||
X |
X, Ascending |
|||
Name |
Type |
Size |
Description |
|
Attributes |
CID |
Number (Integer) |
2 |
Character ID of character which is mapped for identification purposes |
MappedCS |
Text |
16 |
Mapped character state code; positive integer number |
|
MappedName |
Text |
255 |
Name or description of mapped character state (= 'KeyState') |
|
Notes |
Memo |
- |
Internal notes |
|
MinValue |
Number (Double) |
8 |
Numeric characters: The lowest value of X to be mapped to this state |
|
MaxValue |
Number (Double) |
8 |
Numeric characters: The highest value of X to be mapped to this state |
|
Indexes |
CharStateName |
MappedName, Asc. |
||
CID |
CID, Ascending |
Primary key |
||
CS |
MappedCS, Asc. |
|||
Name |
Type |
Size |
Description |
|
Attributes |
CID |
Number (Integer) |
2 |
Character ID |
CSMapped |
Text |
16 |
Character state code in _MAP |
|
CS |
Text |
16 |
Character state code in _CS |
|
Indexes |
CID |
CID, Ascending |
Primary key |
|
_MOD |
Name |
Type |
Size |
Description |
Attributes |
Usage |
Text |
255 |
Type of characters for which the modifier is applicable, e.g. GENERAL. COLORS, FREQuency of occurrence |
Modifier |
Text |
255 |
Modifier phrase for categorical or numerical data, e.g. "mostly", "usually", "rarely". In current language! |
|
Reliability |
Number (Byte) |
1 |
Influence of modifier on data coded through categorical/numerical char. states. More (>5) or less reliable (<5); 5 is default |
|
Postfix |
Yes/No |
1 |
Checked = output after the character state phrase, unchecked = in front of it |
|
UseBlank |
Yes/No |
1 |
Checked = blank is added between the modifier phrase and the item data text, else modifier added compress |
|
Operator |
Number (Byte) |
1 |
Checked = The normal operator is omitted when such a modifier is encountered, e.g. for "TO" |
|
Notes |
Text |
255 |
Internal notes |
|
Indexes |
Modifier |
Modifier, Ascending |
Primary key |
|
Usage |
Usage, Ascending |
|||
_MOD_Link |
Name |
Type |
Size |
Description |
Attributes |
CID |
Number (Integer) |
2 |
Character ID to which the modifier is applicable |
Modifier |
Text |
255 |
Modifier phrase for categorical or numerical data, e.g. "mostly", "usually", "rarely" |
|
Indexes |
CID |
CID, Ascending |
||
Modifier |
Modifier, Ascending |
Primary key |
Appendix 3: Table of Contents
Main table of contents
Next