de.bioforscher.singa.structure.model.oak

Interface Exchangeable<FamilyType extends StructuralFamily>

All Known Subinterfaces:

AminoAcid, LeafSubstructure<FamilyType>, Ligand, Nucleotide

All Known Implementing Classes:

MmtfAminoAcid, MmtfLeafSubstructure, MmtfLigand, MmtfNucleotide, OakAminoAcid, OakLeafSubstructure, OakLigand, OakNucleotide

public interface Exchangeable<FamilyType extends StructuralFamily>

Exchangeable defines an entity that is exchangeable in terms of mapping another label or a set of other labels to that entity.

This constitutes a surjective mapping of StructuralFamilys.

By default an entity implementing Exchangeable is always exchangeable with itself.

Author:

fk

Method Summary

Modifier and Type	Method and Description
default void	addExchangeableFamily(FamilyType exchangeableFamily) Adds an exchangeable StructuralFamily.
default Set<FamilyType>	getContainingFamilies() Returns all StructuralFamily types that are defined, this is the concrete type of the Exchangeable itself plus all exchangeable types.
default Set<FamilyType>	getExchangeableFamilies() Returns the StructuralFamilys to which this entity is exchangeable.
FamilyType	getFamily() Returns the StructuralFamily of this entity.

Method Detail

getFamily

FamilyType getFamily()

Returns the StructuralFamily of this entity.

Returns:

the StructuralFamily

getExchangeableFamilies

default Set<FamilyType> getExchangeableFamilies()

Returns the StructuralFamilys to which this entity is exchangeable. By default an entity is always exchangeable to the same StructuralFamily.

Returns:

a set of exchangeable types

getContainingFamilies

default Set<FamilyType> getContainingFamilies()

Returns all StructuralFamily types that are defined, this is the concrete type of the Exchangeable itself plus all exchangeable types.

Returns:

a set of containing types (own type + exchangeable types)

addExchangeableFamily

default void addExchangeableFamily(FamilyType exchangeableFamily)

Adds an exchangeable StructuralFamily.

Parameters:

exchangeableFamily - the StructuralFamily to be added