com.vividsolutions.jts.geom
Class Point

java.lang.Object
  extended bycom.vividsolutions.jts.geom.Geometry
      extended bycom.vividsolutions.jts.geom.Point
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Comparable, java.io.Serializable

public class Point
extends Geometry

Basic implementation of Point.

Version:
1.7
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.vividsolutions.jts.geom.Geometry
envelope, factory, SRID
 
Constructor Summary
Point(Coordinate coordinate, PrecisionModel precisionModel, int SRID)
          Deprecated. Use GeometryFactory instead
Point(CoordinateSequence coordinates, GeometryFactory factory)
           
 
Method Summary
 void apply(CoordinateFilter filter)
          Performs an operation with or on this Geometry's coordinates.
 void apply(CoordinateSequenceFilter filter)
          Performs an operation on the coordinates in this Geometry's CoordinateSequences.
 void apply(GeometryComponentFilter filter)
          Performs an operation with or on this Geometry and its component Geometry's.
 void apply(GeometryFilter filter)
          Performs an operation with or on this Geometry and its subelement Geometrys (if any).
 java.lang.Object clone()
          Creates and returns a full copy of this Point object.
protected  int compareToSameClass(java.lang.Object other)
          Returns whether this Geometry is greater than, equal to, or less than another Geometry having the same class.
protected  int compareToSameClass(java.lang.Object other, CoordinateSequenceComparator comp)
          Returns whether this Geometry is greater than, equal to, or less than another Geometry of the same class.
protected  Envelope computeEnvelopeInternal()
          Returns the minimum and maximum x and y values in this Geometry , or a null Envelope if this Geometry is empty.
 boolean equalsExact(Geometry other, double tolerance)
          Returns true if the two Geometrys are exactly equal, up to a specified distance tolerance.
 Geometry getBoundary()
          Gets the boundary of this geometry.
 int getBoundaryDimension()
          Returns the dimension of this Geometrys inherent boundary.
 Coordinate getCoordinate()
          Returns a vertex of this Geometry.
 Coordinate[] getCoordinates()
          Returns this Geometry s vertices.
 CoordinateSequence getCoordinateSequence()
           
 int getDimension()
          Returns the dimension of this Geometry.
 java.lang.String getGeometryType()
          Returns the name of this object's com.vivid.jts.geom interface.
 int getNumPoints()
          Returns the count of this Geometrys vertices.
 double getX()
           
 double getY()
           
 boolean isEmpty()
          Returns whether or not the set of points in this Geometry is empty.
 boolean isSimple()
          Tests whether this Geometry is simple.
 boolean isValid()
          Tests the validity of this Geometry.
 void normalize()
          Converts this Geometry to normal form (or canonical form ).
 
Methods inherited from class com.vividsolutions.jts.geom.Geometry
buffer, buffer, buffer, checkNotGeometryCollection, compare, compareTo, compareTo, contains, convexHull, coveredBy, covers, crosses, difference, disjoint, distance, equal, equals, equalsExact, geometryChanged, geometryChangedAction, getArea, getCentroid, getEnvelope, getEnvelopeInternal, getFactory, getGeometryN, getInteriorPoint, getLength, getNumGeometries, getPrecisionModel, getSRID, getUserData, hasNonEmptyElements, hasNullElements, intersection, intersects, isEquivalentClass, isRectangle, isWithinDistance, overlaps, relate, relate, setSRID, setUserData, symDifference, toString, toText, touches, union, within
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Point

public Point(Coordinate coordinate,
             PrecisionModel precisionModel,
             int SRID)
Deprecated. Use GeometryFactory instead

Constructs a Point with the given coordinate.

Parameters:
coordinate - the coordinate on which to base this Point , or null to create the empty geometry.
precisionModel - the specification of the grid of allowable points for this Point
SRID - the ID of the Spatial Reference System used by this Point

Point

public Point(CoordinateSequence coordinates,
             GeometryFactory factory)
Parameters:
coordinates - contains the single coordinate on which to base this Point , or null to create the empty geometry.
Method Detail

getCoordinates

public Coordinate[] getCoordinates()
Description copied from class: Geometry
Returns this Geometry s vertices. If you modify the coordinates in this array, be sure to call #geometryChanged afterwards. The Geometrys contained by composite Geometrys must be Geometry's; that is, they must implement getCoordinates.

Specified by:
getCoordinates in class Geometry
Returns:
the vertices of this Geometry

getNumPoints

public int getNumPoints()
Description copied from class: Geometry
Returns the count of this Geometrys vertices. The Geometry s contained by composite Geometrys must be Geometry's; that is, they must implement getNumPoints

Specified by:
getNumPoints in class Geometry
Returns:
the number of vertices in this Geometry

isEmpty

public boolean isEmpty()
Description copied from class: Geometry
Returns whether or not the set of points in this Geometry is empty.

Specified by:
isEmpty in class Geometry
Returns:
true if this Geometry equals the empty geometry

isSimple

public boolean isSimple()
Description copied from class: Geometry
Tests whether this Geometry is simple. In general, the SFS specification of simplicity follows the rule: Simplicity is defined for each Geometry subclass as follows:

isValid

public boolean isValid()
Description copied from class: Geometry
Tests the validity of this Geometry. Subclasses provide their own definition of "valid".

Overrides:
isValid in class Geometry
Returns:
true if this Geometry is valid
See Also:
IsValidOp

getDimension

public int getDimension()
Description copied from class: Geometry
Returns the dimension of this Geometry.

Specified by:
getDimension in class Geometry
Returns:
the dimension of the class implementing this interface, whether or not this object is the empty geometry

