de.micromata.opengis.kml.v_2_2_0
Class LatLonAltBox

java.lang.Object
  extended by de.micromata.opengis.kml.v_2_2_0.AbstractObject
      extended by de.micromata.opengis.kml.v_2_2_0.AbstractLatLonBox
          extended by de.micromata.opengis.kml.v_2_2_0.LatLonAltBox
All Implemented Interfaces:
java.lang.Cloneable

public class LatLonAltBox
extends AbstractLatLonBox
implements java.lang.Cloneable

(required)

A bounding box that describes an area of interest defined by geographic coordinates and altitudes. Default values and required fields are as follows:


Field Summary
protected  AltitudeMode altitudeMode
          AltitudeMode
protected  java.util.List<AbstractObject> latLonAltBoxObjectExtension
          
protected  java.util.List<java.lang.Object> latLonAltBoxSimpleExtension
           
protected  double maxAltitude
          
protected  double minAltitude
          
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractLatLonBox
abstractLatLonBoxObjectExtension, abstractLatLonBoxSimpleExtension, east, north, south, west
 
Fields inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
id, objectSimpleExtension, targetId
 
Constructor Summary
LatLonAltBox()
           
 
Method Summary
 LatLonAltBox addToAbstractLatLonBoxObjectExtension(AbstractObject abstractLatLonBoxObjectExtension)
          add a value to the abstractLatLonBoxObjectExtension property collection
 LatLonAltBox addToAbstractLatLonBoxSimpleExtension(java.lang.Object abstractLatLonBoxSimpleExtension)
          add a value to the abstractLatLonBoxSimpleExtension property collection
 LatLonAltBox addToLatLonAltBoxObjectExtension(AbstractObject latLonAltBoxObjectExtension)
          add a value to the latLonAltBoxObjectExtension property collection
 LatLonAltBox addToLatLonAltBoxSimpleExtension(java.lang.Object latLonAltBoxSimpleExtension)
          add a value to the latLonAltBoxSimpleExtension property collection
 LatLonAltBox addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
          add a value to the objectSimpleExtension property collection
 LatLonAltBox clone()
           
 boolean equals(java.lang.Object obj)
           
 AltitudeMode getAltitudeMode()
           
 java.util.List<AbstractObject> getLatLonAltBoxObjectExtension()
           
 java.util.List<java.lang.Object> getLatLonAltBoxSimpleExtension()
           
 double getMaxAltitude()
           
 double getMinAltitude()
           
 int hashCode()
           
 void setAbstractLatLonBoxObjectExtension(java.util.List<AbstractObject> abstractLatLonBoxObjectExtension)
           
 void setAbstractLatLonBoxSimpleExtension(java.util.List<java.lang.Object> abstractLatLonBoxSimpleExtension)
           
 void setAltitudeMode(AltitudeMode value)
           
 void setLatLonAltBoxObjectExtension(java.util.List<AbstractObject> latLonAltBoxObjectExtension)
           
 void setLatLonAltBoxSimpleExtension(java.util.List<java.lang.Object> latLonAltBoxSimpleExtension)
           
 void setMaxAltitude(double value)
           
 void setMinAltitude(double value)
           
 void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
           
 LatLonAltBox withAbstractLatLonBoxObjectExtension(java.util.List<AbstractObject> abstractLatLonBoxObjectExtension)
          fluent setter
 LatLonAltBox withAbstractLatLonBoxSimpleExtension(java.util.List<java.lang.Object> abstractLatLonBoxSimpleExtension)
          fluent setter
 LatLonAltBox withAltitudeMode(AltitudeMode altitudeMode)
          fluent setter
 LatLonAltBox withEast(double east)
          fluent setter
 LatLonAltBox withId(java.lang.String id)
          fluent setter
 LatLonAltBox withLatLonAltBoxObjectExtension(java.util.List<AbstractObject> latLonAltBoxObjectExtension)
          fluent setter
 LatLonAltBox withLatLonAltBoxSimpleExtension(java.util.List<java.lang.Object> latLonAltBoxSimpleExtension)
          fluent setter
 LatLonAltBox withMaxAltitude(double maxAltitude)
          fluent setter
 LatLonAltBox withMinAltitude(double minAltitude)
          fluent setter
 LatLonAltBox withNorth(double north)
          fluent setter
 LatLonAltBox withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
          fluent setter
 LatLonAltBox withSouth(double south)
          fluent setter
 LatLonAltBox withTargetId(java.lang.String targetId)
          fluent setter
 LatLonAltBox withWest(double west)
          fluent setter
 
Methods inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractLatLonBox
getAbstractLatLonBoxObjectExtension, getAbstractLatLonBoxSimpleExtension, getEast, getNorth, getSouth, getWest, setEast, setNorth, setSouth, setWest
 
Methods inherited from class de.micromata.opengis.kml.v_2_2_0.AbstractObject
getId, getObjectSimpleExtension, getTargetId, setId, setTargetId
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

minAltitude

protected double minAltitude

Specified in meters (and is affected by the altitude mode specification).


maxAltitude

