/*
* The JTS Topology Suite is a collection of Java classes that
* implement the fundamental operations required to validate a given
* geo-spatial data set to a known topological specification.
*
* Copyright (C) 2001 Vivid Solutions
*
* 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; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* For more information, contact:
*
* Vivid Solutions
* Suite #1A
* 2328 Government Street
* Victoria BC V8T 5G5
* Canada
*
* (250)385-6040
* www.vividsolutions.com
*/
package com.revolsys.geometry.model;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
/**
* A list of {@link Point}s, which may
* be set to prevent repeated coordinates from occurring in the list.
*
*
* @version 1.7
*/
public class PointList extends ArrayList<Point> {
// With contributions from Markus Schaber [schabios@logi-track.com]
// [Jon Aquino 2004-03-25]
private final static Point[] pointArrayType = new Point[0];
private static final long serialVersionUID = 1L;
/**
* Constructs a new list without any coordinates
*/
public PointList() {
super();
}
public PointList(final LineString points) {
ensureCapacity(points.getVertexCount());
add(points, true, true);
}
/**
* Constructs a new list from an array of Coordinates, allowing repeated points.
* (I.e. this constructor produces a {@link PointList} with exactly the same set of points
* as the input array.)
*
* @param coord the initial coordinates
*/
public PointList(final Point[] coord) {
ensureCapacity(coord.length);
add(coord, true);
}
/**
* Constructs a new list from an array of Coordinates,
* allowing caller to specify if repeated points are to be removed.
*
* @param coord the array of coordinates to load into the list
* @param allowRepeated if <code>false</code>, repeated points are removed
*/
public PointList(final Point[] coord, final boolean allowRepeated) {
ensureCapacity(coord.length);
add(coord, allowRepeated);
}
/**
* Inserts the specified coordinate at the specified position in this list.
*
* @param i the position at which to insert
* @param coord the coordinate to insert
* @param allowRepeated if set to false, repeated coordinates are collapsed
*/
public void add(final int i, final Point coord, final boolean allowRepeated) {
// don't add duplicate coordinates
if (!allowRepeated) {
final int size = size();
if (size > 0) {
if (i > 0) {
final Point prev = get(i - 1);
if (prev.equals(2, coord)) {
return;
}
}
if (i < size) {
final Point next = get(i);
if (next.equals(2, coord)) {
return;
}
}
}
}
super.add(i, coord);
}
public boolean add(final LineString coord, final boolean allowRepeated, final boolean direction) {
if (direction) {
for (int i = 0; i < coord.getVertexCount(); i++) {
add(coord.getPoint(i), allowRepeated);
}
} else {
for (int i = coord.getVertexCount() - 1; i >= 0; i--) {
add(coord.getPoint(i), allowRepeated);
}
}
return true;
}
/**
* Adds an array of coordinates to the list.
* @param coord The coordinates
* @param allowRepeated if set to false, repeated coordinates are collapsed
* @param direction if false, the array is added in reverse order
* @return true (as by general collection contract)
*/
public boolean add(final List<Point> coord, final boolean allowRepeated,
final boolean direction) {
if (direction) {
for (int i = 0; i < coord.size(); i++) {
add(coord.get(i), allowRepeated);
}
} else {
for (int i = coord.size() - 1; i >= 0; i--) {
add(coord.get(i), allowRepeated);
}
}
return true;
}
/**
* Adds a coordinate to the list.
* @param obj The coordinate to add
* @param allowRepeated if set to false, repeated coordinates are collapsed
* @return true (as by general collection contract)
*/
public boolean add(final Object obj, final boolean allowRepeated) {
add((Point)obj, allowRepeated);
return true;
}
/**
* Adds a coordinate to the end of the list.
*
* @param coord The coordinates
* @param allowRepeated if set to false, repeated coordinates are collapsed
*/
public void add(final Point coord, final boolean allowRepeated) {
// don't add duplicate coordinates
if (!allowRepeated) {
if (size() >= 1) {
final Point last = get(size() - 1);
if (last.equals(2, coord)) {
return;
}
}
}
super.add(coord);
}
/**
* Adds an array of coordinates to the list.
* @param coord The coordinates
* @param allowRepeated if set to false, repeated coordinates are collapsed
* @return true (as by general collection contract)
*/
public boolean add(final Point[] coord, final boolean allowRepeated) {
add(coord, allowRepeated, true);
return true;
}
/**
* Adds an array of coordinates to the list.
* @param coord The coordinates
* @param allowRepeated if set to false, repeated coordinates are collapsed
* @param direction if false, the array is added in reverse order
* @return true (as by general collection contract)
*/
public boolean add(final Point[] coord, final boolean allowRepeated, final boolean direction) {
if (direction) {
for (final Point element : coord) {
add(element, allowRepeated);
}
} else {
for (int i = coord.length - 1; i >= 0; i--) {
add(coord[i], allowRepeated);
}
}
return true;
}
/**
* Adds a section of an array of coordinates to the list.
* @param coord The coordinates
* @param allowRepeated if set to false, repeated coordinates are collapsed
* @param start the index to start from
* @param end the index to add up to but not including
* @return true (as by general collection contract)
*/
public boolean add(final Point[] coord, final boolean allowRepeated, final int start,
final int end) {
int inc = 1;
if (start > end) {
inc = -1;
}
for (int i = start; i != end; i += inc) {
add(coord[i], allowRepeated);
}
return true;
}
/** Add an array of coordinates
* @param points The coordinates
* @param allowRepeated if set to false, repeated coordinates are collapsed
* @return true (as by general collection contract)
*/
public boolean addAll(final Collection<? extends Point> points, final boolean allowRepeated) {
boolean isChanged = false;
for (final Point point : points) {
add(point, allowRepeated);
isChanged = true;
}
return isChanged;
}
/**
* Returns a deep copy of this <tt>CoordinateList</tt> instance.
*
* @return a clone of this <tt>CoordinateList</tt> instance
*/
@Override
public Object clone() {
final PointList clone = (PointList)super.clone();
for (int i = 0; i < this.size(); i++) {
clone.add(i, this.get(i).newPoint());
}
return clone;
}
/**
* Ensure this coordList is a ring, by adding the start point if necessary
*/
public void closeRing() {
if (size() > 0) {
add(get(0), false);
}
}
public Point getPoint(final int i) {
return get(i);
}
/** Returns the Point in this collection.
*
* @return the coordinates
*/
public Point[] toPointArray() {
return toArray(pointArrayType);
}
}