CSHARP-815: GeoNearPoint now *only* wraps alternate point representations for the GeoNear command. The implementation of a 2D point was moved to XYPoint. Replaced From methods in GeoNearPoint with implicit conversions.

rstam · rstam · commit cc7112afab00 · 2014-02-28T10:30:29.000-05:00
diff --git a/MongoDB.Driver/GeoHaystackSearchArgs.cs b/MongoDB.Driver/GeoHaystackSearchArgs.cs
@@ -31,7 +31,7 @@ public class GeoHaystackSearchArgs
         private int? _limit;
         private double? _maxDistance;
         private TimeSpan? _maxTime;
-        private GeoNearPoint.Legacy _near;
+        private XYPoint _near;
 
         // public properties
         /// <summary>
@@ -100,7 +100,7 @@ public TimeSpan? MaxTime
         /// <value>
         /// The location near which to search.
         /// </value>
-        public GeoNearPoint.Legacy Near
+        public XYPoint Near
         {
             get { return _near; }
             set { _near = value; }
diff --git a/MongoDB.Driver/GeoNearPoint.cs b/MongoDB.Driver/GeoNearPoint.cs
@@ -21,138 +21,142 @@
 namespace MongoDB.Driver
 {
     /// <summary>
-    /// Represents a GeoNearLocation (either a legacy coordinate pair or a GeoJsonPoint).
+    /// Represents a GeoNearPoint (wraps either an XYPoint or a GeoJsonPoint).
     /// </summary>
     public abstract class GeoNearPoint
     {
-        // public static methods
+        // implicit conversions
         /// <summary>
-        /// Creates a GeoNearLocation.GeoJson{TCoordinates} from a GeoJsonPoint{TCoordinates}.
+        /// Implicit conversion to wrap an XYPoint in a GeoNearPoint value.
         /// </summary>
-        /// <typeparam name="TCoordinates">The type of the coordinates.</typeparam>
-        /// <param name="point">The GeoJson point.</param>
-        /// <returns>A GeoNearLocation.GeoJson{TCoordinates}.</returns>
-        public static GeoNearPoint.GeoJson<TCoordinates> From<TCoordinates>(GeoJsonPoint<TCoordinates> point) where TCoordinates : GeoJsonCoordinates
+        /// <param name="value">The value.</param>
+        /// <returns>A GeoNearPoint value.</returns>
+        public static implicit operator GeoNearPoint(XYPoint value)
         {
-            return new GeoJson<TCoordinates>(point);
+            return new Legacy(value);
         }
 
         /// <summary>
-        /// Creates a GeoNearPoint from legacy x and y coordinates.
+        /// Implicit conversion to wrap a 2D GeoJson point in a GeoNearPoint value.
         /// </summary>
-        /// <param name="x">The x value.</param>
-        /// <param name="y">The y value.</param>
-        /// <returns></returns>
-        public static GeoNearPoint.Legacy From(double x, double y)
+        /// <param name="value">The value.</param>
+        /// <returns>A GeoNearPoint value.</returns>
+        public static implicit operator GeoNearPoint(GeoJsonPoint<GeoJson2DCoordinates> value)
+        {
+            return new GeoJson<GeoJson2DCoordinates>(value);
+        }
+
+        /// <summary>
+        /// Implicit conversion to wrap a 2D GeoJson point in a GeoNearPoint value.
+        /// </summary>
+        /// <param name="value">The value.</param>
+        /// <returns>A GeoNearPoint value.</returns>
+        public static implicit operator GeoNearPoint(GeoJsonPoint<GeoJson2DGeographicCoordinates> value)
         {
-            return new Legacy(x, y);
+            return new GeoJson<GeoJson2DGeographicCoordinates>(value);
         }
 
-        // public methods
         /// <summary>
-        /// Converts the GeoNearLocation into a BsonValue for the GeoNear command.
+        /// Implicit conversion to wrap a 2D GeoJson point in a GeoNearPoint value.
+        /// </summary>
+        /// <param name="value">The value.</param>
+        /// <returns>A GeoNearPoint value.</returns>
+        public static implicit operator GeoNearPoint(GeoJsonPoint<GeoJson2DProjectedCoordinates> value)
+        {
+            return new GeoJson<GeoJson2DProjectedCoordinates>(value);
+        }
+
+        // internal methods
+        /// <summary>
+        /// Converts the GeoNearPoint into a BsonValue for the GeoNear command.
         /// </summary>
         /// <returns></returns>
-        public abstract BsonValue ToGeoNearCommandField();
+        internal abstract BsonValue ToGeoNearCommandValue();
 
         // nested classes
         /// <summary>
-        /// Represents a GeoNearLocation expressed as a legacy coordinate pair.
+        /// Represents a GeoNearPoint that wraps an XYPoint.
         /// </summary>
         public class Legacy : GeoNearPoint
         {
             // private fields
-            private readonly double _x;
-            private readonly double _y;
+            private readonly XYPoint _value;
 
             // constructors
             /// <summary>
             /// Initializes a new instance of the <see cref="Legacy"/> class.
             /// </summary>
-            /// <param name="x">The x value.</param>
-            /// <param name="y">The y value.</param>
-            public Legacy(double x, double y)
+            /// <param name="value">The value.</param>
+            public Legacy(XYPoint value)
             {
-                _x = x;
-                _y = y;
+                _value = value;
             }
 
             // public properties
             /// <summary>
-            /// Gets the X value.
-            /// </summary>
-            /// <value>
-            /// The X value.
-            /// </value>
-            public double X
-            {
-                get { return _x; }
-            }
-
-            /// <summary>
-            /// Gets the Y value.
+            /// Gets the value.
             /// </summary>
             /// <value>
-            /// The Y value.
+            /// The value.
             /// </value>
-            public double Y
+            public XYPoint Value
             {
-                get { return _y; }
+                get { return _value; }
             }
 
-            // public methods
+            // internal methods
             /// <summary>
-            /// Converts the GeoNearLocation into a BsonValue for the GeoNear command.
+            /// Converts the GeoNearPoint into a BsonValue for the GeoNear command.
             /// </summary>
-            /// <returns></returns>
-            public override BsonValue ToGeoNearCommandField()
+            /// <returns>A BsonValue.</returns>
+            internal override BsonValue ToGeoNearCommandValue()
             {
-                return new BsonArray { _x, _y };
+                return new BsonArray { _value.X, _value.Y };
             }
         }
 
         /// <summary>
-        /// Represents a GeoNearLocation expressed as a GeoJsonPoint.
+        /// Represents a GeoNearPoint that wraps a GeoJsonPoint.
         /// </summary>
         /// <typeparam name="TCoordinates">The type of the coordinates.</typeparam>
         public class GeoJson<TCoordinates> : GeoNearPoint where TCoordinates : GeoJsonCoordinates
         {
             // private fields
-            private readonly GeoJsonPoint<TCoordinates> _point;
+            private readonly GeoJsonPoint<TCoordinates> _value;
 
             // constructors
             /// <summary>
             /// Initializes a new instance of the <see cref="GeoJson{TCoordinates}"/> class.
             /// </summary>
-            /// <param name="point">The point.</param>
-            public GeoJson(GeoJsonPoint<TCoordinates> point)
+            /// <param name="value">The value.</param>
+            public GeoJson(GeoJsonPoint<TCoordinates> value)
             {
-                _point = point;
+                _value = value;
             }
 
             // public properties
             /// <summary>
-            /// Gets the point.
+            /// Gets the value.
             /// </summary>
             /// <value>
-            /// The point.
+            /// The value.
             /// </value>
-            public GeoJsonPoint<TCoordinates> Point
+            public GeoJsonPoint<TCoordinates> Value
             {
-                get { return _point; }
+                get { return _value; }
             }
 
-            // public methods
+            // internal methods
             /// <summary>
-            /// Converts the GeoNearLocation into a BsonValue for the GeoNear command.
+            /// Converts the GeoNearPoint into a BsonValue for the GeoNear command.
             /// </summary>
-            /// <returns></returns>
-            public override BsonValue ToGeoNearCommandField()
+            /// <returns>A BsonValue.</returns>
+            internal override BsonValue ToGeoNearCommandValue()
             {
                 var document = new BsonDocument();
                 using (var writer = new BsonDocumentWriter(document, BsonDocumentWriterSettings.Defaults))
                 {
-                    new GeoJsonPointSerializer<TCoordinates>().Serialize(writer, typeof(GeoJsonPoint<TCoordinates>), _point, null);
+                    new GeoJsonPointSerializer<TCoordinates>().Serialize(writer, typeof(GeoJsonPoint<TCoordinates>), _value, null);
                 }
                 return document;
             }
diff --git a/MongoDB.Driver/MongoCollection.cs b/MongoDB.Driver/MongoCollection.cs
@@ -877,7 +877,7 @@ public virtual GeoHaystackSearchResult<TDocument> GeoHaystackSearchAs<TDocument>
             var optionsDocument = options.ToBsonDocument();
             var args = new GeoHaystackSearchArgs
             {
-                Near = GeoNearPoint.From(x, y),
+                Near = new XYPoint(x, y),
                 MaxDistance = optionsDocument.Contains("maxDistance") ? (int?)optionsDocument["maxDistance"].ToInt32() : null,
                 Limit = optionsDocument.Contains("limit") ? (int?)optionsDocument["limit"].ToInt32() : null
             };
@@ -966,7 +966,7 @@ public virtual GeoNearResult<TDocument> GeoNearAs<TDocument>(GeoNearArgs args)
             var command = new CommandDocument
             {
                 { "geoNear", _name },
-                { "near", args.Near.ToGeoNearCommandField() },
+                { "near", args.Near.ToGeoNearCommandValue() },
                 { "limit", () => args.Limit.Value, args.Limit.HasValue }, // optional
                 { "maxDistance", () => args.MaxDistance.Value, args.MaxDistance.HasValue }, // optional
                 { "query", () => BsonDocumentWrapper.Create(args.Query), args.Query != null }, // optional
@@ -1023,7 +1023,7 @@ public virtual GeoNearResult<TDocument> GeoNearAs<TDocument>(
             var optionsDocument = options.ToBsonDocument();
             var args = new GeoNearArgs
             {
-                Near = GeoNearPoint.From(x, y),
+                Near = new XYPoint(x, y),
                 Limit = limit,
                 Query = query,
                 DistanceMultiplier = optionsDocument.Contains("distanceMultiplier") ? (double?)optionsDocument["distanceMultiplier"].ToDouble() : null,
diff --git a/MongoDB.Driver/MongoDB.Driver.csproj b/MongoDB.Driver/MongoDB.Driver.csproj
@@ -445,6 +445,7 @@
     <Compile Include="SafeMode.cs" />
     <Compile Include="UpdateFlags.cs" />
     <Compile Include="ExternalEvidence.cs" />
+    <Compile Include="XYPoint.cs" />
   </ItemGroup>
   <ItemGroup>
     <BootstrapperPackage Include="Microsoft.Net.Client.3.5">
diff --git a/MongoDB.Driver/XYPoint.cs b/MongoDB.Driver/XYPoint.cs
@@ -0,0 +1,62 @@
+﻿/* Copyright 2010-2014 MongoDB Inc.
+*
+* 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.
+*/
+
+namespace MongoDB.Driver
+{
+    /// <summary>
+    /// Represents a 2D point represented using x, y coordinates.
+    /// </summary>
+    public class XYPoint
+    {
+        // private fields
+        private readonly double _x;
+        private readonly double _y;
+
+        // constructors
+        /// <summary>
+        /// Initializes a new instance of the <see cref="XYPoint"/> class.
+        /// </summary>
+        /// <param name="x">The x value.</param>
+        /// <param name="y">The y value.</param>
+        public XYPoint(double x, double y)
+        {
+            _x = x;
+            _y = y;
+        }
+
+        // public properties
+        /// <summary>
+        /// Gets the X value.
+        /// </summary>
+        /// <value>
+        /// The X value.
+        /// </value>
+        public double X
+        {
+            get { return _x; }
+        }
+
+        /// <summary>
+        /// Gets the Y value.
+        /// </summary>
+        /// <value>
+        /// The Y value.
+        /// </value>
+        public double Y
+        {
+            get { return _y; }
+        }
+    }
+}
diff --git a/MongoDB.DriverUnitTests/MongoCollectionTests.cs b/MongoDB.DriverUnitTests/MongoCollectionTests.cs
@@ -1270,7 +1270,7 @@ public void TestGeoHaystackSearch()
 
                     var args = new GeoHaystackSearchArgs
                     {
-                        Near = GeoNearPoint.From(33, 33),
+                        Near = new XYPoint(33, 33),
                         AdditionalFieldName = "Type",
                         AdditionalFieldValue = "restaurant",
                         Limit = 30,
@@ -1312,7 +1312,7 @@ public void TestGeoHaystackSearchWithMaxTime()
                             failpoint.SetAlwaysOn();
                             var args = new GeoHaystackSearchArgs
                             {
-                                Near = GeoNearPoint.From(33, 33),
+                                Near = new XYPoint(33, 33),
                                 AdditionalFieldName = "Type",
                                 AdditionalFieldValue = "restaurant",
                                 Limit = 30,
@@ -1342,7 +1342,7 @@ public void TestGeoHaystackSearch_Typed()
 
                     var args = new GeoHaystackSearchArgs
                     {
-                        Near = GeoNearPoint.From(33, 33),
+                        Near = new XYPoint(33, 33),
                         Limit = 30,
                         MaxDistance = 6
                     }
@@ -1376,7 +1376,7 @@ public void TestGeoNear()
 
             var args = new GeoNearArgs
             {
-                Near = GeoNearPoint.From(0, 0),
+                Near = new XYPoint(0, 0),
                 Limit = 100,
                 DistanceMultiplier = 1,
                 MaxDistance = 100
@@ -1422,7 +1422,7 @@ public void TestGeoNearGeneric()
 
             var args = new GeoNearArgs
             {
-                Near = GeoNearPoint.From(0, 0),
+                Near = new XYPoint(0, 0),
                 Limit = 100,
                 DistanceMultiplier = 1,
                 MaxDistance = 100
@@ -1466,7 +1466,7 @@ public void TestGeoNearSphericalFalse()
 
             var args = new GeoNearArgs
             {
-                Near = GeoNearPoint.From(-74.0, 40.74),
+                Near = new XYPoint(-74.0, 40.74),
                 Limit = 100,
                 Spherical = false
             };
@@ -1523,7 +1523,7 @@ public void TestGeoNearSphericalTrue()
 
                 var args = new GeoNearArgs
                 {
-                    Near = GeoNearPoint.From(-74.0, 40.74),
+                    Near = new XYPoint(-74.0, 40.74),
                     Limit = 100,
                     Spherical = true
                 };
@@ -1581,7 +1581,7 @@ public void TestGeoNearWithGeoJsonPoints()
 
                 var args = new GeoNearArgs
                 {
-                    Near = GeoNearPoint.From(GeoJson.Point(GeoJson.Geographic(-74.0, 40.74))),
+                    Near = GeoJson.Point(GeoJson.Geographic(-74.0, 40.74)),
                     Spherical = true
                 };
                 var result = _collection.GeoNearAs<PlaceGeoJson>(args);
@@ -1624,7 +1624,7 @@ public void TestGeoNearWithMaxTime()
                         failpoint.SetAlwaysOn();
                         var args = new GeoNearArgs
                         {
-                            Near = GeoNearPoint.From(0, 0),
+                            Near = new XYPoint(0, 0),
                             MaxTime = TimeSpan.FromMilliseconds(1)
                         };
                         Assert.Throws<ExecutionTimeoutException>(() => _collection.GeoNearAs<BsonDocument>(args));
