Merge pull request #117 from STEMLab/op2rel

02/26 change parameter name op to rel in geometric query

Author: Csenongmin

data/PNU-201_with_interior_shell.json

@@ -640,7 +640,7 @@
           {
             "id": "C3",
             "featureType": "CellSpace",
-            "poi": true,
+            "poi": false,
             "cellSpaceGeom": {
               "geometry3D": {
                 "type": "Polyhedron",
@@ -34964,7 +34964,7 @@
           {
             "id": "C72",
             "featureType": "CellSpace",
-            "poi": false,
+            "poi": true,
             "cellSpaceGeom": {
               "geometry3D": {
                 "type": "Polyhedron",

openAPI/IndoorFeature_openAPI.yaml openAPI/IndoorFefature_openAPI.yamlopenAPI/IndoorFeature_openAPI.yaml renamed to openAPI/IndoorFefature_openAPI.yaml

@@ -966,22 +966,22 @@ paths:
         Performs a spatial query against the **PrimalSpace** of a specific ThematicLayer using 2D geometric predicates.
 
         **Functionality:**
-        This operation filters `CellSpace` geometries based on a provided spatial operator (`op`) and a reference geometry. Unlike a standard bounding box filter, this endpoint supports complex topological predicates (e.g., *intersects*, *contains*, *within*) defined by the OGC Simple Features standard.
+        This operation filters `CellSpace` geometries based on a provided spatial relation (`rel`) and a reference geometry. Unlike a standard bounding box filter, this endpoint supports complex topological predicates (e.g., *intersects*, *contains*, *within*) defined by the OGC Simple Features standard.
 
         **Spatial Duality Logic:**
         - **Primal Space:** Only the `CellSpaceMember` items that satisfy the geometric predicate are returned.
         - **Dual Space:** All of the Nodes and Edges in specified ThematicLayer are returned.
 
         **Parameters:**
-        - `op`: The geometric predicate to apply (e.g., `intersects`, `within`, `contains`).
+        - `rel`: The geometric predicate to apply (e.g., `intersects`, `within`, `contains`).
         - `geometry`: The reference geometry in WKT (Well-Known Text) format used for the predicate.
         - `level`: (Optional) Restricts the search to a specific floor or vertical level within the IndoorGML model.
 
         **Response:**
         Returns a single `ThematicLayer` object containing the filtered Primal and Dual space components.
       operationId: geometricQuery
       parameters:
-        - $ref: '#/components/parameters/op'
+        - $ref: '#/components/parameters/rel'
         - $ref: '#/components/parameters/level'
         - $ref: '#/components/parameters/geometry'
       responses:
@@ -3577,12 +3577,12 @@ components:
       description: Filter results to include only those matching the specified CellSpace name. Exact Match
       schema:
         type: string
-    op:
-      name: op
+    rel:
+      name: rel
       in: query
       required: true
       description: |-
-        Spatial predicate operation applied between the input geometry
+        Spatial predicate relations applied between the input geometry
         and CellSpace geometries.
 
         Supported operations:

openAPI/openAPI_schema.yml

@@ -620,22 +620,22 @@ paths:
         Performs a spatial query against the **PrimalSpace** of a specific ThematicLayer using 2D geometric predicates.
         
         **Functionality:**
-        This operation filters `CellSpace` geometries based on a provided spatial operator (`op`) and a reference geometry. Unlike a standard bounding box filter, this endpoint supports complex topological predicates (e.g., *intersects*, *contains*, *within*) defined by the OGC Simple Features standard.
+        This operation filters `CellSpace` geometries based on a provided spatial relation (`rel`) and a reference geometry. Unlike a standard bounding box filter, this endpoint supports complex topological predicates (e.g., *intersects*, *contains*, *within*) defined by the OGC Simple Features standard.
 
         **Spatial Duality Logic:**
         - **Primal Space:** Only the `CellSpaceMember` items that satisfy the geometric predicate are returned.
         - **Dual Space:** All of the Nodes and Edges in specified ThematicLayer are returned.
 
         **Parameters:**
-        - `op`: The geometric predicate to apply (e.g., `intersects`, `within`, `contains`).
+        - `rel`: The geometric predicate to apply (e.g., `intersects`, `within`, `contains`).
         - `geometry`: The reference geometry in WKT (Well-Known Text) format used for the predicate.
         - `level`: (Optional) Restricts the search to a specific floor or vertical level within the IndoorGML model.
 
         **Response:**
         Returns a single `ThematicLayer` object containing the filtered Primal and Dual space components.
       operationId: geometricQuery
       parameters:
-        - $ref: './parameters/op.yml'
+        - $ref: './parameters/rel.yml'
         - $ref: './parameters/level.yml'
         - $ref: './parameters/geometry.yml'
       responses:

openAPI/parameters/op.yml openAPI/parameters/rel.ymlopenAPI/parameters/op.yml renamed to openAPI/parameters/rel.yml

@@ -1,8 +1,8 @@
-name: op
+name: rel
 in: query
 required: true
 description: |-
-  Spatial predicate operation applied between the input geometry
+  Spatial predicate relations applied between the input geometry
   and CellSpace geometries.
 
   Supported operations:

pygeoapi/api/indoorgml.py

@@ -1443,7 +1443,7 @@ def get_geometric_query(api: API, request: APIRequest, collection_id: str, item_
     :param item_id: Item ID
     :param layer_id: Layer ID
     :param geometry: Input geometry expressed as a 2D Well-Known Text (WKT) string.
-    :param op: Spatial predicate operation applied between the input geometry and CellSpace geometries.
+    :param rel: Spatial predicate relation applied between the input geometry and CellSpace geometries.
     :param level: Filters the indoorFeatures, thematicLayer, and primalSpace content by a specific floor level.
 
     :return: ThematicLayer computed by specific op with geometry
@@ -1453,17 +1453,17 @@ def get_geometric_query(api: API, request: APIRequest, collection_id: str, item_
 
     headers = request.get_response_headers(SYSTEM_LOCALE)
     pidb_provider = PostgresIndoorDB()
-    op_param = request.params.get('op')
+    rel_param = request.params.get('rel')
     geom_param = request.params.get('geometry')
     level = request.params.get('level')
-    if not op_param or not geom_param:
-        msg = 'parameter op and geom should be required'
+    if not rel_param or not geom_param:
+        msg = 'parameter rel and geometry should be required'
         return api.get_exception(
             HTTPStatus.BAD_REQUEST,
             headers, request.format, 'InvalidParameterValue', msg)
 
-    elif op_param.lower() not in ["contains", "within", "intersects"]:
-        msg = 'parameter op should be an one of ["contains", "within", "intersects"]'
+    elif rel_param.lower() not in ["contains", "within", "intersects"]:
+        msg = 'parameter rel should be an one of ["contains", "within", "intersects"]'
         return api.get_exception(
             HTTPStatus.BAD_REQUEST,
             headers, request.format, 'InvalidParameterValue', msg)
@@ -1479,14 +1479,14 @@ def get_geometric_query(api: API, request: APIRequest, collection_id: str, item_
 
     try:
         pidb_provider.connect()
-        result = pidb_provider.geometric_query(collection_id, item_id, layer_id, op=op_param.lower(), geometry=geom, level=level)
+        result = pidb_provider.geometric_query(collection_id, item_id, layer_id, rel=rel_param.lower(), geometry=geom, level=level)
         if not result:
             raise Exception()
         base_url = f"{api.config['server']['url']}/collections/{collection_id}/items/{item_id}/layers/{layer_id}/geoquery"
 
         query_params = {}
-        if op_param:
-            query_params['op'] = op_param
+        if rel_param:
+            query_params['rel'] = rel_param
         if geom:
             query_params['geometry'] = geom
 

pygeoapi/provider/postgresql_indoordb.py

@@ -2911,10 +2911,10 @@ def delete_dual_member(self, collection_id:str, feature_id:str, layer_id:str, me
 # endregion      
 
 # region Services
-    def geometric_query(self, collection_id:str, feature_id:str, layer_id:str, op:str=None, geometry:str=None, level:str=None):
+    def geometric_query(self, collection_id:str, feature_id:str, layer_id:str, rel:str=None, geometry:str=None, level:str=None):
         with self.connection.cursor(cursor_factory=RealDictCursor) as cur:
-            if not op or not geometry:
-                LOGGER.debug("The 'op' and 'geometry' parameter are required.")
+            if not rel or not geometry:
+                LOGGER.debug("The 'rel' and 'geometry' parameter are required.")
                 return False
             lookup_sql = """
                 SELECT t.*
@@ -2928,7 +2928,7 @@ def geometric_query(self, collection_id:str, feature_id:str, layer_id:str, op:st
             if not row:
                 return {}
 
-            primal = self._get_primal_geometric_query(row['id'], row['primalspace_id_str'], op=op, geometry=geometry, level=level,
+            primal = self._get_primal_geometric_query(row['id'], row['primalspace_id_str'], rel=rel, geometry=geometry, level=level,
                                                       p_create=row['p_creation_datetime'], p_terminate=row['p_termination_datetime'])
             dual = self._get_dual_space(row['id'], row['dualspace_id_str'], d_create=row['d_creation_datetime'], 
                                         d_terminate=row['d_termination_datetime'], is_logical=row['is_logical'], is_directed=row['is_directed'])
@@ -2944,7 +2944,7 @@ def geometric_query(self, collection_id:str, feature_id:str, layer_id:str, op:st
 
             return result_layer
 
-    def _get_primal_geometric_query(self, layer_id:str, pSpace_id:str, op: str, geometry: str, level: str = None, p_create=None, p_terminate=None):
+    def _get_primal_geometric_query(self, layer_id:str, pSpace_id:str, rel: str, geometry: str, level: str = None, p_create=None, p_terminate=None):
         primal_space = {
             "id": pSpace_id, 
             "featureType": "PrimalSpaceLayer",
@@ -2971,14 +2971,14 @@ def _get_primal_geometric_query(self, layer_id:str, pSpace_id:str, op: str, geom
                 geometric_query += " AND c.level = %s "
                 params_cells.append(level)
 
-            if op == 'contains':
+            if rel == 'contains':
                 geometric_query += """ AND ST_Contains(c."2D_geometry", ST_GeomFromText(%s, 0)) """
                 LOGGER.debug(geometry)
                 params_cells.append(geometry)
-            elif op == 'within':
+            elif rel == 'within':
                 geometric_query += """ AND ST_Within(c."2D_geometry", ST_GeomFromText(%s, 0)) """
                 params_cells.append(geometry)
-            elif op == 'intersects':
+            elif rel == 'intersects':
                 geometric_query += """ AND ST_Intersects(c."2D_geometry", ST_GeomFromText(%s, 0)) """
                 params_cells.append(geometry)
             else:

pygeoapi/static/workSpace/demo.html

@@ -80,7 +80,7 @@
       <details class="dropdown">
         <summary class="dropdown-summary">[ThematicLayer]Geometric query</summary>
         <div class="dropdown-content">
-          <select id="geoquery-op-input">
+          <select id="geoquery-rel-input">
             <option value="contains">contains</option>
             <option value="contains">intersects</option>
             <option value="contains">within</option>

pygeoapi/static/workSpace/viewer_demo.js

@@ -1244,10 +1244,11 @@ function clearAll(){
   cellStatus.textContent = "";
   routeStatus.textContent = "";
   vizStatus.textContent = "";
-  ROUTE=null;
+  ROUTE = null;
+  BBOX = null;
   GEOQUERY = null;
   drawerEl.classList.add("hidden");
-  document.getElementById("geoquery-op-input").value = null;
+  document.getElementById("geoquery-rel-input").value = null;
   document.getElementById("geoquery-geometry-input").value = null;
   document.getElementById("geoquery-level-input").value = null;
   document.getElementById("bbox-min").value = null;
@@ -1295,16 +1296,16 @@ bboxBtn.addEventListener("click", async () => {
 
 geoQueryBtn.addEventListener("click", async () => {
 
-    const operation = document.getElementById("geoquery-op-input").value;
+    const relation = document.getElementById("geoquery-rel-input").value;
     const geometry = document.getElementById("geoquery-geometry-input").value;
     const level = document.getElementById("geoquery-level-input").value;
 
-    if (!operation || !geometry) {
-      alert("Please select an operation and enter WKT geometry.");
+    if (!relation || !geometry) {
+      alert("Please select an relation and enter WKT geometry.");
       return;
     }
     try {
-      geoqueryResult = await api.geometricQuery(selectedCollectionId, selectedFeatureId, selectedLayerId, operation, geometry, level);
+      geoqueryResult = await api.geometricQuery(selectedCollectionId, selectedFeatureId, selectedLayerId, relation, geometry, level);
       apiLog.textContent = JSON.stringify(geoqueryResult, null, 2);
       GEOQUERY = buildOverlayModel(geoqueryResult);
       renderAll();
@@ -1315,8 +1316,6 @@ geoQueryBtn.addEventListener("click", async () => {
 });
 
 vizAllBtn.addEventListener("click", async () => {
-  
-
   try {
     selectedFeatureDataAll = await api.getSingleFeature(selectedCollectionId, selectedFeatureId, true);
     vizStatus.textContent = "Generating 3D Model...";

tests/IndoorGML/test_postgresql_indoordb.py

@@ -765,14 +765,14 @@ def test_query_get_dual_member(context):
 
 def test_query_geometric_query(context):
     geometry = "POINT(10 10)"
-    op = "intersects"
+    rel = "intersects"
     level = "1F"
     pidb_provider = PostgresIndoorDB()
     pidb_provider.connect()
     result = pidb_provider.geometric_query(context.get('collection_id'),
                                            context.get('ifeature_id'),
                                            context.get('layer_id'),
-                                           op=op,
+                                           rel=rel,
                                            geometry=geometry,
                                            level=level)
     assert result