Merge pull request #283 from qbicsoftware/release/2.15.0

2.15.0 (2022-01-24)
----------------------------

**Added**

* Add displayName to ``life.qbic.datamodel.samples.Status`` (#282)

**Fixed**

**Dependencies**

**Deprecated**

Author: KochTobi

CHANGELOG.rst

@@ -4,6 +4,19 @@ Changelog
 
 This project adheres to `Semantic Versioning <https://semver.org/>`_.
 
+2.15.0 (2022-01-24)
+----------------------------
+
+**Added**
+
+* Add displayName to ``life.qbic.datamodel.samples.Status`` (#282)
+
+**Fixed**
+
+**Dependencies**
+
+**Deprecated**
+
 2.14.4 (2022-01-04)
 -------------------
 

docs/conf.py

@@ -55,9 +55,9 @@
 # the built documents.
 #
 # The short X.Y version.
-version = '2.14.0'
+version = '2.15.0'
 # The full version, including alpha/beta/rc tags.
-release = '2.14.0'
+release = '2.15.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

pom.xml

@@ -7,10 +7,10 @@
 
   <groupId>life.qbic</groupId>
   <artifactId>data-model-lib</artifactId>
-  <version>2.14.4</version> <!-- <<QUBE_FORCE_BUMP>> -->
+  <version>2.15.0</version> <!-- <<QUBE_FORCE_BUMP>> -->
   <name>data-model-lib</name>
   <url>http://github.com/qbicsoftware/data-model-lib</url>
-  <description>Data models. A collection of QBiC's central data models and DTOs.</description>
+  <description>Data models. A collection of QBiC's central data models and DTOs. </description>
   <packaging>jar</packaging>
 
   <properties>

src/main/groovy/life/qbic/datamodel/samples/Status.groovy

@@ -4,21 +4,56 @@ package life.qbic.datamodel.samples;
  * The status of an sample in the context of <a href="https://github.com/qbicsoftware/sample-tracking-service">sample-tracking</a>
  */
 public enum Status {
-  SAMPLE_QC_FAIL,
-  SAMPLE_QC_PASS,
-  SAMPLE_RECEIVED,
-  LIBRARY_PREP_FINISHED,
-  SEQUENCING,
-  SEQUENCING_COMPLETE,
-  METADATA_REGISTERED,
-  WAITING,
-  PROCESSING,
-  FAILED_QC,
-  PROCESSED,
-  DATA_AVAILABLE,
+  SAMPLE_QC_FAIL ("Sample QC Fail"),
+  SAMPLE_QC_PASS ("Sample QC Pass"),
+  SAMPLE_RECEIVED ("Sample Received"),
+  LIBRARY_PREP_FINISHED ("Library Prep Finished"),
+  /**
+   * @deprecated this is deprecated since 2.16.0 please use {@link #SEQUENCING_COMPLETE} instead
+   */
+  @Deprecated
+  SEQUENCING ("Sequencing"),
+  SEQUENCING_COMPLETE ("Sequencing Complete"),
+  METADATA_REGISTERED ("Metadata Registered"),
+  /**
+   * @deprecated this is deprecated since 2.16.0
+   */
+  @Deprecated
+  WAITING ("Waiting"),
+  /**
+   * @deprecated this is deprecated since 2.16.0
+   */
+  @Deprecated
+  PROCESSING ("Processing"),
+  /**
+   * @deprecated this is deprecated since 2.16.0 please use {@link #SAMPLE_QC_FAIL} instead
+   */
+  @Deprecated
+  FAILED_QC ("Failed QC"),
+  /**
+   * @deprecated this is deprecated since 2.16.0
+   */
+  @Deprecated
+  PROCESSED ("Processed"),
+  DATA_AVAILABLE ("Data Available"),
   /** 
   * @deprecated this is deprecated since 2.4.0 please use {@link #DATA_AVAILABLE} instead
   */
   @Deprecated
-  DATA_AT_QBIC
+  DATA_AT_QBIC ("Data at QBiC")
+
+  private final displayName
+
+  private Status(String displayName){
+    this.displayName = displayName
+  }
+
+  /**
+   * Returns to the enum item display name
+   * @return
+   */
+  String getDisplayName() {
+    return this.displayName
+  }
+
 }