Merge pull request #42 from mrflip/operators_have_interfaces

Families of operators have common interfaces

Author: stolstov

.gitignore

@@ -32,3 +32,4 @@ libs/
 Icon?
 ehthumbs.db
 Thumbs.db
+target/*

src/main/java/com/esri/core/geometry/CombineOperator.java

@@ -0,0 +1,45 @@
+/*
+ Copyright 1995-2013 Esri
+
+   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.
+
+ For additional information, contact:
+ Environmental Systems Research Institute, Inc.
+ Attn: Contracts Dept
+ 380 New York Street
+ Redlands, California, USA 92373
+
+ email: [email protected]
+ */
+package com.esri.core.geometry;
+
+import com.esri.core.geometry.Geometry;
+import com.esri.core.geometry.SpatialReference;
+import com.esri.core.geometry.ProgressTracker;
+
+/**
+ * Interface for operators that act on two geometries to produce a new geometry as result.
+ */
+public interface CombineOperator {
+
+	/**
+	 * Operation on two geometries, returning a third. Examples include
+	 * Intersection, Difference, and so forth.
+     *
+	 * @param geom1 and geom2 are the geometry instances to be operated on.
+	 *
+	 */
+	public Geometry execute(Geometry geom1, Geometry geom2,
+        SpatialReference sr, ProgressTracker progressTracker);
+
+}

src/main/java/com/esri/core/geometry/Geometry.java

@@ -26,6 +26,8 @@
 package com.esri.core.geometry;
 
 import com.esri.core.geometry.VertexDescription.Semantics;
+import com.esri.core.geometry.GeometryEngine;
+import com.esri.core.geometry.WktExportFlags;
 import java.io.ObjectStreamException;
 import java.io.Serializable;
 
@@ -507,6 +509,12 @@ static Geometry _clone(Geometry src) {
 		return geom;
 	}
 
+    public String toString() {
+        String snippet = GeometryEngine.geometryToWkt(this, WktExportFlags.wktExportDefaults);
+        if (snippet.length() > 200) { snippet = snippet.substring(0, 197)+"..."; }
+        return String.format("%s: %s", this.getClass().getSimpleName(), snippet);
+    }
+
 	/**
 	 * The stateFlag value changes with changes applied to this geometry. This
 	 * allows the user to keep track of the geometry's state.

src/main/java/com/esri/core/geometry/NumberUtils.java

@@ -24,13 +24,13 @@
 
 package com.esri.core.geometry;
 
-class NumberUtils {
+public class NumberUtils {
 
-	static int snap(int v, int minv, int maxv) {
+	public static int snap(int v, int minv, int maxv) {
 		return v < minv ? minv : v > maxv ? maxv : v;
 	}
 
-	static long snap(long v, long minv, long maxv) {
+	public static long snap(long v, long minv, long maxv) {
 		return v < minv ? minv : v > maxv ? maxv : v;
 	}
 

src/main/java/com/esri/core/geometry/OperatorDifference.java

@@ -25,11 +25,12 @@
 package com.esri.core.geometry;
 
 import com.esri.core.geometry.Operator.Type;
+import com.esri.core.geometry.CombineOperator;
 
 /**
  * Difference of geometries.
  */