getBoundaryDimension

public int getBoundaryDimension()
Description copied from class: Geometry
Returns the dimension of this Geometrys inherent boundary.

Specified by:
getBoundaryDimension in class Geometry
Returns:
the dimension of the boundary of the class implementing this interface, whether or not this object is the empty geometry. Returns Dimension.FALSE if the boundary is the empty geometry.

getX

public double getX()

getY

public double getY()

getCoordinate

public Coordinate getCoordinate()
Description copied from class: Geometry
Returns a vertex of this Geometry.

Specified by:
getCoordinate in class Geometry
Returns:
a Coordinate which is a vertex of this Geometry. Returns null if this Geometry is empty

getGeometryType

public java.lang.String getGeometryType()
Description copied from class: Geometry
Returns the name of this object's com.vivid.jts.geom interface.

Specified by:
getGeometryType in class Geometry
Returns:
the name of this Geometrys most specific com.vividsolutions.jts.geom interface

getBoundary

public Geometry getBoundary()
Gets the boundary of this geometry. Zero-dimensional geometries have no boundary by definition, so an empty GeometryCollection is returned.

Specified by:
getBoundary in class Geometry
Returns:
an empty GeometryCollection
See Also:
Geometry.getBoundary()

computeEnvelopeInternal

protected Envelope computeEnvelopeInternal()
Description copied from class: Geometry
Returns the minimum and maximum x and y values in this Geometry , or a null Envelope if this Geometry is empty. Unlike getEnvelopeInternal, this method calculates the Envelope each time it is called; getEnvelopeInternal caches the result of this method.

Specified by:
computeEnvelopeInternal in class Geometry
Returns:
this Geometrys bounding box; if the Geometry is empty, Envelope#isNull will return true

equalsExact

public boolean equalsExact(Geometry other,
                           double tolerance)
Description copied from class: Geometry
Returns true if the two Geometrys are exactly equal, up to a specified distance tolerance. Two Geometries are exactly equal within a distance tolerance if and only if: If this and the other Geometrys are composites and any children are not Geometrys, returns false.

Specified by:
equalsExact in class Geometry
Parameters:
other - the Geometry with which to compare this Geometry
Returns:
true if this and the other Geometry are of the same class and have equal internal data.

apply

public void apply(CoordinateFilter filter)
Description copied from class: Geometry
Performs an operation with or on this Geometry's coordinates. If this method modifies any coordinate values, #geometryChanged() must be called to update the geometry state. Note that you cannot use this method to modify this Geometry if its underlying CoordinateSequence's #get method returns a copy of the Coordinate, rather than the actual Coordinate stored (if it even stores Coordinates at all).

Specified by:
apply in class Geometry
Parameters:
filter - the filter to apply to this Geometry's coordinates

apply

public void apply(CoordinateSequenceFilter filter)
Description copied from class: Geometry
Performs an operation on the coordinates in this Geometry's CoordinateSequences. If this method modifies any coordinate values, #geometryChanged() must be called to update the geometry state.

Specified by:
apply in class Geometry
Parameters:
filter - the filter to apply

apply

public void apply(GeometryFilter filter)
Description copied from class: Geometry
Performs an operation with or on this Geometry and its subelement Geometrys (if any). Only GeometryCollections and subclasses have subelement Geometry's.

Specified by:
apply in class Geometry
Parameters:
filter - the filter to apply to this Geometry (and its children, if it is a GeometryCollection).

apply

public void apply(GeometryComponentFilter filter)
Description copied from class: Geometry
Performs an operation with or on this Geometry and its component Geometry's. Only GeometryCollections and Polygons have component Geometry's; for Polygons they are the LinearRings of the shell and holes.

Specified by:
apply in class Geometry
Parameters:
filter - the filter to apply to this Geometry.

clone

public java.lang.Object clone()
Creates and returns a full copy of this Point object. (including all coordinates contained by it).

Overrides:
clone in class Geometry
Returns:
a clone of this instance

normalize

public void normalize()
Description copied from class: Geometry
Converts this Geometry to normal form (or canonical form ). Normal form is a unique representation for Geometry s. It can be used to test whether two Geometrys are equal in a way that is independent of the ordering of the coordinates within them. Normal form equality is a stronger condition than topological equality, but weaker than pointwise equality. The definitions for normal form use the standard lexicographical ordering for coordinates. "Sorted in order of coordinates" means the obvious extension of this ordering to sequences of coordinates.

Specified by:
normalize in class Geometry

compareToSameClass

protected int compareToSameClass(java.lang.Object other)
Description copied from class: Geometry
Returns whether this Geometry is greater than, equal to, or less than another Geometry having the same class.

Specified by:
compareToSameClass in class Geometry
Parameters:
other - a Geometry having the same class as this Geometry
Returns:
a positive number, 0, or a negative number, depending on whether this object is greater than, equal to, or less than o, as defined in "Normal Form For Geometry" in the JTS Technical Specifications

compareToSameClass

protected int compareToSameClass(java.lang.Object other,
                                 CoordinateSequenceComparator comp)
Description copied from class: Geometry
Returns whether this Geometry is greater than, equal to, or less than another Geometry of the same class. using the given CoordinateSequenceComparator.

Specified by:
compareToSameClass in class Geometry
Parameters:
other - a Geometry having the same class as this Geometry
comp - a CoordinateSequenceComparator
Returns:
a positive number, 0, or a negative number, depending on whether this object is greater than, equal to, or less than o, as defined in "Normal Form For Geometry" in the JTS Technical Specifications

getCoordinateSequence

public CoordinateSequence getCoordinateSequence()