Implement IsWithinDistance spatial restriction criteria #61

peetw · peetw · commit 672831066852 · 2024-01-21T11:50:21.000Z
diff --git a/NHibernate.Spatial.MsSql/Dialect/MsSql2012FunctionRegistration.cs b/NHibernate.Spatial.MsSql/Dialect/MsSql2012FunctionRegistration.cs
@@ -434,6 +434,27 @@ public SqlString GetSpatialRelationString(object geometry, SpatialRelation relat
             }
         }
 
+        public SqlString GetSpatialRelationString(object geometry, SpatialRelation relation, object anotherGeometry, object parameter, bool criterion)
+        {
+            switch (relation)
+            {
+                case SpatialRelation.IsWithinDistance:
+                    return new SqlStringBuilder()
+                        .Add("CASE WHEN ")
+                        .AddObject(geometry)
+                        .Add(".STDistance(")
+                        .AddObject(anotherGeometry)
+                        .Add(")")
+                        .Add(" <= ")
+                        .Add(parameter.ToString())
+                        .Add(" THEN 1 ELSE 0 END")
+                        .Add(criterion ? " = 1" : "")
+                        .ToSqlString();
+                default:
+                    throw new ArgumentOutOfRangeException(nameof(relation), relation, "Unsupported spatial relation");
+            }
+        }
+
         public SqlString GetSpatialFilterString(string tableAlias, string geometryColumnName, string primaryKeyColumnName, string tableName, Parameter parameter)
         {
             return new SqlStringBuilder(6)
diff --git a/NHibernate.Spatial.MsSql/Dialect/MsSql2012SpatialDialect.cs b/NHibernate.Spatial.MsSql/Dialect/MsSql2012SpatialDialect.cs
@@ -76,6 +76,11 @@ public SqlString GetSpatialRelationString(object geometry, SpatialRelation relat
             return worker.GetSpatialRelationString(geometry, relation, anotherGeometry, criterion);
         }
 
+        public SqlString GetSpatialRelationString(object geometry, SpatialRelation relation, object anotherGeometry, object parameter, bool criterion)
+        {
+            return worker.GetSpatialRelationString(geometry, relation, anotherGeometry, parameter, criterion);
+        }
+
         public SqlString GetSpatialFilterString(string tableAlias, string geometryColumnName, string primaryKeyColumnName, string tableName, Parameter parameter)
         {
             return worker.GetSpatialFilterString(tableAlias, geometryColumnName, primaryKeyColumnName, tableName, parameter);
diff --git a/NHibernate.Spatial.MySQL/Dialect/MySQL57SpatialDialect.cs b/NHibernate.Spatial.MySQL/Dialect/MySQL57SpatialDialect.cs
@@ -344,6 +344,26 @@ public SqlString GetSpatialRelationString(object geometry, SpatialRelation relat
             }
         }
 
+        public SqlString GetSpatialRelationString(object geometry, SpatialRelation relation, object anotherGeometry, object parameter, bool criterion)
+        {
+            switch (relation)
+            {
+                case SpatialRelation.IsWithinDistance:
+                    return new SqlStringBuilder()
+                        .Add(SpatialDialect.IsoPrefix)
+                        .Add("Distance(")
+                        .AddObject(geometry)
+                        .Add(", ")
+                        .AddObject(anotherGeometry)
+                        .Add(")")
+                        .Add(" <= ")
+                        .Add(parameter.ToString())
+                        .ToSqlString();
+                default:
+                    throw new ArgumentOutOfRangeException(nameof(relation), relation, "Unsupported spatial relation");
+            }
+        }
+
         public SqlString GetSpatialRelateString(object geometry, object anotherGeometry, object pattern, bool isStringPattern, bool criterion)
         {
             var builder = new SqlStringBuilder();
diff --git a/NHibernate.Spatial.PostGis/Dialect/PostGis20Dialect.cs b/NHibernate.Spatial.PostGis/Dialect/PostGis20Dialect.cs
@@ -335,6 +335,27 @@ public SqlString GetSpatialRelationString(object geometry, SpatialRelation relat
             }
         }
 
+        public SqlString GetSpatialRelationString(object geometry, SpatialRelation relation, object anotherGeometry, object parameter, bool criterion)
+        {
+            switch (relation)
+            {
+                case SpatialRelation.IsWithinDistance:
+                    return new SqlStringBuilder()
+                        .Add(SpatialDialect.IsoPrefix)
+                        .Add("DWithin")
+                        .Add("(")
+                        .AddObject(geometry)
+                        .Add(", ")
+                        .AddObject(anotherGeometry)
+                        .Add(", ")
+                        .Add(parameter.ToString())
+                        .Add(")")
+                        .ToSqlString();
+                default:
+                    throw new ArgumentOutOfRangeException(nameof(relation), relation, "Unsupported spatial relation");
+            }
+        }
+
         public SqlString GetSpatialRelateString(object geometry, object anotherGeometry, object pattern, bool isStringPattern, bool criterion)
         {
             var builder = new SqlStringBuilder();
diff --git a/NHibernate.Spatial/Criterion/SpatialProjections.cs b/NHibernate.Spatial/Criterion/SpatialProjections.cs
@@ -257,6 +257,18 @@ public static SpatialProjection Intersects(string propertyName, string anotherPr
             return new SpatialRelationProjection(propertyName, SpatialRelation.Intersects, anotherPropertyName);
         }
 
+        /// <summary>
+        /// Determines whether the specified geometry property is within a given distance of another geometry.
+        /// </summary>
+        /// <param name="propertyName">Name of the property.</param>
+        /// <param name="anotherPropertyName">Name of another property.</param>
+        /// <param name="distance">The distance.</param>
+        /// <returns></returns>
+        public static SpatialProjection IsWithinDistance(string propertyName, string anotherPropertyName, double distance)
+        {
+            return new SpatialRelationProjection(propertyName, SpatialRelation.IsWithinDistance, anotherPropertyName, distance);
+        }
+
         /// <summary>
         /// Determines whether the specified geometry property overlaps another geometry property.
         /// </summary>
diff --git a/NHibernate.Spatial/Criterion/SpatialProjectionsLambda.cs b/NHibernate.Spatial/Criterion/SpatialProjectionsLambda.cs
@@ -269,6 +269,18 @@ public static SpatialProjection Intersects<T>(Expression<Func<T, object>> expres
             return Intersects(GetPropertyName(expression), GetPropertyName(anotherExpression));
         }
 
+        /// <summary>
+        /// Determines whether the specified geometry property is within a given distance of another geometry.
+        /// </summary>
+        /// <param name="expression">Name of the property.</param>
+        /// <param name="anotherExpression">Name of another property.</param>
+        /// <param name="distance">The distance.</param>
+        /// <returns></returns>
+        public static SpatialProjection IsWithinDistance<T>(Expression<Func<T, object>> expression, Expression<Func<T, object>> anotherExpression, double distance)
+        {
+            return IsWithinDistance(GetPropertyName(expression), GetPropertyName(anotherExpression), distance);
+        }
+
         /// <summary>
         /// Determines whether the specified geometry property overlaps another geometry property.
         /// </summary>
diff --git a/NHibernate.Spatial/Criterion/SpatialRelationCriterion.cs b/NHibernate.Spatial/Criterion/SpatialRelationCriterion.cs
@@ -32,9 +32,23 @@ namespace NHibernate.Spatial.Criterion
     [Serializable]
     public class SpatialRelationCriterion : AbstractCriterion
     {
-        private readonly string propertyName;
-        private readonly SpatialRelation relation;
-        private readonly object anotherGeometry;
+        private readonly string _propertyName;
+        private readonly SpatialRelation _relation;
+        private readonly object _anotherGeometry;
+        private readonly object _parameter;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SpatialRelationCriterion"/> class.
+        /// </summary>
+        /// <param name="propertyName">Name of the property.</param>
+        /// <param name="relation">The relation.</param>
+        /// <param name="anotherGeometry">Another geometry.</param>
+        /// <param name="parameter">Additional parameter value</param>
+        public SpatialRelationCriterion(string propertyName, SpatialRelation relation, object anotherGeometry, object parameter)
+            : this(propertyName, relation, anotherGeometry)
+        {
+            _parameter = parameter;
+        }
 
         /// <summary>
         /// Initializes a new instance of the <see cref="SpatialRelationCriterion"/> class.
@@ -44,9 +58,9 @@ public class SpatialRelationCriterion : AbstractCriterion
         /// <param name="anotherGeometry">Another geometry.</param>
         public SpatialRelationCriterion(string propertyName, SpatialRelation relation, object anotherGeometry)
         {
-            this.propertyName = propertyName;
-            this.relation = relation;
-            this.anotherGeometry = anotherGeometry;
+            _propertyName = propertyName;
+            _relation = relation;
+            _anotherGeometry = anotherGeometry;
         }
 
         /// <summary>
@@ -59,9 +73,9 @@ public SpatialRelationCriterion(string propertyName, SpatialRelation relation, o
         /// </returns>
         public override TypedValue[] GetTypedValues(ICriteria criteria, ICriteriaQuery criteriaQuery)
         {
-            if (anotherGeometry is Geometry)
+            if (_anotherGeometry is Geometry)
             {
-                return new[] { criteriaQuery.GetTypedValue(criteria, propertyName, anotherGeometry) };
+                return new[] { criteriaQuery.GetTypedValue(criteria, _propertyName, _anotherGeometry) };
             }
             return Array.Empty<TypedValue>();
         }
@@ -81,9 +95,8 @@ public override IProjection[] GetProjections()
         /// </returns>
         public override SqlString ToSqlString(ICriteria criteria, ICriteriaQuery criteriaQuery)
         {
-            //criteriaQuery.AddUsedTypedValues(GetTypedValues(criteria, criteriaQuery));
             var spatialDialect = (ISpatialDialect) criteriaQuery.Factory.Dialect;
-            string[] columns1 = GetColumnNames(criteria, criteriaQuery, propertyName);
+            string[] columns1 = GetColumnNames(criteria, criteriaQuery, _propertyName);
 
             var builder = new SqlStringBuilder(10*columns1.Length);
             for (int i = 0; i < columns1.Length; i++)
@@ -92,17 +105,25 @@ public override SqlString ToSqlString(ICriteria criteria, ICriteriaQuery criteri
                 {
                     builder.Add(" AND ");
                 }
-                if (anotherGeometry is Geometry)
+
+                object anotherGeometry;
+                if (_anotherGeometry is Geometry)
                 {
                     var parameters = criteriaQuery.NewQueryParameter(GetTypedValues(criteria, criteriaQuery)[0]).ToArray();
-                    builder.Add(spatialDialect.GetSpatialRelationString(columns1[i], relation, parameters.Single(), true));
+                    anotherGeometry = parameters.Single();
                 }
                 else
                 {
-                    string[] columns2 = GetColumnNames(criteria, criteriaQuery, (string) anotherGeometry);
-                    builder.Add(spatialDialect.GetSpatialRelationString(columns1[i], relation, columns2[i], true));
+                    string[] columns2 = GetColumnNames(criteria, criteriaQuery, (string) _anotherGeometry);
+                    anotherGeometry = columns2[i];
                 }
+
+                var spatialRelationString = _parameter == null
+                    ? spatialDialect.GetSpatialRelationString(columns1[i], _relation, anotherGeometry, true)
+                    : spatialDialect.GetSpatialRelationString(columns1[i], _relation, anotherGeometry, _parameter, true);
+                builder.Add(spatialRelationString);
             }
+
             return builder.ToSqlString();
         }
 
@@ -119,11 +140,11 @@ public override SqlString ToSqlString(ICriteria criteria, ICriteriaQuery criteri
         public override string ToString()
         {
             return new StringBuilder()
-                .Append(relation)
+                .Append(_relation)
                 .Append("(")
-                .Append(propertyName)
+                .Append(_propertyName)
                 .Append(", ")
-                .Append(anotherGeometry is Geometry ? "<Geometry>" : anotherGeometry.ToString())
+                .Append(_anotherGeometry is Geometry ? "<Geometry>" : _anotherGeometry.ToString())
                 .Append(")")
                 .ToString();
         }
diff --git a/NHibernate.Spatial/Criterion/SpatialRelationProjection.cs b/NHibernate.Spatial/Criterion/SpatialRelationProjection.cs
@@ -29,8 +29,22 @@ namespace NHibernate.Spatial.Criterion
     [Serializable]
     public class SpatialRelationProjection : SpatialProjection
     {
-        private readonly SpatialRelation relation;
-        private readonly string anotherPropertyName;
+        private readonly SpatialRelation _relation;
+        private readonly string _anotherPropertyName;
+        private readonly object _parameter;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SpatialRelationProjection"/> class.
+        /// </summary>
+        /// <param name="propertyName">Name of the property.</param>
+        /// <param name="relation">The relation.</param>
+        /// <param name="anotherPropertyName">Name of another property.</param>
+        /// <param name="parameter">Additional parameter value</param>
+        public SpatialRelationProjection(string propertyName, SpatialRelation relation, string anotherPropertyName, object parameter)
+            : this(propertyName, relation, anotherPropertyName)
+        {
+            _parameter = parameter;
+        }
 
         /// <summary>
         /// Initializes a new instance of the <see cref="SpatialRelationProjection"/> class.
@@ -41,8 +55,8 @@ public class SpatialRelationProjection : SpatialProjection
         public SpatialRelationProjection(string propertyName, SpatialRelation relation, string anotherPropertyName)
             : base(propertyName)
         {
-            this.relation = relation;
-            this.anotherPropertyName = anotherPropertyName;
+            _relation = relation;
+            _anotherPropertyName = anotherPropertyName;
         }
 
         /// <summary>
@@ -67,8 +81,10 @@ public override SqlString ToSqlString(ICriteria criteria, int position, ICriteri
         {
             var spatialDialect = (ISpatialDialect) criteriaQuery.Factory.Dialect;
             string column1 = criteriaQuery.GetColumn(criteria, propertyName);
-            string column2 = criteriaQuery.GetColumn(criteria, anotherPropertyName);
-            var sqlString = spatialDialect.GetSpatialRelationString(column1, relation, column2, false);
+            string column2 = criteriaQuery.GetColumn(criteria, _anotherPropertyName);
+            var sqlString = _parameter == null
+                ? spatialDialect.GetSpatialRelationString(column1, _relation, column2, false)
+                : spatialDialect.GetSpatialRelationString(column1, _relation, column2, _parameter, false);
             return new SqlStringBuilder()
                 .Add(sqlString)
                 .Add(" as y")
diff --git a/NHibernate.Spatial/Criterion/SpatialRestrictions.cs b/NHibernate.Spatial/Criterion/SpatialRestrictions.cs
@@ -165,6 +165,18 @@ public static SpatialRelationCriterion Intersects(string propertyName, object an
             return new SpatialRelationCriterion(propertyName, SpatialRelation.Intersects, anotherGeometry);
         }
 
+        /// <summary>
+        /// Determines whether the specified geometry property is within a given distance of another geometry.
+        /// </summary>
+        /// <param name="propertyName">Name of the property.</param>
+        /// <param name="anotherGeometry">Another geometry.</param>
+        /// <param name="distance">The distance.</param>
+        /// <returns></returns>
+        public static SpatialRelationCriterion IsWithinDistance(string propertyName, object anotherGeometry, double distance)
+        {
+            return new SpatialRelationCriterion(propertyName, SpatialRelation.IsWithinDistance, anotherGeometry, distance);
+        }
+
         /// <summary>
         /// Determines whether the specified geometry property overlaps another geometry.
         /// </summary>
@@ -211,19 +223,6 @@ public static SpatialRelationCriterion Within(string propertyName, object anothe
             return new SpatialRelationCriterion(propertyName, SpatialRelation.Within, anotherGeometry);
         }
 
-        /// <summary>
-        /// Determines whether the specified geometry property is within a givin distance of another geometry.
-        /// </summary>
-        /// <param name="propertyName">Name of the property.</param>
-        /// <param name="anotherGeometry">Another geometry.</param>
-        /// <param name="distance">The distance.</param>
-        /// <returns></returns>
-        public static SpatialRelationCriterion IsWithinDistance(string propertyName, object anotherGeometry, double distance)
-        {
-            // TODO: Implement
-            throw new NotImplementedException();
-        }
-
         // TODO :
         //Distance
         //RelatePattern
diff --git a/NHibernate.Spatial/Dialect/ISpatialDialect.cs b/NHibernate.Spatial/Dialect/ISpatialDialect.cs
@@ -101,6 +101,21 @@ public interface ISpatialDialect
         /// a SQL spatial relation expression</returns>
         SqlString GetSpatialRelationString(object geometry, SpatialRelation relation, object anotherGeometry, bool criterion);
 
+        /// <summary>
+        /// It builds a SQL spatial relation expression.
+        /// </summary>
+        /// <remarks>
+        /// One parameter placeholder must be added to the SqlString.
+        /// </remarks>
+        /// <param name="geometry">SQL expression returning a geometry</param>
+        /// <param name="relation">Spatial relation</param>
+        /// <param name="anotherGeometry">A string SQL geometry expression or a Parameter.Placeholder</param>
+        /// <param name="parameter">Additional parameter value</param>
+        /// <param name="criterion"></param>
+        /// <returns>A <c>SqlString</c> object containing
+        /// a SQL spatial relation expression</returns>
+        SqlString GetSpatialRelationString(object geometry, SpatialRelation relation, object anotherGeometry, object parameter, bool criterion);
+
         /// <summary>
         /// It builds a SQL spatial filter expression.
         /// </summary>
diff --git a/NHibernate.Spatial/SpatialRelation.cs b/NHibernate.Spatial/SpatialRelation.cs
@@ -57,6 +57,11 @@ public enum SpatialRelation
         /// </summary>
         Intersects,
 
+        /// <summary>
+        /// 
+        /// </summary>
+        IsWithinDistance,
+
         /// <summary>
         ///
         /// </summary>
diff --git a/Tests.NHibernate.Spatial.MsSql2012/MsSql2012NtsTestCasesFixture.cs b/Tests.NHibernate.Spatial.MsSql2012/MsSql2012NtsTestCasesFixture.cs
@@ -34,7 +34,7 @@ public void WhenRelateWithoutPatternThenThrows()
                 .Add(Restrictions.Eq("Operation", "Relate"))
                 .SetProjection(Projections.ProjectionList()
                     .Add(Projections.Property("Description"))
-                    .Add(Projections.Property("RelatePattern"))
+                    .Add(Projections.Property("Parameter"))
                     .Add(SpatialProjections.Relate("GeometryA", "GeometryB"))
                 )
                 .List());
diff --git a/Tests.NHibernate.Spatial.MySQL80/NtsTestCases/Model/NtsTestCase.cs b/Tests.NHibernate.Spatial.MySQL80/NtsTestCases/Model/NtsTestCase.cs
@@ -16,7 +16,7 @@ public class NtsTestCase
 
         private string operation;
 
-        private string relatePattern;
+        private string parameter;
 
         private Geometry geometryResult = GeometryCollection.Empty;
 
@@ -52,10 +52,10 @@ public virtual string Operation
             set => operation = value;
         }
 
-        public virtual string RelatePattern
+        public virtual string Parameter
         {
-            get => relatePattern;
-            set => relatePattern = value;
+            get => parameter;
+            set => parameter = value;
         }
 
         public virtual Geometry GeometryResult
diff --git a/Tests.NHibernate.Spatial.MySQL80/NtsTestCases/Model/NtsTestCase.hbm.xml b/Tests.NHibernate.Spatial.MySQL80/NtsTestCases/Model/NtsTestCase.hbm.xml
diff --git a/Tests.NHibernate.Spatial/NtsTestCases/Data/vivid/TestWithinDistance.xml b/Tests.NHibernate.Spatial/NtsTestCases/Data/vivid/TestWithinDistance.xml
diff --git a/Tests.NHibernate.Spatial/NtsTestCases/Model/NtsTestCase.cs b/Tests.NHibernate.Spatial/NtsTestCases/Model/NtsTestCase.cs
diff --git a/Tests.NHibernate.Spatial/NtsTestCases/Model/NtsTestCase.hbm.xml b/Tests.NHibernate.Spatial/NtsTestCases/Model/NtsTestCase.hbm.xml
diff --git a/Tests.NHibernate.Spatial/NtsTestCases/NtsTestCasesFixture.cs b/Tests.NHibernate.Spatial/NtsTestCases/NtsTestCasesFixture.cs

Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,11 @@ public SqlString GetSpatialRelationString(object geometry, SpatialRelation relat`
`76`	`76`	`return worker.GetSpatialRelationString(geometry, relation, anotherGeometry, criterion);`
`77`	`77`	`}`
`78`	`78`
	`79`	`+ public SqlString GetSpatialRelationString(object geometry, SpatialRelation relation, object anotherGeometry, object parameter, bool criterion)`
	`80`	`+ {`
	`81`	`+ return worker.GetSpatialRelationString(geometry, relation, anotherGeometry, parameter, criterion);`
	`82`	`+ }`
	`83`	`+`
`79`	`84`	`public SqlString GetSpatialFilterString(string tableAlias, string geometryColumnName, string primaryKeyColumnName, string tableName, Parameter parameter)`
`80`	`85`	`{`
`81`	`86`	`return worker.GetSpatialFilterString(tableAlias, geometryColumnName, primaryKeyColumnName, tableName, parameter);`