MAINT: Typos and comments.

conf/core/jobs.csv

 #
 # This file is a part of the CaosDB Project.
 #
-# Copyright (C) 2021 Timm Fitsche <t.fitschen@indiscale.com>
-# Copyright (C) 2021 IndiScale GmbH <info@indiscale.com>
+# Copyright (C) 2021-2023 Timm Fitsche <t.fitschen@indiscale.com>
+# Copyright (C) 2021-2023 IndiScale GmbH <info@indiscale.com>
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License as

src/main/java/org/caosdb/server/database/backend/implementation/MySQL/MySQLSetQueryTemplateDefinition.java

@@ -29,7 +29,7 @@ import org.caosdb.server.database.exceptions.TransactionException;
 import org.caosdb.server.entity.EntityID;
 
 /**
- * Implements {@link SetQueryTemplateDefinitionImpl} for a MySQL/MariaDB back-end.
+ * Implements {@link SetQueryTemplateDefinitionImpl} for a MariaDB back-end.
  *
  * @author Timm Fitschen <t.fitschen@indiscale.com>
  */

src/main/java/org/caosdb/server/entity/EntityIdRegistry.java

@@ -27,7 +27,7 @@ import org.caosdb.server.transaction.Transaction;
 /**
  * An abstract layer for managing entity ids.
  *
- * <p>That is, checking wether something is a well-formed id, generating well-formed ids and more.
+ * <p>That is, checking whether something is a well-formed id, generating well-formed ids and more.
  *
  * <p>This class follows a Strategy Pattern. The actual implemenation can be found in one of the
  * implementations of the {@link EntityIdRegistryStrategy} interface.

src/main/java/org/caosdb/server/jobs/Job.java

@@ -579,6 +579,7 @@ public abstract class Job {
       }
       resolvedEntity = null;
     } else {
+      // We want another version, throw away current result.
       resolvedEntity = null;
     }
 
@@ -590,14 +591,14 @@ public abstract class Job {
       }
     }
 
-    // find by name in the container...
+    // Last resort: find by name ...
     if (resolvedEntity == null && versionId == null) {
-      // from current transaction's container
+      // ... from current transaction's container
       resolvedEntity = getEntityByName(name);
     }
 
     if (resolvedEntity == null && name != null) {
-      // from database
+      // ... from database
       resolvedEntity = retrieveValidLazyEntityByName(name, resulting_version);
     }
 

src/main/java/org/caosdb/server/jobs/LazyEntityResolver.java

@@ -36,7 +36,7 @@ import org.caosdb.server.transaction.Transaction;
  * or has been retrieved fully and so on.
  *
  * <p>However, when the entities parents or properties are being retrieved after the transaction's
- * access has been released, a {@link IllegalStateException} will be thrown.
+ * access has been released, an {@link IllegalStateException} will be thrown.
  *
  * @author Timm Fitschen <t.fitschen@indiscale.com>
  */

src/main/java/org/caosdb/server/jobs/Schedule.java

@@ -55,15 +55,15 @@ public class Schedule {
   }
 
   public ScheduledJob add(final Job j) {
-    final ScheduledJob ret = new ScheduledJob(j);
-    List<ScheduledJob> jobs = jobLists.get(ret.getTransactionStage().ordinal());
+    final ScheduledJob scheduled = new ScheduledJob(j);
+    List<ScheduledJob> jobs = jobLists.get(scheduled.getTransactionStage().ordinal());
     if (jobs == null) {
       jobs = new CopyOnWriteArrayList<ScheduledJob>();
-      jobLists.put(ret.getTransactionStage().ordinal(), jobs);
+      jobLists.put(scheduled.getTransactionStage().ordinal(), jobs);
     }
-    if (!jobs.contains(ret)) {
-      jobs.add(ret);
-      return ret;
+    if (!jobs.contains(scheduled)) {
+      jobs.add(scheduled);
+      return scheduled;
     }
     return null;
   }

src/main/java/org/caosdb/server/jobs/core/CheckDatatypePresent.java

@@ -140,9 +140,11 @@ public final class CheckDatatypePresent extends EntityJob {
     }
   }
 
+  /**
+   * If this is a record type property or a concrete property, assign the data type of the
+   * corresponding abstract property.
+   */
   private void inheritDatatypeFromAbstractEntity() throws Message {
-    // if this is a record type property or a concrete property, assign
-    // the data type of the corresponding abstract property.
     EntityInterface abstractProperty = resolve(getEntity());
     if (abstractProperty != null && abstractProperty.hasDatatype()) {
       getEntity().setDatatype(abstractProperty.getDatatype());

src/main/java/org/caosdb/server/jobs/core/ResolveNames.java

@@ -67,7 +67,7 @@ public class ResolveNames extends ContainerJob {
                   .getEntity();
           e.setId(valid.getId());
         } catch (final EntityDoesNotExistException exc) {
-          // definitely not an id.
+          // Definitely not an existing id.
         }
       }