DiversityDescriptions (DeltaAccess) (version 1.9):
Documentation of the information model

By Gregor Hagedorn (30. March 2005)

This document contains a complete list of all entities and attributes used in the information model of this application module. It is primarily intended as a technical reference. It can also be helpful, however, in understanding the scope and usage of certain attributes. When you have a question like 'where does this information fit in', reading the attribute description may help you.

Besides the human readable documentation provided below, three additional technical documents are provided:

Index to entities

CHAR (characters)
CHAR_Translation
CHAR_Heading
CHAR_Heading_Translation
CHAR_Heading_Link
 CS (Char. states)
CS_Translation
MOD (modifiers)
MOD_Translation
MOD_Link
DEP (dependency)
 ITEM (description header)
DESCR (description data)
RSC (resources)
PROPERTY
CurrentLanguage

See also the separate alphabetical index to attribute names.

Principal entities of DiversityDescriptions

Entity relationship diagram of DiversityDescriptions 1.9 CHAR (characters, click to show attributes) CS (character states, click to show attributes) MOD (Modifiers, click to show attributes) MOD_Link (n:m table, click to show attributes) DEP (Character dependency, click to show attributes) ITEM (description header, click to show attributes) DESCR (description records, click to show attributes)

Complete entity relationship diagram of DiversityDescriptions

Entity relationship diagram of DiversityDescriptions 1.9 CHAR (characters, click to show attributes) CS (character states, click to show attributes) MOD (Modifiers, click to show attributes) MOD_Link (n:m table, click to show attributes) DEP (Character dependency, click to show attributes) ITEM (description header, click to show attributes) DESCR (description records, click to show attributes) CHAR_Translation (click to show attributes) CHAR_Heading (click to show attributes) CHAR_Heading_Translation (click to show attributes) CHAR_Heading_Link (n:m table, click to show attributes) CS_Translation (click to show attributes) MOD_Translation (click to show attributes) RSC (resources like images, click to show attributes) PROPERTY (project metadata, click to show attributes) CurrentLanguage (click to show attributes)

(You can click on the entities to go to the attribute tables.)


CHAR

Character table.

