io.github.sebasbaumh.postgis.PolygonBase Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of postgis-java-ng Show documentation
Show all versions of postgis-java-ng Show documentation
This project contains Java bindings for using PostGIS geometries coming from a PostgreSQL database.
The newest version!
/*
* PostGIS extension for PostgreSQL JDBC driver
*
* (C) 2004 Paul Ramsey, [email protected]
* (C) 2005 Markus Schaber, [email protected]
* (C) 2015 Phillip Ross, [email protected]
* (C) 2018-2023 Sebastian Baumhekel, [email protected]
*
* 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, see type of the ring geometries
*/
@NonNullByDefault
public abstract class PolygonBase extends Geometry implements Iterable, LineBasedGeometry
{
/* JDK 1.5 Serialization */
private static final long serialVersionUID = 0x100;
private T lsOuterRing;
private final ArrayList rings = new ArrayList();
/**
* Constructor for subclasses.
* @param clazzRing class of the ring
* @param type has to be given by all subclasses
*/
protected PolygonBase(int type, Class clazzRing)
{
super(type);
this.lsOuterRing = createRing(clazzRing);
}
/**
* Constructor for subclasses.
* @param clazzRing class of the ring
* @param type has to be given by all subclasses
* @param rings rings
*/
@edu.umd.cs.findbugs.annotations.SuppressFBWarnings("PCOA_PARTIALLY_CONSTRUCTED_OBJECT_ACCESS")
protected PolygonBase(int type, Class clazzRing, Iterable rings)
{
super(type);
Iterator it = rings.iterator();
// first the outer ring
if (it.hasNext())
{
this.lsOuterRing = it.next();
// inner rings
while (it.hasNext())
{
addRing(it.next());
}
}
else
{
this.lsOuterRing = createRing(clazzRing);
}
}
/**
* Constructor for subclasses.
* @param type has to be given by all subclasses
* @param lsOuterRing outer ring
*/
protected PolygonBase(int type, U lsOuterRing)
{
super(type);
this.lsOuterRing = lsOuterRing;
}
/**
* Adds a ring.
* @param ring ring
*/
public void addRing(T ring)
{
// ensure ring is closed
if (!ring.isClosed())
{
ring.close();
}
// use correct orientation for holes
if (!ring.isClockwise())
{
ring.reverse();
}
this.rings.add(ring);
}
@Override
public boolean checkConsistency()
{
if (!super.checkConsistency())
{
return false;
}
return PostGisUtil.checkConsistency(rings);
}
/**
* Clears all rings.
*/
public void clearRings()
{
this.rings.clear();
}
/**
* Creates a new empty ring.
* @param clazzRing class of the ring
* @return ring
* @throws IllegalArgumentException if the class could not be created
*/
@edu.umd.cs.findbugs.annotations.SuppressFBWarnings("EXS_EXCEPTION_SOFTENING_NO_CONSTRAINTS")
private T createRing(Class clazzRing)
{
try
{
return clazzRing.getDeclaredConstructor().newInstance();
}
catch (InstantiationException | IllegalAccessException | IllegalArgumentException | InvocationTargetException
| NoSuchMethodException | SecurityException e)
{
throw new IllegalArgumentException("unable to create empty ring", e);
}
}
@Override
public boolean equals(@Nullable Object other)
{
// check type and parent
if ((other instanceof PolygonBase poly) && super.equals(other))
{
return PostGisUtil.equalsIterable(this.rings, poly.rings);
}
return false;
}
/*
* (non-Javadoc)
* @see io.github.sebasbaumh.postgis.Geometry#getCoordinates()
*/
@Override
public Iterable getCoordinates()
{
return lsOuterRing.getCoordinates();
}
/*
* (non-Javadoc)
* @see io.github.sebasbaumh.postgis.LineBasedGeometry#getEndPoint()
*/
@Nullable
@Override
public Point getEndPoint()
{
return lsOuterRing.getEndPoint();
}
/*
* (non-Javadoc)
* @see io.github.sebasbaumh.postgis.Geometry#getNumberOfCoordinates()
*/
@Override
public int getNumberOfCoordinates()
{
return lsOuterRing.getNumberOfCoordinates();
}
/**
* Gets the number of rings.
* @return number of rings.
*/
public int getNumberOfRings()
{
return rings.size();
}
/**
* Gets the outer ring/boundary of the polygon.
* @return outer ring
*/
public T getOuterRing()
{
return this.lsOuterRing;
}
/**
* Gets all inner rings.
* @return inner rings
*/
public Iterable getRings()
{
return this.rings;
}
/*
* (non-Javadoc)
* @see io.github.sebasbaumh.postgis.LineBasedGeometry#getStartPoint()
*/
@Nullable
@Override
public Point getStartPoint()
{
return lsOuterRing.getStartPoint();
}
@Override
public int hashCode()
{
return 31 * super.hashCode() + Objects.hash(lsOuterRing, rings);
}
/*
* (non-Javadoc)
* @see io.github.sebasbaumh.postgis.Geometry#hasMeasure()
*/
@Override
public boolean hasMeasure()
{
for (T geom : rings)
{
if (geom.hasMeasure())
{
return true;
}
}
return false;
}
/*
* (non-Javadoc)
* @see io.github.sebasbaumh.postgis.Geometry#is3d()
*/
@Override
public boolean is3d()
{
for (T geom : rings)
{
if (geom.is3d())
{
return true;
}
}
return false;
}
/**
* Checks if this polygon is oriented in clockwise direction. Is false for the outer polygon and true for its holes.
* @return true on success, else false
*/
public boolean isClockwise()
{
return lsOuterRing.isClockwise();
}
/*
* (non-Javadoc)
* @see io.github.sebasbaumh.postgis.LineBasedGeometry#isClosed()
*/
@Override
public boolean isClosed()
{
return this.lsOuterRing.isClosed();
}
/*
* (non-Javadoc)
* @see io.github.sebasbaumh.postgis.Geometry#isEmpty()
*/
@Override
public boolean isEmpty()
{
return lsOuterRing.isEmpty();
}
/*
* (non-Javadoc)
* @see java.lang.Iterable#iterator()
*/
@Override
public Iterator iterator()
{
return this.rings.iterator();
}
/*
* (non-Javadoc)
* @see io.github.sebasbaumh.postgis.LineBasedGeom#length()
*/
@Override
public double length()
{
return this.lsOuterRing.length();
}
/**
* Sets the outer ring/boundary of the polygon.
* @param ls outer ring
*/
public void setOuterRing(T ls)
{
this.lsOuterRing = ls;
}
/*
* (non-Javadoc)
* @see java.lang.Object#toString()
*/
@Override
public String toString()
{
return this.getClass().getSimpleName() + " [" + this.getNumberOfCoordinates() + " points, " + getNumberOfRings()
+ " inner rings]";
}
}