2 * Copyright (C) 2007 EDIT
3 * European Distributed Institute of Taxonomy
4 * http://www.e-taxonomy.eu
6 * The contents of this file are subject to the Mozilla Public License Version 1.1
7 * See LICENSE.TXT at the top of this package for the full license terms.
10 package eu
.etaxonomy
.cdm
.model
.description
;
12 import java
.util
.HashMap
;
14 import java
.util
.UUID
;
16 import javax
.persistence
.Entity
;
17 import javax
.xml
.bind
.annotation
.XmlAccessType
;
18 import javax
.xml
.bind
.annotation
.XmlAccessorType
;
19 import javax
.xml
.bind
.annotation
.XmlRootElement
;
20 import javax
.xml
.bind
.annotation
.XmlType
;
22 import org
.apache
.log4j
.Logger
;
23 import org
.hibernate
.envers
.Audited
;
24 import org
.hibernate
.search
.annotations
.Indexed
;
26 import eu
.etaxonomy
.cdm
.model
.common
.DefinedTermBase
;
27 import eu
.etaxonomy
.cdm
.model
.common
.Language
;
28 import eu
.etaxonomy
.cdm
.model
.common
.TermVocabulary
;
32 * This class represents terms describing different statistical measures (such
33 * as "sample size", "minimum" or "average") for {@link Feature features} that can be
34 * described with numerical values (like for instance weights or temperature).
38 * @created 08-Nov-2007 13:06:54
40 @XmlAccessorType(XmlAccessType
.FIELD
)
41 @XmlType(name
= "StatisticalMeasure")
42 @XmlRootElement(name
= "StatisticalMeasure")
44 @Indexed(index
= "eu.etaxonomy.cdm.model.common.DefinedTermBase")
46 public class StatisticalMeasure
extends DefinedTermBase
<StatisticalMeasure
> {
47 private static final long serialVersionUID
= 9168097283660941430L;
48 @SuppressWarnings("unused")
49 private static final Logger logger
= Logger
.getLogger(StatisticalMeasure
.class);
51 protected static Map
<UUID
, StatisticalMeasure
> termMap
= null;
54 private static final UUID uuidMin
= UUID
.fromString("2c8b42e5-154c-42bd-a301-03b483275dd6");
55 private static final UUID uuidMax
= UUID
.fromString("8955815b-7d21-4149-b1b7-d37af3c2046c");
56 private static final UUID uuidAverage
= UUID
.fromString("264c3979-d551-4795-9e25-24c6b533fbb1");
57 private static final UUID uuidSampleSize
= UUID
.fromString("571f86ca-a44c-4484-9981-11fd82138a7a");
58 private static final UUID uuidVariance
= UUID
.fromString("4d22cf5e-89ff-4de3-a9ae-12dbeda3faba");
59 private static final UUID uuidTypicalLowerBoundary
= UUID
.fromString("8372a89a-35ad-4755-a881-7edae6c37c8f");
60 private static final UUID uuidTypicalUpperBoundary
= UUID
.fromString("9eff88ba-b8e7-4631-9e55-a50bd16ba79d");
61 private static final UUID uuidStandardDeviation
= UUID
.fromString("9ee4397e-3496-4fe1-9114-afc7d7bdc652");
63 // ************* CONSTRUCTORS *************/
65 * Class constructor: creates a new empty statistical measure instance.
67 * @see #StatisticalMeasure(String, String, String)
69 public StatisticalMeasure() {
71 public StatisticalMeasure(String term
, String label
, String labelAbbrev
) {
72 super(term
, label
, labelAbbrev
);
75 //********* METHODS **************************************/
77 * Creates a new empty statistical measure instance.
79 * @see #NewInstance(String, String, String)
81 public static StatisticalMeasure
NewInstance(){
82 return new StatisticalMeasure();
85 * Creates a new statistical measure instance with a description
86 * (in the {@link Language#DEFAULT() default language}), a label and a label abbreviation.
88 * @param term the string (in the default language) describing the
89 * new statistical measure to be created
90 * @param label the string identifying the new statistical measure
92 * @param labelAbbrev the string identifying (in abbreviated form) the
93 * new statistical measure to be created
96 public static StatisticalMeasure
NewInstance(String term
, String label
, String labelAbbrev
){
97 return new StatisticalMeasure(term
, label
, labelAbbrev
);
101 //************************** METHODS ********************************
104 * @see eu.etaxonomy.cdm.model.common.DefinedTermBase#resetTerms()
107 public void resetTerms(){
113 protected static StatisticalMeasure
getTermByUuid(UUID uuid
){
114 if (termMap
== null){
115 return null; //better return null then initialize the termMap in an unwanted way
117 return (StatisticalMeasure
)termMap
.get(uuid
);
120 public static final StatisticalMeasure
MIN(){
121 return getTermByUuid(uuidMin
);
124 public static final StatisticalMeasure
MAX(){
125 return getTermByUuid(uuidMax
);
128 public static final StatisticalMeasure
AVERAGE(){
129 return getTermByUuid(uuidAverage
);
132 public static final StatisticalMeasure
SAMPLE_SIZE(){
133 return getTermByUuid(uuidSampleSize
);
136 public static final StatisticalMeasure
VARIANCE(){
137 return getTermByUuid(uuidVariance
);
140 public static final StatisticalMeasure
TYPICAL_LOWER_BOUNDARY(){
141 return getTermByUuid(uuidTypicalLowerBoundary
);
144 public static final StatisticalMeasure
TYPICAL_UPPER_BOUNDARY(){
145 return getTermByUuid(uuidTypicalUpperBoundary
);
148 public static final StatisticalMeasure
STANDARD_DEVIATION(){
149 return getTermByUuid(uuidStandardDeviation
);
154 protected void setDefaultTerms(TermVocabulary
<StatisticalMeasure
> termVocabulary
) {
155 termMap
= new HashMap
<UUID
, StatisticalMeasure
>();
156 for (StatisticalMeasure term
: termVocabulary
.getTerms()){
157 termMap
.put(term
.getUuid(), (StatisticalMeasure
)term
);