Attributes and indices of the entity 'CHAR'
Name Type Description / Default value & validation Rqrd./Index
CID Integer Character ID number. Also currently defines the order of characters. This ID may change over time, please compare the separate CharID. R I (P)
CharName Text Short name of character.
Validation rule: Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 R I (U)
Unit Text For numeric characters: an optional measurement unit like 'mm'. Only true units here, text like 'wide' belongs to CharWording2!
Validation rule: Is Null Or Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 - -
Example
values (any
other values
may be added): 		m; dm; cm; mm; µm; kg; g; mg; µg; L; ml; µl; nl; °C; M; mM; µM; nM; pM; Mol; mMol; µMol; g/ml; Pa; hPa; bar; mbar; mm Hg; mS; µS; °; '; "; in; ft; µm2; mm2; cm2; m2; km2; µm3; mm3; cm3; m3
Notes Memo Character notes.
Validation rule: Is Null Or Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 - -
Type Text Type of character: Text, Ordered/unordered multistate, Integer/Real numeric.
Default value: "UM"; Validation rule: "UM" Or "OM" Or "IN" Or "RN" Or "TE"		 R I
Values currently
restricted to:
CODE Description
UM Unordered multistate (categorical data/nominal scale)
OM Ordered multistate (categorical data/ordinal scale)
TE Textual data
IN Integer numeric (cardinal scale)
RN Real numeric (floating point, interval scale)
Mandatory Boolean Is the scoring of this character mandatory (required) in each item?
Default value: 0		 R -
MultiStateType Byte+ Are multiple states allowed and how are they interpreted?
Default value: 1		 R I
Values currently
restricted to:
Label CODE Description
Excl.   0   states are exclusive = only a single state may be present in each item
Or   1   combine states with OR operator (DELTA: '/')
And   2   combine states with AND operator (DELTA: '&')
To   3   states intergrade, e. g. '1 to 2 or 5 to 6' (DELTA: '1-2/5-6')
To/And   4   states intergrade, e. g. '1 to 2 and 5 to 6' (DELTA: '1-2&5-6')
With   5   states are a combination, e. g. 'green with some yellow'
Reliability Single Reliability (or weight) of character for identification, 1-10.
Default value: 5; Validation rule: (>=0 And <=32) Or Is Null		 R -
Values
restricted
to:
CODE Description
0 ignore
1 very low
2 low
3 below average
4 slightly below average
5 standard (default value)
6 slightly above average
7 above average
8 high
9 very high
Availability Single Availability (or accessibility) of character for identification, 1-10. This is an extension to the Delta standard.
Default value: 5; Validation rule: Validation rule: (>=0 And <=32) Or Is Null		 R -
Values restricted to: (Identical with Reliability values above)
Fuzziness Single For identification: Unless a range is explicitly present, used to form a range around the mean (RN/IN) or state (OM).
Default value: 0		 R -
FuzzinessIsPercent Boolean Interpret 'Fuzziness' as 'percent' rather than 'absolute value' (e. g. Fuzziness=10 ® range=mean ± 10%, instead of ± 10 absolute).
Default value: 0		 R -
KeyStates Text For use in a key: combine multistate char, into new combinations or define ranges for numeric char. - I
CharHeading Integer A heading defined in the headings definition, inserted in char. def. output in front of the current character. - I (N)
HeadingLink Integer A heading defined in the headings definition, inserted in natural language descriptions in front of descriptions using this character. - I (N)
CharWording Text Natural language descript.: Wording to be used instead of CharName.
Validation rule: Is Null Or Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 - -
CharWording2 Text Natural language descript.: Wording to be used AFTER states or values + unit, e. g. 'wide' for 'leaves 3-5 mm wide'.
Validation rule: Is Null Or Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 - -
UnitIsPrefix Boolean True if unit is to be placed in front of value, e. g. to output "pH 7.2". - -
FormatString Text Default formatting for all states (compare StateFormatString). Esp. for numeric values (number of decimal places etc.). Standard Basic formatting string like "#.0". - -
Example
values (any
other values
may be added):
CODE   Description
## ##0   numerical, no decimal places, 1000 separator = blank
## ##0.0   numerical, 1 decimal place
## ##0.00   numerical, 2 decimal places
(Note: Only the first 3 rows of the pick list are displayed.)
ParagraphLink Long Natural language descript.: Define char. linked into a single paragraph. A new paragraph starts if group ID changes.
Default value: 1; Validation rule: >0 Or Is Null		 - -
SentenceLink Long Natural language descript.: Define char. linked into a single sentence. A new sentence starts if group ID changes or whenever Null.
Validation rule: >0 Or Is Null		 - -
CommaLink Long Natural language descript.: Define characters linked into a comma-enumeration ('sub-sentence'). A new group starts if group ID changes or whenever Null.
Validation rule: >0 Or Is Null		 - -
UseComma2 Boolean Natural language descript.: Use alternative comma separator between states of this character (e. g. for Chinese). - -
OmitFinalComma Boolean Natural language descript.: The final comma between character states is omitted ('1,2 and 3' instead of '1,2, and 3').
Default value: 0		 R -
OmitValues Text Natural language descript.: Omit lower ('-') or upper ('+') part of numeric character ranges.
Validation rule: Is Null Or '+' Or '-'		 - -
Values currently
restricted to:
CODE   Description
  output full range in natural language description
