com.chemaxon.clustering.framework

Interface FrameworkIndex<F>

Type Parameters:

F - Framework type

All Known Implementing Classes:

SimpleFrameworkAssociation

@Beta
public interface FrameworkIndex<F>

Index association for frameworks. Implementation represents the identification of the equivalent frameworks associated to the input structures. This identification collapses the individual chains of frameworks into a hierarchy.

Method Summary

Modifier and Type	Method and Description
int	frameworkIndex(int level, F framework) Retrieve or create a unique ID for a framework.

Method Detail

frameworkIndex

int frameworkIndex(int level,
                   F framework)

Retrieve or create a unique ID for a framework.

Parameters:

level - Framework level. 0 used for the first (immediate) level. This parameter might be ignored. A typical Bemis-Murcko clustering implementation will consider this parameter while a typical scaffold tree clustering implementation will ignore it.

framework - The framework at given level

Returns:

Unique ID (among all levels) associated to the given framework.