geotools-commits Mailing List for GeoTools, the Java GIS toolkit (Page 1182)

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/geotools/geotools/src/uk/ac/leeds/ccg/geotools
In directory usw-pr-cvs1:/tmp/cvs-serv27212/uk/ac/leeds/ccg/geotools

Modified Files:
	GeoPolygon.java 
Log Message:
Fixed JavaDoc comments.

Index: GeoPolygon.java
===================================================================
RCS file: /cvsroot/geotools/geotools/src/uk/ac/leeds/ccg/geotools/GeoPolygon.java,v
retrieving revision 1.19
retrieving revision 1.20
diff -w -C2 -d -r1.19 -r1.20
*** GeoPolygon.java	2001/08/01 12:32:18	1.19
--- GeoPolygon.java	2002/01/19 17:40:30	1.20
***************
*** 1,7 ****
  /*
!  * @(#)GeoPolygon.java  0.5 17 April 1997  James Macgill
   *
   */

  package uk.ac.leeds.ccg.geotools;

--- 1,10 ----
  /*
!  * GeoTools java GIS tookit (c) The Centre for Computational Geography 2002
   *
+  * This library is free software; you can redistribute it and/or modify it under the terms
+  * of the GNU Lesser General Public License as published by the Free Software Foundation version 2.1
   */

+ 
  package uk.ac.leeds.ccg.geotools;

