From 1c6fbb61603512d5eaaeea151653cba90c1b1760 Mon Sep 17 00:00:00 2001
From: Sven Fillinger <sven.fillinger@qbic.uni-tuebingen.de>
Date: Thu, 5 Sep 2024 16:38:12 +0200
Subject: [PATCH] Add JDs

---
 .../datamanager/parser/PropertyToString.java  | 49 ++++++++++++++++++-
 1 file changed, 48 insertions(+), 1 deletion(-)

diff --git a/user-interface/src/main/java/life/qbic/datamanager/parser/PropertyToString.java b/user-interface/src/main/java/life/qbic/datamanager/parser/PropertyToString.java
index 223dbbf72..a59e30ba0 100644
--- a/user-interface/src/main/java/life/qbic/datamanager/parser/PropertyToString.java
+++ b/user-interface/src/main/java/life/qbic/datamanager/parser/PropertyToString.java
@@ -23,13 +23,45 @@ public class PropertyToString {
 
   private static final String ONTOLOGY_TERM = "%s [%s]"; // <term label> [CURIE]
 
+  /**
+   * Takes a {@link Condition} and transforms it into a String representation.
+   * <p>
+   * In its current implementation, the String representation results into a
+   * <code>;</code>-separated concatenation of {@link VariableLevel}. See
+   * {@link PropertyToString#variableLevel(VariableLevel)} for more details.
+   * <p>
+   * Example: a condition with the two variable levels <code>size: 20 cm</code> and <code>hue:
+   * blue</code> will result in:
+   * <p>
+   * <code>size: 20cm; hue: blue</code>
+   * <p>
+   * The generalised form is: <p>
+   * <code>[var name 1]: [level value 1] [unit 1];...; [var name N]: [level value N] [unit N];
+   * </code>
+   *
+   * @param condition the condition object to transform
+   * @return the String representation
+   * @since 1.5.0
+   */
   public static String condition(Condition condition) {
     Objects.requireNonNull(condition);
     List<String> stringValues = new ArrayList<>();
-    condition.getVariableLevels().forEach(variableLevel -> stringValues.add(variableLevel(variableLevel)));
+    condition.getVariableLevels()
+        .forEach(variableLevel -> stringValues.add(variableLevel(variableLevel)));
     return String.join("; ", stringValues);
   }
 
+  /**
+   * Takes a {@link VariableLevel} and transforms it into a String representation.
+   * <p>
+   * The generalised form of the output can be described with:
+   * <p>
+   * <code>[name]: [value] [unit]</code>
+   *
+   * @param variableLevel the variable level to transform
+   * @return the String representation of the variable level
+   * @since 1.5.0
+   */
   public static String variableLevel(VariableLevel variableLevel) {
     Objects.requireNonNull(variableLevel);
     if (variableLevel.experimentalValue().unit().isPresent()) {
@@ -42,6 +74,21 @@ public static String variableLevel(VariableLevel variableLevel) {
     }
   }
 
+  /**
+   * Transforms an {@link OntologyTerm} to its String representation.
+   * <p>
+   * The String representation currently contains the term label and the OBO ID.
+   * <p>
+   * The generalised form can be described as:
+   * <p>
+   * <code>[label] [[obo ID]]</code>
+   * <p>
+   * So e.g. 'Homo sapiens [NCBITaxon:9606]'
+   *
+   * @param ontologyTerm the ontology term to transform
+   * @return the String representation of the ontology term
+   * @since 1.5.0
+   */
   public static String ontologyTerm(OntologyTerm ontologyTerm) {
     Objects.requireNonNull(ontologyTerm);
     return ONTOLOGY_TERM.formatted(ontologyTerm.getLabel(), ontologyTerm.getOboId());