BI-2109 - Create Sub-entity Dataset from UI

src/assets/scss/main.scss

@@ -84,6 +84,8 @@ $table-striped-row-even-hover-background-color:$link-light;
 $medium-modal-content-width: $modal-content-width * 1.4;
 $medium-modal-body-padding: 0 3em 2em 3em;
 
+$large-modal-content-width: $modal-content-width * 1.8;
+
 //$margin-right: 2 rem;
 
 // Import buefy before bulma
@@ -904,7 +906,7 @@ tr:nth-child(odd) td.db-filled {
   }
 }
 
-.experiment-observations-download-button {
+.sub-entity-dataset-modal, .experiment-observations-download-button {
   .modal {
     .modal-card {
       width: $medium-modal-content-width;
@@ -915,6 +917,17 @@ tr:nth-child(odd) td.db-filled {
   }
 }
 
+.sub-entity-dataset-modal {
+  .modal {
+    .modal-card {
+      width: $large-modal-content-width;
+      .modal-card-body {
+        padding: $medium-modal-body-padding;
+      }
+    }
+  }
+}
+
 .content {
   .pagination-list {
     margin-top: 0;

src/breeding-insight/dao/ExperimentDAO.ts

@@ -20,6 +20,7 @@ import * as api from "@/util/api";
 import {Result, ResultGenerator} from "@/breeding-insight/model/Result";
 import {Trial} from "@/breeding-insight/model/Trial.ts";
 import {DatasetModel} from "@/breeding-insight/model/DatasetModel";
+import {DatasetMetadata} from "@/breeding-insight/model/DatasetMetadata";
 
 export class ExperimentDAO {
 
@@ -38,6 +39,22 @@ export class ExperimentDAO {
             return ResultGenerator.err(error);
         }
     }
+
+    static async getDatasetMetadata(programId: string, experimentId: string): Promise<Result<Error, DatasetMetadata[]>> {
+        const config: any = {};
+        config.url = `${process.env.VUE_APP_BI_API_V1_PATH}/programs/${programId}/experiments/${experimentId}/datasets`;
+        config.method = 'get';
+        config.programId = programId;
+        config.experimentId = experimentId;
+        try {
+            const res = await api.call(config) as Response;
+            let { result } = res.data;
+            return ResultGenerator.success(result);
+        } catch (error) {
+            return ResultGenerator.err(error);
+        }
+    }
+
     static async getDatasetById(programId: string, experimentId: string, datasetId: string, stats: boolean): Promise<Result<Error, DatasetModel>> {
         const config: any = {};
         config.url = `${process.env.VUE_APP_BI_API_V1_PATH}/programs/${programId}/experiments/${experimentId}/dataset/${datasetId}`;
@@ -57,4 +74,19 @@ export class ExperimentDAO {
         }
     }
 
+    static async createSubEntityDataset(programId: string, experimentId: string, name: string, repeatedMeasures: number): Promise<Result<Error, DatasetModel>> {
+        const config: any = {};
+        config.url = `${process.env.VUE_APP_BI_API_V1_PATH}/programs/${programId}/experiments/${experimentId}/dataset`;
+        config.method = 'post';
+        config.programId = programId;
+        config.experimentId = experimentId;
+        config.data = {name: name, repeatedMeasures: repeatedMeasures}  // Corresponds to SubEntityDatasetRequest in bi-api.
+        try {
+            const res = await api.call(config) as Response;
+            let { result } = res.data;
+            return ResultGenerator.success(result);
+        } catch (error) {
+            return ResultGenerator.err(error);
+        }
+    }
 }

src/breeding-insight/model/ExperimentDatasetOption.ts → src/breeding-insight/model/DatasetMetadata.ts

@@ -15,16 +15,21 @@
  * limitations under the License.
  */
 
-import {SelectOption} from "@/breeding-insight/model/SelectOption";
+import {Observation} from "@/breeding-insight/model/Observation";
+import {ObservationUnit} from "@/breeding-insight/model/ObservationUnit";
+import {ObservationVariable} from "@/breeding-insight/model/ObservationVariable";
 
-export class ExperimentDatasetOption implements SelectOption<string, string> {
-    static observations = new ExperimentDatasetOption("Observation Dataset", "observations");
-
-    name: string;
+export class DatasetMetadata {
     id: string;
+    name: string;
+    level: number;
 
-    constructor(name: string, id: string) {
-        this.name = name;
+    constructor(id: string,
+                name: string,
+                level: number
+    ) {
         this.id = id;
+        this.name = name;
+        this.level = level;
     }
 }

src/breeding-insight/model/DatasetModel.ts

@@ -28,7 +28,6 @@ export class DatasetModel {
   additionalInfo?: any;
 
 
-
   constructor(id: string,
               experimentId: string,
               data: Observation[],

src/breeding-insight/model/ExperimentExportOptions.ts

@@ -22,7 +22,7 @@ import {ExperimentDatasetOption} from "@/breeding-insight/model/ExperimentDatase
 export class ExperimentExportOptions {
 
     public fileExtension: string = FileTypeOption.xls.id;
-    public dataset: string = ExperimentDatasetOption.observations.id;
+    public datasetId: string;
     public environments: string[] = [];
     public allEnvironments: boolean = false;
     public includeTimestamps: string = 'No';

src/breeding-insight/model/SubEntityDatasetNewRequest.ts

@@ -0,0 +1,31 @@
+/*
+ * See the NOTICE file distributed with this work for additional information
+ * regarding copyright ownership.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {Observation} from "@/breeding-insight/model/Observation";
+import {ObservationUnit} from "@/breeding-insight/model/ObservationUnit";
+import {ObservationVariable} from "@/breeding-insight/model/ObservationVariable";
+
+export class SubEntityDatasetNewRequest {
+    name: string;
+    repeatedMeasures: number;
+
+
+    constructor(name: string, repeatedMeasures: string) {
+        this.name = name;
+        this.repeatedMeasures = repeatedMeasures;
+    }
+}

src/breeding-insight/service/ExperimentService.ts

@@ -16,9 +16,12 @@
  */
 
 import {ExperimentDAO} from "@/breeding-insight/dao/ExperimentDAO";
-import {Trial} from "@/breeding-insight/model/Trial.ts";
+import {Trial} from "@/breeding-insight/model/Trial";
 import {Result, ResultGenerator} from "@/breeding-insight/model/Result";
 import {DatasetModel} from "@/breeding-insight/model/DatasetModel";
+import {DatasetMetadata} from "@/breeding-insight/model/DatasetMetadata";
+import {SubEntityDatasetNewRequest} from "@/breeding-insight/model/SubEntityDatasetNewRequest";
+import {BrAPIUtils} from "@/breeding-insight/utils/BrAPIUtils";
 
 export class ExperimentService {
 
@@ -36,4 +39,36 @@ export class ExperimentService {
         return await ExperimentDAO.getDatasetById(programId,experimentId, datasetId, true);
     }
 
+    static async createSubEntityDataset(programId: string, experimentId: string, subEntityRequest: SubEntityDatasetNewRequest): Promise<Result<Error, DatasetModel>> {
+        if (!programId) {
+            return ResultGenerator.err(new Error('Missing or invalid program id'));
+        }
+        return await ExperimentDAO.createSubEntityDataset(programId, experimentId, subEntityRequest.name, subEntityRequest.repeatedMeasures);
+    }
+
+    static async getDatasetMetadata(programId: string, experimentId: string): Promise<Result<Error, DatasetMetadata[]>> {
+        if (!programId) {
+            return ResultGenerator.err(new Error('Missing or invalid program id'));
+        }
+        return await ExperimentDAO.getDatasetMetadata(programId, experimentId);
+    }
+
+    static async getDatasetMetadataByTrial(programId: string, trial: Trial): Promise<Result<Error, DatasetMetadata[]>> {
+        if (!programId) {
+            return ResultGenerator.err(new Error('Missing or invalid program id'));
+        }
+        if (!trial) {
+            return ResultGenerator.err(new Error('Missing or invalid trial'));
+        }
+        if (!trial.externalReferences) {
+            return ResultGenerator.err(new Error('Trial is missing external references'));
+        }
+        // Try to get the /trials external reference.
+        let externalReferenceId = BrAPIUtils.getBreedingInsightId(trial.externalReferences, '/trials');
+        // Throw if trial is missing ExternalReferenceId.
+        if (!externalReferenceId) {
+            return ResultGenerator.err(new Error("Trial is missing external reference."));
+        }
+        return await ExperimentDAO.getDatasetMetadata(programId, externalReferenceId);
+    }
 }

src/components/experiments/ExperimentObservationsDownloadModal.vue

@@ -20,7 +20,7 @@
     v-bind:unique-id="trialId"
     v-bind:modal-title="modalTitle"
     v-bind:download="downloadList"
-    v-bind:active="active && loadingStudyOptionsComplete"
+    v-bind:active="active && loadingStudyOptionsComplete && loadingDatasetOptionsComplete"
     modal-class="experiment-observations-download-button"
     v-on:deactivate="resetExportOptions"
   >
@@ -37,7 +37,7 @@
               <div class="select">
                 <select
                   v-bind:id="`dataset-select-${trialId}`"
-                  v-model="fileOptions.dataset"
+                  v-model="fileOptions.datasetId"
                 >
                   <option
                     v-for="option in datasetOptions"
@@ -157,15 +157,16 @@ import {mapGetters} from "vuex";
 import {Program} from "@/breeding-insight/model/Program";
 import {ExperimentExportOptions} from "@/breeding-insight/model/ExperimentExportOptions";
 import {FileTypeOption} from "@/breeding-insight/model/FileTypeOption";
-import {ExperimentDatasetOption} from "@/breeding-insight/model/ExperimentDatasetOption";
 import {AlertTriangleIcon} from 'vue-feather-icons';
 import {Trial} from "@/breeding-insight/model/Trial";
 import {Metadata} from "@/breeding-insight/model/BiResponse";
 import {Study} from "@/breeding-insight/model/Study";
 import {StudyService} from "@/breeding-insight/service/StudyService";
 import {Result} from "@/breeding-insight/model/Result";
 import {BrAPIUtils} from "@/breeding-insight/utils/BrAPIUtils";
-import DownloadModal from "@/components/DownloadModal.vue";
+import DownloadModal from "@/components/modals/DownloadModal.vue";
+import {DatasetMetadata} from "@/breeding-insight/model/DatasetMetadata";
+import {ExperimentService} from "@/breeding-insight/service/ExperimentService";
 
 @Component({
   mixins: [validationMixin],
@@ -186,20 +187,25 @@ export default class ExperimentObservationsDownloadModal extends Vue {
   experiment!: Trial;
   @Prop()
   modalTitle?: string;
+  @Prop()
+  defaultDatasetId?: string;
 
   private activeProgram?: Program;
   private fileOptions: ExperimentExportOptions = new ExperimentExportOptions();
   private showEnvironmentsValidationError: boolean = false;
   private fileExtensionOptions: object[] = Object.values(FileTypeOption);
-  private datasetOptions: object[] = Object.values(ExperimentDatasetOption);
+  private datasetOptions: DatasetMetadata[] = [];
   private environmentOptions: object[] = [];
   private loadingStudyOptionsComplete: boolean = false;
+  private loadingDatasetOptionsComplete: boolean = false;
 
   @Watch('experiment', {immediate: true})
   onExperimentChanged() {
-    // reset loading flag
+    // Reset loading flags.
     this.loadingStudyOptionsComplete = false;
+    this.loadingDatasetOptionsComplete = false;
     this.getStudyOptions();
+    this.getDatasetOptions();
   }
 
   async getStudyOptions() {
@@ -217,6 +223,34 @@ export default class ExperimentObservationsDownloadModal extends Vue {
     }
   }
 
+  async getDatasetOptions() {
+    // Fetch all datasets available for this experiment.
+    try {
+      const response: Result<Error, DatasetMetadata[]> = await ExperimentService.getDatasetMetadataByTrial(this.activeProgram!.id!, this.experiment!);
+      if (response.isErr()) {
+        throw response.value;
+      }
+      this.datasetOptions = response.value;
+
+      this.setDefaultDatasetOption();
+
+      this.loadingDatasetOptionsComplete = true;
+    } catch (err) {
+      // Display error that datasets cannot be loaded
+      this.$emit('show-error-notification', 'Error while trying to load datasets');
+      throw err;
+    }
+  }
+
+  setDefaultDatasetOption() {
+    // Set default selected dataset to property if provided, fall back to first in list of options.
+    if (this.defaultDatasetId !== undefined) {
+      this.fileOptions.datasetId = this.defaultDatasetId;
+    } else if (this.datasetOptions.length > 0){
+      this.fileOptions.datasetId = this.datasetOptions[0].id;
+    }
+  }
+
   downloadList(): boolean {
     // Validate selected options.
     if (this.validateOptions()) {
@@ -229,8 +263,8 @@ export default class ExperimentObservationsDownloadModal extends Vue {
             + this.trialId
             + '/export?fileExtension='
             + this.fileOptions.fileExtension
-            + '&dataset='
-            + this.fileOptions.dataset
+            + '&datasetId='
+            + this.fileOptions.datasetId
             + (this.fileOptions.allEnvironments ? '' : ('&environments=' + this.fileOptions.environments))
             + '&includeTimestamps='
             + this.fileOptions.timestampsTrueFalseString(),
@@ -246,6 +280,8 @@ export default class ExperimentObservationsDownloadModal extends Vue {
     this.$emit('deactivate');
     // Reset file export options.
     this.fileOptions = new ExperimentExportOptions();
+    // Make sure default dataset option is selected.
+    this.setDefaultDatasetOption();
     // Reset validation state.
     this.showEnvironmentsValidationError = false;
   }