Update to Neo4j 5.25

Updated to Neo4j 5.25
Deprecating com.neo4jh3 in favor of neo4jh3
Added com.neo4jh3.coverage and com.neo4jh3.coverageString

Author: davidfauth

CHANGELOG.md

@@ -1,3 +1,9 @@
+# CHANGELOG - 5.25.1 - 2024-11-25
+* [Added] - Deprecating the old naming convention with com.neo4jh3 and migrating to neo4jh3
+* [Added] - Added new documentation document for the new naming convention. 
+* [Added] - Added com.neo4jh3.coverage and com.neo4jh3.coverageString procedures which return a list of hex addresses that fully cover a polygon.
+* [Updated] - Tested through Neo4j 5.25.1
+
 # CHANGELOG - 5.19.1 - 2024-06-05
 * [Added] - Added two new procedures to read a WKT polygon file and return the Hex Addresss. These are com.neo4jh3.polygonash3 and com.neo4jh3.polygonash3String. These procedures expect the POLYGON in Longitude, Latitude order.
 * [Updated] - Updated Documentation with bug fixes.

Documentation.md

@@ -1019,8 +1019,63 @@ An LIST of H3 cell IDs of the same type as the values in the input LIST expressi
 
     "85283447fffffff", "8528340ffffffff", "8528340bfffffff", "85283457fffffff", "85283443fffffff", "8528344ffffffff", "852836b7fffffff", "8528342bfffffff", "8528343bfffffff", "85283407fffffff", "85283403fffffff", "8528341bfffffff", "8428347ffffffff" 
 
-## com.neo4jh3.gridDisk( h3CellIdExpr, kExpr )
-Returns the H3 cells that are within (grid) distance k of the origin cell. The set of these H3 cells is called the k-ring of the origin cell.
+## com.neo4jh3.coverage( ListOuterGeography, h3_resolution, LatLonOrder  )
+Returns a list of HexAddresses (as LONG values) identifying the minimal set of H3 cells that completely cover a shape specified by the ListOuterGeography.
+
+### Syntax
+CALL com.neo4jh3.coverage( ListOuterGeography, h3_resolution, LatLonOrder ) yield value return value;
+
+### Arguments
+* ListOuterGeography: A LIST of latitude and longitude values that express a polygon
+* h3_resolution(h3CellIdExpr) and 15 inclusive, specifying the resolution of the children H3 cell IDs.
+* LatLonOrder A STRING that indicates the order of the geometry (latlon or lonlat)
+
+### Returns
+Returns a list of HexAddresses (as LONG values) identifying the minimal set of H3 cells that completely cover a shape specified by the ListOuterGeography
+
+### Error conditions
+If h3_resolution is invalid, the function returns -2
+
+### Example
+    call com.neo4jh3.coverage(['-122.481889,37.826683','122.479487,37.808548','-122.481889,37.826683','-122.479487,37.808548','-122.474150,37.808904','-122.476510,37.826935','-122.481889,37.826683'],8,'lonlat') yield value return value;
+    613196571542028287
+    613196571548319743
+    613196571598651391
+    613196571539931135
+    613196571560902655
+    613196571550416895
+
+    call com.neo4jh3.coverage(['-122.481889,37.826683','122.479487,37.808548','-122.481889,37.826683','-122.479487,37.808548','-122.474150,37.808904','-122.476510,37.826935','-122.481889,37.826683'],17,'lonlat') yield value return value;
+    -2
+    
+## com.neo4jh3.coverageString( ListOuterGeography, h3_resolution, LatLonOrder  )
+Returns a list of HexAddresses (as STRING values) identifying the minimal set of H3 cells that completely cover a shape specified by the ListOuterGeography.
+
+### Syntax
+CALL com.neo4jh3.coverageString( ListOuterGeography, h3_resolution, LatLonOrder ) yield value return value;
+
+### Arguments
+* ListOuterGeography: A LIST of latitude and longitude values that express a polygon
+* h3_resolution(h3CellIdExpr) and 15 inclusive, specifying the resolution of the children H3 cell IDs.
+* LatLonOrder A STRING that indicates the order of the geometry (latlon or lonlat)
+
+### Returns
+Returns a list of HexAddresses (as LONG values) identifying the minimal set of H3 cells that completely cover a shape specified by the ListOuterGeography
+
+### Error conditions
+If h3_resolution is invalid, the function returns -2
+
+### Example
+    call com.neo4jh3.coverageString(['-122.481889,37.826683','122.479487,37.808548','-122.481889,37.826683','-122.479487,37.808548','-122.474150,37.808904','-122.476510,37.826935','-122.481889,37.826683'],8,'lonlat') yield value return value;
+    8828308703fffff
+    8828308715fffff
+    88301c1a09fffff
+    882830870bfffff
+    8828308709fffff
+    8828308739fffff
+
+    call com.neo4jh3.coverageString(['-122.481889,37.826683','122.479487,37.808548','-122.481889,37.826683','-122.479487,37.808548','-122.474150,37.808904','-122.476510,37.826935','-122.481889,37.826683'],17,'lonlat') yield value return value;
+    "-2"
 
 ### Syntax
 CALL com.neo4jh3.gridDisk( h3CellIdExpr, kExpr ) yield value return value;