Class TLcdNVG20Arrow

All Implemented Interfaces:
ILcdDataObject, ILcdNVGNode, ILcdBounded, ILcdGeoBuffer, ILcdPointList, ILcdPolyline, ILcdShape, ILcd2DEditableGeoBuffer, ILcd2DEditablePointList, ILcd2DEditablePolyline, ILcd2DEditableShape, ILcdCache, ILcdCloneable, ILcdDeepCloneable, ILcdInvalidateable, Serializable, Cloneable

ILcd2DEditableGeoBuffer implementation with an ILcd2DEditablePolyline as an underlying shape that represents an NVG 2.0 Arrow.
Since:
2015.0
See Also:
  • Field Details

    • LEG_TYPE_PROPERTY

      public static final TLcdDataProperty LEG_TYPE_PROPERTY
      Data property that maps to the leg-type attribute. The possible values for this property are instances of String.
    • POINTS_PROPERTY

      public static final TLcdDataProperty POINTS_PROPERTY
      Data property that maps to the points attribute. The possible values for this property are instances of ILcd2DEditablePointList.
    • WIDTH_NVG_PROPERTY

      public static final TLcdDataProperty WIDTH_NVG_PROPERTY
      Data property that maps to the width attribute. The possible values for this property are instances of double.
    • MODIFIERS_PROPERTY

      public static final TLcdDataProperty MODIFIERS_PROPERTY
      Data property that maps to the modifiers attribute. The possible values for this property are instances of TLcdNVGModifiers.
    • SYMBOL_PROPERTY

      public static final TLcdDataProperty SYMBOL_PROPERTY
      Data property that maps to the symbol attribute. The possible values for this property are instances of TLcdNVGSymbol.
    • HREF_PROPERTY

      public static final TLcdDataProperty HREF_PROPERTY
      Data property that maps to the href attribute. The possible values for this property are instances of URI.
    • LABEL_PROPERTY

      public static final TLcdDataProperty LABEL_PROPERTY
      Data property that maps to the label attribute. The possible values for this property are instances of String.
    • STYLE_PROPERTY

      public static final TLcdDataProperty STYLE_PROPERTY
      Data property that maps to the style attribute. The possible values for this property are instances of TLcdNVGStyle.
    • URI_PROPERTY

      public static final TLcdDataProperty URI_PROPERTY
      Data property that maps to the uri attribute. The possible values for this property are instances of URI.
    • METADATA_PROPERTY

      public static final TLcdDataProperty METADATA_PROPERTY
      Data property that maps to the metadata element. The possible values for this property are instances of TLcdNVG20Extension.
    • EXTENDED_DATA_PROPERTY

      public static final TLcdDataProperty EXTENDED_DATA_PROPERTY
      Data property that maps to the ExtendedData element. The possible values for this property are instances of TLcdNVG20ExtendedData.
    • TEXT_INFO_PROPERTY

      public static final TLcdDataProperty TEXT_INFO_PROPERTY
      Data property that maps to the textInfo element. The possible values for this property are instances of String.
    • TIME_STAMP_PROPERTY

      public static final TLcdDataProperty TIME_STAMP_PROPERTY
      Data property that maps to the TimeStamp element. The possible values for this property are instances of XMLGregorianCalendar.
    • TIME_SPAN_PROPERTY

      public static final TLcdDataProperty TIME_SPAN_PROPERTY
      Data property that maps to the TimeSpan element. The possible values for this property are instances of TimeSpan.
    • EXTENSION_PROPERTY

      public static final TLcdDataProperty EXTENSION_PROPERTY
      Data property that maps to the extension element. The possible values for this property are instances of TLcdNVG20Extension.
  • Constructor Details

    • TLcdNVG20Arrow

      public TLcdNVG20Arrow()
    • TLcdNVG20Arrow

      public TLcdNVG20Arrow(TLcdDataType aDataType)
      Creates a new instance of TLcdNVG20Arrow with the given data type.
      Parameters:
      aDataType - the data type of the arrow.
  • Method Details

    • clone

      public TLcdNVG20Arrow clone(Map aObjectDictionary)
      Description copied from class: TLcdDataObject
      Returns a deep clone of this object. If the clone is not already present in the dictionary, a new instance if created as follows:
      • First, a new instance is created using Java's clone() mechanism.
      • Then, all properties of this object are cloned and set on the newly created instance. A property is cloned as follows:
        • If the property value is an 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.
        • If the value implements ILcdDeepCloneable or ILcdCloneable then this interface is used to clone the value.
        • Otherwise, the property value is copied by reference.
      Specified by:
      clone in interface ILcdDeepCloneable
      Overrides:
      clone in class TLcdDataObject
      Parameters:
      aObjectDictionary - the Object dictionary that keeps track of the objects for which a clone has already been made, and their corresponding clone Object.
      Returns:
      a deep clone of this object
    • clone

      public TLcdNVG20Arrow clone()
      Description copied from class: TLcdDataObject
      Returns a deep clone of this object. This method delegates to TLcdDataObject.clone(Map).
      Specified by:
      clone in interface ILcdCloneable
      Overrides:
      clone in class TLcdDataObject
      Returns:
      a deep clone of this object
      See Also:
    • setValue

      public void setValue(TLcdDataProperty aProperty, Object aValue)

      Sets the value of the given property for this data object. The implementation is allowed to throw an exception if the given value can't be set.

      The given property must be declared in the data object's type or in one of its super types. In other words, getDataType().getProperties().contains( aProperty ) should always be true. Otherwise, the implementation should throw an IllegalArgumentException.

      Specified by:
      setValue in interface ILcdDataObject
      Overrides:
      setValue in class TLcdDataObject
      Parameters:
      aProperty - the property for which the value is to be set
      aValue - the value to set
      See Also:
    • clearCache

      public void clearCache()
      Description copied from interface: ILcdCache
      Clears the cache.
      Specified by:
      clearCache in interface ILcdCache
    • removeCachedObject

      public Object removeCachedObject(Object aKey)
      Description copied from interface: ILcdCache
      Looks up and removes the cached Object corresponding to the given key.
      Specified by:
      removeCachedObject in interface ILcdCache
      Parameters:
      aKey - the key Object that was used for storing the cache Object.
      Returns:
      the cached Object, or null if there was no Object corresponding to the given key.
    • getCachedObject

      public Object getCachedObject(Object aKey)
      Description copied from interface: ILcdCache
      Looks up and returns the cached Object corresponding to the given key.
      Specified by:
      getCachedObject in interface ILcdCache
      Parameters:
      aKey - the key Object that was used for storing the cache Object.
      Returns:
      the cached Object, or null if there is no Object corresponding to the given key.
    • insertIntoCache

      public void insertIntoCache(Object aKey, Object aObject)
      Description copied from interface: ILcdCache
      Inserts a cache Object corresponding to the given key Object.
      Specified by:
      insertIntoCache in interface ILcdCache
      Parameters:
      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.
    • invalidateObject

      public void invalidateObject()
      Description copied from interface: ILcdInvalidateable
      Invalidates all cached values of this object. Call this method whenever one or more of this object's compositing values has been changed, to notify this object it needs to recompute its cached values.
      Specified by:
      invalidateObject in interface ILcdInvalidateable
    • setWidthNVG

      public void setWidthNVG(double aValue)
      Sets the value of the property that maps to the width attribute.

      The width of the body of the arrow in meters.

      Parameters:
      aValue - the value to set for the WIDTH_NVG_PROPERTY property.
    • setPoints

      public void setPoints(ILcd2DEditablePointList aValue)
      Sets the value of the property that maps to the points attribute.

      The waypoints of the centerline of the arrow (ending at the tip of the arrow)

      Parameters:
      aValue - the value to set for the POINTS_PROPERTY property.
    • setLegType

      public void setLegType(String aLegType)
      Set the interpolation for the underlying polyline. Possible values are ILcdCurve.INTERPOLATION_RHUMB and ILcdCurve.INTERPOLATION_GEODESIC. Other values will be considered equal to geodesic;
      Parameters:
      aLegType - the interpolation
    • removePointAt

      public void removePointAt(int aIndex)
      Description copied from interface: ILcd2DEditablePointList
      Removes the point at the given index from this ILcd2DEditablePointList.
      Specified by:
      removePointAt in interface ILcd2DEditablePointList
      Parameters:
      aIndex - a valid index in the list of ILcdPoint objects.
    • insert2DPoint

      public void insert2DPoint(int aIndex, double aX, double aY)
      Description copied from interface: ILcd2DEditablePointList
      Inserts a point at the given index into this ILcd2DEditablePointList.
      Specified by:
      insert2DPoint in interface ILcd2DEditablePointList
      Parameters:
      aIndex - a valid new index in the list of points.
      aX - the x coordinate of the new point.
      aY - the y coordinate of the new point.
    • translate2DPoint

      public void translate2DPoint(int aIndex, double aDeltaX, double aDeltaY)
      Description copied from interface: ILcd2DEditablePointList
      Translates the specified point of this ILcd2DEditablePointList from its current position over the given translation vector in the 2D space. Only the first two dimensions of the points are considered. The third dimension is left unchanged.
      Specified by:
      translate2DPoint in interface ILcd2DEditablePointList
      Parameters:
      aDeltaX - the x coordinate of the translation vector.
      aDeltaY - the y coordinate of the translation vector.
    • move2DPoint

      public void move2DPoint(int aIndex, double aX, double aY)
      Description copied from interface: ILcd2DEditablePointList
      Moves the specified point of this ILcd2DEditablePointList to the given point in the 2D space. Only the first two dimensions of the ILcdShape are considered. The third dimension is left unchanged.
      Specified by:
      move2DPoint in interface ILcd2DEditablePointList
      Parameters:
      aIndex - a valid index in the list of points.
      aX - the x coordinate of the point.
      aY - the y coordinate of the point.
    • translate2D

      public void translate2D(double aDeltaX, double aDeltaY)
      Description copied from interface: ILcd2DEditableShape
      Translates this ILcd2DEditableShape from its current position over the given translation vector in the 2D space. Only the first two dimensions of the ILcdShape are considered. The third dimension is left unchanged.
      Specified by:
      translate2D in interface ILcd2DEditablePointList
      Specified by:
      translate2D in interface ILcd2DEditableShape
      Parameters:
      aDeltaX - the x coordinate of the translation vector.
      aDeltaY - the y coordinate of the translation vector.
    • move2D

      public void move2D(double aX, double aY)
      Description copied from interface: ILcd2DEditableShape
      Moves this ILcd2DEditableShape to the given point in the 2D space. The focus point is used as the handle by which the shape is moved. Only the first two dimensions of the ILcdShape are considered. The third dimension is left unchanged.
      Specified by:
      move2D in interface ILcd2DEditableShape
      Parameters:
      aX - the x coordinate of the point.
      aY - the y coordinate of the point.
    • move2D

      public void move2D(ILcdPoint aPoint)
      Description copied from interface: ILcd2DEditableShape
      Moves this ILcd2DEditableShape to the given point in the 2D space. The focus point is used as the handle by which the shape is moved. Only the first two dimensions of the ILcdShape and the ILcdPoint are considered. The third dimension is left unchanged.
      Specified by:
      move2D in interface ILcd2DEditableShape
      Parameters:
      aPoint - the ILcdPoint to move to.
      See Also:
    • getPoint

      public ILcdPoint getPoint(int aIndex) throws IndexOutOfBoundsException
      Description copied from interface: ILcdPointList
      Returns the ILcdPoint at a given index.
      Specified by:
      getPoint in interface ILcdPointList
      Parameters:
      aIndex - a valid index in the list of ILcdPoint objects.
      Returns:
      the ILcdPoint at the given index.
      Throws:
      IndexOutOfBoundsException - if the given index is out of bounds.
    • getPointCount

      public int getPointCount()
      Description copied from interface: ILcdPointList
      Returns the number of ILcdPoint objects in the list.
      Specified by:
      getPointCount in interface ILcdPointList
      Returns:
      the number of ILcdPoint objects in the list.
    • getBounds

      public ILcdBounds getBounds()
      Description copied from interface: ILcdBounded
      Returns the 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.

      Specified by:
      getBounds in interface ILcdBounded
      Returns:
      the ILcdBounds by which the geometry of this ILcdBounded object is bounded.
    • contains3D

      public boolean contains3D(double aX, double aY, double aZ)
      Description copied from interface: ILcdShape
      Checks whether this ILcdShape contains the given point in the 3D space.
      Specified by:
      contains3D in interface ILcdShape
      Parameters:
      aX - the x coordinate of the point.
      aY - the y coordinate of the point.
      aZ - the z coordinate of the point.
      Returns:
      the boolean result of the containment test.
    • contains3D

      public boolean contains3D(ILcdPoint aPoint)
      Description copied from interface: ILcdShape
      Checks whether this ILcdShape contains the given ILcdPoint in the 3D space.
      Specified by:
      contains3D in interface ILcdShape
      Parameters:
      aPoint - the ILcdPoint to test.
      Returns:
      the boolean result of the containment test.
      See Also:
    • contains2D

      public boolean contains2D(double aX, double aY)
      Description copied from interface: ILcdShape
      Checks whether this ILcdShape contains the given point in the 2D space. Only the first two dimensions of the ILcdShape are considered.
      Specified by:
      contains2D in interface ILcdShape
      Parameters:
      aX - the x coordinate of the point.
      aY - the y coordinate of the point.
      Returns:
      the boolean result of the containment test.
    • getFocusPoint

      public ILcdPoint getFocusPoint()
      Description copied from interface: ILcdShape
      Returns the focus point of this ILcdShape.
      Specified by:
      getFocusPoint in interface ILcdShape
      Returns:
      the focus point of this ILcdShape.
    • contains2D

      public boolean contains2D(ILcdPoint aPoint)
      Description copied from interface: ILcdShape
      Checks whether this ILcdShape contains the given ILcdPoint in the 2D space. Only the first two dimensions of the ILcdShape and the ILcdPoint are considered.
      Specified by:
      contains2D in interface ILcdShape
      Parameters:
      aPoint - the ILcdPoint to test.
      Returns:
      the boolean result of the containment test.
      See Also:
    • setBaseShape

      public void setBaseShape(ILcdShape aBaseShape)
      Description copied from interface: ILcd2DEditableGeoBuffer
      Sets the base shape of the buffer.
      Specified by:
      setBaseShape in interface ILcd2DEditableGeoBuffer
      Parameters:
      aBaseShape - the base shape of the buffer.
    • setJoinStyle

      public void setJoinStyle(int aJoinStyle)
      Description copied from interface: ILcd2DEditableGeoBuffer
      Sets the join style of the buffer, which must be ILcdGeoBuffer.JOIN_ROUND.
      Specified by:
      setJoinStyle in interface ILcd2DEditableGeoBuffer
      Parameters:
      aJoinStyle - the join style of the buffer.
    • setEndCapStyle

      public void setEndCapStyle(int aEndCapStyle)
      Description copied from interface: ILcd2DEditableGeoBuffer
      Sets the end cap style of the buffer, which must be either ILcdGeoBuffer.CAP_BUTT or ILcdGeoBuffer.CAP_ROUND.
      Specified by:
      setEndCapStyle in interface ILcd2DEditableGeoBuffer
      Parameters:
      aEndCapStyle - the end cap style of the buffer.
    • setWidth

      public void setWidth(double aWidth)
      Description copied from interface: ILcd2DEditableGeoBuffer
      Sets the width of the buffer, expressed in meters and measured from the axis to the border.
      Specified by:
      setWidth in interface ILcd2DEditableGeoBuffer
      Parameters:
      aWidth - the width of the buffer.
    • getWidth

      public double getWidth()
      Description copied from interface: ILcdGeoBuffer
      Returns the width of this buffer, expressed in meters and measured from the line segments of the base shape to the contour. The width is positive (width >= 0).
      Specified by:
      getWidth in interface ILcdGeoBuffer
      Returns:
      the width of the buffer.
    • invalidateShape

      public void invalidateShape()
      Description copied from interface: ILcd2DEditableGeoBuffer
      Indicates that the base shape has been changed, and that the buffer should be recalculated.
      Specified by:
      invalidateShape in interface ILcd2DEditableGeoBuffer
    • getBaseShape

      public ILcd2DEditablePolyline getBaseShape()
      Description copied from interface: ILcdGeoBuffer
      Returns the base shape of the buffer.
      Specified by:
      getBaseShape in interface ILcdGeoBuffer
      Returns:
      the base shape of the buffer.
    • getEndCapStyle

      public int getEndCapStyle()
      Description copied from interface: ILcdGeoBuffer
      Returns the end cap style of this buffer, which defines the representation of the contour at the endings of the base shape. This is one of ILcdGeoBuffer.CAP_ROUND or ILcdGeoBuffer.CAP_BUTT.
      Specified by:
      getEndCapStyle in interface ILcdGeoBuffer
      Returns:
      the end cap style of the buffer.
    • getJoinStyle

      public int getJoinStyle()
      Description copied from interface: ILcdGeoBuffer
      Returns the join style for the contour of this buffer, which defines the representation of the contour at the joins between two line segments of the base shape. This is always ILcdGeoBuffer.JOIN_ROUND.
      Specified by:
      getJoinStyle in interface ILcdGeoBuffer
      Returns:
      the join style of the buffer.
    • getLegType

      public String getLegType()
      Returns the value of the property that maps to the leg-type attribute.

      The line interpolation algorithm.

      Returns:
      the value of the LEG_TYPE_PROPERTY property.
    • getPoints

      public ILcd2DEditablePointList getPoints()
      Returns the value of the property that maps to the points attribute.

      The waypoints of the centerline of the arrow (ending at the tip of the arrow)

      Returns:
      the value of the POINTS_PROPERTY property.
    • getWidthNVG

      public double getWidthNVG()
      Returns the value of the property that maps to the width attribute.

      The width of the body of the arrow in meters.

      Returns:
      the value of the WIDTH_NVG_PROPERTY property.
    • getModifiers

      public TLcdNVGModifiers getModifiers()
      Returns the value of the property that maps to the modifiers attribute.

      The modifiers attribute is used to associate additional information with the the symbol attribute

      Returns:
      the value of the MODIFIERS_PROPERTY property.
    • setModifiers

      public void setModifiers(TLcdNVGModifiers aValue)
      Sets the value of the property that maps to the modifiers attribute.

      The modifiers attribute is used to associate additional information with the the symbol attribute

      Parameters:
      aValue - the value to set for the MODIFIERS_PROPERTY property.
    • getSymbol

      public TLcdNVGSymbol getSymbol()
      Returns the value of the property that maps to the symbol attribute.

      Symbology attribute that binds the content to a specific symbol scheme and code. Format: :

      Returns:
      the value of the SYMBOL_PROPERTY property.
    • setSymbol

      public void setSymbol(TLcdNVGSymbol aValue)
      Sets the value of the property that maps to the symbol attribute.

      Symbology attribute that binds the content to a specific symbol scheme and code. Format: :

      Parameters:
      aValue - the value to set for the SYMBOL_PROPERTY property.
    • getHref

      public URI getHref()
      Returns the value of the property that maps to the 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.

      Returns:
      the value of the HREF_PROPERTY property.
    • setHref

      public void setHref(URI aValue)
      Sets the value of the property that maps to the 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.

      Parameters:
      aValue - the value to set for the HREF_PROPERTY property.
    • getLabel

      public String getLabel()
      Returns the value of the property that maps to the label attribute.

      A short text label describing the content. Long text should be placed in the text element.

      Returns:
      the value of the LABEL_PROPERTY property.
    • setLabel

      public void setLabel(String aValue)
      Sets the value of the property that maps to the label attribute.

      A short text label describing the content. Long text should be placed in the text element.

      Parameters:
      aValue - the value to set for the LABEL_PROPERTY property.
    • getStyle

      public TLcdNVGStyle getStyle()
      Returns the value of the property that maps to the style attribute.

      A text string (inline CSS string) that defines how objects should be rendered graphically.

      Returns:
      the value of the STYLE_PROPERTY property.
    • setStyle

      public void setStyle(TLcdNVGStyle aValue)
      Sets the value of the property that maps to the style attribute.

      A text string (inline CSS string) that defines how objects should be rendered graphically.

      Parameters:
      aValue - the value to set for the STYLE_PROPERTY property.
    • getUri

      public URI getUri()
      Returns the value of the property that maps to the 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.

      Returns:
      the value of the URI_PROPERTY property.
    • setUri

      public void setUri(URI aValue)
      Sets the value of the property that maps to the 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.

      Parameters:
      aValue - the value to set for the URI_PROPERTY property.
    • getMetadata

      public TLcdNVG20Extension getMetadata()
      Returns the value of the property that maps to the metadata element.

      named container for NDMS / Dublin Core defined metadata

      Returns:
      the value of the METADATA_PROPERTY property.
    • setMetadata

      public void setMetadata(TLcdNVG20Extension aValue)
      Sets the value of the property that maps to the metadata element.

      named container for NDMS / Dublin Core defined metadata

      Parameters:
      aValue - the value to set for the METADATA_PROPERTY property.
    • getExtendedData

      public TLcdNVG20ExtendedData getExtendedData()
      Returns the value of the property that maps to the ExtendedData element.
      Returns:
      the value of the EXTENDED_DATA_PROPERTY property.
    • setExtendedData

      public void setExtendedData(TLcdNVG20ExtendedData aValue)
      Sets the value of the property that maps to the ExtendedData element.
      Parameters:
      aValue - the value to set for the EXTENDED_DATA_PROPERTY property.
    • getTextInfo

      public String getTextInfo()
      Returns the value of the property that maps to the textInfo element.

      Additional human readable text in addition to @label. Long text content should be placed here.

      Returns:
      the value of the TEXT_INFO_PROPERTY property.
    • setTextInfo

      public void setTextInfo(String aValue)
      Sets the value of the property that maps to the textInfo element.

      Additional human readable text in addition to @label. Long text content should be placed here.

      Parameters:
      aValue - the value to set for the TEXT_INFO_PROPERTY property.
    • getTimeStamp

      public XMLGregorianCalendar getTimeStamp()
      Returns the value of the property that maps to the TimeStamp element.

      comparable point in time (DTG) to represent the last state change of this element

      Returns:
      the value of the TIME_STAMP_PROPERTY property.
    • setTimeStamp

      public void setTimeStamp(XMLGregorianCalendar aValue)
      Sets the value of the property that maps to the TimeStamp element.

      comparable point in time (DTG) to represent the last state change of this element

      Parameters:
      aValue - the value to set for the TIME_STAMP_PROPERTY property.
    • getTimeSpan

      public TLcdNVG20Content.TimeSpan getTimeSpan()
      Returns the value of the property that maps to the 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

      Returns:
      the value of the TIME_SPAN_PROPERTY property.
    • setTimeSpan

      public void setTimeSpan(TLcdNVG20Content.TimeSpan aValue)
      Sets the value of the property that maps to the 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

      Parameters:
      aValue - the value to set for the TIME_SPAN_PROPERTY property.
    • getExtension

      public TLcdNVG20Extension getExtension()
      Returns the value of the property that maps to the extension element.

      Extension point for structured community of interest specific content.

      Returns:
      the value of the EXTENSION_PROPERTY property.
    • setExtension

      public void setExtension(TLcdNVG20Extension aValue)
      Sets the value of the property that maps to the extension element.

      Extension point for structured community of interest specific content.

      Parameters:
      aValue - the value to set for the EXTENSION_PROPERTY property.