cleaned up bcgw code and adding some more comments

bcgov · Jan 16, 2024 · c9c9dba · c9c9dba
1 parent a23e458
commit c9c9dba
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 752 deletions.
diff --git a/api/src/repositories/bcgw-repository.ts b/api/src/repositories/bcgw-repository.ts
diff --git a/api/src/repositories/region-repository.ts b/api/src/repositories/region-repository.ts
@@ -49,8 +49,14 @@ export class RegionRepository extends BaseRepository {
    * Intersections are calculated based on area coverage passed in through intersectionThreshold
    * Any regions intersecting with this calculated value are returned.
    *
+   * intersectThreshold is expecting a range of values from 0.0 - 1.0.
+   * A value of 0.0 means 0% of the geometries area need to intersect meaning all values from `region_lookup` will be returned.
+   * A value of 1.0 means 100% of the geometries area need to be an exact match before returning a value.
+   * A value of 0.3 means that 30% of the geometries area need to intersect before returning a value.
+   *
+   *
    * @param {number} submissionId
-   * @param {number} [intersectThreshold=1] intersectThreshold Expected 0-1. Determines the percentage threshold for intersections to be valid
+   * @param {number} [intersectThreshold=1] intersectThreshold Expected 0.0 - 1.0. Determines the percentage threshold for intersections to be valid
    * @returns {*} {Promise<{region_id: number}}[]>} An array of found region ids
    * @memberof RegionRepository
    */

diff --git a/api/src/repositories/search-index-respository.ts b/api/src/repositories/search-index-respository.ts
@@ -267,8 +267,4 @@ export class SearchIndexRepository extends BaseRepository {
 
     return response.rows;
   }
-
-  async getSpatialRecordsForSubmissionId(submissionId: number): Promise<any[]> {
-    return [];
-  }
 }
diff --git a/api/src/services/bcgw-layer-service.test.ts b/api/src/services/bcgw-layer-service.test.ts
diff --git a/api/src/services/bcgw-layer-service.ts b/api/src/services/bcgw-layer-service.ts