prajna.geo

Class GeoMarker

java.lang.Object

prajna.geo.GeoMarker

All Implemented Interfaces:

java.awt.Shape, java.io.Serializable, Locatable, GeoShape

public class GeoMarker
extends java.lang.Object
implements GeoShape

Geographic shape which represents a single location.

Author:

Edward Swing

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GeoMarker(double lat, double lon) Create a geographic marker at the specified coordinates
GeoMarker(GeoCoord coordinate) Create a geographic marker at the specified coordinate

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(double x, double y) Tests if the specified coordinates are inside the boundary of the Shape.
boolean	contains(double x, double y, double w, double h) Tests if the interior of the Shape entirely contains the specified rectangular area.
boolean	contains(java.awt.geom.Point2D point) Tests if the specified point is inside the boundary of the Shape
boolean	contains(java.awt.geom.Rectangle2D rect) Tests if the interior of the Shape entirely contains the specified rectangular area.
java.awt.Rectangle	getBounds() Returns an integer Rectangle that completely encloses the Shape.
java.awt.geom.Rectangle2D	getBounds2D() Returns a high-precision Rectangle that completely encloses the Shape.
GeoCoord	getCenter() Get the center of the shape.
DataRecord	getData() Gets the user data of this GeoShape
GeoBounds	getGeoBounds() Get the geographic bounds for this shape.
GeoCoord[]	getGeoPoints() Returns the list of Geographic coordinates for this shape
java.awt.Shape	getMarkerShape() Get the shape used to render the marker.
java.awt.geom.PathIterator	getPathIterator(java.awt.geom.AffineTransform at) Returns an iterator object that iterates along the Shape boundary and provides access to the geometry of the Shape outline.
java.awt.geom.PathIterator	getPathIterator(java.awt.geom.AffineTransform at, double flatness) Returns an iterator object that iterates along the Shape boundary and provides access to a flattened view of the Shape outline geometry.
double	getRadius() Get the radius for this geoShape.
RenderStyle	getRenderStyle() Get the rendering style for this GeoShape.
boolean	intersects(double x, double y, double w, double h) Tests if the interior of the Shape intersects the interior of a specified rectangular area.
boolean	intersects(java.awt.geom.Rectangle2D rect) Tests if the interior of the Shape intersects the interior of a specified Rectangle
void	project(Projection proj) Projects the geographic coordinates into the given projection
void	setData(DataRecord node) Sets the data record associated with this GeoMarker
void	setMarkerShape(java.awt.Shape shape) Set the shape used to render the marker.
void	setRenderStyle(RenderStyle style) Set the rendering style for this GeoShape.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeoMarker

public GeoMarker(double lat,
         double lon)

Create a geographic marker at the specified coordinates

Parameters:

lat - the marker geographic latitude, in radians

lon - the marker geo graphic longitude, in radians

GeoMarker

public GeoMarker(GeoCoord coordinate)

Create a geographic marker at the specified coordinate

Parameters:

coordinate - the marker geographic coordinate

Method Detail

contains

public boolean contains(double x,
               double y)

Tests if the specified coordinates are inside the boundary of the Shape.

Specified by:

contains in interface java.awt.Shape

Parameters:

x - the specified x coordinate

y - the specified x coordinate

Returns:

true if the specified coordinates are inside the Shape boundary; false otherwise.

contains

public boolean contains(double x,
               double y,
               double w,
               double h)

Tests if the interior of the Shape entirely contains the specified rectangular area.

Specified by:

contains in interface java.awt.Shape

Parameters:

x - the x coordinate of the specified rectangular area

y - the y coordinate of the specified rectangular area

w - the width of the specified rectangular area

h - the height of the specified rectangular area

Returns:

true if the rectangle is contained within the shape, false otherwise

contains

public boolean contains(java.awt.geom.Point2D point)

Tests if the specified point is inside the boundary of the Shape

Specified by:

contains in interface java.awt.Shape

Parameters:

point - the specified point

Returns:

true if the specified point is inside the shape, false otherwise.

contains

public boolean contains(java.awt.geom.Rectangle2D rect)

Tests if the interior of the Shape entirely contains the specified rectangular area.

Specified by:

contains in interface java.awt.Shape

Parameters:

rect - the specified rectangle

Returns:

true if the rectangle is contained within the shape, false otherwise

getBounds

public java.awt.Rectangle getBounds()

Returns an integer Rectangle that completely encloses the Shape.

Specified by:

