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

Class InteractionEvidenceComparator

java.lang.Object

psidev.psi.mi.jami.utils.comparator.interaction.InteractionEvidenceComparator

All Implemented Interfaces:

Comparator<InteractionEvidence>

Direct Known Subclasses:

UnambiguousCuratedInteractionEvidenceComparator, UnambiguousExactCuratedInteractionEvidenceComparator, UnambiguousExactInteractionEvidenceComparator, UnambiguousInteractionEvidenceComparator

public class InteractionEvidenceComparator
extends Object
implements Comparator<InteractionEvidence>

Basic InteractionEvidenceComparator. It will first compare the basic interaction properties using Comparator of type Interaction. It will then compares the IMEx identifiers if both IMEx ids are set. If at least one IMEx id is not set, it will compare the negative properties. A negative interaction will come after a positive interaction. it will compare the experiment using ExperimentComparator. If the experiments are the same, it will compare the participants using ParticipantEvidenceComparator. Then it will compare the parameters using ParameterComparator. If the parameters are the same, it will first compare the experimental variableParameters using VariableParameterValueSetComparator and then it will compare the inferred boolean value (Inferred interactions will always come after).

Since:

18/01/13

Version:

$Id$

Author:

Marine Dumousseau (marine@ebi.ac.uk)

Constructor Summary

Constructors

Constructor	Description
InteractionEvidenceComparator(Comparator<ParticipantEvidence> participantComparator, Comparator<Interaction> interactionComparator, ExperimentComparator experimentComparator, ParameterComparator parameterComparator)	Creates a new InteractionEvidenceComparator.
InteractionEvidenceComparator(CollectionComparator<ParticipantEvidence> participantComparator, Comparator<Interaction> interactionComparator, ExperimentComparator experimentComparator, CollectionComparator<Parameter> parameterComparator, CollectionComparator<VariableParameterValueSet> variableParameterValuesSetComparator)	Constructor for InteractionEvidenceComparator.

Method Summary

Modifier and Type	Method	Description
int	compare(InteractionEvidence experimentalInteraction1, InteractionEvidence experimentalInteraction2)	It will first compare the basic interaction properties using Comparator of type Interaction.
ExperimentComparator	getExperimentComparator()	Getter for the field experimentComparator.
Comparator<Interaction>	getInteractionBaseComparator()	getInteractionBaseComparator
CollectionComparator<Parameter>	getParameterCollectionComparator()	Getter for the field parameterCollectionComparator.
CollectionComparator<ParticipantEvidence>	getParticipantCollectionComparator()	Getter for the field participantCollectionComparator.
CollectionComparator<VariableParameterValueSet>	getVariableParameterValueSetCollectionComparator()	Getter for the field variableParameterValueSetCollectionComparator.

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

InteractionEvidenceComparator

public InteractionEvidenceComparator(Comparator<ParticipantEvidence> participantComparator,
                                     Comparator<Interaction> interactionComparator,
                                     ExperimentComparator experimentComparator,
                                     ParameterComparator parameterComparator)

Creates a new InteractionEvidenceComparator.

Parameters:

interactionComparator - : required to compare basic interaction properties

experimentComparator - : required to compare experiments

parameterComparator - : required to compare parameters

participantComparator - a Comparator object.

InteractionEvidenceComparator

public InteractionEvidenceComparator(CollectionComparator<ParticipantEvidence> participantComparator,
                                     Comparator<Interaction> interactionComparator,
                                     ExperimentComparator experimentComparator,
                                     CollectionComparator<Parameter> parameterComparator,
                                     CollectionComparator<VariableParameterValueSet> variableParameterValuesSetComparator)

Constructor for InteractionEvidenceComparator.

Parameters:

participantComparator - a CollectionComparator object.

interactionComparator - a Comparator object.

experimentComparator - a ExperimentComparator object.

parameterComparator - a CollectionComparator object.

variableParameterValuesSetComparator - a CollectionComparator object.

Method Detail

getParameterCollectionComparator

public CollectionComparator<Parameter> getParameterCollectionComparator()

Getter for the field parameterCollectionComparator.

Returns:

a CollectionComparator object.

getInteractionBaseComparator

public Comparator<Interaction> getInteractionBaseComparator()

getInteractionBaseComparator

Returns:

a Comparator object.

getExperimentComparator

public ExperimentComparator getExperimentComparator()

Getter for the field experimentComparator.

Returns:

a ExperimentComparator object.

getParticipantCollectionComparator

public CollectionComparator<ParticipantEvidence> getParticipantCollectionComparator()

Getter for the field participantCollectionComparator.

Returns:

a CollectionComparator object.

getVariableParameterValueSetCollectionComparator

public CollectionComparator<VariableParameterValueSet> getVariableParameterValueSetCollectionComparator()

Getter for the field variableParameterValueSetCollectionComparator.

Returns:

a CollectionComparator object.

compare

public int compare(InteractionEvidence experimentalInteraction1,
                   InteractionEvidence experimentalInteraction2)

It will first compare the basic interaction properties using Comparator of type Interaction. It will then compares the IMEx identifiers if both IMEx ids are set. If at least one IMEx id is not set, it will compare the negative properties. A negative interaction will come after a positive interaction. it will compare the experiment using ExperimentComparator. If the experiments are the same, it will compare the participants using ParticipantEvidenceComparator. Then, it will compare the parameters using ParameterComparator. If the parameters are the same, it will first compare the experimental variableParameters using VariableParameterValueSetComparator and then it will compare the inferred boolean value (Inferred interactions will always come after).

Specified by:

compare in interface Comparator<InteractionEvidence>

Parameters:

experimentalInteraction1 - a InteractionEvidence object.

experimentalInteraction2 - a InteractionEvidence object.

Returns:

a int.