SDD Enumeration info

This document is automatically generated based on the enumerations present in the following schema: "SDD 1.0 beta 2". The html representation is intended for documentation and to improve discussion and correction of errors (please comment on http://efgblade.cs.umb.edu/twiki/bin/view/SDD). The xml representation follows the general conventions of UBIF documents and may be easier to import or integrate into user interfaces than the schema itself. This is especially true for SDD documents, where a large part of the terminology is provided in the form of data documents by the experts of a given knowledge domain. This document can be used side-by-side as schema-defined terminology with user-defined terminology. Note that a special UBIF payload schema Enumeration is defined in the schema UBIF_Enumerations.xsd, with which the xml version of this file can be validated.


Contents

 -  BasicCodingStatusEnum
 -  PresenceOfInformationEnum
 -  GlossaryKindOfTermEnum
 -  UnivarStatMeasureCompareWithEnum
 -  StateCollectionModelEnum
 -  ConceptTreeTypeEnum
 -  ConceptTreeRoleEnum
 -  DataOriginEnum
 -  RatingOriginEnum

BasicCodingStatusEnum

Enumeration used in CodingStatus/Specification. These required values enable applications to interprete user-defined coding status values.

ValueLabel Details
ToBeCodedTo Be CodedInformation has not yet been entered, but is is planned to do so.
NotToBeCodedNot To Be CodedInformation has not yet been entered, and is is not planned to do so (esp. because resources are lacking and other characters should have priority).
CannotBeCodedCannot Be CodedInformation cannot be entered due to objective (inapplicable character) or subjective (cannot interpret available data) reasons.
CodedSuccessfullyCoded SuccessfullyInformation has been entered successfully.

(Return to table of contents)

PresenceOfInformationEnum

Enumeration used in CodingStatus/Specification. These required values enable applications to interprete user-defined coding status values.

ValueLabel Details
NotEvaluatedNot EvaluatedThe presence of information has not yet been evaluated.
CannotExistCannot ExistInformation cannot exist for logical reasons (i. e. a character with a coding status having this value is inapplicable).
DoesNotExistDoes Not ExistInformation should exist, but extensive research has failed to find it.
ExistsExistsInformation has already been found, but may not yet have been entered.

(Return to table of contents)

GlossaryKindOfTermEnum

Defines the type of a concept tree (list of enumerated values to support application interoperability).

ValueLabel 
PartOrStructure
PropertyTerm
FunctionalConcept
MethodOrProcedure
ChemicalCompound
Modifier
NomenclatureTerm
OtherTerm

(Return to table of contents)

UnivarStatMeasureCompareWithEnum

When mapping numerical ranges to categorical states (essentially creating a histogram), several methods which statistical measures are used for the mapping are possible. Using the central value compares a point with the mapping range, whereas using ranges or extremes results in a comparison of two kind of ranges for overlap. Only the central value method can guarantee an unambiguous partitioning into categories. However, the ranges or extremes methods may be desirable because of their improved error tolerance.

ValueLabel Details
CentralMeasureCentral measureThe first central measure encountered (mean, median, mode) is used as the basis of comparison. If none is found, but ranges or extremes are present, a central value is calculated based on the these.
RangesRangesAny ranges that are not the extremes (quantile, percentile, confidence interval, mean plus/minus s.d., etc.) is attempted to use for comparison. If none is found, Extreme values are used.
ExtremesExtremesThe extreme range values (= minimum and maximum) are used as the basis of comparison.

(Return to table of contents)

StateCollectionModelEnum

Used in descriptive data (not in terminology): Collections of states in instance documents may be ordered (sequence) or unordered (set), and may be connected with 'and', 'or', 'with', or 'between'. Since set/sequence and operators are dependent on each other, the two aspects are combined into a 'model' enumeration

ValueLabel Details
OrSetUnordered set of states, combined with 'or'Multiple states scored for a character in a description form a set. The order of states has no special meaning and may be changed. In natural language output the states should be combined with 'or' to express that in individual objects (that belong to the class that is being described), the states may occur together or alone.
OrSeqOrdered sequence of states, combined with 'or'Multiple states scored for a character in a description form a sequence, i. e. the state order carries some semantics and should be preserved in output. The sequence semantics is not explicitly defined, but intelligable to human consumers and presumably relates to some concept of relevance or importance. In natural language output the states should be combined with 'or' to express that in individual objects (that belong to the class that is being described), the states may occur together or alone.
AndSetUnordered set of states, of states, combined with 'and'Multiple states scored for a character in a description form a set. The order of states has no special meaning and may be changed. In natural language output the states should be combined with 'and' to express that in any individual object (that belong to the class that is being described), the states will always occur together. Example: two colors that occur together in a pattern.
AndSeqOrdered sequence of states, combined with 'and'Multiple states scored for a character in a description form a sequence, i. e. the state order carries some semantics and should be preserved in output. The sequence semantics is not explicitly defined, but intelligable to human consumers and presumably relates to some concept of relevance or importance. In natural language output the states should be combined with 'and' to express that in any individual object (that belong to the class that is being described), the states will always occur together. Example: a black part with small red markings, is more appropriately described as 'black and red' than 'red and black'.
WithSeqOne state occurring together with others of secondary relevance.This is a special case of AndSeq, and in many circumstances (except natural language generation) may be treated as AndSeg. Example: "Green with brown" (often this may be two characters, e. g. base color and dot color).
BetweenTrue value lying between (usually two) statesExample: "Between oval and elliptic" = "Oval to elliptic".

(Return to table of contents)

ConceptTreeTypeEnum

Defines the type of a concept tree (list of enumerated values to support application interoperability).

ValueLabel 
PropertyHierarchyCategorizing characters into basic property types (e. g., color, 2-dim. shape, 3-dim. shape, surface texture, taste, smell, behavior, physiology, measurements, etc.) greatly improves the analysis and management of larger character sets and is therefore recommended. [@ Note: Only a single concept tree should have this hierarchy type. (not enforced in schema, how can it be enforced? Other types occur multiple, i. e. one cannot make a UNIQUE statement on attribute! @]
MethodHierarchyA hierarchy that organizes characters by observation method or instrumentation, e. g., field observation, light microscopy, electron microscopy, molecular methods, culture techniques, etc.
PartCompositionHierarchyA hierarchy that organizes characters by a morphological or anatomical "contains" or "part-of" hierarchy: plant = root/stem/leaf, leaf = base/stipules/petiole/lamina, etc.
PartGeneralizationHierarchyA hierarchy that organizes structural parts in a kind-of hierarchy (e. g., a 'teliospore' is a kind of 'spore')
OtherConceptHierarchyUsed for concept trees that fall into none of the categories property, method, part. Such trees may be intended only for internal purposes (e. g., defining dependency rules) or for browsing by the user.
PresentationTablePresentationTable concept trees are small sets of a usually a few characters that allow to display data in a tabular arrangement. It is possible to define tables in more than 2 dimensions. By default the innermost dimension is considered cells in a row, the next rows in a table. Any further dimension may be displayed as multiple 2-dimensional tables one below the other. However, applications may also offer a browser based on pivot tables. - Note: Trees of type PresentationTable should not be offered in the user interface when selecting a browsing tree.
SubsetFilterA concept tree of type "SubsetFilter" is intended only for the purpose of filtering characters. It will often be a flat list of characters. Applications should not offer it as a choice when the user selects a hierarchy for displaying or reporting purposes. Note that conversely, the filter selection dialog in applications should not be restricted to trees of type SubsetFilter. Any concept tree, including part, method or property hierarchies may be used as a filter to define character subsets.

(Return to table of contents)

ConceptTreeRoleEnum

Defines the intended roles that a designer may assign to a concept tree (list of enumerated values to support application interoperability).

ValueLabel 
DescriptionEditingSetting this value in a concept tree is a recommendation to applications with a user interface to offer this tree for editing the description data set (the application may, however, enable the user to select any concept tree).
BuildingStoredIdentificationKeysSetting this value in a concept tree is a recommendation to applications with a user interface to offer this tree for building stored identification keys (e. g., dichotomous keys).
InteractiveIdentificationSetting this value in a concept tree is a recommendation to applications with a user interface to offer this tree for interactive identification.
TerminologyReportingSetting this value in a concept tree is a recommendation to applications to use this for creating a report of the character terminology. (Note that no TerminologyEditing value is defined; all concept trees should be available when designing the terminology. However, the tree marked as TerminologyReporting may be used as the initial editing view.)
NaturalLanguageReportingSetting this value in a concept tree is a recommendation to applications to offer this tree for natural language reporting.
FilteringSetting this value in a concept tree is a recommendation to applications to offer this tree for filtering purposes. Some trees are explicitly (separately) typed as being intended exclusively for filtering/subset definition; but many trees are useful for filtering purposes.

(Return to table of contents)

DataOriginEnum

Defines the origin of data that may have been entered, calculated, aggregated or inherited

ValueLabel 
OriginalDataThe data are directly entered by a machine or human agent. These are the original data all other cached data (Origin unequal 'OriginalData') are based upon.
CalculatedThe data are calculated from other data using a calculation rule. Examples: a ratio calculated from other characters, a mean calculated from a sample that is available under SampleData/Sample (if a mean is calculated from data no longer available, it would be recorded as 'OriginalData').
MappedThe data are calculated from other data based on a mapping definition (either from numeric to categorical, or from fine-grained categorical to coarse-grained categorical.
AggregatedThe data are derived from data in classes placed below the current class in the class hierarchy. This applies both to aggregating data from objects to classes, as generalizing lower classes to higher classes. Note: BioLink calls this 'Compile from below'.
InheritedThe data are derived from data in classes placed above the current class in the class hierarchy.

(Return to table of contents)

RatingOriginEnum

Defines the origin of concept/character ratings. Similar to DataOriginEnum, but fewer enumerated values.

ValueLabel 
OriginalDataThe data are directly entered by a machine or human agent.
InheritedConcept ratings may inherit from ratings at higher concept nodes, and character ratings may inherit from all concept nodes they belong to (possibly in multiple concept trees).

(Return to table of contents)