com.chemaxon.clustering.framework

Class SimpleFrameworkAssociation<T>

java.lang.Object

com.chemaxon.clustering.framework.SimpleFrameworkAssociation<T>

All Implemented Interfaces:

FrameworkIndex<T>, Serializable

public abstract class SimpleFrameworkAssociation<T>
extends Object
implements FrameworkIndex<T>, Serializable

Simple implementation of FrameworkIndex with retrieval.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimpleFrameworkAssociation() Construct.

Method Summary

Modifier and Type	Method and Description
int	frameworkIndex(int level, T framework) Retrieve or create a unique ID for a framework.
T	getFrameworkForIndex(int index) Get a stored framework.
ImmutableList<T>	getFrameworks() Get all frameworks.
protected abstract Map<T,Integer>	getFrameworkToIndexMapping(int level) Index mapping for a level.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleFrameworkAssociation

protected SimpleFrameworkAssociation()

Construct.

Method Detail

getFrameworkToIndexMapping

protected abstract Map<T,Integer> getFrameworkToIndexMapping(int level)

Index mapping for a level.

Parameters:

level - Cluster level

Returns:

Mapping of frameworks to indices

frameworkIndex

public int frameworkIndex(int level,
                          T framework)

Description copied from interface: FrameworkIndex

Retrieve or create a unique ID for a framework.

Specified by:

frameworkIndex in interface FrameworkIndex<T>

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.

getFrameworkForIndex

public T getFrameworkForIndex(int index)

Get a stored framework. Please note that a present framework might missing from the associated clustering hierarchy in case permissive error handling used.

Parameters:

index - Index of cluster

Returns:

represented framework.

getFrameworks

public ImmutableList<T> getFrameworks()

Get all frameworks. Please note that a present framework might missing from the associated clustering hierarchy in case permissive error handling used.

Returns:

All frameworks