Create insert panel for inserting instances and relations

.vscode/settings.json

@@ -7,5 +7,8 @@
         "out": true // set this to false to include "out" folder in search results
     },
     // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
-    "typescript.tsc.autoDetect": "off"
+    "typescript.tsc.autoDetect": "off",
+    "cSpell.words": [
+        "insertable"
+    ]
 }

commands/src/commands.ts

@@ -7,20 +7,23 @@ export enum Commands {
   INFORM = "inform",
 
   // Table Panel Commands
-  CREATE_TABLE = 'createTable',
-  ROW_CLICKED = 'rowClicked',
-  HIDE_PROPERTIES = 'hideProperties',
-  ASK_FOR_VIEWPOINTS = 'askForViewpoints',
-  ASK_FOR_COMMANDS = 'askForCommands',
-  GENERATE_TABLE_DATA = 'generateTableData',
-  UPDATE_CM_STATE = 'updateCmState',
-  REFRESH_TABLE_DATA = 'refreshTableData',
-  GET_ELEMENT_RELATIONS = 'getElementRelations',
+  CREATE_TABLE = "createTable",
+  ROW_CLICKED = "rowClicked",
+  HIDE_PROPERTIES = "hideProperties",
+  ASK_FOR_VIEWPOINTS = "askForViewpoints",
+  ASK_FOR_COMMANDS = "askForCommands",
+  GENERATE_TABLE_DATA = "generateTableData",
+  UPDATE_CM_STATE = "updateCmState",
+  REFRESH_TABLE_DATA = "refreshTableData",
+  GET_ELEMENT_RELATIONS = "getElementRelations",
   // This differs to the GET_ELEMENT_RELATIONS because it grabs the predicate/verb and object instead of the subject of the selected element
-  GET_ELEMENT_RELATIONS_TOTAL = 'getElementRelationsTotal',
-  EXECUTE_CREATE_ELEMENTS = 'executeCreateElements',
-  EXECUTE_DELETE_ELEMENTS = 'executeDeleteElements',
-  CREATE_FCR = 'createFCR',
+  GET_ELEMENT_RELATIONS_TOTAL = "getElementRelationsTotal",
+  // This differs from GET_ELEMENT_RELANTIONS_TOTAL because it gets all relations in OML Model not just a selected element
+  GET_ALL_ELEMENT_RELATIONS = "getAllElementRelations",
+  GET_ALL_INSTANCE_CATEGORIES = "getAllInstanceCategories",
+  EXECUTE_CREATE_ELEMENTS = "executeCreateElements",
+  EXECUTE_DELETE_ELEMENTS = "executeDeleteElements",
+  CREATE_FCR = "createFCR",
 
   // Property Panel Commands
   ASK_FOR_PROPERTIES = "askForProperties",
@@ -39,27 +42,29 @@ export enum Commands {
   PING_TRIPLESTORE_TASK = "pingTriplestoreTask",
 
   // Extension To Table Panel Commands
-  UPDATE_LOCAL_VALUE = 'updateLocalValue',
-  SEND_VIEWPOINTS = 'sendViewpoints',
-  SEND_COMMANDS = 'sendCommands',
-  OPEN_WIZARD = 'openWizard',
-  CREATE_FILTERED_DIAGRAM = 'createFilteredDiagram',
-  LOADED_PROPERTY_SHEET = 'loadedPropertySheet',
-  LOADED_TABLE_DATA = 'loadedTableData',
-  LOADED_ELEMENT_RELATIONS = 'loadedElementRelations',
+  UPDATE_LOCAL_VALUE = "updateLocalValue",
+  SEND_VIEWPOINTS = "sendViewpoints",
+  SEND_COMMANDS = "sendCommands",
+  OPEN_WIZARD = "openWizard",
+  CREATE_FILTERED_DIAGRAM = "createFilteredDiagram",
+  LOADED_PROPERTY_SHEET = "loadedPropertySheet",
+  LOADED_TABLE_DATA = "loadedTableData",
+  LOADED_ELEMENT_RELATIONS = "loadedElementRelations",
   // This differs to the LOADED_ELEMENT_RELATIONS because it loads the predicate/verb and object instead of the subject of the selected element
-  LOADED_ELEMENT_RELATIONS_TOTAL = 'loadedElementRelationsTotal',
-  DELETED_ELEMENTS = 'deletedElements',
-  CREATED_ELEMENT = 'createdElement',
-  CLONED_ELEMENTS = 'clonedElements',
-  SHOW_PROPERTIES = 'showProperties',
+  LOADED_ELEMENT_RELATIONS_TOTAL = "loadedElementRelationsTotal",
+  // This differs from LOADED_ELEMENT_RELATIONS_TOTAL because it loads all relations in OML Model not just a selected element
+  LOADED_ALL_ELEMENT_RELATIONS = "loadedAllElementRelations",
+  LOADED_ALL_INSTANCE_CATEGORIES = "loadedAllInstanceCategories",
+  DELETED_ELEMENTS = "deletedElements",
+  CREATED_ELEMENT = "createdElement",
+  CLONED_ELEMENTS = "clonedElements",
+  SHOW_PROPERTIES = "showProperties",
 
   // Context Menu to Triplestore.  All crud commands
-  CREATE_QUERY = 'createQuery',
-  READ_QUERY = 'readQuery',
-  UPDATE_QUERY = 'updateQuery',
-  DELETE_QUERY = 'deleteQuery',
-
+  CREATE_QUERY = "createQuery",
+  READ_QUERY = "readQuery",
+  UPDATE_QUERY = "updateQuery",
+  DELETE_QUERY = "deleteQuery",
 }
 
 export type CommandStructures = {
@@ -94,6 +99,12 @@ export type CommandStructures = {
     payload: { webviewPath: string; iriArray: string[]; labelArray?: string[] };
     wizardId?: string;
   };
+  [Commands.GET_ALL_ELEMENT_RELATIONS]: {
+    payload: { webviewPath: string };
+  };
+  [Commands.GET_ALL_INSTANCE_CATEGORIES]: {
+    payload: { webviewPath: string };
+  };
   [Commands.EXECUTE_DELETE_ELEMENTS]: {
     payload: { webviewPath: string; IRIsToDelete: ITableData[] };
     wizardId?: string;
@@ -140,10 +151,10 @@ export type CommandStructures = {
   };
   [Commands.UPDATE_LOCAL_VALUE]: {};
   [Commands.SEND_VIEWPOINTS]: {
-    payload: { [filename: string]: Record<string, string> | any[] }
+    payload: { [filename: string]: Record<string, string> | any[] };
   };
   [Commands.SEND_COMMANDS]: {
-    payload: { [filename: string]: Record<string, string> | any[] }
+    payload: { [filename: string]: Record<string, string> | any[] };
   };
   [Commands.OPEN_WIZARD]: {
     payload: {
@@ -180,6 +191,18 @@ export type CommandStructures = {
       relations?: Record<string, any>[];
     };
   };
+  [Commands.LOADED_ALL_ELEMENT_RELATIONS]: {
+    errorMessage?: string;
+    payload: {
+      relations?: string[];
+    };
+  };
+  [Commands.LOADED_ALL_INSTANCE_CATEGORIES]: {
+    errorMessage?: string;
+    payload: {
+      instances?: string[];
+    };
+  };
   [Commands.DELETED_ELEMENTS]: {
     errorMessage?: string;
     wizardId: string;
@@ -205,21 +228,21 @@ export type CommandStructures = {
   };
   [Commands.CREATE_QUERY]: {
     query: string;
-    selectedElements?: string[]
+    selectedElements?: string[];
   };
   [Commands.READ_QUERY]: {
     query: string;
-    selectedElements?: string[]
+    selectedElements?: string[];
   };
   [Commands.UPDATE_QUERY]: {
     query: string;
-    selectedElements?: string[]
-    before_parameters?: Object
-    after_parameters?: Object
+    selectedElements?: string[];
+    before_parameters?: Object;
+    after_parameters?: Object;
   };
   [Commands.DELETE_QUERY]: {
     query: string;
-    selectedElements?: string[]
+    selectedElements?: string[];
   };
 };
 

commands/src/tablePanelMessageHandler.ts

@@ -6,6 +6,8 @@ import { SparqlClient } from "../../controller/src/sparql/SparqlClient";
 import { getElementRelations } from "../../controller/src/sparql/data-manager/getElementRelations";
 import { executeDeleteElements } from "../../controller/src/sparql/data-manager/executeDeleteElements";
 import { getElementRelationsTotal } from "../../controller/src/sparql/data-manager/getElementRelationsTotal";
+import { getAllElementRelations } from "../../controller/src/sparql/data-manager/getAllElementRelations";
+import { getAllInstanceCategories } from "../../controller/src/sparql/data-manager/getAllInstanceCategories";
 
 /**
  * Handles commands that are sent to a Editor (Table, Tree, or Diagram)
@@ -101,7 +103,7 @@ export function handleTablePanelMessage(
         specificMessage.payload.labelArray
       );
       break;
-    
+
     case Commands.GET_ELEMENT_RELATIONS_TOTAL:
       specificMessage =
         message as CommandStructures[Commands.GET_ELEMENT_RELATIONS_TOTAL];
@@ -121,14 +123,30 @@ export function handleTablePanelMessage(
       const { webviewPath: delWebviewPath, IRIsToDelete = [] } =
         specificMessage.payload;
 
-        // Refer to the CommandStructures[Commands.EXECUTE_DELETE_ELEMENTS] to see how the parameters are structured
-        executeDeleteElements(
-          specificMessage.payload.webviewPath,
-          specificMessage.wizardId,
-          specificMessage.payload.IRIsToDelete,
-        )
+      // Refer to the CommandStructures[Commands.EXECUTE_DELETE_ELEMENTS] to see how the parameters are structured
+      executeDeleteElements(
+        specificMessage.payload.webviewPath,
+        specificMessage.wizardId,
+        specificMessage.payload.IRIsToDelete
+      );
       break;
 
+    case Commands.GET_ALL_ELEMENT_RELATIONS:
+      specificMessage =
+        message as CommandStructures[Commands.GET_ALL_ELEMENT_RELATIONS];
+      const { webviewPath: relationWebviewPath } = specificMessage.payload;
+
+      // Refer to the CommandStructures[Commands.GET_ALL_ELEMENT_RELATIONS] to see how the parameters are structured
+      getAllElementRelations(specificMessage.payload.webviewPath);
+
+    case Commands.GET_ALL_INSTANCE_CATEGORIES:
+      specificMessage =
+        message as CommandStructures[Commands.GET_ALL_INSTANCE_CATEGORIES];
+      const { webviewPath: instanceWebviewPath } = specificMessage.payload;
+
+      // Refer to the CommandStructures[Commands.GET_ALL_ELEMENT_RELATIONS] to see how the parameters are structured
+      getAllInstanceCategories(specificMessage.payload.webviewPath);
+
     case Commands.CREATE_FCR:
       specificMessage = message as CommandStructures[Commands.CREATE_FCR];
       const fcrPayload = specificMessage.payload;

controller/src/extension.ts

@@ -514,5 +514,3 @@ export function activate(context: vscode.ExtensionContext) {
 function cloneSelectedRows(context: Record<string, any>) {
   throw new Error("Function not implemented.");
 }
-
-

controller/src/sparql/data-manager/getAllElementRelations.ts

@@ -0,0 +1,59 @@
+import * as vscode from "vscode";
+import { TablePanel } from "../../panels/TablePanel";
+import { Commands } from "../../../../commands/src/commands";
+import { SparqlClient } from "../SparqlClient";
+import { getAllRelations } from "../queries/getAllRelations";
+
+/**
+ * This SPARQL query gets all distinct relations from a given OML model and sends them through a controller command.
+ *
+ * @remarks
+ * For more information on OML relations please refer to the official documentation found {@link http://www.opencaesar.io/oml/#Relations | here}
+ *
+ * For more information on the postMessage controller command please refer to the official documentation found {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage | here}
+ *
+ * @returns
+ *
+ */
+export const getAllElementRelations = async (
+  webviewPath: string
+): Promise<void> => {
+  try {
+    const relations_query = getAllRelations();
+    const relations_data = await SparqlClient(relations_query, "query");
+
+    // Get all relation values
+    const relations: string[] = relations_data.map(
+      (relation: Record<string, string>) => {
+        // We only want values because the record will look like verb: relation_value
+        // We're only grabbing the verb from the key value pair
+        // If the relation.verb is not undefined then return it else return a blank string
+        return relation.verb.split("/").pop() ?? "";
+      }
+    );
+
+    // Send data to current webview
+    TablePanel.currentPanels.get(webviewPath)?.sendMessage({
+      command: Commands.LOADED_ALL_ELEMENT_RELATIONS,
+      payload: {
+        relations: relations,
+      },
+    });
+  } catch (error) {
+    if (error instanceof Error) {
+      vscode.window.showErrorMessage(`Error: ${error.message}`);
+      TablePanel.currentPanels.get(webviewPath)?.sendMessage({
+        command: Commands.LOADED_ALL_ELEMENT_RELATIONS,
+        payload: {},
+        errorMessage: `Error: ${error.message}`,
+      });
+    } else {
+      vscode.window.showErrorMessage(`An unknown error occurred: ${error}`);
+      TablePanel.currentPanels.get(webviewPath)?.sendMessage({
+        command: Commands.LOADED_ALL_ELEMENT_RELATIONS,
+        payload: {},
+        errorMessage: `An unknown error occurred: ${error}`,
+      });
+    }
+  }
+};

controller/src/sparql/data-manager/getAllInstanceCategories.ts

@@ -0,0 +1,57 @@
+import * as vscode from "vscode";
+import { TablePanel } from "../../panels/TablePanel";
+import { Commands } from "../../../../commands/src/commands";
+import { SparqlClient } from "../SparqlClient";
+import { getAllInstances } from "../queries/getAllInstances";
+
+/**
+ * This SPARQL query gets all distinct instances from a given OML model and sends them through a controller command.
+ *
+ * @remarks
+ * For more information on OML instances please refer to the official documentation found {@link http://www.opencaesar.io/oml/#Instances-LR | here}
+ *
+ * For more information on the postMessage controller command please refer to the official documentation found {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage | here}
+ *
+ * @returns
+ *
+ */
+export const getAllInstanceCategories = async (
+  webviewPath: string
+): Promise<void> => {
+  try {
+    const instance_query = getAllInstances();
+    const instance_data = await SparqlClient(instance_query, "query");
+    // Get all instance values
+    const instances: string[] = instance_data.map(
+      (instance: Record<string, string>) => {
+        // We only want values because the record will look like verb: instance_value
+        // We're only grabbing the verb from the key value pair
+        // If the instance.verb is not undefined then return it else return a blank string
+        return instance.subject.split("/").pop() ?? "";
+      }
+    );
+    // Send data to current webview
+    TablePanel.currentPanels.get(webviewPath)?.sendMessage({
+      command: Commands.LOADED_ALL_INSTANCE_CATEGORIES,
+      payload: {
+        instances: instances,
+      },
+    });
+  } catch (error) {
+    if (error instanceof Error) {
+      vscode.window.showErrorMessage(`Error: ${error.message}`);
+      TablePanel.currentPanels.get(webviewPath)?.sendMessage({
+        command: Commands.LOADED_ALL_INSTANCE_CATEGORIES,
+        payload: {},
+        errorMessage: `Error: ${error.message}`,
+      });
+    } else {
+      vscode.window.showErrorMessage(`An unknown error occurred: ${error}`);
+      TablePanel.currentPanels.get(webviewPath)?.sendMessage({
+        command: Commands.LOADED_ALL_INSTANCE_CATEGORIES,
+        payload: {},
+        errorMessage: `An unknown error occurred: ${error}`,
+      });
+    }
+  }
+};

controller/src/sparql/queries/getAllInstances.ts

@@ -0,0 +1,21 @@
+/**
+ * This SPARQL query gets all distinct instances from a given OML model
+ *
+ * @remarks
+ * For more information on OML instances please refer to the official documentation found {@link http://www.opencaesar.io/oml/#Instances-LR | here}
+ *
+ * For more information on SPARQL query `regex` and `str` please refer to the official documentation found {@link https://www.w3.org/TR/sparql11-query/ | here}
+ *
+ * @returns SPARQL select query string
+ *
+ */
+
+export function getAllInstances(): string {
+  return `SELECT DISTINCT ?subject
+    WHERE {
+      ?subject ?verb ?object .
+      FILTER regex(str(?subject), "vocabulary", "i")
+      FILTER regex(str(?object), "Concept", "i")
+    }
+    ORDER BY ?subject`;
+}

controller/src/sparql/queries/getAllRelations.ts

@@ -0,0 +1,21 @@
+/**
+ * This SPARQL query gets all relations from a given OML model
+ *
+ * @remarks
+ * For more information on OML relations please refer to the official documentation found {@link http://www.opencaesar.io/oml/#Relations | here}
+ *
+ * For more information on SPARQL query `regex` and `str` please refer to the official documentation found {@link https://www.w3.org/TR/sparql11-query/ | here}
+ *
+ * @returns SPARQL select query string
+ *
+ */
+
+export function getAllRelations(): string {
+  return `SELECT DISTINCT ?verb
+    WHERE {
+      ?subject ?verb ?object .
+      FILTER regex(str(?subject), "description", "i")
+      FILTER regex(str(?verb), "vocabulary", "i")
+    }
+    ORDER BY ?verb`;
+}