Ontologies (#1110)

* add sample ontologies file * add ontologies reducer * Move select category to own component * Dialog and Input factored out * refactoring categorical, partway * validationn * anno * suggest populates input * frontend for ontology working * initial implementation of back-end support for ontologies * edit is now dialog again * autosuggest working on edit * part way through create arbitrary label * handle choice in function * pass duplicate cat prop * editing works * update test to match new CLI params * fix occupancy alignment * edit category as dialogue * secondary button * remove stubbed out ontologies * add label setting upon new label creation * Update legal characters for labels (#1119) * Allow any term in the ontology (bypass legal name check) * Add hyphens and parens to legal characters in names * improve performance for large ontologies * correctly handle case where ontologies are disabled * fix logic error in CLI Co-authored-by: Bruce Martin <bruce@chanzuckerberg.com> * PR cleanup 1 * lint * validate user generated labels * finish hooking up connected suggest component * protect against undefined callbacks * Fix illegal characters error message * break out npm run commands * fix error detection on label edit Co-authored-by: Bruce Martin <bruce@chanzuckerberg.com> Co-authored-by: Sidney Bell <sidneymbell@users.noreply.github.com>
2026-10-04 10:08:12 +08:00 · 2020-01-23 17:04:17 -05:00
parent 8d725b1ad9
commit d48647a655
20 changed files with 964 additions and 532 deletions
@@ -0,0 +1,57 @@
+import React from "react";
+import { AnnotationsHelpers } from "../../util/stateManager";
+
+export function isLabelErroneous(label, metadataField, ontology, schema) {
+	/*
+    return false if this is a LEGAL/acceptable category name or NULL/empty string,
+    or return an error type.
+    */
+
+	/* allow empty string */
+	if (label === "") return false;
+
+	/* check for label syntax errors, but allow terms in ontology */
+	const termInOntology = ontology?.termSet.has(label) ?? false;
+	const error = AnnotationsHelpers.annotationNameIsErroneous(label);
+	if (error && !termInOntology) return error;
+
+	/* disallow duplicates */
+	const { obsByName } = schema.annotations;
+	if (obsByName[metadataField].categories.indexOf(label) !== -1)
+		return "duplicate";
+
+	/* otherwise, no error */
+	return false;
+}
+
+export function labelErrorMessage(label, metadataField, ontology, schema) {
+	const err = isLabelErroneous(label, metadataField, ontology, schema);
+
+	if (err === "duplicate") {
+		/* duplicate error is special cased because it has special formatting */
+		return (
+			<span>
+				<span style={{ fontStyle: "italic" }}>{label}</span> already
+				exists already exists within{" "}
+				<span style={{ fontStyle: "italic" }}>{metadataField}</span>{" "}
+			</span>
+		);
+	}
+
+	if (err) {
+		/* all other errors - map code to human error message */
+		const errorMessageMap = {
+			"empty-string": "Blank names not allowed",
+			duplicate: "Name must be unique",
+			"trim-spaces": "Leading and trailing spaces not allowed",
+			"illegal-characters":
+				"Only alphanumeric and special characters (-_.) allowed",
+			"multi-space-run": "Multiple consecutive spaces not allowed"
+		};
+		const errorMessage = errorMessageMap[err] ?? "error";
+		return <span>{errorMessage}</span>;
+	}
+
+	/* no error, no message generated */
+	return null;
+}