1832 generalize sol superordinate location relation to soe superordin…

…ate entity relation (#1837) * rename sol to soe, add allowedEntities LOESBV * update logic in backend for SOE relations * Replace abbreviation in the data files --------- Co-authored-by: Petr Hanak <[email protected]> Co-authored-by: adammertel <[email protected]>
DISSINET · Sep 28, 2023 · d41c09c · d41c09c
1 parent 65aa50a
commit d41c09c
Show file tree

Hide file tree

Showing 16 changed files with 71,382 additions and 73 deletions.
diff --git a/packages/database/datasets/all-parsed/relations.json b/packages/database/datasets/all-parsed/relations.json
diff --git a/packages/database/datasets/relationstest/relations.json b/packages/database/datasets/relationstest/relations.json
@@ -272,58 +272,58 @@
   },
 
   {
-    "type": "SOL",
+    "type": "SOE",
     "entityIds": ["l1", "l6"],
     "order": 2
   },
   {
-    "type": "SOL",
+    "type": "SOE",
     "entityIds": ["l1", "l10"],
     "order": 3
   },
   {
-    "type": "SOL",
+    "type": "SOE",
     "entityIds": ["l1", "l8"],
     "order": 4
   },
   {
-    "type": "SOL",
+    "type": "SOE",
     "entityIds": ["l6", "l9"],
     "order": 1
   },
   {
-    "type": "SOL",
+    "type": "SOE",
     "entityIds": ["l10", "l8"],
     "order": 1
   },
   {
-    "type": "SOL",
+    "type": "SOE",
     "entityIds": ["l8", "l9"],
     "order": 1
   },
 
   {
-    "type": "SOL",
+    "type": "SOE",
     "entityIds": ["l1200", "l1201"],
     "order": 1
   },
   {
-    "type": "SOL",
+    "type": "SOE",
     "entityIds": ["l1201", "l1202"],
     "order": 1
   },
   {
-    "type": "SOL",
+    "type": "SOE",
     "entityIds": ["l1201", "l1204"],
     "order": 2
   },
   {
-    "type": "SOL",
+    "type": "SOE",
     "entityIds": ["l1204", "l1"],
     "order": 1
   },
   {
-    "type": "SOL",
+    "type": "SOE",
     "entityIds": ["l1202", "l1203"],
     "order": 1
   },