-public abstract class OperatorDifference extends Operator {
+public abstract class OperatorDifference extends Operator implements CombineOperator {
 
 	@Override
 	public Type getType() {

src/main/java/com/esri/core/geometry/OperatorExportToWktLocal.java

@@ -42,7 +42,7 @@ static void exportToWkt(int export_flags, Geometry geometry,
 					|| (export_flags & WktExportFlags.wktExportMultiLineString) != 0
 					|| (export_flags & WktExportFlags.wktExportPoint) != 0
 					|| (export_flags & WktExportFlags.wktExportMultiPoint) != 0)
-				throw new IllegalArgumentException();
+				throw new IllegalArgumentException("Cannot export a Polygon as Line/Point : "+export_flags);
 
 			exportPolygonToWkt(export_flags, (Polygon) geometry, string);
 			return;
@@ -52,7 +52,7 @@ static void exportToWkt(int export_flags, Geometry geometry,
 					|| (export_flags & WktExportFlags.wktExportMultiPolygon) != 0
 					|| (export_flags & WktExportFlags.wktExportPoint) != 0
 					|| (export_flags & WktExportFlags.wktExportMultiPoint) != 0)
-				throw new IllegalArgumentException();
+				throw new IllegalArgumentException("Cannot export a Polyline as (Multi)Polygon/(Multi)Point : "+export_flags);
 
 			exportPolylineToWkt(export_flags, (Polyline) geometry, string);
 			return;
@@ -62,7 +62,7 @@ static void exportToWkt(int export_flags, Geometry geometry,
 					|| (export_flags & WktExportFlags.wktExportMultiLineString) != 0
 					|| (export_flags & WktExportFlags.wktExportPolygon) != 0
 					|| (export_flags & WktExportFlags.wktExportMultiPolygon) != 0)
-				throw new IllegalArgumentException();
+				throw new IllegalArgumentException("Cannot export a MultiPoint as (Multi)LineString/(Multi)Polygon: "+export_flags);
 
 			exportMultiPointToWkt(export_flags, (MultiPoint) geometry, string);
 			return;
@@ -72,7 +72,7 @@ static void exportToWkt(int export_flags, Geometry geometry,
 					|| (export_flags & WktExportFlags.wktExportMultiLineString) != 0
 					|| (export_flags & WktExportFlags.wktExportPolygon) != 0
 					|| (export_flags & WktExportFlags.wktExportMultiPolygon) != 0)
-				throw new IllegalArgumentException();
+				throw new IllegalArgumentException("Cannot export a Point as (Multi)LineString/(Multi)Polygon: "+export_flags);
 
 			exportPointToWkt(export_flags, (Point) geometry, string);
 			return;
@@ -82,7 +82,7 @@ static void exportToWkt(int export_flags, Geometry geometry,
 					|| (export_flags & WktExportFlags.wktExportMultiLineString) != 0
 					|| (export_flags & WktExportFlags.wktExportPoint) != 0
 					|| (export_flags & WktExportFlags.wktExportMultiPoint) != 0)
-				throw new IllegalArgumentException();
+				throw new IllegalArgumentException("Cannot export an Envelop as (Multi)LineString/(Multi)Point: "+export_flags);
 
 			exportEnvelopeToWkt(export_flags, (Envelope) geometry, string);
 			return;
@@ -149,7 +149,7 @@ static void exportPolygonToWkt(int export_flags, Polygon polygon,
 
 		if ((export_flags & WktExportFlags.wktExportPolygon) != 0) {
 			if (polygon_count > 1)
-				throw new IllegalArgumentException();
+				throw new IllegalArgumentException("Cannot export a Polygon with specified export flags: "+export_flags);
 
 			polygonTaggedText_(precision, b_export_zs, b_export_ms, zs, ms,
 					position, path_flags, paths, path_count, string);
@@ -207,7 +207,7 @@ static void exportPolylineToWkt(int export_flags, Polyline polyline,
 
 		if ((export_flags & WktExportFlags.wktExportLineString) != 0) {
 			if (path_count > 1)
-				throw new IllegalArgumentException();
+				throw new IllegalArgumentException("Cannot export a LineString with specified export flags: "+export_flags);
 
 			lineStringTaggedText_(precision, b_export_zs, b_export_ms, zs, ms,
 					position, path_flags, paths, string);
@@ -256,7 +256,7 @@ static void exportMultiPointToWkt(int export_flags, MultiPoint multipoint,
 
 		if ((export_flags & WktExportFlags.wktExportPoint) != 0) {
 			if (point_count > 1)
-				throw new IllegalArgumentException();
+				throw new IllegalArgumentException("Cannot export a Point with specified export flags: "+export_flags);
 
 			pointTaggedTextFromMultiPoint_(precision, b_export_zs, b_export_ms,
 					zs, ms, position, string);

src/main/java/com/esri/core/geometry/OperatorIntersection.java

@@ -25,11 +25,12 @@
 package com.esri.core.geometry;
 
 import com.esri.core.geometry.Operator.Type;
+import com.esri.core.geometry.CombineOperator;
 
 /**
  *Intersection of geometries by a given geometry.
  */
-public abstract class OperatorIntersection extends Operator {
+public abstract class OperatorIntersection extends Operator implements CombineOperator {
 	@Override
 	public Type getType() {
 		return Type.Intersection;

src/main/java/com/esri/core/geometry/OperatorSymmetricDifference.java

@@ -24,12 +24,13 @@
 package com.esri.core.geometry;
 
 import com.esri.core.geometry.Operator.Type;
+import com.esri.core.geometry.CombineOperator;
 
 /**
  * Symmetric difference (XOR) operation between geometries. 
  *
  */
-public abstract class OperatorSymmetricDifference extends Operator {
+public abstract class OperatorSymmetricDifference extends Operator implements CombineOperator {
 	@Override
 	public Type getType() {
 		return Type.Difference;

src/main/java/com/esri/core/geometry/OperatorUnion.java

@@ -25,13 +25,14 @@
 package com.esri.core.geometry;
 
 import com.esri.core.geometry.Operator.Type;
+import com.esri.core.geometry.CombineOperator;
 
 /**
  * 
  * Union of geometries.
  *
  */
-public abstract class OperatorUnion extends Operator {
+public abstract class OperatorUnion extends Operator implements CombineOperator {
 	@Override
 	public Type getType() {
 		return Type.Union;

src/main/java/com/esri/core/geometry/WktParser.java

@@ -264,7 +264,9 @@ private void geometry_() {
 			m_current_token_type = WktToken.geometrycollection;
 			m_function_stack.add(State.geometryCollectionStart);
 		} else {
-			throw new IllegalArgumentException();
+            String snippet = (m_wkt_string.length() > 200 ?
+                m_wkt_string.substring(0,200)+"..." : m_wkt_string);
+			throw new IllegalArgumentException("Could not parse Well-Known Text: "+snippet);
 		}
 
 		m_function_stack.add(State.attributes);