protected double maxAltitude

Specified in meters (and is affected by the altitude mode specification).


altitudeMode

protected AltitudeMode altitudeMode
AltitudeMode

clampToGround, relativeToGround, absolute

See Also: See and


latLonAltBoxSimpleExtension

protected java.util.List<java.lang.Object> latLonAltBoxSimpleExtension

latLonAltBoxObjectExtension

protected java.util.List<AbstractObject> latLonAltBoxObjectExtension

This is an abstract base class and cannot be used directly in a KML file. It provides the id attribute, which allows unique identification of a KML element, and the targetId attribute, which is used to reference objects that have already been loaded into Google Earth. The id attribute must be assigned if the mechanism is to be used.

Syntax:
<!-- abstract element; do not create -->
 <!-- Object id="ID" targetId="NCName" -->
 <!-- /Object> -->

Constructor Detail

LatLonAltBox

public LatLonAltBox()
Method Detail

getMinAltitude

public double getMinAltitude()
Returns:
possible object is Double
See Also:
minAltitude

setMinAltitude

public void setMinAltitude(double value)
Parameters:
value - allowed object is Double
See Also:
minAltitude

getMaxAltitude

public double getMaxAltitude()
Returns:
possible object is Double
See Also:
maxAltitude

setMaxAltitude

public void setMaxAltitude(double value)
Parameters:
value - allowed object is Double
See Also:
maxAltitude

getAltitudeMode

public AltitudeMode getAltitudeMode()
Returns:
possible object is <Object <AltitudeMode <de.micromata.opengis.kml.v_2_2_0.gx.AltitudeMode
See Also:
altitudeMode

setAltitudeMode

public void setAltitudeMode(AltitudeMode value)
Parameters:
value - allowed object is <Object <AltitudeMode <de.micromata.opengis.kml.v_2_2_0.gx.AltitudeMode
See Also:
altitudeMode

getLatLonAltBoxSimpleExtension

public java.util.List<java.lang.Object> getLatLonAltBoxSimpleExtension()
See Also:
latLonAltBoxSimpleExtension

getLatLonAltBoxObjectExtension

public java.util.List<AbstractObject> getLatLonAltBoxObjectExtension()
See Also:
latLonAltBoxObjectExtension

hashCode

public int hashCode()
Overrides:
hashCode in class AbstractLatLonBox

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class AbstractLatLonBox

setLatLonAltBoxSimpleExtension

public void setLatLonAltBoxSimpleExtension(java.util.List<java.lang.Object> latLonAltBoxSimpleExtension)
Parameters:
latLonAltBoxSimpleExtension -
See Also:
latLonAltBoxSimpleExtension

addToLatLonAltBoxSimpleExtension

public LatLonAltBox addToLatLonAltBoxSimpleExtension(java.lang.Object latLonAltBoxSimpleExtension)
add a value to the latLonAltBoxSimpleExtension property collection

Parameters:
latLonAltBoxSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setLatLonAltBoxObjectExtension

public void setLatLonAltBoxObjectExtension(java.util.List<AbstractObject> latLonAltBoxObjectExtension)
Parameters:
latLonAltBoxObjectExtension -
See Also:
latLonAltBoxObjectExtension

addToLatLonAltBoxObjectExtension

public LatLonAltBox addToLatLonAltBoxObjectExtension(AbstractObject latLonAltBoxObjectExtension)
add a value to the latLonAltBoxObjectExtension property collection

Parameters:
latLonAltBoxObjectExtension - Objects of the following type are allowed in the list: AbstractObject
Returns:
true (as general contract of Collection.add).

setObjectSimpleExtension

public void setObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
Overrides:
setObjectSimpleExtension in class AbstractLatLonBox
See Also:
objectSimpleExtension

addToObjectSimpleExtension

public LatLonAltBox addToObjectSimpleExtension(java.lang.Object objectSimpleExtension)
Description copied from class: AbstractObject
add a value to the objectSimpleExtension property collection

Overrides:
addToObjectSimpleExtension in class AbstractLatLonBox
Parameters:
objectSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setAbstractLatLonBoxSimpleExtension

public void setAbstractLatLonBoxSimpleExtension(java.util.List<java.lang.Object> abstractLatLonBoxSimpleExtension)
Overrides:
setAbstractLatLonBoxSimpleExtension in class AbstractLatLonBox
See Also:
abstractLatLonBoxSimpleExtension

addToAbstractLatLonBoxSimpleExtension

public LatLonAltBox addToAbstractLatLonBoxSimpleExtension(java.lang.Object abstractLatLonBoxSimpleExtension)
Description copied from class: AbstractLatLonBox
add a value to the abstractLatLonBoxSimpleExtension property collection

Overrides:
addToAbstractLatLonBoxSimpleExtension in class AbstractLatLonBox
Parameters:
abstractLatLonBoxSimpleExtension - Objects of the following type are allowed in the list: Object
Returns:
true (as general contract of Collection.add).

setAbstractLatLonBoxObjectExtension