- omit lower range and min in natural language description
+ omit upper range and max in natural language description
Emphasize Boolean Natural language descript.: Emphasize (italic or bold print) this character in all items.
Default value: 0		 - -
OmitPeriod Boolean Natural language descript.: Omit the end delimiter (usually the period for a sentence, DELTA: 'OMIT PERIOD FOR CHAR').
Default value: 0		 - -
NumStates Integer Calculated field: Number of states other than special states U,V,- present in this character. Calculated automatically, do not edit!
Default value: 2		 R I
CharID Autonum Immutable unique number identifying a character (candidate key). Not exported to DELTA! Semantics are similar to CID, which, however, is exported to DELTA and requires renumbering after character deletions. - I (U)
Index name:  Attributes & index properties
CharHeading:  CharHeading (Duplicates OK; Ignore Nulls)
CharID:  CharID (Unique values)
CharName:  CharName (Unique values)
CID:  CID (Primary key; Unique values)
HeadingLink:  HeadingLink (Duplicates OK; Ignore Nulls)
KeyStates:  KeyStates (Duplicates OK)
MultiStateType:  MultiStateType (Duplicates OK)
NumStates:  NumStates (Duplicates OK)
Type:  Type (Duplicates OK)
Relation type:  Attributes involved
Updates cascade  CHAR_Heading.HID « CHAR.CharHeading
Updates cascade  CHAR_Heading.HID « CHAR.HeadingLink
Updates & deletions cascade  CHAR.CID « CHAR_Heading_Link.CID
Updates & deletions cascade  CHAR.CharID « CHAR_Translation.CharID
Updates & deletions cascade  CHAR.CID « CS.CID
Updates & deletions cascade  CHAR.CID « DEP.InapplicableCID
Simple relation (no integrity)  CHAR.CID « DESCR.CID
Updates & deletions cascade  CHAR.CID « MOD_Link.CID
Updates & deletions cascade  CHAR.CharID « RSC.CharID


CHAR_Translation

Character table, translations into multiple languages.

Attributes and indices of the entity 'CHAR_Translation'
Name Type Description / Default value & validation Rqrd./Index
CharID Long Character ID (unchanging version). R I(PM)
Language Text Language of the translation. R I(PM)
CharName Text Short label for character; in the current Language. R I
CharWording Text Natural language descript.: Wording to be used instead of CharName; in the current Language. - -
CharWording2 Text Natural language descript.: Wording to be used AFTER states or values + unit, e. g. 'wide' for 'leaves 3-5 mm wide'; in the current Language. - -
Unit Text For numeric characters: an optional measurement unit like 'mm'. Only true units here, text like 'wide' belongs to CharWording2! - -
UnitIsPrefix Boolean True if unit is to be placed in front of value, e. g. to output "pH 7.2". - -
Notes Memo Character Notes (for DELTA data this could be an extensive definition of the character). - -
FormatString Text Default formatting for all states (compare StateFormatString). Esp. for numeric values (number of decimal places etc.). Standard Basic formatting string like "#.0". - -
Index name:  Attributes & index properties
CharNameTranslation:  CharName (Duplicates OK)
CID:  CharID; Language (Primary key; Unique values)
Relation type:  Attributes involved
Updates & deletions cascade  CHAR.CharID « CHAR_Translation.CharID


CHAR_Heading

Character heading/Identification/HeadingLink table.

Attributes and indices of the entity 'CHAR_Heading'
Name Type Description / Default value & validation Rqrd./Index
HID Integer Character heading ID; determines sequence of headings when used in identification; change number to change that sequence!
validation message: You must use integer numbers greater than zero.		 R I (P)
HeadingName Text Heading name, used for CharHeadings and Named character groups (identification).
Validation rule: Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 R I (U)
HeadingWording Text Optional wording; preferred over HeadingName if headings for natural language descriptions are defined through the HeadingLink mechanism .
Validation rule: Is Null Or Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 - -
Notes Memo Internal notes (not exported to Delta format).
Validation rule: Is Null Or Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 - -
AutoGroup Text Empty for user defined headings; else special code which is recognized during identification or a SQL query returning a set of character IDs. (HeadingName of predefined AutoGroups may be changed!). - -
ParentHeadingID Long A hierarchy of headings can be defined in DeltaAccess by adding the higher hierarchy here. However, this is not supported by DELTA and can not be exported. - I
HeadingID Autonum Immutable unique number identifying a heading (candidate key). - I (U)
Index name:  Attributes & index properties
HeadingID:  HeadingID (Unique values)
HeadingName:  HeadingName (Unique values)
HID:  HID (Primary key; Unique values)
ParentHID:  ParentHeadingID (Duplicates OK)
Relation type:  Attributes involved
Updates & deletions cascade  CHAR_Heading.HID « CHAR_Heading_Link.HID
Updates & deletions cascade  CHAR_Heading.HeadingID « CHAR_Heading_Translation.HeadingID
Updates cascade  CHAR_Heading.HeadingID « CHAR_Heading.ParentHeadingID
Updates cascade  CHAR_Heading.HID « CHAR.CharHeading
Updates cascade  CHAR_Heading.HID « CHAR.HeadingLink


