From fa4057912f6bece31136210cead98dc015cf2fb6 Mon Sep 17 00:00:00 2001
From: Daniel <d.hornung@indiscale.com>
Date: Thu, 12 Oct 2023 17:38:45 +0200
Subject: [PATCH] MAINT: Typos and comments.
---
conf/core/jobs.csv | 4 ++--
.../MySQL/MySQLSetQueryTemplateDefinition.java | 2 +-
.../org/caosdb/server/entity/EntityIdRegistry.java | 2 +-
src/main/java/org/caosdb/server/jobs/Job.java | 7 ++++---
.../org/caosdb/server/jobs/LazyEntityResolver.java | 2 +-
src/main/java/org/caosdb/server/jobs/Schedule.java | 12 ++++++------
.../server/jobs/core/CheckDatatypePresent.java | 6 ++++--
.../org/caosdb/server/jobs/core/ResolveNames.java | 2 +-
8 files changed, 20 insertions(+), 17 deletions(-)
diff --git a/conf/core/jobs.csv b/conf/core/jobs.csv
index 7e153c34..3da052ff 100644
--- a/conf/core/jobs.csv
+++ b/conf/core/jobs.csv
@@ -1,8 +1,8 @@
#
# 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
diff --git a/src/main/java/org/caosdb/server/database/backend/implementation/MySQL/MySQLSetQueryTemplateDefinition.java b/src/main/java/org/caosdb/server/database/backend/implementation/MySQL/MySQLSetQueryTemplateDefinition.java
index ad1f40c7..70293edb 100644
--- a/src/main/java/org/caosdb/server/database/backend/implementation/MySQL/MySQLSetQueryTemplateDefinition.java
+++ b/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>
*/
diff --git a/src/main/java/org/caosdb/server/entity/EntityIdRegistry.java b/src/main/java/org/caosdb/server/entity/EntityIdRegistry.java
index e3cfd736..e4e11584 100644
--- a/src/main/java/org/caosdb/server/entity/EntityIdRegistry.java
+++ b/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.
diff --git a/src/main/java/org/caosdb/server/jobs/Job.java b/src/main/java/org/caosdb/server/jobs/Job.java
index 299e32c2..7bb94635 100644
--- a/src/main/java/org/caosdb/server/jobs/Job.java
+++ b/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);
}
diff --git a/src/main/java/org/caosdb/server/jobs/LazyEntityResolver.java b/src/main/java/org/caosdb/server/jobs/LazyEntityResolver.java
index 9932962a..7088ce7d 100644
--- a/src/main/java/org/caosdb/server/jobs/LazyEntityResolver.java
+++ b/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>
*/
diff --git a/src/main/java/org/caosdb/server/jobs/Schedule.java b/src/main/java/org/caosdb/server/jobs/Schedule.java
index bc51fca9..1b7ac8f4 100644
--- a/src/main/java/org/caosdb/server/jobs/Schedule.java
+++ b/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;
}
diff --git a/src/main/java/org/caosdb/server/jobs/core/CheckDatatypePresent.java b/src/main/java/org/caosdb/server/jobs/core/CheckDatatypePresent.java
index 257e1895..b3a06ca0 100644
--- a/src/main/java/org/caosdb/server/jobs/core/CheckDatatypePresent.java
+++ b/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());
diff --git a/src/main/java/org/caosdb/server/jobs/core/ResolveNames.java b/src/main/java/org/caosdb/server/jobs/core/ResolveNames.java
index b19aca6d..e353375b 100644
--- a/src/main/java/org/caosdb/server/jobs/core/ResolveNames.java
+++ b/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.
}
}
--
GitLab