getBounds in interface java.awt.Shape

Returns:

a Rectangle that completely encloses the Shape.

getBounds2D

public java.awt.geom.Rectangle2D getBounds2D()

Returns a high-precision Rectangle that completely encloses the Shape.

Specified by:

getBounds2D in interface java.awt.Shape

Returns:

a Rectangle that completely encloses the Shape.

getCenter

public GeoCoord getCenter()

Get the center of the shape. This simply returns the marker coordinate

Specified by:

getCenter in interface Locatable

Specified by:

getCenter in interface GeoShape

Returns:

the center of the shape

getData

public DataRecord getData()

Gets the user data of this GeoShape

Specified by:

getData in interface GeoShape

Returns:

the user Object

getGeoBounds

public GeoBounds getGeoBounds()

Get the geographic bounds for this shape. This method returns a bounding box of zero area, with both the minimum and maximum latitude and longitude equal to the coordinates of the marker

Specified by:

getGeoBounds in interface GeoShape

Returns:

the geographic bounds for this shape

getGeoPoints

public GeoCoord[] getGeoPoints()

Returns the list of Geographic coordinates for this shape

Returns:

a single element array containing the coordinate for this marker

getMarkerShape

public java.awt.Shape getMarkerShape()

Get the shape used to render the marker. This is a convenience method which accesses the markerShape of this marker's renderStyle. If the marker shape has not been set, this method returns a zero-length line to represent a point.

Returns:

the shape used to render the marker

getPathIterator

public java.awt.geom.PathIterator getPathIterator(java.awt.geom.AffineTransform at)

Returns an iterator object that iterates along the Shape boundary and provides access to the geometry of the Shape outline.

Specified by:

getPathIterator in interface java.awt.Shape

Parameters:

at - an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if untransformed coordinates are desired

Returns:

a new PathIterator that independently traverses the Shape geometry.

getPathIterator

public java.awt.geom.PathIterator getPathIterator(java.awt.geom.AffineTransform at,
                                         double flatness)

Returns an iterator object that iterates along the Shape boundary and provides access to a flattened view of the Shape outline geometry.

Specified by:

getPathIterator in interface java.awt.Shape

Parameters:

at - an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if untransformed coordinates are desired

flatness - the maximum distance that the line segments used to approximate the curved segments are allowed to deviate from any point on the original curve

Returns:

a new PathIterator that independently traverses the Shape geometry.

getRadius

public double getRadius()

Get the radius for this geoShape. The radius of a marker is zero

Specified by:

getRadius in interface Locatable

Specified by:

getRadius in interface GeoShape

Returns:

0

getRenderStyle

public RenderStyle getRenderStyle()

Get the rendering style for this GeoShape.

Specified by:

getRenderStyle in interface GeoShape

Returns:

the Rendering style

intersects

public boolean intersects(double x,
                 double y,
                 double w,
                 double h)

Tests if the interior of the Shape intersects the interior of a specified rectangular area.

Specified by:

intersects in interface java.awt.Shape

Parameters:

x - the x coordinate of the specified rectangular area

y - the y coordinate of the specified rectangular area

w - the width of the specified rectangular area

h - the height of the specified rectangular area

Returns:

true if the interior of the Shape and the interior of the rectangular area intersect, false otherwise

intersects

public boolean intersects(java.awt.geom.Rectangle2D rect)

Tests if the interior of the Shape intersects the interior of a specified Rectangle

Specified by:

intersects in interface java.awt.Shape

Parameters:

rect - the specified Rectangle

Returns:

true if the interior of the Shape and the interior of the rectangular area intersect, false otherwise

See Also:

Path2D.intersects(java.awt.geom.Rectangle2D)

project

public void project(Projection proj)

Projects the geographic coordinates into the given projection

Specified by:

project in interface GeoShape

Parameters:

proj - the Projection for the conversion

setData

public void setData(DataRecord node)

Sets the data record associated with this GeoMarker

Specified by:

setData in interface GeoShape

Parameters:

node - the data record

setMarkerShape

public void setMarkerShape(java.awt.Shape shape)

Set the shape used to render the marker. This is a convenience method which sets the markerShape of this marker's renderStyle.

Parameters:

shape - the shape used to render the marker

setRenderStyle

public void setRenderStyle(RenderStyle style)

Set the rendering style for this GeoShape. Any fields specifically set for a GeoShape should override the layer's default style.

Specified by:

setRenderStyle in interface GeoShape

Parameters:

style - The rendering style