CHAR_Heading_Translation

Character headings, translations into multiple languages.

Attributes and indices of the entity 'CHAR_Heading_Translation'
Name Type Description / Default value & validation Rqrd./Index
HeadingID Long Character heading ID. R I(PM)
Language Text Language of the translation. R I(PM)
HeadingName Text Heading name, used for CharHeadings and Named character groups (identification).
Validation rule: Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 R I (U)
HeadingWording Text Optional wording; preferred over HeadingName if headings for natural language descriptions are defined through the HeadingLink mechanism .
Validation rule: Is Null Or Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 - -
Notes Memo Notes on translation.
Validation rule: Is Null Or Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 - -
Index name:  Attributes & index properties
CID:  HeadingID; Language (Primary key; Unique values)
HeadingName:  HeadingName (Unique values)
Relation type:  Attributes involved
Updates & deletions cascade  CHAR_Heading.HeadingID « CHAR_Heading_Translation.HeadingID


CHAR_Heading_Link

Character groups for Identification, Linking.

Attributes and indices of the entity 'CHAR_Heading_Link'
Name Type Description / Default value & validation Rqrd./Index
HID Integer Character heading ID to be linked.
validation message: You must use integer numbers greater than zero.		 R I(PM)
CID Integer Character ID to which the identification heading is applicable. R I/I(PM)
Index name:  Attributes & index properties
CID:  CID (Duplicates OK)
HID:  HID; CID (Primary key; Unique values)
Relation type:  Attributes involved
Updates & deletions cascade  CHAR_Heading.HID « CHAR_Heading_Link.HID
Updates & deletions cascade  CHAR.CID « CHAR_Heading_Link.CID


CS

Character states for each character.

Attributes and indices of the entity 'CS'
Name Type Description / Default value & validation Rqrd./Index
CID Integer Character ID. R I(UM)+
CS Text Character state code. Usually pos. integer number or special codes for variable/unknown and for statistics (mean etc.).
Validation rule: Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 R I/I(PM)
CharStateName Text Name or description of character state.
Validation rule: Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 R I(UM)
Notes Memo Character state notes.
Validation rule: Is Null Or Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 - -
StateWording Text Wording to be used instead of CharStateName for natural language descriptions output.
Validation rule: Is Null Or Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 - -
StateFormatString Text State specific formatting, overriding FormatString defined in the character definition. Standard Basic formatting string like "#.0". - -
Example
values (any
other values
may be added):
CODE   Description
## ##0   numerical, no decimal places, 1000 separator = blank
## ##0.0   numerical, 1 decimal place
## ##0.00   numerical, 2 decimal places
(Note: Only the first 3 rows of the pick list are displayed.)
Implicit Boolean Mark this state as a default which is automatically set.
Default value: 0		 R -
UseEdit Boolean (Not yet implemented!) Use this state during entering or updating of item descriptions.
Default value: True		 - -
UseIdentify Boolean (Not yet implemented!) Use this state during interactive identification.
Default value: True		 - -
UseDescr Boolean (Not yet implemented!) Use this state for natural language item descriptions.
Default value: True		 - -
UsePhylo Boolean (Not yet implemented!) Use this state for phylogenetic analysis.
Default value: True		 - -
UseOther Boolean (Not yet implemented!) Use this to define a character state set for user-defined purposes.
Default value: True		 - -
MinValue Double Numeric characters only: The lowest value of X in item description to be mapped to this state (inclusive).
Default value: -1E+308		 R -
MaxValue Double Numeric characters only: The highest value of X in item description to be mapped to this state (inclusive).
Default value: 1E+308		 R -
StateID Autonum Immutable unique number identifying a character state independently of the character. Not exported to DELTA! Preferred key for any external references to states not protected by cascaded referential updates. (Candidate key). - I (U)
Index name:  Attributes & index properties
CID:  CID; CS (Primary key; Unique values)
CS:  CS (Duplicates OK)
CSNameUniqueInCID:  CharStateName; CID (Unique values)
StateID:  StateID (Unique values)
Relation type:  Attributes involved
Updates & deletions cascade  CHAR.CID « CS.CID
Updates & deletions cascade  CS.StateID « CS_Translation.StateID
Updates & deletions cascade  CS.CID « DEP.CID; CS.CS « DEP.CS
Updates & deletions cascade  CS.CID « DESCR.CID; CS.CS « DESCR.CS
Updates & deletions cascade  CS.StateID « RSC.StateID


