public class TLcdNVG20Circle extends TLcdNVG20AreaContent implements ILcdCache, ILcdEditableSurface, ILcdInvalidateable
ILcdEditableSurface
implementation whose exterior ring is an ILcd2DEditableCircle
, that represents
an NVG 2.0 Circle.TLcdNVG20Content.ShapeType, TLcdNVG20Content.TimeSpan
Modifier and Type | Field and Description |
---|---|
static TLcdDataProperty |
EXCLUDE_PROPERTY
Data property that maps to the
exclude element. |
static TLcdDataProperty |
EXTENDED_DATA_PROPERTY
Data property that maps to the
ExtendedData element. |
static TLcdDataProperty |
EXTENSION_PROPERTY
Data property that maps to the
extension element. |
static TLcdDataProperty |
HREF_PROPERTY
Data property that maps to the
href attribute. |
static TLcdDataProperty |
LABEL_PROPERTY
Data property that maps to the
label attribute. |
static TLcdDataProperty |
MAXIMUM_Z_PROPERTY
Data property that maps to the
maxaltitude attribute. |
static TLcdDataProperty |
METADATA_PROPERTY
Data property that maps to the
metadata element. |
static TLcdDataProperty |
MINIMUM_Z_PROPERTY
Data property that maps to the
minaltitude attribute. |
static TLcdDataProperty |
MODIFIERS_PROPERTY
Data property that maps to the
modifiers attribute. |
static TLcdDataProperty |
RADIUS_PROPERTY
Data property that maps to the
r attribute. |
static TLcdDataProperty |
STYLE_PROPERTY
Data property that maps to the
style attribute. |
static TLcdDataProperty |
SYMBOL_PROPERTY
Data property that maps to the
symbol attribute. |
static TLcdDataProperty |
TEXT_INFO_PROPERTY
Data property that maps to the
textInfo element. |
static TLcdDataProperty |
TIME_SPAN_PROPERTY
Data property that maps to the
TimeSpan element. |
static TLcdDataProperty |
TIME_STAMP_PROPERTY
Data property that maps to the
TimeStamp element. |
static TLcdDataProperty |
URI_PROPERTY
Data property that maps to the
uri attribute. |
static TLcdDataProperty |
X_PROPERTY
Data property that maps to the
cx attribute. |
static TLcdDataProperty |
Y_PROPERTY
Data property that maps to the
cy attribute. |
Constructor and Description |
---|
TLcdNVG20Circle() |
TLcdNVG20Circle(TLcdDataType aDataType)
Creates a new instance of TLcdNVG20Circle with the given data type.
|
Modifier and Type | Method and Description |
---|---|
void |
clearCache()
Clears the cache.
|
TLcdNVG20Circle |
clone()
Returns a deep clone of this object.
|
TLcdNVG20Circle |
clone(Map aObjectDictionary)
Returns a deep clone of this object.
|
boolean |
contains2D(double aX,
double aY)
Checks whether this
ILcdShape contains the given point in
the 2D space. |
boolean |
contains2D(ILcdPoint aILcdPoint)
Checks whether this
ILcdShape contains the given ILcdPoint in the 2D space. |
boolean |
contains3D(double aX,
double aY,
double aZ)
Checks whether this
ILcdShape contains the given point in
the 3D space. |
boolean |
contains3D(ILcdPoint aILcdPoint)
Checks whether this
ILcdShape contains the given ILcdPoint in the 3D space. |
ILcdBounds |
getBounds()
Returns the
ILcdBounds by which the geometry of this ILcdBounded object
is bounded. |
Object |
getCachedObject(Object aKey)
Looks up and returns the cached Object corresponding to the given key.
|
ILcdPoint |
getCenter() |
TLcdNVG20Exclusion |
getExclude()
Returns the value of the property that maps to the
exclude element. |
TLcdNVG20ExtendedData |
getExtendedData()
Returns the value of the property that maps to the
ExtendedData element. |
TLcdNVG20Extension |
getExtension()
Returns the value of the property that maps to the
extension element. |
ILcdRing |
getExteriorRing()
Returns the exterior boundary of this surface.
|
ILcdPoint |
getFocusPoint()
Returns the focus point of this
ILcdShape . |
URI |
getHref()
Returns the value of the property that maps to the
href attribute. |
String |
getLabel()
Returns the value of the property that maps to the
label attribute. |
double |
getMaximumZ()
Returns the value of the property that maps to the
maxaltitude attribute. |
TLcdNVG20Extension |
getMetadata()
Returns the value of the property that maps to the
metadata element. |
double |
getMinimumZ()
Returns the value of the property that maps to the
minaltitude attribute. |
TLcdNVGModifiers |
getModifiers()
Returns the value of the property that maps to the
modifiers attribute. |
double |
getRadius()
Returns the value of the property that maps to the
r attribute. |
TLcdNVGStyle |
getStyle()
Returns the value of the property that maps to the
style attribute. |
TLcdNVGSymbol |
getSymbol()
Returns the value of the property that maps to the
symbol attribute. |
String |
getTextInfo()
Returns the value of the property that maps to the
textInfo element. |
TLcdNVG20Content.TimeSpan |
getTimeSpan()
Returns the value of the property that maps to the
TimeSpan element. |
XMLGregorianCalendar |
getTimeStamp()
Returns the value of the property that maps to the
TimeStamp element. |
URI |
getUri()
Returns the value of the property that maps to the
uri attribute. |
double |
getX()
Returns the value of the property that maps to the
cx attribute. |
double |
getY()
Returns the value of the property that maps to the
cy attribute. |
void |
insertIntoCache(Object aKey,
Object aObject)
Inserts a cache Object corresponding to the given key Object.
|
void |
invalidateObject()
Invalidates all cached values of this object.
|
void |
move2D(double aX,
double aY) |
void |
move2D(ILcdPoint aILcdPoint) |
Object |
removeCachedObject(Object aKey)
Looks up and removes the cached Object corresponding to the given key.
|
void |
setExclude(TLcdNVG20Exclusion aValue)
Sets the value of the property that maps to the
exclude element. |
void |
setExtendedData(TLcdNVG20ExtendedData aValue)
Sets the value of the property that maps to the
ExtendedData element. |
void |
setExtension(TLcdNVG20Extension aValue)
Sets the value of the property that maps to the
extension element. |
void |
setExteriorRing(ILcdRing aRing)
Sets the exterior boundary of this surface.
|
void |
setHref(URI aValue)
Sets the value of the property that maps to the
href attribute. |
void |
setLabel(String aValue)
Sets the value of the property that maps to the
label attribute. |
void |
setMaximumZ(double aValue)
Sets the value of the property that maps to the
maxaltitude attribute. |
void |
setMetadata(TLcdNVG20Extension aValue)
Sets the value of the property that maps to the
metadata element. |
void |
setMinimumZ(double aValue)
Sets the value of the property that maps to the
minaltitude attribute. |
void |
setModifiers(TLcdNVGModifiers aValue)
Sets the value of the property that maps to the
modifiers attribute. |
void |
setRadius(double aValue)
Sets the value of the property that maps to the
r attribute. |
void |
setStyle(TLcdNVGStyle aValue)
Sets the value of the property that maps to the
style attribute. |
void |
setSymbol(TLcdNVGSymbol aValue)
Sets the value of the property that maps to the
symbol attribute. |
void |
setTextInfo(String aValue)
Sets the value of the property that maps to the
textInfo element. |
void |
setTimeSpan(TLcdNVG20Content.TimeSpan aValue)
Sets the value of the property that maps to the
TimeSpan element. |
void |
setTimeStamp(XMLGregorianCalendar aValue)
Sets the value of the property that maps to the
TimeStamp element. |
void |
setUri(URI aValue)
Sets the value of the property that maps to the
uri attribute. |
void |
setX(double aValue)
Sets the value of the property that maps to the
cx attribute. |
void |
setY(double aValue)
Sets the value of the property that maps to the
cy attribute. |
void |
translate2D(double aDeltaX,
double aDeltaY) |
getInteriorRings
getAPP6CodedFromMapObject, getMS2525CodedFromMapObject, setSymbolFromAPP6, setSymbolFromMS2525
getParent, getShapeType, setParent
getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getInteriorRings
public static final TLcdDataProperty X_PROPERTY
cx
attribute.
The possible values for this property are instances of double
.public static final TLcdDataProperty Y_PROPERTY
cy
attribute.
The possible values for this property are instances of double
.public static final TLcdDataProperty RADIUS_PROPERTY
r
attribute.
The possible values for this property are instances of double
.public static final TLcdDataProperty MAXIMUM_Z_PROPERTY
maxaltitude
attribute.
The possible values for this property are instances of double
.public static final TLcdDataProperty MINIMUM_Z_PROPERTY
minaltitude
attribute.
The possible values for this property are instances of double
.public static final TLcdDataProperty EXCLUDE_PROPERTY
exclude
element.
The possible values for this property are instances of TLcdNVG20Exclusion
.public static final TLcdDataProperty MODIFIERS_PROPERTY
modifiers
attribute.
The possible values for this property are instances of TLcdNVGModifiers
.public static final TLcdDataProperty SYMBOL_PROPERTY
symbol
attribute.
The possible values for this property are instances of TLcdNVGSymbol
.public static final TLcdDataProperty HREF_PROPERTY
href
attribute.
The possible values for this property are instances of URI
.public static final TLcdDataProperty LABEL_PROPERTY
label
attribute.
The possible values for this property are instances of String
.public static final TLcdDataProperty STYLE_PROPERTY
style
attribute.
The possible values for this property are instances of TLcdNVGStyle
.public static final TLcdDataProperty URI_PROPERTY
uri
attribute.
The possible values for this property are instances of URI
.public static final TLcdDataProperty METADATA_PROPERTY
metadata
element.
The possible values for this property are instances of TLcdNVG20Extension
.public static final TLcdDataProperty EXTENDED_DATA_PROPERTY
ExtendedData
element.
The possible values for this property are instances of TLcdNVG20ExtendedData
.public static final TLcdDataProperty TEXT_INFO_PROPERTY
textInfo
element.
The possible values for this property are instances of String
.public static final TLcdDataProperty TIME_STAMP_PROPERTY
TimeStamp
element.
The possible values for this property are instances of XMLGregorianCalendar
.public static final TLcdDataProperty TIME_SPAN_PROPERTY
TimeSpan
element.
The possible values for this property are instances of TimeSpan
.public static final TLcdDataProperty EXTENSION_PROPERTY
extension
element.
The possible values for this property are instances of TLcdNVG20Extension
.public TLcdNVG20Circle()
public TLcdNVG20Circle(TLcdDataType aDataType)
aDataType
- the data type for the circle.public void setX(double aValue)
cx
attribute.
Center longitude in decimal degrees (WGS84)
aValue
- the value to set for the X_PROPERTY
property.public void setY(double aValue)
cy
attribute.
Center latitude in decimal degrees (WGS84)
aValue
- the value to set for the Y_PROPERTY
property.public void setRadius(double aValue)
r
attribute.
Radius of the circle in meters.
aValue
- the value to set for the RADIUS_PROPERTY
property.public TLcdNVG20Circle clone()
TLcdDataObject
TLcdDataObject.clone(Map)
.clone
in interface ILcdCloneable
clone
in class TLcdDataObject
Object.clone()
public TLcdNVG20Circle clone(Map aObjectDictionary)
TLcdDataObject
ILcdDataObject
, the value is cloned by first creating a new instance via
the value.getDataType().newInstance()
method, and then cloning its properties one by one.ILcdDeepCloneable
or
ILcdCloneable
then this interface is used to clone the value.clone
in interface ILcdDeepCloneable
clone
in class TLcdDataObject
aObjectDictionary
- the Object dictionary that keeps track of the objects for which a clone has already been made,
and their corresponding clone Object.public void insertIntoCache(Object aKey, Object aObject)
ILcdCache
insertIntoCache
in interface ILcdCache
aKey
- the key Object that will be used to identify the Object.
The key must therefore be a unique identifier, typically the caller
itself: insertIntoCache(this, ...)
.aObject
- the Object to be cached.public Object getCachedObject(Object aKey)
ILcdCache
getCachedObject
in interface ILcdCache
aKey
- the key Object that was used for storing the cache Object.public Object removeCachedObject(Object aKey)
ILcdCache
removeCachedObject
in interface ILcdCache
aKey
- the key Object that was used for storing the cache Object.public void clearCache()
ILcdCache
clearCache
in interface ILcdCache
public ILcdPoint getCenter()
public boolean contains2D(double aX, double aY)
ILcdShape
ILcdShape
contains the given point in
the 2D space. Only the first two dimensions of the ILcdShape
are considered.contains2D
in interface ILcdShape
aX
- the x coordinate of the point.aY
- the y coordinate of the point.public boolean contains2D(ILcdPoint aILcdPoint)
ILcdShape
ILcdShape
contains the given ILcdPoint
in the 2D space.
Only the first two dimensions of the ILcdShape
and the ILcdPoint
are considered.contains2D
in interface ILcdShape
aILcdPoint
- the ILcdPoint
to test.ILcdShape.contains2D(double, double)
public boolean contains3D(double aX, double aY, double aZ)
ILcdShape
ILcdShape
contains the given point in
the 3D space.contains3D
in interface ILcdShape
aX
- the x coordinate of the point.aY
- the y coordinate of the point.aZ
- the z coordinate of the point.public boolean contains3D(ILcdPoint aILcdPoint)
ILcdShape
ILcdShape
contains the given ILcdPoint
in the 3D space.contains3D
in interface ILcdShape
aILcdPoint
- the ILcdPoint
to test.ILcdShape.contains3D(double, double, double)
public ILcdPoint getFocusPoint()
ILcdShape
ILcdShape
.getFocusPoint
in interface ILcdShape
ILcdShape
.public ILcdBounds getBounds()
ILcdBounded
ILcdBounds
by which the geometry of this ILcdBounded
object
is bounded.
If the geometry does not allow retrieving valid bounds (for example a polyline with 0 points)
the return value is unspecified.
It is highly recommended to return an undefined
bounds.
You can create undefined bounds using the default constructors
of TLcdLonLatBounds
or TLcdXYBounds
.
getBounds
in interface ILcdBounded
ILcdBounds
by which the geometry of this ILcdBounded
object
is bounded.public void move2D(double aX, double aY)
public void move2D(ILcdPoint aILcdPoint)
public void translate2D(double aDeltaX, double aDeltaY)
public ILcdRing getExteriorRing()
ILcdSurface
getExteriorRing
in interface ILcdSurface
public void invalidateObject()
ILcdInvalidateable
invalidateObject
in interface ILcdInvalidateable
public void setExteriorRing(ILcdRing aRing)
ILcdEditableSurface
Note that this implementations may throw a
ClassCastException
or IllegalArgumentException
in case the class of the ring is not
compatible with the implementation of the surface. Implementations should
specify in their documentation all restrictions that apply in this context.
setExteriorRing
in interface ILcdEditableSurface
aRing
- the exterior boundary of this surface.public double getX()
cx
attribute.
Center longitude in decimal degrees (WGS84)
X_PROPERTY
property.public double getY()
cy
attribute.
Center latitude in decimal degrees (WGS84)
Y_PROPERTY
property.public double getRadius()
r
attribute.
Radius of the circle in meters.
RADIUS_PROPERTY
property.public double getMaximumZ()
maxaltitude
attribute.
Maximum altitude over the datum surface (WGS-84) expressed in meters
MAXIMUM_Z_PROPERTY
property.public void setMaximumZ(double aValue)
maxaltitude
attribute.
Maximum altitude over the datum surface (WGS-84) expressed in meters
aValue
- the value to set for the MAXIMUM_Z_PROPERTY
property.public double getMinimumZ()
minaltitude
attribute.
Minimum altitude over the datum surface (WGS-84) expressed in meters
MINIMUM_Z_PROPERTY
property.public void setMinimumZ(double aValue)
minaltitude
attribute.
Minimum altitude over the datum surface (WGS-84) expressed in meters
aValue
- the value to set for the MINIMUM_Z_PROPERTY
property.public TLcdNVG20Exclusion getExclude()
exclude
element.EXCLUDE_PROPERTY
property.public void setExclude(TLcdNVG20Exclusion aValue)
exclude
element.aValue
- the value to set for the EXCLUDE_PROPERTY
property.public TLcdNVGModifiers getModifiers()
modifiers
attribute.
The modifiers attribute is used to associate additional information with the the symbol attribute
MODIFIERS_PROPERTY
property.public void setModifiers(TLcdNVGModifiers aValue)
modifiers
attribute.
The modifiers attribute is used to associate additional information with the the symbol attribute
aValue
- the value to set for the MODIFIERS_PROPERTY
property.public TLcdNVGSymbol getSymbol()
symbol
attribute.
Symbology attribute that binds the content to a specific symbol scheme and code. Format:
SYMBOL_PROPERTY
property.public void setSymbol(TLcdNVGSymbol aValue)
symbol
attribute.
Symbology attribute that binds the content to a specific symbol scheme and code. Format:
aValue
- the value to set for the SYMBOL_PROPERTY
property.public URI getHref()
href
attribute.
A URL to human readable content providing more information about the ContentType. Typically the NVG document will contain just a small amount of metadata required to render the content. The URL allows the user to drill-down (click through) to the full content.
HREF_PROPERTY
property.public void setHref(URI aValue)
href
attribute.
A URL to human readable content providing more information about the ContentType. Typically the NVG document will contain just a small amount of metadata required to render the content. The URL allows the user to drill-down (click through) to the full content.
aValue
- the value to set for the HREF_PROPERTY
property.public String getLabel()
label
attribute.
A short text label describing the content. Long text should be placed in the text element.
LABEL_PROPERTY
property.public void setLabel(String aValue)
label
attribute.
A short text label describing the content. Long text should be placed in the text element.
aValue
- the value to set for the LABEL_PROPERTY
property.public TLcdNVGStyle getStyle()
style
attribute.
A text string (inline CSS string) that defines how objects should be rendered graphically.
STYLE_PROPERTY
property.public void setStyle(TLcdNVGStyle aValue)
style
attribute.
A text string (inline CSS string) that defines how objects should be rendered graphically.
aValue
- the value to set for the STYLE_PROPERTY
property.public URI getUri()
uri
attribute.
The unique identifier for the content. The URI is immutable and shall remain constant across documents produced by the same source. Furthermore, the URI shall remain constant as the document is transferred through a mediation service/process.
URI_PROPERTY
property.public void setUri(URI aValue)
uri
attribute.
The unique identifier for the content. The URI is immutable and shall remain constant across documents produced by the same source. Furthermore, the URI shall remain constant as the document is transferred through a mediation service/process.
aValue
- the value to set for the URI_PROPERTY
property.public TLcdNVG20Extension getMetadata()
metadata
element.
named container for NDMS / Dublin Core defined metadata
METADATA_PROPERTY
property.public void setMetadata(TLcdNVG20Extension aValue)
metadata
element.
named container for NDMS / Dublin Core defined metadata
aValue
- the value to set for the METADATA_PROPERTY
property.public TLcdNVG20ExtendedData getExtendedData()
ExtendedData
element.EXTENDED_DATA_PROPERTY
property.public void setExtendedData(TLcdNVG20ExtendedData aValue)
ExtendedData
element.aValue
- the value to set for the EXTENDED_DATA_PROPERTY
property.public String getTextInfo()
textInfo
element.
Additional human readable text in addition to @label. Long text content should be placed here.
TEXT_INFO_PROPERTY
property.public void setTextInfo(String aValue)
textInfo
element.
Additional human readable text in addition to @label. Long text content should be placed here.
aValue
- the value to set for the TEXT_INFO_PROPERTY
property.public XMLGregorianCalendar getTimeStamp()
TimeStamp
element.
comparable point in time (DTG) to represent the last state change of this element
TIME_STAMP_PROPERTY
property.public void setTimeStamp(XMLGregorianCalendar aValue)
TimeStamp
element.
comparable point in time (DTG) to represent the last state change of this element
aValue
- the value to set for the TIME_STAMP_PROPERTY
property.public TLcdNVG20Content.TimeSpan getTimeSpan()
TimeSpan
element.
Define a show/hide period (based on strict DTG) for the shape as defined by KML on https://developers.google.com/kml/documentation/kmlreference#timespan
TIME_SPAN_PROPERTY
property.public void setTimeSpan(TLcdNVG20Content.TimeSpan aValue)
TimeSpan
element.
Define a show/hide period (based on strict DTG) for the shape as defined by KML on https://developers.google.com/kml/documentation/kmlreference#timespan
aValue
- the value to set for the TIME_SPAN_PROPERTY
property.public TLcdNVG20Extension getExtension()
extension
element.
Extension point for structured community of interest specific content.
EXTENSION_PROPERTY
property.public void setExtension(TLcdNVG20Extension aValue)
extension
element.
Extension point for structured community of interest specific content.
aValue
- the value to set for the EXTENSION_PROPERTY
property.