RACK Nature: better leverage Eclipse workflow patterns for RACK development

[chrisage]

Background: The RITE IDE has RACK functionality spread across views, buttons and menu clicks. These functions should align better to Eclipse's standards for better organization and usability.

Reorganizing the RACK functions within RITE will lower the learning curve and add usability. Additional functionality will encourage users to user RITE for data gathering.

The goal is to make RITE a tool to more easily organize data into an RDF database

Acceptance Criteria: Addition of RACK type projects

Implementation Details:

1. Create a RACK Type Projects - designating a Project 'RACK' Type enables:

   • Import as RACK Type - automatically imports dependencies to the project based on manifest
   • Code completion (source headers from rack resources e.g. csv headers etc.)
   • Validations & hover over text (resolution recommendations)
   • Automatically add scaffolding / required files when a (data, nodegroup, manifest) module is added
   • Follow the Architecture from the pre-existing plugin: https://github.com/helospark/kube-editor/tree/master/src/com/helospark/kubeeditor

2. Consolidate right-click resources under a 'RACK' submenu

   • copy the maven action structure (run as, update, etc.)

3. Create a 'RACK' perspective

   • When a RACK action is run, the perspective is opened which includes all RACK views so the user doesn't have to search for them

Refer to this tutorial: https://www.vogella.com/tutorials/EclipseProjectNatures/article.html#project-natures-in-eclipse

[saratge]

Very good observations and vision @chrisage!

[chrisage]

• Remove "Set as Rack Project" -> Replace with Import as Rack Project Instead of General Project
• Group Upload as Ingestion Package and Upload Nodegroups under a single RACK actions menu (ref maven menu)

[chrisage]

• Move all RACK actions to right-click menu (removing necessity for RACK project designation) except for Clear RACK and RACK settings

[chrisage]

• Create RACK Project Nature
• Add a 'Create new Ingestion Package' workflow in the import wizard
• Once a project is added as a RACK project, enable RACK project validations & add menu (e.g. add new 'Nodegroups')
  • SADL File Validations
  • Project Heirarchy Rules (eclipse warnings / errors on files and compilations)
    • Warning on: multiple manifests in a single project
    • Warning on import.yaml - Validations on model.yaml and data.yaml files

[chrisage]

RACK Projects are associated with the RACK Perspective - when a project opens, RACK development views open

[chrisage]

@davidcok Currently there are RACK (eclipse) views in RITE that expose a connected RACK state. We only support a single instance of RACK to be connected at once. The project explorer may contain many instances of local ingestion packages. The idea is that you can collect multiple data modules locally, and upload them piecemeal. There exists a "Generate Ingestion Data" workflow - a user right clicks an ontology entity (object model) from the RACK ontology view panel and can choose to add instance data for that entity type. The UX problem is that there could multiple RACK ingestion packages in the project explorer, but adding instance data should only be applied to one of them. Is there a good UX pattern to designate which project the instance data should be added to? Currently, we have the designate a main RACK package (globally), and the instance data is saved there.

[chrisage]

Great Tutorials:

• Import Wizard: https://www.vogella.com/tutorials/EclipseWizards/article.html
• Project Nature: https://www.vogella.com/tutorials/EclipseProjectNatures/article.html
• Configuring Import as New Menu Item: https://help.eclipse.org/latest/index.jsp?topic=%2Forg.eclipse.pde.doc.user%2Freference%2Fextension-points%2Forg_eclipse_pde_ui_newExtension.html
• Example Configuration Project: https://github.com/harperjiang/TeXDojo/blob/master/LaTeXEditorPlugin/plugin.xml
  • Latex Nature Example: https://github.com/harperjiang/TeXDojo/blob/master/LaTeXEditorPlugin/src/hao/texdojo/latexeditor/project/LaTeXNature.java
  • Latex Builder Example (does the heavy-lifting): https://github.com/harperjiang/TeXDojo/blob/master/LaTeXEditorPlugin/src/hao/texdojo/latexeditor/project/LaTeXBuilder.java
• Xtext Plugin Repo (to extend for nature): https://github.com/eclipse/xtext
  • Toggle Nature: https://github.com/eclipse/xtext/blob/main/org.eclipse.xtext.builder/src/org/eclipse/xtext/builder/nature/ToggleXtextNatureCommand.java
  • XText Nature: https://github.com/eclipse/xtext/blob/main/org.eclipse.xtext.builder/src/org/eclipse/xtext/builder/nature/XtextNature.java
  • XText Builder: https://github.com/eclipse/xtext/blob/main/org.eclipse.xtext.builder/src/org/eclipse/xtext/builder/impl/XtextBuilder.java#L74