CS_Translation

Character states, translations into multiple languages.

Attributes and indices of the entity 'CS_Translation'
Name Type Description / Default value & validation Rqrd./Index
StateID Long State ID (foreign key).
Default value: 0		 R I/I(PM)
Language Text Language of the translation. R I(PM)
CharStateName Text Name or description of character state.
Validation rule: Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 R -
Notes Memo Notes on translation.
Validation rule: Is Null Or Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 - -
StateWording Text Wording to be used instead of CharStateName for natural language descriptions output.
Validation rule: Is Null Or Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 - -
Example
values (any
other values
may be added):
SELECT DISTINCTROW StateWording FROM X_CS ORDER BY StateWording  
StateFormatString Text State specific formatting, overriding FormatString defined in the character definition. Standard Basic formatting string like "#.0". - -
Example
values (any
other values
may be added):
CODE   Description
## ##0   numerical, no decimal places, 1000 separator = blank
## ##0.0   numerical, 1 decimal place
## ##0.00   numerical, 2 decimal places
(Note: Only the first 3 rows of the pick list are displayed.)
Index name:  Attributes & index properties
PrimaryKey:  StateID; Language (Primary key; Unique values)
StateID:  StateID (Duplicates OK)
Relation type:  Attributes involved
Updates & deletions cascade  CS.StateID « CS_Translation.StateID


MOD

Modifier wordings for categorical or numerical data.

Attributes and indices of the entity 'MOD'
Name Type Description / Default value & validation Rqrd./Index
Usage Text Type of characters for which the modifier is applicable, e. g. GENERAL. COLORS, FREQuency of occurrence. R I
Example
values (any
other values
may be added):
SELECT DISTINCTROW Usage FROM MOD GROUP BY Usage ORDER BY Usage  
Modifier Text Modifier wording for categorical or numerical data, e. g. "mostly", "usually", "rarely". R I (P)
Reliability Byte+ Influence of modifier on data coded through categorical/numerical char. states. More (>5) or less reliable (<5).
Default value: 5; Validation rule: Validation rule: (>=0 And <=32) Or Is Null		 R -
Values restricted to: (see list shown for CHAR.Reliability)
MisinterpretationMarker Boolean If set to true, the state to which this modifier is added is marked as being present only by misinterpretation of structure (phylloclade as leaf) or state (rough spore surface as smooth).
Default value: 0		 R -
Postfix Boolean Checked = output after the character state wording, unchecked = in front of it. R -
UseBlank Boolean Checked = blank is added between the modifier wording and the item data text, else modifier added compress.
Default value: -1		 R -
Operator Byte+ >0 = Override operator, the normal operator between states is omitted when this modifier is encountered, e. g. to insert AND where normal operator would be OR.
Default value: 0; Validation rule: (>-1 And <4) Or 5		 R -
Values restricted to:
0   NONE  
1   OR  
2   AND  
3   TO  
5   WITH  
Notes Text Internal notes. - -
LowerFreq Single The lower border of the frequency range, for freq. modifiers only.
Validation Rule: (>=0 And <=1) Or Is Null		 - -
UpperFreq Single The upper border of the frequency range, for freq. modifiers only.
Validation Rule: (>=0 And <=1) Or Is Null		 - -
Index name:  Attributes & index properties
Modifier:  Modifier (Primary key; Unique values)
Usage:  Usage (Duplicates OK)
Relation type:  Attributes involved
Updates & deletions cascade  MOD.Modifier « DESCR.Modifier
Updates & deletions cascade  MOD.Modifier « MOD_Link.Modifier
Updates & deletions cascade  MOD.Modifier « MOD_Translation.Modifier


