Package chemaxon.clustering.common

Interface IDBasedClusterBuilderSpec

@Beta
@PublicApi
public interface IDBasedClusterBuilderSpec

Allowing fluent API calls to IDBasedHierarchicClusterBuilder.

Method Summary

Modifier and Type	Method	Description
IDBasedClusterBuilderSpec	addChildCluster(int childClusterId)	Add child cluster.
IDBasedClusterBuilderSpec	addImmediateLeaf(int leafId)	Add a leaf to this cluster.
IDBasedClusterBuilderSpec	addImmediateLeafWithLevel(int leafId, double level)	Add a leaf to this cluster.
IDBasedClusterBuilderSpec	addImmediateLeaves(Integer... leafIds)	Add multiple leaves to the represented cluster.
IDBasedHierarchicClustering	build()	Build represented hierarchy.
IDBasedClusterBuilderSpec	newChildCluster()	Add a child cluster.
IDBasedClusterBuilderSpec	newRootCluster()	Add a new root cluster.
IDBasedClusterBuilderSpec	newSiblingCluster()	Add a child cluster to the same parent.
IDBasedClusterBuilderSpec	parent()	Refers to the parent cluster if present.
IDBasedClusterBuilderSpec	setLevel(double level)	Set level.
IDBasedClusterBuilderSpec	setRepresentant(int memberId)	Set representant.

Method Details

addImmediateLeaf

IDBasedClusterBuilderSpec addImmediateLeaf(int leafId)

Add a leaf to this cluster.

Delegates to IDBasedHierarchicClusterBuilder.addStructureToCluster(int, int).

Parameters:

leafId - Leaf ID

Returns:

Reference to this instance

addImmediateLeafWithLevel

IDBasedClusterBuilderSpec addImmediateLeafWithLevel(int leafId,
 double level)

Add a leaf to this cluster.

Delegates to IDBasedHierarchicClusterBuilder.addStructureToCluster(int, int) and IDBasedHierarchicClusterBuilder.setLeafPreferredLevel(int, double).

Parameters:

leafId - Leaf ID

level - Leaf level

Returns:

Reference to this instance

addImmediateLeaves

IDBasedClusterBuilderSpec addImmediateLeaves(Integer... leafIds)

Add multiple leaves to the represented cluster.

Delegates to IDBasedHierarchicClusterBuilder.addStructureToCluster(int, int).

Parameters:

leafIds - IDs of the leaves

Returns:

Reference to this instance

setRepresentant

IDBasedClusterBuilderSpec setRepresentant(int memberId)

Set representant.

Delegates to IDBasedHierarchicClusterBuilder.setClusterRepresentant(int, int).

Parameters:

memberId - Representant member ID

Returns:

Reference to this instance

setLevel

IDBasedClusterBuilderSpec setLevel(double level)

Set level.

Delegates to IDBasedHierarchicClusterBuilder.setClusterPreferredLevel(int, double).

Parameters:

level - Cluster level

Returns:

Reference to this instance

addChildCluster

IDBasedClusterBuilderSpec addChildCluster(int childClusterId)

Add child cluster.

This method returns with a reference associated to the newly added child cluster!. Delegates to IDBasedHierarchicClusterBuilder.addChildCluster(int, int).

Parameters:

childClusterId - Child cluster ID

Returns:

reference to the child cluster spec

newChildCluster

IDBasedClusterBuilderSpec newChildCluster()

Add a child cluster.

Returns:

reference to the child cluster spec

newSiblingCluster

IDBasedClusterBuilderSpec newSiblingCluster()

Add a child cluster to the same parent.

Returns:

reference to the child cluster spec

Throws:

IllegalStateException - when the representant cluster has no parent

parent

IDBasedClusterBuilderSpec parent()

Refers to the parent cluster if present.

Returns:

Reference to the parent cluster spec

Throws:

IllegalStateException - when no parent cluster is set

newRootCluster

IDBasedClusterBuilderSpec newRootCluster()

Add a new root cluster.

Delegates to IDBasedHierarchicClusterBuilder.newCluster().

Returns:

reference to the new cluster spec

build

IDBasedHierarchicClustering build()

Build represented hierarchy.

Delegates to IDBasedHierarchicClusterBuilder.build()

Returns:

built hierarchy