Project

General

Profile

Revision 96b27743

ID96b27743e2c7ccda62a0d81ce20cb9e21ee6f9c1
Parent 7e477034
Child 55e16d38

Added by Andreas Müller about 1 year ago

ref #7957 add javadoc to description types

View differences:

cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/description/DescriptionType.java
27 27
 */
28 28
public enum DescriptionType implements IEnumTerm<DescriptionType>{
29 29

  
30
    /**
31
     * The description has been computed by a machine, e.g. by aggregation or any
32
     * other algorithm. Usually such descriptions should not be edited by users manually.
33
     * {@link DescriptionType#COMPUTED} is a base type for more specific types such as
34
     * {@link DescriptionType#AGGREGATED}
35
     */
30 36
    @XmlEnumValue("COM")
31 37
    COMPUTED(UUID.fromString("7048c64e-9e61-41ed-b561-5765bc8e4ba2"), "Computed", "COM", null),
32 38

  
39
    /**
40
     * The description has been computed by a machine by aggregation of data.
41
     * Usually such descriptions should not be edited by users manually.
42
     */
33 43
    @XmlEnumValue("AGG")
34 44
    AGGREGATED(UUID.fromString("d1c02cbf-e27c-49ee-919a-7393d953ef36"), "Aggregated", "AGG", COMPUTED),
35 45

  
46
    /**
47
     * Description is a clone which was used to fix a certain state of data to define
48
     * it as a source for e.g. computed data.
49
     * E.g. when computing a taxon description the underlying specimen descriptions might
50
     * be cloned and locked for editing to keep them as exact source for the computed
51
     * taxon description.
52
     */
36 53
    @XmlEnumValue("CLO")
37 54
    CLONE_FOR_SOURCE(UUID.fromString("2d58416f-506b-40c5-bdb6-60b6735c92d3"), "Clone", "CLO", null),
38 55

  
56
    /**
57
     * Kind of a marker to define that data comes from a secondary source. E.g. if
58
     * taxon descriptions are computed mostly on primary data (e.g. specimen descriptions)
59
     * some data might come from literature though to complete the description.
60
     * This literature data then should be marked as "Secondary data"
61
     */
39 62
    @XmlEnumValue("SEC")
40 63
    SECONDARY_DATA(UUID.fromString("382e6b00-9725-4877-bd50-18ee263fe90e"), "Secondary Data", "SEC", null),
41 64

  
42 65
    /**
43
     * If Descriptions are aggregated, these values can be taken as default if explicit values do not exist.
66
     * If Descriptions are aggregated for e.g. taxon descriptions, often explicit data for some parameters
67
     * are missing as all underlying data have the same value on this parameter.
68
     * A description can be defined to hold default values for these parameters.
44 69
     */
45 70
    @XmlEnumValue("DVA")
46 71
    DEFAULT_VALUES_FOR_AGGREGATION(UUID.fromString("e4a51ab3-7040-4f60-9d08-51782c2255a1"), "Default Values for Aggregation", "DVA", null),

Also available in: Unified diff

Add picture from clipboard (Maximum size: 40 MB)