MOD_Translation

Modifier wordings, translations into multiple languages.

Attributes and indices of the entity 'MOD_Translation'
Name Type Description / Default value & validation Rqrd./Index
Modifier Text Modifier wording. Foreign key linking to _MOD. In current language! R I(PM)
Language Text Language of the translation. R I(PM)
ModifierTranslation Text Translation of modifier wording. R -
Index name:  Attributes & index properties
Modifier:  Modifier; Language (Primary key; Unique values)
Relation type:  Attributes involved
Updates & deletions cascade  MOD.Modifier « MOD_Translation.Modifier


MOD_Link

Links between characters and modifiers.

Attributes and indices of the entity 'MOD_Link'
Name Type Description / Default value & validation Rqrd./Index
CID Integer Character ID to which the modifier is applicable. R I/I(PM)
Modifier Text Modifier wording for categorical or numerical data, e. g. "mostly", "usually", "rarely". R I(PM)
Index name:  Attributes & index properties
CID:  CID (Duplicates OK)
Modifier:  Modifier; CID (Primary key; Unique values)
Relation type:  Attributes involved
Updates & deletions cascade  CHAR.CID « MOD_Link.CID
Updates & deletions cascade  MOD.Modifier « MOD_Link.Modifier


DEP

Dependent (= inapplicable) characters for each character state.

Attributes and indices of the entity 'DEP'
Name Type Description / Default value & validation Rqrd./Index
CID Integer Controlling character ID. R I(PM)
CS Text Controlling character state. R I(PM)
InapplicableCID Integer CID of dependent character, i.e. inapplicable for any item where current CID/CS combination is used. R I/I(PM)
Index name:  Attributes & index properties
CID:  CID; CS; InapplicableCID (Primary key; Unique values)
InapplicableCID:  InapplicableCID (Duplicates OK)
Relation type:  Attributes involved
Updates & deletions cascade  CHAR.CID « DEP.InapplicableCID
Updates & deletions cascade  CS.CID « DEP.CID; CS.CS « DEP.CS


ITEM

Item or taxon table.

Attributes and indices of the entity 'ITEM'
Name Type Description / Default value & validation Rqrd./Index
IID Long Item ID. R I (P)
ItemName Text Name or description of item (incl. taxon authors if necessary), link to taxonomic subsystem.
Validation rule: Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 R I
ItemWording Text Natural language descript.: Wording to be used instead of ItemName.
Validation rule: Is Null Or Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 - -
Notes Memo Item notes.
Validation rule: Is Null Or Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 - -
Abundance Single Abundance, relative importance (or weight) of item, 1-10.
Default value: 5. Validation Rule: (>=0 And <=10) Or Is Null		 R I
Values currently
restricted to:
CODE Description
0 ignore
1 very low
2 low
3 below average
4 slightly below average
5 standard (default value)
6 slightly above average
7 above average
8 high
9 very high
CollUnit Text Unit code in specimen collection, link into collection subsystem. NOT DEFINED IN DELTA! - I (N)
LitRef Text Literature reference (user-readable text form). NOT DEFINED IN DELTA! - I (N)
LitKey Long Literature reference (numeric link into literature reference subsystem). NOT DEFINED IN DELTA! - I (N)
LitRefDetail Text Reference detail, like page(s) of interest, specific figures, etc. - -
ItemID Autonum Immutable unique number identifying an item (candidate key). Not exported to DELTA! Semantics are similar to IID, which, however, is exported to DELTA and requires renumbering after deletions. - I (U)
Index name:  Attributes & index properties
Abundance:  Abundance (Duplicates OK)
CollUnit:  CollUnit (Duplicates OK; Ignore Nulls)
IID:  IID (Primary key; Unique values)
ItemID:  ItemID (Unique values)
ItemName:  ItemName (Duplicates OK)
LitKey:  LitKey (Duplicates OK; Ignore Nulls)
LitRef:  LitRef (Duplicates OK; Ignore Nulls)
Relation type:  Attributes involved
Updates & deletions cascade  ITEM.IID « DESCR.IID
Updates & deletions cascade  ITEM.ItemID « RSC.ItemID