***************
*** 11,50 ****

  /**
! * This class is intended for storing georaphical polygons such as boundry data
! * for wards, costlines etc.<p>
  *
! * @author Jamaes Macgill
! * @version 0.5 17 April 1997
  */
  public class GeoPolygon extends GeoShape {

  	/**
! 	 * control debugging. For now, either turn it off or on
  	 */
  	private final static boolean DEBUG=false;
  	/**
! 	 * Performance switch, to turn of use of Vector. use with CARE
  	 */
  	private boolean useVector = true;

  	/**
! 	 * Polygon centroid coordinates
  	 */
  	private double xcent,ycent;

  	/**
! 	 * Number of points in polygon
  	 */
  	public int npoints;

  	/**
! 	 * Area of polygon
  	 */
  	 private double area;

  	/**
! 	 * Array of points
  	 */
! 	public double xpoints[],ypoints[];
      private Vector storedPoints = null;
      private boolean pointsStored = false;
--- 14,66 ----

  /**
!  * This class is intended for storing georaphical polygons such as boundary data
!  * for wards, coastlines etc.<p>
   *
!  * $Log$
!  * Revision 1.20  2002/01/19 17:40:30  loxnard
!  * Fixed JavaDoc comments.
!  *
!  *
!  * @author James Macgill
!  * @author Mathieu Van Loon - getPointsAsArrayX, getPointsAsArrayY, dropVector
!  * @version $Revision$ $Date$
!  * @since 0.5.0
   */
  public class GeoPolygon extends GeoShape {

  	/**
! 	 * Control debugging. For now, either turn it off or on.
  	 */
  	private final static boolean DEBUG=false;
  	/**
! 	 * Performance switch, to turn off use of Vector. Use with CARE
  	 */
  	private boolean useVector = true;

  	/**
! 	 * Polygon centroid coordinates.
  	 */
  	private double xcent,ycent;

  	/**
! 	 * Number of points in polygon.
  	 */
  	public int npoints;

  	/**
! 	 * Area of polygon.
  	 */
  	 private double area;

  	/**
! 	 * Array of points.
  	 */
! 	public double xpoints[];
!         
!         /**
!          * Array of points.
!          */
!         public double[] ypoints;
!         
      private Vector storedPoints = null;
      private boolean pointsStored = false;
***************
*** 53,61 ****

  	public static final int OUTSIDE = -1;
  	public static final int NA = Integer.MAX_VALUE;

    /**
!    * Create an empty polygon
     */
    public GeoPolygon(){
--- 69,83 ----

+     /**
+      * Probably redundant constant.
+      */    
  	public static final int OUTSIDE = -1;
+         /**
+          * Probably redundant constant.
+          */        
  	public static final int NA = Integer.MAX_VALUE;

    /**
!    * Create an empty polygon.
     */
    public GeoPolygon(){
***************
*** 68,79 ****

      /**
!      * Construct a polygon with full details
       *
!      * @param id polygon ID
!      * @param xcent x coordinate of centroid
!      * @param ycent y coordinate of centroid
!      * @param xpoints vector of x values in Doubles (npoints in size)
!      * @param ypoints vector of y values in Doubles (npoints in size)
!      * @param npoints number of points
       */
    public GeoPolygon(int id,double xcent,double ycent,Vector xpoints,Vector ypoints) {
--- 90,100 ----

      /**
!      * Construct a polygon with full details.
       *
!      * @param id Polygon ID.
!      * @param xcent X-coordinate of centroid.
!      * @param ycent Y-coordinate of centroid.
!      * @param xpoints Vector of x values in Doubles (npoints in size).
!      * @param ypoints Vector of y values in Doubles (npoints in size) where npoints = number of points.
       */
    public GeoPolygon(int id,double xcent,double ycent,Vector xpoints,Vector ypoints) {
***************
*** 111,122 ****

      /**
!      * Construct a polygon with full details
       *
!      * @param id polygon ID
!      * @param xcent x coordinate of centroid
!      * @param ycent y coordinate of centroid
!      * @param xpoints array of x values (npoints in size)
!      * @param ypoints array of y values (npoints in size)
!      * @param npoints number of points
       */
    public GeoPolygon(int id,double xcent,double ycent,double[] xpoints,double[] ypoints,int npoints) {
--- 132,143 ----

      /**
!      * Construct a polygon with full details.
       *
!      * @param id Polygon ID.
!      * @param xcent X-coordinate of centroid.
!      * @param ycent Y-coordinate of centroid.
!      * @param xpoints Array of x values (npoints in size).
!      * @param ypoints Array of y values (npoints in size).
!      * @param npoints Number of points.
       */
    public GeoPolygon(int id,double xcent,double ycent,double[] xpoints,double[] ypoints,int npoints) {
***************
*** 150,159 ****

    /**
!    * Construct a polygon with no defined centroid
     *
!    * @param id Polygon ID
!    * @param xpoints array of x values (npoints in size)
!    * @param ypoints array of y values (npoints in size)
!    * @param npoints number of points
     */
    public GeoPolygon(int id,double[] xpoints,double[] ypoints,int npoints) {
--- 171,180 ----

    /**
!    * Construct a polygon with no defined centroid.
     *
!    * @param id Polygon ID.
!    * @param xpoints Array of x values (npoints in size).
!    * @param ypoints Array of y values (npoints in size).
!    * @param npoints Number of points.
     */
    public GeoPolygon(int id,double[] xpoints,double[] ypoints,int npoints) {
***************
*** 162,170 ****

      /**
!      * Construct a polygon and generate its centroid
!      * 08/May/2000 added call to calculateCentroidLocation
!      * @author James Macgill JM
!      * @param id Polygon ID
!      * @param points[] an Array of points to build the polygon off
       */
    public GeoPolygon(int id,GeoPoint[] points) {
--- 183,189 ----

      /**
!      * Construct a polygon and generate its centroid.
!      * @param id Polygon ID.
!      * @param points An array of points to build the polygon off.
       */
    public GeoPolygon(int id,GeoPoint[] points) {
***************
*** 190,198 ****

      /**
! 	 * Construct a polygon with no defined centroid or ID
  	 *
! 	 * @param xpoints array of x values (npoints in size)
!      * @param ypoints array of y values (npoints in size)
!      * @param npoints number of points
       */
  	public GeoPolygon(double[] xpoints,double[] ypoints,int npoints) {
--- 209,217 ----

      /**
!      * Construct a polygon with no defined centroid or ID.
       *
!      * @param xpoints Array of x values (npoints in size).
!      * @param ypoints Array of y values (npoints in size).
!      * @param npoints Number of points.
       */
  	public GeoPolygon(double[] xpoints,double[] ypoints,int npoints) {
***************
*** 200,208 ****

    /**
!    * Construct an empty polygon with ID and centroid only
     *
!    * @param id polygon ID
!    * @param xcent x coordinate of centroid
!    * @param ycent y coordinate of centroid
     */
    public GeoPolygon(int id,double xcent,double ycent) {
--- 219,227 ----

    /**
!    * Construct an empty polygon with ID and centroid only.
     *
!    * @param id Polygon ID.
!    * @param xcent X-coordinate of centroid.
!    * @param ycent Y-coordinate of centroid.
     */
    public GeoPolygon(int id,double xcent,double ycent) {
***************
*** 218,224 ****

      /**
!      * Construct a GeoPolygon based on an existing GeoPolygon
       *
!      * @param poly GeoPolygon to clone
       */
  	public GeoPolygon(GeoPolygon poly) {
--- 237,243 ----

      /**
!      * Construct a GeoPolygon based on an existing GeoPolygon.
       *
!      * @param poly GeoPolygon to clone.
       */
  	public GeoPolygon(GeoPolygon poly) {
***************
*** 226,233 ****

      /**
!      * Add a vertex to the polygon
       *
!      * @param x x coordinate of point to add
!      * @param y y coordinate of point to add
       */
  	public void addPoint(double x,double y) {
--- 245,252 ----

      /**
!      * Add a vertex to the polygon.
       *
!      * @param x X-coordinate of point to add.
!      * @param y Y-coordinate of point to add.
       */
  	public void addPoint(double x,double y) {
***************
*** 256,260 ****
  		extendBounds(x,y);
  		//calculateArea();//TODO JM:v.wastefull, save until a area request is made?
! 		//calculateCentroidLocation();//TODO JM:v.wastefull, save until a area request is made?
  		areaDone=centroidDone=false;
  	}
--- 275,279 ----
  		extendBounds(x,y);
  		//calculateArea();//TODO JM:v.wastefull, save until a area request is made?
! 		//calculateCentroidLocation();//TODO JM:v.wasteful, save until an area request is made?
  		areaDone=centroidDone=false;
  	}
***************
*** 264,270 ****

  	/**
! 	 * Add a vertex to the polygon
  	 *
! 	 * @param p A GeoPoint to add
  	 */
  	 public void addPoint(GeoPoint p){
--- 283,289 ----

  	/**
! 	 * Add a vertex to the polygon.
  	 *
! 	 * @param p A GeoPoint to add.
  	 */
  	 public void addPoint(GeoPoint p){
***************
*** 273,279 ****

  	/**
! 	* Returns a standard AWT.Polygon from the GeoPolygon
! 	* <em>note</em> The GeoPolygon used doubles , the Polygon uses ints
  	* so there will be precision loss.
  	*/
  		public Polygon toAWTPolygon() {
--- 292,299 ----

  	/**
!          * Returns a standard AWT.Polygon from the GeoPolygon.
!          * <em>Note</em> The GeoPolygon uses doubles, the Polygon uses ints,
           * so there will be precision loss.
+          * @return Standard AWT.Polygon.
           */
  		public Polygon toAWTPolygon() {
***************
*** 291,299 ****

  	/**
! 	 * Return the polygon ID
  	 */
  	 public int getID(){
  	    return id;
  	 }
  	 public void setID(int id){
  		this.id=id;
--- 311,324 ----

  	/**
!          * Return the polygon ID.
!          * @return Polygon ID.
           */
  	 public int getID(){
  	    return id;
  	 }
+          /**
+           * Set the polygon ID.
+           * @param id Polygon ID.
+           */         
  	 public void setID(int id){
  		this.id=id;
***************
*** 304,310 ****
  	  * This value is calculated from the polygon data on construction
  	  * and upon any changes to the polygon's points.
! 	  * @since 0.7.7.1 8/May/2000
! 	  * @author James Macgill
! 	  * @return double The area of this polygon
  	  */
  	 public double getArea(){
--- 329,333 ----
  	  * This value is calculated from the polygon data on construction
  	  * and upon any changes to the polygon's points.
! 	  * @return double The area of this polygon.
  	  */
  	 public double getArea(){
***************
*** 316,324 ****

  	 /**
! 	  * Calculates and returns the perimeter of this polygon.<br>
! 	  * Value is currently generated per-request.
! 	  * @author James Macgill JM
! 	  * @since 0.7.7.1 8/May/2000
! 	  * @return double the perimeter of this polygon
  	  */
  	 public double getPerimeter(){
--- 339,345 ----

  	 /**
! 	  * Calculate and return the perimeter of this polygon.<br>
! 	  * Value is currently generated per request.
! 	  * @return double The perimeter of this polygon.
  	  */
  	 public double getPerimeter(){
***************
*** 333,343 ****
  	 /**
  	  * Return the centroid of this polygon.
! 	  * this value was either supplied to the constructor or has been
! 	  * calculated automaticaly.<br>
! 	  * automaticaly calculated centroids are not guaranteed to be inside the
! 	  * polygon, insted they represent the polygons center of mass.
! 	  * @since 0.7.7.1 8/May/2000
! 	  * @author James Macgill JM
! 	  * @return GeoPoint The centroid of this polygon
  	  */
  	 public GeoPoint getCentroidLocation(){
--- 354,362 ----
  	 /**
  	  * Return the centroid of this polygon.
! 	  * This value was either supplied to the constructor or has been
! 	  * calculated automatically.<br>
! 	  * Automatically calculated centroids are not guaranteed to be inside the
! 	  * polygon. Instead, they represent the polygon's centre of mass.
! 	  * @return GeoPoint The centroid of this polygon.
  	  */
  	 public GeoPoint getCentroidLocation(){
***************
*** 349,353 ****

  	 /**
! 	  * Return the number of points that make the polygon
  	  */
  	  public int getNPoints(){
--- 368,373 ----

  	 /**
!           * Return the number of points that make the polygon.
!           * @return Number of points.
            */
  	  public int getNPoints(){
***************
*** 356,365 ****

  	/**
! 	  * get the geopoints as as an array of x or y
! 	  * @author Mathieu van Loon <ma...@PL...>
  	  */
  	public double[] getPointsAsArrayX() {
  		return xpoints;
  	}
  	public double[] getPointsAsArrayY() {
  		return ypoints;
--- 376,389 ----

  	/**
!          * Get the geopoints as an array of x.
!          * @return Geopoints as array of x.
           */
  	public double[] getPointsAsArrayX() {
  		return xpoints;
  	}
+         /**
+          * Get the geopoints as an array of y.
+          * @return Geopoints as an array of y.
+          */        
  	public double[] getPointsAsArrayY() {
  		return ypoints;
***************
*** 369,375 ****
  	 * Drop the use of a Vector to store the points. This method
  	 * is available for performance reasons. You will only want to use
! 	 * this method if you store a lot of GeoPolygons, and you wish
  	 * to decrease the memory load.
- 	 * @author Mathieu van Loon <ma...@PL...>
  	 */
  	public void dropVector() {
--- 393,398 ----
  	 * Drop the use of a Vector to store the points. This method
  	 * is available for performance reasons. You will only want to use
! 	 * this method if you store a lot of GeoPolygons and you wish
  	 * to decrease the memory load.
  	 */
  	public void dropVector() {
***************
*** 378,381 ****
--- 401,408 ----
  	}

+         /**
+          * Points which make up this polygon stored in a Vector.
+          * @return A Vector of points which make up the polygon.
+          */        
  	public final Vector getPoints(){
  		if(useVector)
***************
*** 393,396 ****
--- 420,428 ----
  	}

+         /**
+          * Tests for equality with another object.
+          * @param o The object to test against for equality.
+          * @return True only if IDs are equal and polygons are pointwise equivalent.
+          */        
  	  public boolean equals(Object o){
              if(! (o instanceof GeoPolygon)){return false;}
***************
*** 401,404 ****
--- 433,441 ----
           }

+           /**
+            * Tests for pointwise equality.
+            * @param b The object to test for equality against.
+            * @return True if polygons are pointwise equivalent.
+            */          
            public boolean equalsIgnoreID(GeoPolygon b){
              int iCount = 0;
***************
*** 434,442 ****

  	  /**
! 	   * Tests to see if the polygon is Clockwise<br>
! 	   * anti-clockwise polygons often represent holes<br>
! 	   * this is computed on the fly so might be expensive.<br>
! 	   * Addapted from C function writen by Paul Bourke.
! 	   * @return boolean true if polygon is clockwise.
  	   */
  	   public boolean isClockwise(){
--- 471,479 ----

/**
! 	 * Tests to see if the polygon is clockwise. 
! 	 * Anti-clockwise polygons often represent holes. 
! 	 * This is computed on the fly, so might be expensive. 
! 	 * Adapted from C function written by Paul Bourke.
! 	 * @return boolean True if polygon is clockwise.
 	 */
 	 public boolean isClockwise(){
***************
*** 461,470 ****

  	   /**
! 	    * Calculates the area of the polygon
! 	    * the result is stored in the private member variable area<br>
! 	    * Must be called during construction and after any changes to the polygons point set.
! 	    * N.B. Polygons with anti-clockwise point storage will result in a negative area
! 	    * @author James Macgill
! 	    * @since 0.7.7.1 08/May/00
  	    */
  	    private void calculateArea(){
--- 498,505 ----

  	   /**
! 	    * Calculates the area of the polygon.
! 	    * The result is stored in the private member variable area.<br>
! 	    * Must be called during construction and after any changes to the polygon's pointset.
! 	    * N.B. Polygons with anti-clockwise point storage will result in a negative area.
  	    */
  	    private void calculateArea(){
***************
*** 475,479 ****
  	     double area;
  	     double total =0;
! 	     //Calculate area of each tapezoid formed by droping lines from each pair of point to the x-axis.
  	     //x[i]<x[i-1] will contribute a negative area
  	     for(int i=0;i<npoints-1;i++){
--- 510,514 ----
  	     double area;
  	     double total =0;
! 	     //Calculate area of each trapezoid formed by droping lines from each pair of point to the x-axis.
  	     //x[i]<x[i-1] will contribute a negative area
  	     for(int i=0;i<npoints-1;i++){
***************
*** 487,502 ****

  	    /**
! 	     * Calculates a waighted centroid location for this polygon.<br>
! 	     * the result is stored in the private member variables xcent and ycent
! 	     * overwriting any values that may already be stored their.<br>
! 	     * area must be set before calling this method, e.g. a call to calculateArea should have been made
  	     * during construction.<br>
! 	     * Polygons must have clockwise point encoding in order to have a centroid, holes (encoded
! 	     * with anti-clockwise points) have undefined behavior at this point.
! 	     * N.B. the centroid will be the 'center of mass' but this is not guaranteed to be inside the
  	     * polygon.
! 	     * @author James Macgill JM
! 	     * @since 0.7.7.1 08/May/2000
! 	     * @see #calculateArea
  	     */
  	    protected void calculateCentroidLocation(){
--- 522,535 ----

  	    /**
! 	     * Calculates a weighted centroid location for this polygon.<br>
! 	     * The result is stored in the private member variables, xcent and ycent,
! 	     * overwriting any values that may already be stored there.<br>
! 	     * Area must be set before calling this method, e.g. a call to calculateArea should have been made
  	     * during construction.<br>
! 	     * Polygons must have clockwise point encoding in order to have a centroid. Holes (encoded
! 	     * with anti-clockwise points) have undefined behaviour at this point.
! 	     * N.B. The centroid will be the 'centre of mass' but this is not guaranteed to be inside the
  	     * polygon.
! 	     * @see uk.ac.leeds.ccg.geotools.GeoPolygon#calculateArea.
  	     */
  	    protected void calculateCentroidLocation(){
***************
*** 531,536 ****
  	    * Will test the given polygon to see if it is adjacent to this polygon.
  	    * <br>This code is somewhat experimental and has not been fully tested.
! 	    * @param gp The GeoPolygon to test for contiguity
! 	    * @return boolean, true if this polygon and gp share two or more verteces that are consecetive in both polygons
  	    */
  	   public boolean isContiguous(GeoPolygon gp){
--- 564,569 ----
  	    * Will test the given polygon to see if it is adjacent to this polygon.
  	    * <br>This code is somewhat experimental and has not been fully tested.
! 	    * @param gp The GeoPolygon to test for contiguity.
! 	    * @return boolean True if this polygon and gp share two or more vertices that are consecutive in both polygons.
  	    */
  	   public boolean isContiguous(GeoPolygon gp){
***************
*** 568,575 ****

  	   /**
! 	    * Calculates the length of all arcs that are common both to this polygon and to the polygon pased in.
! 	    * @param gp The polygon to measure shared lengths with
  	    * <br>This code is somewhat experimental and has not been fully tested.
! 	    * @return double the total length of all shared arcs between the two polygons, returns as 0 if there are no shared arcs/
  	    */
  	   public double getContiguousLength(GeoPolygon gp){
--- 601,608 ----

/**
! 	 * Calculates the length of all arcs that are common both to this polygon and to the polygon passed in.
! 	 * @param gp The polygon to measure shared lengths with.
 	 * This code is somewhat experimental and has not been fully tested.
! 	 * @return double The total length of all shared arcs between the two polygons. Returns as 0 if there are no shared arcs.
 	 */
 	 public double getContiguousLength(GeoPolygon gp){
***************
*** 601,611 ****

  	   /**
! 	    * Tests the two provied points to see if they apeare next to each other in any of this
! 	    * polygons arcs.  The test is regardless of order.
  	    *
  	    * <br>This code is somewhat experimental and has not been fully tested.
! 	    * @param p1 the first point to test
! 	    * @param p2 the second point to test
! 	    * @return boolean true if p1 follows p2 or p2 follows p1, false in any other case, including p1 and/or p2 being absent from the polygon
  	    *
  	    */
--- 634,644 ----

/**
! 	 * Tests the two provied points to see if they appear next to each other in any of this
! 	 * polygon's arcs. The test is regardless of order.
 	 *
 	 * This code is somewhat experimental and has not been fully tested.
! 	 * @param p1 The first point to test.
! 	 * @param p2 The second point to test.
! 	 * @return boolean True if p1 follows p2 or p2 follows p1. False in any other case, including p1 and/or p2 being absent from the polygon.
 	 *
 	 */
***************
*** 630,638 ****

  	   /**
! 	    * Provides a list of all of the polygons from the provided list that are adjacent to this one
  	    *
  	    * <br>This code is somewhat experimental and has not been fully tested.
! 	    * @param polys a Vector of GeoPolgyons to test against for contiguity.
! 	    * @return Vector a sub set of polys that contains only the polygons that are adjacent to this one.
  	    */
  	   public Vector getContiguityList(Vector polys){
--- 663,671 ----

  	   /**
! 	    * Provides a list of all of the polygons from the provided list that are adjacent to this one.
  	    *
  	    * <br>This code is somewhat experimental and has not been fully tested.
! 	    * @param polys A Vector of GeoPolgyons to test against for contiguity.
! 	    * @return Vector A sub-set of polys that contains only the polygons that are adjacent to this one.
  	    */
  	   public Vector getContiguityList(Vector polys){
***************
*** 669,675 ****
  	    * <br>p1 and p2 SHOULD be points that are in this polygon.
  	    * <br>This code is somewhat experimental and has not been fully tested.
! 	    * @param p1 GeoPoint the first endpoint of the line to test
! 	    * @param p2 GeoPoint the second endpoint of the line to test
! 	    * @param polys A Vector of polygons to test the line agains for inside/outside ness.
  	    */
  	   public boolean isOnOutside(GeoPoint p1,GeoPoint p2,Vector polys){
--- 702,709 ----
              * <br>p1 and p2 SHOULD be points that are in this polygon.
              * <br>This code is somewhat experimental and has not been fully tested.
!             * @param p1 GeoPoint The first endpoint of the line to test.
!             * @param p2 GeoPoint The second endpoint of the line to test.
!             * @param polys A Vector of polygons to test the line against for inside/outside ness.
!             * @return boolean True if external.
              */
  	   public boolean isOnOutside(GeoPoint p1,GeoPoint p2,Vector polys){
***************
*** 688,697 ****

  	   /**
! 	    * Tests this polygon to see if contains at least one edge that is on the outside of the set of polygons
  	    * described in the provided set.
  	    *
  	    * <br>This code is somewhat experimental and has not been fully tested.
! 	    * @param polys A Vector of polygons to test against
! 	    * @param boolean true if any edge of this polygon is not contiguous with any of the polgyons listed in polys
  	    */
  	   public boolean isOnOutside(Vector polys){
--- 722,731 ----

  	   /**
!             * Tests this polygon to see if it contains at least one edge that is on the outside of the set of polygons
              * described in the provided set.
              *
              * <br>This code is somewhat experimental and has not been fully tested.
!             * @param polys A Vector of polygons to test against.
!             * @return boolean True if external.
              */
  	   public boolean isOnOutside(Vector polys){
***************
*** 707,710 ****
--- 741,753 ----
  	   }

+            /**
+             * A static method that will dissolve all internal borders within the provided set to create a single polygon
+             * which describes the outline of all the given polygons combined.
+             *
+             * <br>This code is somewhat experimental and has not been fully tested.
+             * In particular, if the polygons do not define a single clump then it will not work as expected.
+             * @param polys A Vector of GeoPolgyons to dissolve.
+             * @return GeoPolygon The dissolved version of the polys set.
+             */           
  	    public static GeoPolygon dissolve(Vector polys){
  	       return dissolve(0,polys);
***************
*** 712,723 ****

  	   /**
! 	    * A static method that will disolve all internal borders within the provided set to create a single polygon
  	    * which describes the outline of all the given polygons combined.
  	    * 
  	    * <br>This code is somewhat experimental and has not been fully tested.
! 	    * in particular, if the polygons do not define a single clump then it will not work as expected.
! 	    * @param polys A Vector of GeoPolgyons to disolve.
! 	    * @param an id for this new polygon.
! 	    * @return GeoPolygon the disolved version of the polys set.
  	    */
  	   public static GeoPolygon dissolve(int id,Vector polys){
--- 755,766 ----

  	   /**
!             * A static method that will dissolve all internal borders within the provided set to create a single polygon
              * which describes the outline of all the given polygons combined.
              *
              * <br>This code is somewhat experimental and has not been fully tested.
!             * In particular, if the polygons do not define a single clump then it will not work as expected.
!             * @param polys A Vector of GeoPolgyons to dissolve.
!             * @param id ID for this new polygon.
!             * @return GeoPolygon The dissolved version of the polys set.
              */
  	   public static GeoPolygon dissolve(int id,Vector polys){
***************
*** 747,756 ****
  	                    /* TODO JM: sort out holes properly by implementing cases 2 and 3, although a change in the represenation of
  	                     * polygon toplogy may come first.
! 	                     * this part represents a hole.
  	                     * There are three states that this hole could be in for this zone.
  	                     * 1) Empty, with no polygons at all inside it.
  	                     * 2) Filled, with polygons that belong to this zone.
  	                     * 3) Semi-filled, with some or all of the polygons inside it not belonging to this zone.
! 	                     * 3 is a hard case that will need to be planed out carefully and proably requires
  	                     * more constructive geometry methods than exist at the moment
  	                     */
--- 790,799 ----
  	                    /* TODO JM: sort out holes properly by implementing cases 2 and 3, although a change in the represenation of
  	                     * polygon toplogy may come first.
! 	                     * This part represents a hole.
  	                     * There are three states that this hole could be in for this zone.
  	                     * 1) Empty, with no polygons at all inside it.
  	                     * 2) Filled, with polygons that belong to this zone.
  	                     * 3) Semi-filled, with some or all of the polygons inside it not belonging to this zone.
! 	                     * 3 is a hard case that will need to be planned out carefully and probably requires
  	                     * more constructive geometry methods than exist at the moment
  	                     */
***************
*** 768,772 ****
                              //case 2 or 3 from above.
                              //There is something attached to this hole, other than the polygon to which it is attached.
!                             //for now we will assume a simple case 2 by removing all polygons attached to this hole
                              //this is the danger that a polygon will be attached to a polygon that is attached to this hole.
                              //TODO JM: implement case 2 properly and sort out case 3
--- 811,815 ----
                              //case 2 or 3 from above.
                              //There is something attached to this hole, other than the polygon to which it is attached.
!                             //For now we will assume a simple case 2 by removing all polygons attached to this hole
                              //this is the danger that a polygon will be attached to a polygon that is attached to this hole.
                              //TODO JM: implement case 2 properly and sort out case 3
***************
*** 935,939 ****

  	    }//while !finished
! 	    //re-add any empty holes that were in some of the origional polygons.
  	    if(toDo.size()>0){
  	       if(DEBUG)System.out.println("Finished with "+toDo.size());
--- 978,982 ----

  	    }//while !finished
! 	    //re-add any empty holes that were in some of the original polygons.
  	    if(toDo.size()>0){
  	       if(DEBUG)System.out.println("Finished with "+toDo.size());
***************
*** 947,953 ****
  	   /**
  	    * Combines this polygon with the provided polygon to create a new single polygon with the combined outline of both.
! 	    * <br> both polygons must be contiguous.
! 	    * @param gp the GeoPolygon to disolve into this one.
! 	    * @return GeoPolygon the resulting disolved polygon.
  	    */
  	   public GeoPolygon dissolve(GeoPolygon gp){
--- 990,996 ----
  	   /**
  	    * Combines this polygon with the provided polygon to create a new single polygon with the combined outline of both.
! 	    * <br> Both polygons must be contiguous.
! 	    * @param gp The GeoPolygon to dissolve into this one.
! 	    * @return GeoPolygon The resulting dissolved polygon.
  	    */
  	   public GeoPolygon dissolve(GeoPolygon gp){
***************
*** 1022,1026 ****
  	   * Tests to see if a point is contained by this polygon.
  	   * @param p The GeoPoint to test.
! 	   * @return boolean true if point is contained by this polygon.
  	   */
  	   public boolean contains(GeoPoint p){
--- 1065,1069 ----
             * Tests to see if a point is contained by this polygon.
             * @param p The GeoPoint to test.
!            * @return boolean True if point is contained by this polygon.
             */
  	   public boolean contains(GeoPoint p){
***************
*** 1089,1096 ****

      /**
!      * Calcualtes and returns the perimiter of this polygon
!      * @deprecated miss spelling use getPerimeter instead.
!      * @see getPerimeter
!      * @return double the perimiter of this polygon
       */
       public double getPerimiter(){
--- 1132,1139 ----

             /**
!             * Calculates and returns the perimeter of this polygon.
!             * @return double The perimeter of this polygon.
!             * @see uk.ac.leeds.ccg.geotools.GeoPolygon#getPerimeter.
!             * @deprecated misspelling. Use uk.ac.leeds.ccg.geotools.GeoPolygon#getPerimeter instead.
              */
       public double getPerimiter(){
***************
*** 1104,1111 ****

       /**
!       * Calculates and returns the length of the segment between the specifed points
!       * @param start int of the index of the start point
!       * @param end int of the index of the end point
!       * @return double length of segment
        */
        public double getSegmentLength(int start,int end){
--- 1147,1154 ----

       /**
!       * Calculates and returns the length of the segment between the specifed points.
!       * @param start Int of the index of the start point.
!       * @param end Int of the index of the end point.
!       * @return double Length of segment.
        */
        public double getSegmentLength(int start,int end){
***************
*** 1123,1126 ****
--- 1166,1172 ----
          return dist;
        }
+       /**
+        * Gets a representation of this polygon as a String.
+        * @return String in the form "GeoPolygon : [id <i>id</i>] {x1,y1,...,xn,yn}".*/      
  	public String toString(){
  	 StringBuffer sb = new StringBuffer();
***************
*** 1138,1141 ****
--- 1184,1193 ----

  	}
+         /**
+          * Tests if this polygon contains the specified co-ordinate.
+          * @param x X value of coordinate.
+          * @param y Y value of coordinate.
+          * @return True if coordinate is inside, if coordinate lies exactly on boundary, behaviour is undefined.
+          */        
  	   public boolean contains(double x,double y){
  	    GeoPoint p = new GeoPoint(x,y);
***************
*** 1147,1150 ****
--- 1199,1205 ----
  /*
   * $Log$
+  * Revision 1.20  2002/01/19 17:40:30  loxnard
+  * Fixed JavaDoc comments.
+  *
   * Revision 1.19  2001/08/01 12:32:18  ianturton
   * modification submited by Michael Becke <becke@u.washington.edu> to reduce

2001	Jan	Feb	Mar	Apr	May	Jun	Jul	Aug	Sep	Oct	Nov (39)	Dec (70)
2002	Jan (52)	Feb (168)	Mar (248)	Apr (143)	May (418)	Jun (558)	Jul (702)	Aug (311)	Sep (141)	Oct (350)	Nov (172)	Dec (182)
2003	Jan (320)	Feb (362)	Mar (356)	Apr (218)	May (447)	Jun (203)	Jul (745)	Aug (494)	Sep (175)	Oct (422)	Nov (554)	Dec (162)
2004	Jan (217)	Feb (353)	Mar (228)	Apr (407)	May (211)	Jun (270)	Jul (264)	Aug (198)	Sep (268)	Oct (227)	Nov (118)	Dec (47)
2005	Jan (207)	Feb (243)	Mar (297)	Apr (197)	May (281)	Jun (166)	Jul (164)	Aug (92)	Sep (155)	Oct (196)	Nov (189)	Dec (114)
2006	Jan (129)	Feb (219)	Mar (274)	Apr (213)	May (245)	Jun (220)	Jul (376)	Aug (347)	Sep (179)	Oct (493)	Nov (448)	Dec (339)
2007	Jan (304)	Feb (273)	Mar (237)	Apr (186)	May (215)	Jun (320)	Jul (229)	Aug (313)	Sep (331)	Oct (279)	Nov (347)	Dec (266)
2008	Jan (332)	Feb (280)	Mar (203)	Apr (277)	May (301)	Jun (356)	Jul (292)	Aug (203)	Sep (277)	Oct (142)	Nov (210)	Dec (239)
2009	Jan (250)	Feb (193)	Mar (174)	Apr (183)	May (342)	Jun (230)	Jul (292)	Aug (161)	Sep (204)	Oct (280)	Nov (281)	Dec (175)
2010	Jan (113)	Feb (106)	Mar (199)	Apr (166)	May (298)	Jun (147)	Jul (175)	Aug (192)	Sep (71)	Oct (79)	Nov (58)	Dec (55)
2011	Jan (83)	Feb (169)	Mar (142)	Apr (207)	May (311)	Jun (183)	Jul (218)	Aug (190)	Sep (158)	Oct (197)	Nov (93)	Dec (74)
2012	Jan (92)	Feb (50)	Mar (64)	Apr (45)	May (100)	Jun (70)	Jul (3)	Aug (1)	Sep (2)	Oct (5)	Nov (7)	Dec (4)
2013	Jan (6)	Feb (2)	Mar (2)	Apr (4)	May (3)	Jun	Jul (2)	Aug	Sep	Oct (1)	Nov (1)	Dec
2014	Jan (2)	Feb (2)	Mar (2)	Apr (3)	May (3)	Jun (1)	Jul	Aug (4)	Sep	Oct (1)	Nov (1)	Dec
2015	Jan	Feb	Mar	Apr	May	Jun (1)	Jul	Aug (1)	Sep	Oct	Nov (1)	Dec (1)
2016	Jan	Feb	Mar	Apr	May (1)	Jun (1)	Jul	Aug (3)	Sep	Oct	Nov (1)	Dec
2017	Jan (1)	Feb	Mar	Apr	May	Jun	Jul	Aug	Sep	Oct	Nov	Dec

geotools-commits Mailing List for GeoTools, the Java GIS toolkit (Page 1182)

Toolkit for working with and mapping geospatial data

geotools-commits — A read only list to which all svn commit statments are posted