Package psidev.psi.mi.jami.utils.comparator.cooperativity

Class UnambiguousAllosteryComparator

java.lang.Object

psidev.psi.mi.jami.utils.comparator.cooperativity.AllosteryComparator

psidev.psi.mi.jami.utils.comparator.cooperativity.UnambiguousAllosteryComparator

All Implemented Interfaces:

Comparator<Allostery>

public class UnambiguousAllosteryComparator
extends AllosteryComparator

Unambiguous comparator for Allostery It will first compare basic cooperative effect properties using UnambiguousCooperativeEffectBaseComparator. Then, it will compare the allosteric effector types : - molecule effector types always come first - if both allosteric effector are molecule effectors, it will use UnambiguousMoleculeEffectorComparator to compare them - if both allosteric effector are feature modification effectors, it will use UnambiguousFeatureModificationEffectorComparator to compare them Then, it will compare the allosteric mechanisms using UnambiguousCvTermComparator Then, it will compare the allostery type using UnambiguousCvTermComparator Finally, it will compare the allosteric molecule using UnambiguousModelledParticipantComparator

Since:

31/05/13

Version:

$Id$

Author:

Marine Dumousseau (marine@ebi.ac.uk)

Constructor Summary

Constructors

Constructor	Description
UnambiguousAllosteryComparator()	Constructor for UnambiguousAllosteryComparator.

Method Summary

Modifier and Type	Method	Description
static boolean	areEquals(Allostery effect1, Allostery effect2)	Use UnambiguousAllosteryComparator to know if two allostery are equals.
int	compare(Allostery effect1, Allostery effect2)	It will first compare basic cooperative effect properties using CooperativeEffectBaseComparator.
UnambiguousCooperativeEffectBaseComparator	getCooperativeEffectComparator()	Getter for the field cooperativeEffectComparator.
UnambiguousFeatureModificationEffectorComparator	getFeatureModificationEffectorComparator()	Getter for the field featureModificationEffectorComparator.
UnambiguousMoleculeEffectorComparator	getMoleculeEffectorComparator()	Getter for the field moleculeEffectorComparator.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Comparator

equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

UnambiguousAllosteryComparator

public UnambiguousAllosteryComparator()

Constructor for UnambiguousAllosteryComparator.

Method Detail

getCooperativeEffectComparator

public UnambiguousCooperativeEffectBaseComparator getCooperativeEffectComparator()

Getter for the field cooperativeEffectComparator.

Overrides:

getCooperativeEffectComparator in class AllosteryComparator

Returns:

a CooperativeEffectBaseComparator object.

getMoleculeEffectorComparator

public UnambiguousMoleculeEffectorComparator getMoleculeEffectorComparator()

Getter for the field moleculeEffectorComparator.

Overrides:

getMoleculeEffectorComparator in class AllosteryComparator

Returns:

a MoleculeEffectorComparator object.

getFeatureModificationEffectorComparator

public UnambiguousFeatureModificationEffectorComparator getFeatureModificationEffectorComparator()

Getter for the field featureModificationEffectorComparator.

Overrides:

getFeatureModificationEffectorComparator in class AllosteryComparator

Returns:

a FeatureModificationEffectorComparator object.

compare

public int compare(Allostery effect1,
                   Allostery effect2)

It will first compare basic cooperative effect properties using CooperativeEffectBaseComparator. Then, it will compare the allosteric effector types : - molecule effector types always come first - if both allosteric effector are molecule effectors, it will use MoleculeEffectorComparator to compare them - if both allosteric effector are feature modification effectors, it will use FeatureModificationEffectorComparator to compare them Then, it will compare the allosteric mechanisms using AbstractCvTermComparator Then, it will compare the allostery type using AbstractCvTermComparator Finally, it will compare the allosteric molecule using ModelledParticipantComparator It will first compare basic cooperative effect properties using UnambiguousCooperativeEffectBaseComparator. Then, it will compare the allosteric effector types : - molecule effector types always come first - if both allosteric effector are molecule effectors, it will use UnambiguousMoleculeEffectorComparator to compare them - if both allosteric effector are feature modification effectors, it will use UnambiguousFeatureModificationEffectorComparator to compare them Then, it will compare the allosteric mechanisms using UnambiguousCvTermComparator Then, it will compare the allostery type using UnambiguousCvTermComparator Finally, it will compare the allosteric molecule using UnambiguousModelledParticipantComparator

Specified by:

compare in interface Comparator<Allostery>

Overrides:

compare in class AllosteryComparator

Parameters:

effect1 - : first allostery

effect2 - : second allostery

Returns:

the comparison value

areEquals

public static boolean areEquals(Allostery effect1,
                                Allostery effect2)

Use UnambiguousAllosteryComparator to know if two allostery are equals.

Parameters:

effect1 - a Allostery object.

effect2 - a Allostery object.

Returns:

true if the two Allostery are equal