DESCR

Data/descriptions for each item.

Attributes and indices of the entity 'DESCR'
Name Type Description / Default value & validation Rqrd./Index
IID Long Item ID. R I/I(PM)
CID Integer Character ID. R I(PM)
Modifier Text Modifier wording for categorical or numerical data, e. g. "mostly", "usually", "rarely".
Validation rule: Is Null Or Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 - -
CS Text Character state code. Usually pos. integer number or special codes for variable/unknown and for statistics (mean etc.). R I/I(PM)
X Double Numeric value, defined by CS. - I (N)
TXT Memo Text data.
Validation rule: Is Null Or Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 - -
Notes Memo Notes and additional information, included in natural language item descriptions.
Validation rule: Is Null Or Not (Like ' %' Or Like '% ' Or Like '% %'). Validation message: Do not start or end with a blank. Do not include multiple blanks.		 - -
SEQ Long Sequence of character states for the item. - I
Table validation rule:  (Not IsNull([TXT]) And IsNull([X]) And [CS]='TE') Or (IsNull([TXT]) And (IsNull([X]) Or Not IsNull([X]) And Not IsNumeric([CS])))
Table validation text:  You may not enter data in both TXT and X, use only one of them! To enter TXT data, use CS='TE', to enter numeric data use the appropriate CS attributes.
Index name:  Attributes & index properties
CID:  CID; CS; IID (Primary key; Unique values)
CS:  CS (Duplicates OK)
IID:  IID (Duplicates OK)
SEQ:  SEQ (Duplicates OK)
X:  X (Duplicates OK; Ignore Nulls)
Relation type:  Attributes involved
Simple relation (no integrity)  CHAR.CID « DESCR.CID
Updates & deletions cascade  CS.CID « DESCR.CID; CS.CS « DESCR.CS
Updates & deletions cascade  ITEM.IID « DESCR.IID
Updates & deletions cascade  MOD.Modifier « DESCR.Modifier


RSC

External resources stored as files or URL, e. g. illustrations for characters/items.

Attributes and indices of the entity 'RSC'
Name Type Description / Default value & validation Rqrd./Index
ItemID Long ID of associated item (optional). This refers to ItemID, not IID! - I (N)
CharID Long ID of associated character (optional). This refers to CharID, not CID! - I (N)
StateID Long ID of associated character state (optional). This refers to StateID, not CS! - I (N)
Role Text Roles the resource is intended for: I = Icon, S = Selector (displayed directly, e. g. to select a state), D = Definition (usually displayed only as thumbnail image or link for further information).
Default value: "S"; Validation rule: In ("I","S","D")		 R -
Values currently
restricted to:
CODE   Label   Description
I   Icon   Small image; usually not informative enough to make a choice without a text label. Only a single resource per item/char./state should be defined as icon.
S   Selector   Medium sized and sufficient to make a selection without text. Multiple resources per item/char./state may have this role.
D   Definition   Detailed supplementary information used to define an item, char., or state.
A   Association   Associated information that is considered useful to relate.
ItemUsage Text Usage of resource in the context of items (including natural language descriptions). Usage is especially relevant if both Item and CharIDs are defined, but resource is relevant for entire item (e. g. habit).
Validation rule: Is Null Or In ("1","2","3")		 - -
Values
restricted
to:
CODE   Label   Description
1   Always   Always include resource (especially for character in char. definition, for item in natural language report)
2   Desirable   It is desirable to include resource if space permits (e. g., in web forms, in addition to usage "always")
3   Secondary   Resource of secondary relevance (e. g., in web forms on request; in case of characters: e. g. state resources not illustrating character as a whole)
CharUsage Text Usage of resource in the context of items (especially character definition in print or web form). Usage is especially relevant if also Item or StateIDs are defined, but resource is relevant for entire character as well.
Validation rule: Is Null Or In ("1","2","3")		 - -
Values
restricted
to: 		(Identical with ItemUsage values above)
Resource Text Filename of illustration (photo/drawing/graph) or other media resources (see ResourceDefaultPath/DefaultURL in table _PROPERTY for setting global paths). R I
Caption Memo Caption for the resource, e. g. a text to display while showing an illustration or a video. - -
Language Text Language of the caption translation. - -
Notes Memo Internal notes (perhaps also formatting commands for INTKEY). - -
DisplayOrder Long A positive number that can be used to define the sequence in which multiple resources are displayed.
Default value: 0		 R -
ResourceID Autonum Media resource ID (any of item, char, state IDs may be missing). R I (P)
Index name:  Attributes & index properties
CID:  CharID (Duplicates OK; Ignore Nulls)
CS:  StateID (Duplicates OK; Ignore Nulls)
IID:  ItemID (Duplicates OK; Ignore Nulls)
Resource:  Resource (Duplicates OK)
RID:  ResourceID (Primary key; Unique values)
Relation type:  Attributes involved
Updates & deletions cascade  CHAR.CharID « RSC.CharID
Updates & deletions cascade  CS.StateID « RSC.StateID
Updates & deletions cascade  ITEM.ItemID « RSC.ItemID


