TLcdCluster (LuciadFusion API documentation)

java.lang.Object
- com.luciad.model.transformation.clustering.TLcdCluster<T>

All Implemented Interfaces:

ILcdDataObject
```
public final class TLcdCluster<T>
extends Object
implements ILcdDataObject
```
Represents a cluster of objects that are elements from the original model.
When using a data model to describe your data, you don't have to downcast to this class as the clusters can also be identified by their data type.
TLcdClusterDataTypes defines several properties of clusters. These can be retrieved as follows:
```
     ILcdDataObject dataObject = ...;
     String classification = (String) dataObject.getValue(TLcdClusterDataTypes.CLASSIFICATION_PROPERTY);
 
```
There are convenience methods provided so that if you do downcast, you can simply call a getter.
```
     TLcdCluster<?> cluster = ...;
     String classification = cluster.getClassification();
 
```
Since:

2016.0

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`boolean`	`equals(Object o)`
`String`	`getClassification()` Returns the classification of this cluster.
`ILcdShape`	`getClusterShape()` Returns the `ILcdShape` used to represent the cluster.
`Set<T>`	`getComposingElements()` Returns the set of elements that make up this cluster.
`TLcdDataType`	`getDataType()` Returns the type of this data object.
`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.
`int`	`hashCode()`
`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`	`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.

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

- Method Detail
  - getClusterShape
```
public ILcdShape getClusterShape()
```
    Returns the ILcdShape used to represent the cluster. Returns the same value as the TLcdClusterDataTypes.SHAPE_PROPERTY.
    
    Returns:
    
    the cluster shape.
    
    See Also:
    
    ILcdClusterShapeProvider
  - getClassification
```
public String getClassification()
```
    Returns the classification of this cluster. Each composing element of this cluster shares this classification. Returns the same value as the TLcdClusterDataTypes.CLASSIFICATION_PROPERTY.
    
    Returns:
    
    the classification of this cluster.
    
    See Also:
    
    ILcdClassifier
  - getComposingElements
```
public Set<T> getComposingElements()
```
    Returns the set of elements that make up this cluster. These are all elements of the original model, that was used as input for clustering. Returns the same value as the TLcdClusterDataTypes.COMPOSING_ELEMENTS_PROPERTY.
    
    Returns:
    
    The composing elements.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Object
  - 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.

LuciadFusionClass TLcdCluster<T>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getClusterShape

getClassification

getComposingElements

equals

hashCode

clone

getDataType

getValue

getValue

setValue

setValue

hasValue

hasValue