- Type Parameters:
T- Type of elements contained by the clusters
@Beta @PublicAPI public interface Cluster<T>Cluster represents a group of structures.
An instance of
Clusteris considered a
Listof represented/referenced (nonnegative) structure IDs.
The represented group is immutable, so
Listmodification operators are not supported, they throw
Please note that this interface is marked with
Betaannotation, so it can be subject of incompatible changes or removal in later releases.
membersRepresented members of this cluster. For a single level clustering members are defined that the leave structures associated to that cluster. Hierarchical clusters are considered as a cluster which is divided further by sub clusters (children). Some of the members of a hierarchical cluster is associated to those children, while some are not. Those members which are not contained by the child clusters are referred as immediate leaves.
Please note that members list in case of a hierarchic clustering might be constructed on-the-fly as the union of the immediate leaves and the members of the child clusters. To get member count access
memberCount()which is expected to execute efficiently.
- Immutable, non empty list of represented cluster members
- Member count.