public void setAbstractLatLonBoxObjectExtension(java.util.List<AbstractObject> abstractLatLonBoxObjectExtension)
Overrides:
setAbstractLatLonBoxObjectExtension in class AbstractLatLonBox
See Also:
abstractLatLonBoxObjectExtension

addToAbstractLatLonBoxObjectExtension

public LatLonAltBox addToAbstractLatLonBoxObjectExtension(AbstractObject abstractLatLonBoxObjectExtension)
Description copied from class: AbstractLatLonBox
add a value to the abstractLatLonBoxObjectExtension property collection

Overrides:
addToAbstractLatLonBoxObjectExtension in class AbstractLatLonBox
Parameters:
abstractLatLonBoxObjectExtension - Objects of the following type are allowed in the list: AbstractObject
Returns:
true (as general contract of Collection.add).

withMinAltitude

public LatLonAltBox withMinAltitude(double minAltitude)
fluent setter

Parameters:
minAltitude - required parameter
See Also:
setMinAltitude(double)

withMaxAltitude

public LatLonAltBox withMaxAltitude(double maxAltitude)
fluent setter

Parameters:
maxAltitude - required parameter
See Also:
setMaxAltitude(double)

withAltitudeMode

public LatLonAltBox withAltitudeMode(AltitudeMode altitudeMode)
fluent setter

Parameters:
altitudeMode - required parameter
See Also:
#setAltitudeMode(Object)

withLatLonAltBoxSimpleExtension

public LatLonAltBox withLatLonAltBoxSimpleExtension(java.util.List<java.lang.Object> latLonAltBoxSimpleExtension)
fluent setter

Parameters:
latLonAltBoxSimpleExtension - required parameter
See Also:
#setLatLonAltBoxSimpleExtension(List)

withLatLonAltBoxObjectExtension

public LatLonAltBox withLatLonAltBoxObjectExtension(java.util.List<AbstractObject> latLonAltBoxObjectExtension)
fluent setter

Parameters:
latLonAltBoxObjectExtension - required parameter
See Also:
#setLatLonAltBoxObjectExtension(List)

withObjectSimpleExtension

public LatLonAltBox withObjectSimpleExtension(java.util.List<java.lang.Object> objectSimpleExtension)
Description copied from class: AbstractObject
fluent setter

Overrides:
withObjectSimpleExtension in class AbstractLatLonBox
Parameters:
objectSimpleExtension - required parameter
See Also:
#setObjectSimpleExtension(List)

withId

public LatLonAltBox withId(java.lang.String id)
Description copied from class: AbstractObject
fluent setter

Overrides:
withId in class AbstractLatLonBox
Parameters:
id - required parameter
See Also:
AbstractObject.setId(String)

withTargetId

public LatLonAltBox withTargetId(java.lang.String targetId)
Description copied from class: AbstractObject
fluent setter

Overrides:
withTargetId in class AbstractLatLonBox
Parameters:
targetId - required parameter
See Also:
AbstractObject.setTargetId(String)

withNorth

public LatLonAltBox withNorth(double north)
Description copied from class: AbstractLatLonBox
fluent setter

Overrides:
withNorth in class AbstractLatLonBox
Parameters:
north - required parameter
See Also:
AbstractLatLonBox.setNorth(double)

withSouth

public LatLonAltBox withSouth(double south)
Description copied from class: AbstractLatLonBox
fluent setter

Overrides:
withSouth in class AbstractLatLonBox
Parameters:
south - required parameter
See Also:
AbstractLatLonBox.setSouth(double)

withEast

public LatLonAltBox withEast(double east)
Description copied from class: AbstractLatLonBox
fluent setter

Overrides:
withEast in class AbstractLatLonBox
Parameters:
east - required parameter
See Also:
AbstractLatLonBox.setEast(double)

withWest

public LatLonAltBox withWest(double west)
Description copied from class: AbstractLatLonBox
fluent setter

Overrides:
withWest in class AbstractLatLonBox
Parameters:
west - required parameter
See Also:
AbstractLatLonBox.setWest(double)

withAbstractLatLonBoxSimpleExtension

public LatLonAltBox withAbstractLatLonBoxSimpleExtension(java.util.List<java.lang.Object> abstractLatLonBoxSimpleExtension)
Description copied from class: AbstractLatLonBox
fluent setter

Overrides:
withAbstractLatLonBoxSimpleExtension in class AbstractLatLonBox
Parameters:
abstractLatLonBoxSimpleExtension - required parameter
See Also:
#setAbstractLatLonBoxSimpleExtension(List)

withAbstractLatLonBoxObjectExtension

public LatLonAltBox withAbstractLatLonBoxObjectExtension(java.util.List<AbstractObject> abstractLatLonBoxObjectExtension)
Description copied from class: AbstractLatLonBox
fluent setter

Overrides:
withAbstractLatLonBoxObjectExtension in class AbstractLatLonBox
Parameters:
abstractLatLonBoxObjectExtension - required parameter
See Also:
#setAbstractLatLonBoxObjectExtension(List)

clone

public LatLonAltBox clone()
Overrides:
clone in class AbstractLatLonBox