com.partnersoft.formats.kml
Class KmlPoint

java.lang.Object
  com.partnersoft.formats.kml.KmlGeometry
      com.partnersoft.formats.kml.KmlPoint

All Implemented Interfaces:

KmlObject

Direct Known Subclasses:

KmlLine

public class KmlPoint
extends KmlGeometry

A Kml Point geometry element.

Copyright 2008 Partner Software, Inc

Version:

$Id$

Author:

Rich Stepanski

Constructor Summary

KmlPoint()

KmlPoint(java.lang.String coordinates)
Creates a KmlPoint object using the passed coordinates string.

KmlPoint(java.lang.String coordinates, java.lang.String altitudeMode)
Creates a KmlPoint object using the passed coordinates string.

KmlPoint(java.lang.String coordinates, java.lang.String altitudeMode, boolean extrude)
Creates a KmlPoint object using the passed coordinates string.

KmlPoint(XyPoint lonLat)
Creates a KmlPoint object using the XyPoint to get longitude and latitude.

Method Summary

java.lang.String	getAltitudeMode()
java.lang.String	getCoordinates()
boolean	isExtrude()
void	setAltitudeMode(java.lang.String altitudeMode) Valid altitudeMode values are: clampToGround, relativeToGround, or absolute.
void	setCoordinates(java.lang.String coordinates) Expects longitude,latitude[,altitude] in order.
void	setExtrude(boolean extrude) If point is above the ground and extrude is true, the point will stretch from altitude to surface.
void	write(XmlBuilder writer) Object writes itself to the passed writer in the correct format for the object based on it's fields.

Methods inherited from class java.lang.Object

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

Constructor Detail

KmlPoint

public KmlPoint()

KmlPoint

public KmlPoint(java.lang.String coordinates)

Creates a KmlPoint object using the passed coordinates string. Expects longitude,latitude[,altitude] in order. All values are in decimal. longitude >= -180 and <= 180. latitude >= -90 and <= 90 altitude is optional and in meters above sea level.

Parameters:

coordinates - - String longitude,latitude[,altitude] without spaces.

KmlPoint

public KmlPoint(XyPoint lonLat)

Creates a KmlPoint object using the XyPoint to get longitude and latitude.

Parameters:

lonLat - - XyPoint, x = longitude and y = latitude.

KmlPoint

public KmlPoint(java.lang.String coordinates,
                java.lang.String altitudeMode)

Creates a KmlPoint object using the passed coordinates string. Expects longitude,latitude[,altitude] in order. All values are in decimal. longitude >= -180 and <= 180. latitude >= -90 and <= 90 altitude is optional and in meters above sea level.

altitudeMode can be clampToGround, relativeToGround, or absolute.

Parameters:

coordinates - - String longitude,latitude[,altitude] without spaces.

altitudeMode - - clampToGround, relativeToGround, or absolute.

KmlPoint

public KmlPoint(java.lang.String coordinates,
                java.lang.String altitudeMode,
                boolean extrude)

Creates a KmlPoint object using the passed coordinates string. Expects longitude,latitude[,altitude] in order. All values are in decimal. longitude >= -180 and <= 180. latitude >= -90 and <= 90 altitude is optional and in meters above sea level.

Valid altitudeMode values are: clampToGround, relativeToGround, or absolute.

If point is above the ground and extrude is true, the point will stretch from altitude to surface.

Parameters:

coordinates - - String longitude,latitude[,altitude] without spaces.

altitudeMode - - clampToGround, relativeToGround, or absolute.

extrude - - Connects to ground if true, floats if false.

Method Detail

isExtrude

public boolean isExtrude()

setExtrude

public void setExtrude(boolean extrude)

If point is above the ground and extrude is true, the point will stretch from altitude to surface.

Parameters:

extrude - - boolean flag.

getAltitudeMode

public java.lang.String getAltitudeMode()

setAltitudeMode

public void setAltitudeMode(java.lang.String altitudeMode)

Valid altitudeMode values are: clampToGround, relativeToGround, or absolute.

Parameters:

altitudeMode -

getCoordinates

public java.lang.String getCoordinates()

setCoordinates

public void setCoordinates(java.lang.String coordinates)

Expects longitude,latitude[,altitude] in order. All values are in decimal. longitude >= -180 and <= 180. latitude >= -90 and <= 90 altitude is optional and in meters above sea level.

Parameters:

coordinates -

write

public void write(XmlBuilder writer)
           throws java.io.IOException

Description copied from interface: KmlObject

Object writes itself to the passed writer in the correct format for the object based on it's fields.

Specified by:

write in interface KmlObject

Specified by:

write in class KmlGeometry

Parameters:

writer - - Writer to write kml to.

Throws:

java.io.IOException - - Thrown if an error occurs while writing.