TLcySLDDomainObject (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.lucy.addons.drawing.format.TLcySLDDomainObject

All Implemented Interfaces:

ILcdDataObject, ILcdBounded, ILcdShape, ILcdShapeList, ILcdCache, ILcdCloneable, ~~ILcdFeatured~~ , ILcdInvalidateable, Serializable, Cloneable
```
public class TLcySLDDomainObject
extends Object
implements ILcdShapeList, 
ILcdFeatured
, ILcdCache, ILcdDataObject, ILcdInvalidateable
```
The default domain object. An instance of TLcySLDDomainObject has the following properties:
- It has one or more ILcdShapes that make up its geometry. Current implementation supposes the domain object contains exactly one ILcdShape. This shape can be retrieved by calling getDelegateShape.
- It can have properties by implementing ILcdDataObject, which can be altered and retrieved by calling setValue and getValue respectively.
- It has a SLD based style, accessible by the methods getStyle and setStyle
Instances of this class should be created by using a TLcySLDDomainObjectSupplier.

Note: although this class implements Serializable, instances of this class cannot be serialized. Use the available drawing model encoders/decoders if you want to store/restore domain objects.
Since:

8.2

See Also:

TLcySLDDomainObjectSupplier, Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canSetFeature(int aIndex)` Checks whether the specified feature is editable.
`void`	`clearCache()` Clears the cache.
`Object`	`clone()` Makes `Object.clone()` public.
`boolean`	`contains2D(double aX, double aY)` Checks whether this `ILcdShape` contains the given point in the 2D space.
`boolean`	`contains2D(ILcdPoint aPoint)` 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 aPoint)` 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.
`TLcdDataType`	`getDataType()` Returns the type of this data object.
`ILcdShape`	`getDelegateShape()` In the current implementation a drawing shape object contains exactly one `ILcdShape`, which can be retrieved by calling this method.
`protected String`	`getDisplayName()` Returns the display name for this type of object.
`Object`	`getFeature(int aIndex)` Returns the feature `Object` at the given index.
`int`	`getFeatureCount()` Returns the number of features.
`ILcdPoint`	`getFocusPoint()` Returns the focus point of this `ILcdShape`.
`ILcdShape`	`getShape(int aIndex)` Returns the `ILcdShape` at the given index.
`int`	`getShapeCount()` Returns the number of `ILcdShape` objects in the list.
`TLcdSLDFeatureTypeStyle`	`getStyle()` Returns the SLD style of this drawing shape.
`Object`	`getValue(String aPropertyName)` Convenience method that returns the value of the property with the given name.
`Object`	`getValue(TLcdDataProperty aProperty)` Returns the value of the given property.
`boolean`	`hasValue(String aPropertyName)` Indicates whether this data object has a value for the given property.
`boolean`	`hasValue(TLcdDataProperty aProperty)` Indicates whether this data object has a value for the given property.
`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.
`void`	`setFeature(int aIndex, Object aFeature)` Sets the feature `Object` at the given index.
`protected void`	`setFeatures(Object[] aFeatures)` Sets the features for this domain object.
`void`	`setStyle(TLcdSLDFeatureTypeStyle aStyle)` Sets the SLD style for this drawing shape.
`void`	`setValue(String aPropertyName, Object aValue)` Convenience method that sets the value of the property with the given name.
`void`	`setValue(TLcdDataProperty aProperty, Object aValue)` Sets the value of the given property for this data object.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - setFeatures
```
protected void setFeatures(Object[] aFeatures)
```
    Sets the features for this domain object. After calling this method, these features can be accessed through the ILcdFeatured interface.
    
    Parameters:
    
    aFeatures - The features of this domain objects. It must not be null (use an empty array instead). The contents of the array is copied to another array, so changes in the original array are not reflected in this domain object. The array should not contain any null values.
  - getFeatureCount
```
public int getFeatureCount()
```
    Description copied from interface: ILcdFeatured
    
    Returns the number of features.
    
    Specified by:
    
    getFeatureCount in interface ILcdFeatured
    
    Returns:
    
    the number of features.
  - getFeature
```
public Object getFeature(int aIndex)
                  throws IndexOutOfBoundsException
```
    Description copied from interface: ILcdFeatured
    
    Returns the feature Object at the given index.
    
    Specified by:
    
    getFeature in interface ILcdFeatured
    
    Parameters:
    
    aIndex - a valid feature index.
    
    Returns:
    
    the feature Object at the given index.
    
    Throws:
    
    IndexOutOfBoundsException - when an index is chosen greater than the result of getFeatureCount.
    
    See Also:
    
    ILcdFeatured.setFeature(int, java.lang.Object)
  - canSetFeature
```
public boolean canSetFeature(int aIndex)
```
    Description copied from interface: ILcdFeatured
    
    Checks whether the specified feature is editable.
    
    Specified by:
    
    canSetFeature in interface ILcdFeatured
    
    Parameters:
    
    aIndex - a valid feature index.
    
    Returns:
    
    true if the feature can be set, false otherwise.
  - setFeature
```
public void setFeature(int aIndex,
                       Object aFeature)
```
    Sets the feature Object at the given index.
    
    Specified by:
    
    setFeature in interface ILcdFeatured
    
    Parameters:
    
    aIndex - a valid feature index.
    
    aFeature - the new feature Object.. Should not be null
    
    See Also:
    
    ILcdFeatured.getFeature(int), ILcdFeatured.canSetFeature(int)
  - getShape
```
public ILcdShape getShape(int aIndex)
                   throws IndexOutOfBoundsException
```
    Description copied from interface: ILcdShapeList
    
    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.
  - getShapeCount
```
public int getShapeCount()
```
    Description copied from interface: ILcdShapeList
    
    Returns the number of ILcdShape objects in the list.
    
    Specified by:
    
    getShapeCount in interface ILcdShapeList
    
    Returns:
    
    the number of ILcdShape objects in the list.
  - 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.
  - 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:
    
    ILcdShape.contains2D(double, double)
  - 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:
    
    ILcdShape.contains3D(double, double, double)
  - 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.
  - 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.
  - clone
```
public Object clone()
```
    Description copied from interface: ILcdCloneable
    Makes Object.clone() public.
    When for example extending from java.lang.Object, it can be implemented like this:
```
 public Object clone() {
   try {
     return super.clone();
   } catch ( CloneNotSupportedException e ) {
     // Cannot happen: extends from Object and implements Cloneable (see also Object.clone)
     throw new RuntimeException( e );
   }
 }
 
```
    Specified by:
    
    clone in interface ILcdCloneable
    
    Overrides:
    
    clone in class Object
    
    See Also:
    
    Object.clone()
  - getDisplayName
```
protected String getDisplayName()
```
    Returns the display name for this type of object. This display name isn't meant per instance, but per type of object. E.g. 'Polyline' or 'Point'. It is mainly used in the popup menu when alt-click selecting an object, and similar usages of toString...
    
    Returns:
    
    The display name for this type of object
  - getStyle
```
public TLcdSLDFeatureTypeStyle getStyle()
```
    Returns the SLD style of this drawing shape.
    
    Returns:
    
    the SLD style of this drawing shape.
  - setStyle
```
public void setStyle(TLcdSLDFeatureTypeStyle aStyle)
```
    Sets the SLD style for this drawing shape.
    
    Parameters:
    
    aStyle - the new SLD style for this drawing shape.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the default implementation returns the displayname
  - getDelegateShape
```
public ILcdShape getDelegateShape()
```
    In the current implementation a drawing shape object contains exactly one ILcdShape, which can be retrieved by calling this method.
    
    Returns:
    
    the one and only ILcdShape contained in this drawing shape.
  - 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.
  - 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.
  - 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.
  - clearCache
```
public void clearCache()
```
    Description copied from interface: ILcdCache
    
    Clears the cache.
    
    Specified by:
    
    clearCache in interface ILcdCache
  - getDataType
```
public TLcdDataType getDataType()
```
    Description copied from interface: ILcdDataObject
    
    Returns the type of this data object. This can never be null.
    
    Specified by:
    
    getDataType in interface ILcdDataObject
    
    Returns:
    
    the type of this data object
  - getValue
```
public Object getValue(TLcdDataProperty aProperty)
```
    Description copied from interface: ILcdDataObject
    
    Returns the value of the given property.
    
    If the property is a collection, the returned value will never be null. If the property has not been set, an empty collection of the appropriate type will be returned (Set, List or Map).
    
    The property must not be null, and must be declared in the data object's type or in one of its super types. Otherwise an IllegalArgumentException is thrown.
    
    Specified by:
    
    getValue in interface ILcdDataObject
    
    Parameters:
    
    aProperty - the property for which the value is to be returned
    
    Returns:
    
    the value of the given property for this data object
  - getValue
```
public Object getValue(String aPropertyName)
```
    Description copied from interface: ILcdDataObject
    
    Convenience method that returns the value of the property with the given name.
    If more than one property exists with the given name, the most specific property should be used (this is the property defined by the most specialized type in this object's data type hierarchy).
    See ILcdDataObject.getValue(TLcdDataProperty) for more information.
    
    Specified by:
    
    getValue in interface ILcdDataObject
    
    Parameters:
    
    aPropertyName - the name of the property of which the value is to be returned
    
    Returns:
    
    the value of the property with the given name
    
    See Also:
    
    TLcdDataType.getProperty(String)
  - setValue
```
public void setValue(TLcdDataProperty aProperty,
                     Object aValue)
```
    Description copied from interface: ILcdDataObject
    
    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
    
    Parameters:
    
    aProperty - the property for which the value is to be set
    
    aValue - the value to set
    
    See Also:
    
    TLcdDataType.getProperty(String)
  - setValue
```
public void setValue(String aPropertyName,
                     Object aValue)
```
    Description copied from interface: ILcdDataObject
    
    Convenience method that sets the value of the property with the given name.
    If more than one property exists with the given name, the most specific property should be used (this is the property defined by the most specialized type in this object's data type hierarchy).
    See ILcdDataObject.setValue(TLcdDataProperty, Object) for more information.
    
    Specified by:
    
    setValue in interface ILcdDataObject
    
    Parameters:
    
    aPropertyName - the name of the property of which the value is to be set
    
    aValue - the value to set
  - hasValue
```
public boolean hasValue(TLcdDataProperty aProperty)
```
    Description copied from interface: ILcdDataObject
    Indicates whether this data object has a value for the given property.
    - aProperty is from the right data type, and this instance has a value for it: returns true
    - aProperty is from the right data type, and this instance has no value for it: returns false
    - aProperty is not from the right data type: not allowed, you will get IllegalArgumentException
    - aProperty is null: not allowed, you will get NullPointerException
    A multivalued property is considered to have a value if it has at least one value.
    Specified by:
    
    hasValue in interface ILcdDataObject
    
    Parameters:
    
    aProperty - the property for which to return whether a value is present or not.
    
    Returns:
    
    true if this data object has a value for the given property, false otherwise.
  - hasValue
```
public boolean hasValue(String aPropertyName)
```
    Description copied from interface: ILcdDataObject
    
    Indicates whether this data object has a value for the given property.
    See ILcdDataObject.hasValue(TLcdDataProperty) for more information.
    
    Specified by:
    
    hasValue in interface ILcdDataObject
    
    Parameters:
    
    aPropertyName - the name of the property for which to return whether a value is present or not.
    
    Returns:
    
    true if this data object has a value for the property with the given name, false otherwise.
  - 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

LuciadLightspeedClass TLcySLDDomainObject

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setFeatures

getFeatureCount

getFeature

canSetFeature

setFeature

getShape

getShapeCount

contains2D

contains2D

contains3D

contains3D

getFocusPoint

getBounds

clone

getDisplayName

getStyle

setStyle

toString

getDelegateShape

insertIntoCache

getCachedObject

removeCachedObject

clearCache

getDataType

getValue

getValue

setValue

setValue

hasValue

hasValue

invalidateObject