@@ -608,7 +608,12 @@
   },
   {
     "type": "SYN",
-    "entityIds": ["c-has-isync-1", "c-has-isync-2", "c-has-isync-3", "c-has-isync-4"],
+    "entityIds": [
+      "c-has-isync-1",
+      "c-has-isync-2",
+      "c-has-isync-3",
+      "c-has-isync-4"
+    ],
     "order": 1
   },
   {

diff --git a/packages/database/schemas/Relation.ISuperordinateLocation.schema.json b/packages/database/schemas/Relation.ISuperordinateLocation.schema.json
@@ -1,8 +1,8 @@
 {
-  "$ref": "#/definitions/Relation.ISuperordinateLocation",
+  "$ref": "#/definitions/Relation.ISuperordinateEntity",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "definitions": {
-    "Relation.ISuperordinateLocation": {
+    "Relation.ISuperordinateEntity": {
       "additionalProperties": false,
       "properties": {
         "entityIds": {

diff --git a/packages/database/scripts/generate-json-schemas.py b/packages/database/scripts/generate-json-schemas.py
@@ -31,7 +31,7 @@
     {'file': input_path + 'types/relation.ts', 'class': 'Relation.IRelated'},
     {'file': input_path + 'types/relation.ts', 'class': 'Relation.IActionEventEquivalent'},
     {'file': input_path + 'types/relation.ts', 'class': 'Relation.ISubjectActant1Reciprocal'},
-    {'file': input_path + 'types/relation.ts', 'class': 'Relation.ISuperordinateLocation'},
+    {'file': input_path + 'types/relation.ts', 'class': 'Relation.ISuperordinateEntity'},
     {'file': input_path + 'types/relation.ts', 'class': 'Relation.IPropertyReciprocal'},
     {'file': input_path + 'types/relation.ts', 'class': 'Relation.ISuperclass'},
     {'file': input_path + 'types/relation.ts', 'class': 'Relation.IHolonym'},
@@ -52,7 +52,7 @@
 #  {'file': input_path + 'types/actant.ts', 'class': 'IActant'},
 #  {'file': input_path + 'types/relation.ts', 'class': 'Relation.IClassification'},
  # {'file': input_path + 'types/relation.ts', 'class': 'Relation.ISubjectActant1Reciprocal'},
-# {'file': input_path + 'types/relation.ts', 'class': 'Relation.ISuperordinateLocation'},
+# {'file': input_path + 'types/relation.ts', 'class': 'Relation.ISuperordinateEntity'},
 #]
 
 for case in files_and_classes:

diff --git a/packages/database/scripts/parse-development.ipynb b/packages/database/scripts/parse-development.ipynb
@@ -372,7 +372,7 @@
     "        'Relation.ISynonym':{\n",
     "            'id':'', 'type':'SYN','entityIds': ['','']\n",
     "        },\n",
-    "        'Relation.ISuperordinateLocation':{\n",
+    "        'Relation.ISuperordinateEntity':{\n",
     "            'id':'', 'type':'SOL','entityIds': ['',''], \"order\":1\n",
     "        },\n",
     "        'Relation.ISuperclass':{\n",

diff --git a/packages/server/src/models/entity/response-tooltip.ts b/packages/server/src/models/entity/response-tooltip.ts
@@ -28,7 +28,7 @@ export class ResponseTooltip
 
     await this.relations.prepare(request, [
       RelationEnums.Type.Superclass,
-      RelationEnums.Type.SuperordinateLocation,
+      RelationEnums.Type.SuperordinateEntity,
       RelationEnums.Type.Synonym,
       RelationEnums.Type.ActionEventEquivalent,
       RelationEnums.Type.Classification,
@@ -43,7 +43,7 @@ export class ResponseTooltip
     );
     this.addLinkedEntities(
       this.relations.getEntityIdsFromType(
-        RelationEnums.Type.SuperordinateLocation
+        RelationEnums.Type.SuperordinateEntity
       )
     );
     this.addLinkedEntities(

diff --git a/packages/server/src/models/factory.ts b/packages/server/src/models/factory.ts
@@ -27,7 +27,7 @@ import Holonym from "./relation/holonym";
 import Implication from "./relation/implication";
 import Related from "./relation/related";
 import Superclass from "./relation/superclass";
-import SuperordinateLocation from "./relation/superordinate-location";
+import SuperordinateEntity from "./relation/superordinate-entity";
 import PropertyReciprocal from "./relation/property-reciprocal";
 import ActionEventEquivalent from "./relation/action-event-equivalent";
 import SubjectActant1Reciprocal from "./relation/subject-actant1-reciprocal";
@@ -97,8 +97,8 @@ export function getRelationClass(data: UnknownObject): Relation {
       return new Related(data);
     case RelationEnums.Type.Superclass:
       return new Superclass(data);
-    case RelationEnums.Type.SuperordinateLocation:
-      return new SuperordinateLocation(data);
+    case RelationEnums.Type.SuperordinateEntity:
+      return new SuperordinateEntity(data);
     case RelationEnums.Type.Identification:
       return new Identification(data);
     case RelationEnums.Type.Synonym:

diff --git a/packages/server/src/models/relation/functions.ts b/packages/server/src/models/relation/functions.ts
@@ -174,22 +174,22 @@ export const getIdentifications = async (
  * recursively search for superordinate location relations
  * @param conn
  */
-export const getSuperordinateLocationTree = async (
+export const getSuperordinateEntityTree = async (
   conn: Connection,
   asClass: EntityEnums.Class,
   parentId: string
-): Promise<EntityTooltip.ISuperordinateLocationTree> => {
-  const out: EntityTooltip.ISuperordinateLocationTree = {
+): Promise<EntityTooltip.ISuperordinateEntityTree> => {
+  const out: EntityTooltip.ISuperordinateEntityTree = {
     entityId: parentId,
     subtrees: [],
   };
 
   if (asClass === EntityEnums.Class.Location) {
-    const locations: RelationTypes.ISuperordinateLocation[] =
+    const locations: RelationTypes.ISuperordinateEntity[] =
       await Relation.findForEntity(
         conn,
         parentId,
-        RelationEnums.Type.SuperordinateLocation,
+        RelationEnums.Type.SuperordinateEntity,
         0
       );
 
@@ -200,7 +200,7 @@ export const getSuperordinateLocationTree = async (
 
     for (const subparentId of subrootIds) {
       out.subtrees.push(
-        await getSuperordinateLocationTree(conn, asClass, subparentId)
+        await getSuperordinateEntityTree(conn, asClass, subparentId)
       );
     }
   }
@@ -209,7 +209,7 @@ export const getSuperordinateLocationTree = async (
 };
 
 export const getEntityIdsFromTree = (
-  tree: EntityTooltip.ISuperordinateLocationTree
+  tree: EntityTooltip.ISuperordinateEntityTree
 ): string[] => {
   const out: string[] = [tree.entityId];
 

diff --git a/packages/server/src/models/relation/identification.ts b/packages/server/src/models/relation/identification.ts
@@ -49,7 +49,7 @@ export default class Identification
       return out;
     }
 
-    let relations: RelationTypes.IIdentification[] =
+    const relations: RelationTypes.IIdentification[] =
       await Relation.findForEntity(
         conn,
         entityId,

diff --git a/packages/server/src/models/relation/relations.ts b/packages/server/src/models/relation/relations.ts
@@ -16,11 +16,11 @@ import Related from "./related";
 import SubjectActant1Reciprocal from "./subject-actant1-reciprocal";
 import SubjectSemantics from "./subject-semantics";
 import Superclass from "./superclass";
-import SuperordinateLocation from "./superordinate-location";
+import SuperordinateEntity from "./superordinate-entity";
 import Synonym from "./synonym";
 
 type ISuperclass = RelationTypes.ISuperclass;
-type ISuperordinateLocation = RelationTypes.ISuperordinateLocation;
+type ISuperordinateEntity = RelationTypes.ISuperordinateEntity;
 type ISynonym = RelationTypes.ISynonym;
 type IAntonym = RelationTypes.IAntonym;
 type IHolonym = RelationTypes.IHolonym;
@@ -47,7 +47,7 @@ export class UsedRelations implements RelationTypes.IUsedRelations {
 
   [RelationEnums.Type.Superclass]?: RelationTypes.IDetailType<ISuperclass>;
   [RelationEnums.Type
-    .SuperordinateLocation]?: RelationTypes.IDetailType<ISuperordinateLocation>;
+    .SuperordinateEntity]?: RelationTypes.IDetailType<ISuperordinateEntity>;
   [RelationEnums.Type.Synonym]?: RelationTypes.IDetailType<ISynonym>;
   [RelationEnums.Type.Antonym]?: RelationTypes.IDetailType<IAntonym>;
   [RelationEnums.Type.Holonym]?: RelationTypes.IDetailType<IHolonym>;
@@ -98,18 +98,18 @@ export class UsedRelations implements RelationTypes.IUsedRelations {
     };
   }
 
-  async prepareSuperordinateLocations(dbConn: Connection): Promise<void> {
-    this[RelationEnums.Type.SuperordinateLocation] = {
+  async prepareSuperordinateEntitys(dbConn: Connection): Promise<void> {
+    this[RelationEnums.Type.SuperordinateEntity] = {
       connections:
-        await SuperordinateLocation.getSuperordinateLocationForwardConnections(
+        await SuperordinateEntity.getSuperordinateEntityForwardConnections(
           dbConn,
           this.entityId,
           this.entityClass,
           this.maxNestLvl,
           0
         ),
       iConnections:
-        await SuperordinateLocation.getSuperordinateLocationInverseConnections(
+        await SuperordinateEntity.getSuperordinateEntityInverseConnections(
           dbConn,
           this.entityId,
           this.entityClass
@@ -297,8 +297,8 @@ export class UsedRelations implements RelationTypes.IUsedRelations {
       await this.prepareSuperclasses(req.db.connection);
     }
 
-    if (types.indexOf(RelationEnums.Type.SuperordinateLocation) != -1) {
-      await this.prepareSuperordinateLocations(req.db.connection);
+    if (types.indexOf(RelationEnums.Type.SuperordinateEntity) != -1) {
+      await this.prepareSuperordinateEntitys(req.db.connection);
     }
 
     if (types.indexOf(RelationEnums.Type.Synonym) != -1) {

diff --git a/...models/relation/superordinate-location.ts → ...c/models/relation/superordinate-entity.ts b/...models/relation/superordinate-location.ts → ...c/models/relation/superordinate-entity.ts
@@ -3,43 +3,41 @@ import Relation from "./relation";
 import { Relation as RelationTypes } from "@shared/types";
 import { Connection } from "rethinkdb-ts";
 
-export default class SuperordinateLocation
+export default class SuperordinateEntity
   extends Relation
-  implements RelationTypes.ISuperordinateLocation
+  implements RelationTypes.ISuperordinateEntity
 {
-  type: RelationEnums.Type.SuperordinateLocation;
+  type: RelationEnums.Type.SuperordinateEntity;
   entityIds: [string, string];
   order: number;
 
-  constructor(data: Partial<RelationTypes.ISuperordinateLocation>) {
+  constructor(data: Partial<RelationTypes.ISuperordinateEntity>) {
     super(data);
     this.entityIds = data.entityIds as [string, string];
-    this.type = RelationEnums.Type.SuperordinateLocation;
+    this.type = RelationEnums.Type.SuperordinateEntity;
     this.order = data.order === undefined ? EntityEnums.Order.Last : data.order;
   }
 
-  static async getSuperordinateLocationForwardConnections(
+  static async getSuperordinateEntityForwardConnections(
     conn: Connection,
     parentId: string,
     asClass: EntityEnums.Class,
     maxNestLvl: number,
     nestLvl: number
-  ): Promise<
-    RelationTypes.IConnection<RelationTypes.ISuperordinateLocation>[]
-  > {
-    const out: RelationTypes.IConnection<RelationTypes.ISuperordinateLocation>[] =
+  ): Promise<RelationTypes.IConnection<RelationTypes.ISuperordinateEntity>[]> {
+    const out: RelationTypes.IConnection<RelationTypes.ISuperordinateEntity>[] =
       [];
 
     if (nestLvl > maxNestLvl) {
       return out;
     }
 
-    if (asClass === EntityEnums.Class.Location) {
-      const relations: RelationTypes.ISuperordinateLocation[] =
+    if (EntityEnums.LOESBV.indexOf(asClass) !== -1) {
+      const relations: RelationTypes.ISuperordinateEntity[] =
         await Relation.findForEntity(
           conn,
           parentId,
-          RelationEnums.Type.SuperordinateLocation,
+          RelationEnums.Type.SuperordinateEntity,
           0
         );
 
@@ -52,14 +50,14 @@ export default class SuperordinateLocation
 
       for (const relation of relations) {
         const subparentId = relation.entityIds[1];
-        const connection: RelationTypes.IConnection<RelationTypes.ISuperordinateLocation> =
+        const connection: RelationTypes.IConnection<RelationTypes.ISuperordinateEntity> =
           {
             ...relation,
             subtrees: [],
           };
 
         connection.subtrees =
-          await SuperordinateLocation.getSuperordinateLocationForwardConnections(
+          await SuperordinateEntity.getSuperordinateEntityForwardConnections(
             conn,
             subparentId,
             asClass,
@@ -74,18 +72,18 @@ export default class SuperordinateLocation
     return out;
   }
 
-  static async getSuperordinateLocationInverseConnections(
+  static async getSuperordinateEntityInverseConnections(
     conn: Connection,
     parentId: string,
     asClass: EntityEnums.Class
-  ): Promise<RelationTypes.ISuperordinateLocation[]> {
-    let out: RelationTypes.ISuperordinateLocation[] = [];
+  ): Promise<RelationTypes.ISuperordinateEntity[]> {
+    let out: RelationTypes.ISuperordinateEntity[] = [];
 
-    if (asClass === EntityEnums.Class.Location) {
+    if (EntityEnums.LOESBV.indexOf(asClass) !== -1) {
       out = await Relation.findForEntity(
         conn,
         parentId,
-        RelationEnums.Type.SuperordinateLocation,
+        RelationEnums.Type.SuperordinateEntity,
         1
       );
     }

diff --git a/packages/shared/enums/entities.ts b/packages/shared/enums/entities.ts
@@ -55,6 +55,14 @@ export namespace EntityEnums {
     Class.Resource,
     Class.Being,
   ];
+  export const LOESBV = [
+    Class.Location,
+    Class.Object,
+    Class.Event,
+    Class.Statement,
+    Class.Being,
+    Class.Value,
+  ];
 
   export enum Extension {
     Any = "*",