PROPERTY

General header information about the project.

Attributes and indices of the entity 'PROPERTY'
Name Type Description / Default value & validation Rqrd./Index
PropertyName Text The name of the project property (do not change!). R I (P)
TextValue Memo Text information. Use Shift F2 to zoom into larger window! - -
DateTimeValue Date/Time Date or time information, e. g. of last update. - -
NumericValue Double Numerical information, stored as real number. - I (N)
Language Text Language of a property translation, e. g. for project title.
Default value: 'en'		 R -
Index name:  Attributes & index properties
NumericValue:  NumericValue (Duplicates OK; Ignore Nulls)
PropertyName:  PropertyName (Primary key; Unique values)


CurrentLanguage

Definition of a single language as the current working language, determines which language is displayed in editing forms, reports, etc. The table supports only a single record!

Attributes and indices of the entity 'CurrentLanguage'
Name Type Description / Default value & validation Rqrd./Index
ID Long ID (restricted to a single record, ID must always be 1!).
Default value: 1		 R I (P)
Language Text 2 character ISO language code. R -
Index name:  Attributes & index properties
PropertyName:  ID (Primary key; Unique values)

 

Footnotes: The following abbreviations have been used in the tables: R: It is required to enter data in this field. I: The field is indexed to enable faster searching. Different types of indices are denoted by additional letters in parentheses: P = attribute is part of the primary key (values in the index must be unique), U = values in the index must be unique, N = Null values are ignored in the index, M = the index contains more than one attribute, + = the attribute is involved in more than one multiple-field index. The names of attributes that are part of the primary key are underlined in the first column.

Attribute names of system fields and logging fields (record creation or updating) are enclosed in square brackets: [].

Data types: 'Text (255)' indicates a text of varying length for which no specific design restrictions have been formulated. 255 characters should be read as a proposed technical maximum limit, that can be changed if required by the database management system. In contrast, 'Memo' is explicitly defined as text of unlimited length. All text is Unicode text. Numeric types: BigInt = 8 byte integer, Long = 4 byte integer, Integer or Int = 2 byte integer, Byte = 1 byte integer. A + (e. g. Byte+) indicates that the integer is unsigned and only positive values are allowed.

We are interested in your opinion. If you see any problems with the model that you would like to bring to our attention, please contact us by sending an email to name@gmail.com, please replace name with g.m.hagedorn!

This work is licensed under a Creative Commons License Valid XHTML 1.0! Valid CSS1! Documentation last revised on 30. Mar. 2005, email address revised 2010-08-05.