Package com.luciad.format.nvg.nvg15.model

Class TLcdNVG15Anchor

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.format.nvg.nvg15.model.TLcdNVG15Anchor
All Implemented Interfaces:
ILcdDataObject, ILcdNVGNode, ILcdBounded, ILcdEditableShapeList, ILcdShape, ILcdShapeList, ILcdCache, ILcdCloneable, ILcdDeepCloneable, ILcdInvalidateable, Serializable, Cloneable
public class TLcdNVG15Anchor extends TLcdDataObject implements ILcdEditableShapeList, ILcdCache, ILcdInvalidateable, ILcdNVGNode
An anchor is a domain object container that has an href property, similar to the anchor element in HTML.

You can retrieve elements through getGeometry() or the ILcdEditableShapeList interface. Anchors contain either shapes (e.g. TLcdNVG15Circle). text, * composte, groups or data objects.

The ILcdEditableShapeList only exposes elements that implement ILcdShape.

Since:
2015.0
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final TLcdDataProperty
    GEOMETRY_PROPERTY
    Data property that maps to the choice between the text and point and circle and ellipse and polyline and corridor and polygon and arc and arcband and multipoint and content-item and arrow and composite and g elements.
    static final TLcdDataProperty
    HREF_PROPERTY
    Data property that maps to the href attribute.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TLcdNVG15Anchor()
     
    TLcdNVG15Anchor(TLcdDataType aDataType)
    Constructs a new instance of TLcdNVG15Anchor with the given data type.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addShape(int aIndex, ILcdShape aShape)
    Inserts the specified shape at the specified position in this ILcdShapeList.
    void
    addShape(ILcdShape aShape)
    Appends the specified shape to the end of this ILcdShapeList.
    void
    addShapes(ILcdShape[] aShapes)
    Appends the specified array of shapes to the end of this ILcdShapeList.
    void
    clearCache()
    Clears the cache.
    void
    clearShapes()
    Removes all of the shapes from this ILcdShapeList.
    TLcdNVG15Anchor
    clone()
    Returns a deep clone of this object.
    TLcdNVG15Anchor
    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
    getFocusPoint()
    Returns the focus point of this ILcdShape.
    List<Object>
    getGeometry()
    Returns the value of the property that maps to the choice between the text and point and circle and ellipse and polyline and corridor and polygon and arc and arcband and multipoint and content-item and arrow and composite and g elements.
    URI
    getHref()
    Returns the value of the property that maps to the href attribute.
    Object
    getObject(int aIndex)
    Returns the Object at the given index.
    int
    getObjectCount()
    Returns the total number of Object objects in the list.
    ILcdNVGNode
    getParent()
    Get the parent of this object.
    ILcdShape
    getShape(int aIndex)
    Returns the ILcdShape at the given index.
    int
    getShapeCount()
    Returns the number of ILcdShape objects in the list.
    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.
    Object
    removeCachedObject(Object aKey)
    Looks up and removes the cached Object corresponding to the given key.
    ILcdShape
    removeShape(int aIndex)
    Removes the shape at the specified position in this ILcdShapeList.
    boolean
    removeShape(ILcdShape aShape)
    Removes the first occurrence of the specified shape in this ILcdShapeList.
    void
    removeShapes(ILcdShape[] aShapes)
    Removes all shapes from this ILcdShapeList that are contained in the specified array of shapes.
    void
    setHref(URI aValue)
    Sets the value of the property that maps to the href attribute.
    void
    setParent(ILcdNVGNode aParent)
    Set the parent of this object to the given parent.
    ILcdShape
    setShape(int aIndex, ILcdShape aShape)
    Replaces the shape at the specified position in this ILcdShapeList with the specified shape.
    void
    setShapes(ILcdShape[] aShapes)
    Replace the list of shapes contained in this ILcdShapeList with the specified array of shapes.
    void
    shapeChanged(int aIndex)
    Notifies this ILcdShapeList that the shape at the specified position has changed.
    void
    shapeChanged(ILcdShape aShape)
    Notifies this ILcdShapeList that the specified shape has changed.
    void
    shapesChanged()
    Notifies this ILcdShapeList that some (possibly all) of its shapes have changed.

    Methods inherited from class com.luciad.datamodel.TLcdDataObject

    getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • TLcdNVG15Anchor

      public TLcdNVG15Anchor()

    • TLcdNVG15Anchor

      public TLcdNVG15Anchor(TLcdDataType aDataType)
      Constructs a new instance of TLcdNVG15Anchor with the given data type.
      Parameters:
      aDataType - the data type of the anchor

  • Method Details

    • clone

      public TLcdNVG15Anchor clone()
      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:

    • clone

      public TLcdNVG15Anchor 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

    • insertIntoCache

      public void insertIntoCache(Object aKey, Object aObject)
      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.

    • getCachedObject

      public Object getCachedObject(Object aKey)
      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.

    • removeCachedObject

      public Object removeCachedObject(Object aKey)
      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.

    • clearCache

      public void clearCache()
      Clears the cache.
      Specified by:
      clearCache in interface ILcdCache

    • getShapeCount

      public int getShapeCount()
      Returns the number of ILcdShape objects in the list.
      Specified by:
      getShapeCount in interface ILcdShapeList
      Returns:
      the number of ILcdShape objects in the list.

    • getObjectCount

      public int getObjectCount()
      Returns the total number of Object objects in the list.
      Returns:
      the total number of Object objects in the list.

    • getShape

      public ILcdShape getShape(int aIndex) throws IndexOutOfBoundsException
      Returns the ILcdShape at the given index.
      Specified by:
      getShape in interface ILcdShapeList
      Parameters:
      aIndex - a valid index in the list of ILcdShape objects.
      Returns:
      the ILcdShape at the given index.
      Throws:
      IndexOutOfBoundsException - when the index is not valid.

    • getObject

      public Object getObject(int aIndex) throws IndexOutOfBoundsException
      Returns the Object at the given index.
      Parameters:
      aIndex - a valid index in the list of Object objects.
      Returns:
      the Object at the given index. This could be a ILcdShape.
      Throws:
      IndexOutOfBoundsException - when the index is not valid.

    • getFocusPoint

      public ILcdPoint getFocusPoint()
      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 aILcdPoint)
      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:
      aILcdPoint - the ILcdPoint to test.
      Returns:
      the boolean result of the containment test.
      See Also:

    • contains2D

      public boolean contains2D(double aX, double aY)
      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.

    • contains3D

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

    • contains3D

      public boolean contains3D(double aX, double aY, double aZ)
      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.

    • getBounds

      public ILcdBounds getBounds()
      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.

    • getParent

      public ILcdNVGNode getParent()
      Description copied from interface: ILcdNVGNode
      Get the parent of this object.
      Specified by:
      getParent in interface ILcdNVGNode
      Returns:
      The parent of this object.

    • setParent

      public void setParent(ILcdNVGNode aParent)
      Description copied from interface: ILcdNVGNode
      Set the parent of this object to the given parent.
      Specified by:
      setParent in interface ILcdNVGNode
      Parameters:
      aParent - The parent to be set to this object.

    • 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

    • shapesChanged

      public void shapesChanged()
      Description copied from interface: ILcdEditableShapeList
      Notifies this ILcdShapeList that some (possibly all) of its shapes have changed.
      Specified by:
      shapesChanged in interface ILcdEditableShapeList

    • shapeChanged

      public void shapeChanged(ILcdShape aShape)
      Description copied from interface: ILcdEditableShapeList
      Notifies this ILcdShapeList that the specified shape has changed.
      Specified by:
      shapeChanged in interface ILcdEditableShapeList
      Parameters:
      aShape - the shape that has changed.

    • shapeChanged

      public void shapeChanged(int aIndex)
      Description copied from interface: ILcdEditableShapeList
      Notifies this ILcdShapeList that the shape at the specified position has changed.
      Specified by:
      shapeChanged in interface ILcdEditableShapeList
      Parameters:
      aIndex - the index of the shape that has changed.

    • setShapes

      public void setShapes(ILcdShape[] aShapes)
      Description copied from interface: ILcdEditableShapeList
      Replace the list of shapes contained in this ILcdShapeList with the specified array of shapes.
      Specified by:
      setShapes in interface ILcdEditableShapeList
      Parameters:
      aShapes - the array of shapes to be stored in this ILcdShapeList.

    • removeShapes

      public void removeShapes(ILcdShape[] aShapes)
      Description copied from interface: ILcdEditableShapeList
      Removes all shapes from this ILcdShapeList that are contained in the specified array of shapes.
      Specified by:
      removeShapes in interface ILcdEditableShapeList
      Parameters:
      aShapes - the array of shapes to be removed from this ILcdShapeList.

    • removeShape

      public boolean removeShape(ILcdShape aShape)
      Description copied from interface: ILcdEditableShapeList
      Removes the first occurrence of the specified shape in this ILcdShapeList. If this ILcdShapeList does not contain the shape, it is unchanged.
      Specified by:
      removeShape in interface ILcdEditableShapeList
      Parameters:
      aShape - the shape to be removed, if present.
      Returns:
      true if this ILcdShapeList contained the specified element.

    • clearShapes

      public void clearShapes()
      Description copied from interface: ILcdEditableShapeList
      Removes all of the shapes from this ILcdShapeList.
      Specified by:
      clearShapes in interface ILcdEditableShapeList

    • addShapes

      public void addShapes(ILcdShape[] aShapes)
      Description copied from interface: ILcdEditableShapeList
      Appends the specified array of shapes to the end of this ILcdShapeList.
      Specified by:
      addShapes in interface ILcdEditableShapeList
      Parameters:
      aShapes - the array of shapes to be appended to this ILcdShapeList.

    • addShape

      public void addShape(int aIndex, ILcdShape aShape)
      Description copied from interface: ILcdEditableShapeList
      Inserts the specified shape at the specified position in this ILcdShapeList.
      Specified by:
      addShape in interface ILcdEditableShapeList
      Parameters:
      aIndex - the index at which the shape is to be inserted.
      aShape - the shape to be inserted.

    • removeShape

      public ILcdShape removeShape(int aIndex)
      Description copied from interface: ILcdEditableShapeList
      Removes the shape at the specified position in this ILcdShapeList. Shifts any subsequent shapes to the left. Returns the shape that was removed from this ILcdShapeList.
      Specified by:
      removeShape in interface ILcdEditableShapeList
      Parameters:
      aIndex - the index of the shape to removed.
      Returns:
      the shape previously at the specified position.

    • setShape

      public ILcdShape setShape(int aIndex, ILcdShape aShape)
      Description copied from interface: ILcdEditableShapeList
      Replaces the shape at the specified position in this ILcdShapeList with the specified shape.
      Specified by:
      setShape in interface ILcdEditableShapeList
      Parameters:
      aIndex - index of shape to replace.
      aShape - the shape to be stored at the specified position.
      Returns:
      the shape previously at the specified position.

    • addShape

      public void addShape(ILcdShape aShape)
      Description copied from interface: ILcdEditableShapeList
      Appends the specified shape to the end of this ILcdShapeList.
      Specified by:
      addShape in interface ILcdEditableShapeList
      Parameters:
      aShape - the shape to be appended to this ILcdShapeList.

    • getHref

      public URI getHref()
      Returns the value of the property that maps to the href attribute.

      Callback URI for amplifying information on the objects which are represented by the children of this element.

      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.

      Callback URI for amplifying information on the objects which are represented by the children of this element.

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

    • getGeometry

      public List<Object> getGeometry()
      Returns the value of the property that maps to the choice between the text and point and circle and ellipse and polyline and corridor and polygon and arc and arcband and multipoint and content-item and arrow and composite and g elements.

      The possible values for this property are instances of java.util.List with elements of class

      Returns:
      the value of the GEOMETRY_PROPERTY property.