Package psidev.psi.mi.jami.xml.model.extension.binary

Class XmlBinaryInteractionWrapper

java.lang.Object

psidev.psi.mi.jami.xml.model.extension.binary.XmlBinaryInteractionWrapper

All Implemented Interfaces:

BinaryInteraction<Participant>, FileSourceContext, Interaction<Participant>, NamedInteraction<Participant>, ExtendedPsiXmlInteraction<Participant>, PsiXmlInteraction<Participant>

public class XmlBinaryInteractionWrapper
extends Object
implements BinaryInteraction<Participant>, FileSourceContext, ExtendedPsiXmlInteraction<Participant>

Wrapper for ModelledBinaryInteraction

Since:

16/10/13

Version:

$Id$

Author:

Marine Dumousseau (marine@ebi.ac.uk)

Constructor Summary

Constructors

Constructor	Description
XmlBinaryInteractionWrapper(ExtendedPsiXmlInteraction interaction)	Constructor for XmlBinaryInteractionWrapper.
XmlBinaryInteractionWrapper(ExtendedPsiXmlInteraction interaction, CvTerm complexExpansion)	Constructor for XmlBinaryInteractionWrapper.

Method Summary

Modifier and Type	Method	Description
boolean	addAllParticipants(Collection<? extends Participant> participants)	This method will add all the participant and set the interaction of the new participant to this current interaction
boolean	addParticipant(Participant part)	This method will add the participant and set the interaction of the new participant to this current interaction
Collection<Alias>	getAliases()	getAliases.
Collection<Annotation>	getAnnotations()	The Collection of annotations describing the interaction.
CvTerm	getCausalRegulatoryMechanism()	getCausalRegulatoryMechanism.
Collection<Checksum>	getChecksums()	Set of checksums computed for this interaction..
CvTerm	getComplexExpansion()	getComplexExpansion.
Date	getCreatedDate()	The creation date.
Entry	getEntry()	getEntry.
String	getFullName()	The full name of the interaction.
int	getId()	getId.
Collection<Xref>	getIdentifiers()	The identifiers for an interaction.
List<AbstractInferredInteraction>	getInferredInteractions()	getInferredInteractions.
CvTerm	getInteractionType()	The interaction type is a controlled vocabulary term.
List<CvTerm>	getInteractionTypes()	getInteractionTypes.
Participant	getParticipantA()	getParticipantA.
Participant	getParticipantB()	getParticipantB.
Collection<Participant>	getParticipants()	The collection of participants involved in this interaction.
String	getRigid()	The checksum computed from the rogids from all the proteins involved in the interaction.
String	getShortName()	The short name of the interaction.
FileSourceLocator	getSourceLocator()	The locator of a position in a file.
Date	getUpdatedDate()	The last update date.
Collection<Xref>	getXrefs()	The external cross references for an interaction.
boolean	isIntraMolecular()	isIntraMolecular.
boolean	removeAllParticipants(Collection<? extends Participant> participants)	This method will remove the participant and set the interaction of the removed participant to null.
boolean	removeParticipant(Participant part)	This method will remove the participant and set the interaction of the new participant to null
void	setCausalRegulatoryMechanism(CvTerm causalRegulatoryMechanism)	Sets the causal regulatory mechanism of this binary interaction
void	setComplexExpansion(CvTerm expansion)	Sets the complex expansion of this binary interaction
void	setCreatedDate(Date created)	Sets the created date
void	setEntry(Entry entry)	setEntry.
void	setFullName(String name)	Sets the full name of the interaction
void	setId(int id)	setId.
void	setInteractionType(CvTerm term)	Sets the interaction type.
void	setIntraMolecular(boolean intra)	setIntraMolecular.
void	setParticipantA(Participant participantA)	Sets the first participant of this interaction
void	setParticipantB(Participant participantB)	Sets the second participant of this interaction
void	setRigid(String rigid)	Sets the rigid of this interaction.
void	setShortName(String name)	Sets the short name of the interaction
void	setSourceLocator(FileSourceLocator locator)	Sets the source locator
void	setUpdatedDate(Date updated)	Sets the last update date
String	toString()	toString

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlBinaryInteractionWrapper

public XmlBinaryInteractionWrapper(ExtendedPsiXmlInteraction interaction)

Constructor for XmlBinaryInteractionWrapper.

Parameters:

interaction - a ExtendedPsiXmlInteraction object.

XmlBinaryInteractionWrapper

public XmlBinaryInteractionWrapper(ExtendedPsiXmlInteraction interaction,
                                   CvTerm complexExpansion)

Constructor for XmlBinaryInteractionWrapper.

Parameters:

interaction - a ExtendedPsiXmlInteraction object.

complexExpansion - a CvTerm object.

Method Detail

getParticipantA

public Participant getParticipantA()

getParticipantA.

Specified by:

getParticipantA in interface BinaryInteraction<Participant>

Returns:

a Participant object.

getParticipantB

public Participant getParticipantB()

getParticipantB.

Specified by:

getParticipantB in interface BinaryInteraction<Participant>

Returns:

a Participant object.

setParticipantA

public void setParticipantA(Participant participantA)

Sets the first participant of this interaction

Specified by:

setParticipantA in interface BinaryInteraction<Participant>

Parameters:

participantA - : the first participant

setParticipantB

public void setParticipantB(Participant participantB)

Sets the second participant of this interaction

Specified by:

setParticipantB in interface BinaryInteraction<Participant>

Parameters:

participantB - : the second participant

getComplexExpansion

public CvTerm getComplexExpansion()

getComplexExpansion.

Specified by:

getComplexExpansion in interface BinaryInteraction<Participant>

Returns:

a CvTerm object.

setComplexExpansion

public void setComplexExpansion(CvTerm expansion)

Sets the complex expansion of this binary interaction

Specified by:

setComplexExpansion in interface BinaryInteraction<Participant>

Parameters:

expansion - : the complex expansion

getCausalRegulatoryMechanism

public CvTerm getCausalRegulatoryMechanism()

getCausalRegulatoryMechanism.

Specified by:

getCausalRegulatoryMechanism in interface BinaryInteraction<Participant>

Returns:

a CvTerm object.

setCausalRegulatoryMechanism

public void setCausalRegulatoryMechanism(CvTerm causalRegulatoryMechanism)

Sets the causal regulatory mechanism of this binary interaction

Specified by:

setCausalRegulatoryMechanism in interface BinaryInteraction<Participant>

Parameters:

causalRegulatoryMechanism - : the complex regulatory mechanism CvTerm

getParticipants

public Collection<Participant> getParticipants()

The collection of participants involved in this interaction. The collection cannot be null. If the interaction does not involve any participants, the method should return an empty set. The collection of participants for this binary interaction. It cannot be changed.

Specified by:

getParticipants in interface Interaction<Participant>

Returns:

the particiants

addParticipant

public boolean addParticipant(Participant part)

This method will add the participant and set the interaction of the new participant to this current interaction Adds a new Participant and set the Interaction of this participant if added. If the participant B and A are null, it will first set the participantA. If the participantA is set, it will set the ParticipantB

Specified by:

addParticipant in interface Interaction<Participant>

Parameters:

part - : participant to add

Returns:

true if participant is added to the list of participants

removeParticipant

public boolean removeParticipant(Participant part)

This method will remove the participant and set the interaction of the new participant to null Removes the Participant from this binary interaction

Specified by:

removeParticipant in interface Interaction<Participant>

Parameters:

part - : participant to remove

Returns:

true if participant is removed from the list of participants

addAllParticipants

public boolean addAllParticipants(Collection<? extends Participant> participants)

This method will add all the participant and set the interaction of the new participant to this current interaction Adds the participants and set the Interaction of this participant if added. If the participant B and A are null, it will first set the participantA. If the participantA is set, it will set the ParticipantB

Specified by:

addAllParticipants in interface Interaction<Participant>

Parameters:

participants - : participants to add

Returns:

true if participant are added to the list of participants

removeAllParticipants

public boolean removeAllParticipants(Collection<? extends Participant> participants)

This method will remove the participant and set the interaction of the removed participant to null.

Specified by:

removeAllParticipants in interface Interaction<Participant>

Parameters:

participants - : participants to remove

Returns:

true if participant are removed from the list of participants

getFullName

public String getFullName()

The full name of the interaction. It can be null

Specified by:

getFullName in interface NamedInteraction<Participant>

Returns:

the full name

setFullName

public void setFullName(String name)

Sets the full name of the interaction

Specified by:

setFullName in interface NamedInteraction<Participant>

Parameters:

name - : full name

getAliases

public Collection<Alias> getAliases()

getAliases.

Specified by:

getAliases in interface ExtendedPsiXmlInteraction<Participant>

Specified by:

getAliases in interface NamedInteraction<Participant>

Specified by:

getAliases in interface PsiXmlInteraction<Participant>

Returns:

a Collection object.

getInteractionTypes

public List<CvTerm> getInteractionTypes()

getInteractionTypes.

Specified by:

getInteractionTypes in interface ExtendedPsiXmlInteraction<Participant>

Returns:

a List object.

getEntry

public Entry getEntry()

getEntry.

Specified by:

getEntry in interface PsiXmlInteraction<Participant>

Returns:

a Entry object.

setEntry

public void setEntry(Entry entry)

setEntry.

Specified by:

setEntry in interface PsiXmlInteraction<Participant>

Parameters:

entry - a Entry object.

getInferredInteractions

public List<AbstractInferredInteraction> getInferredInteractions()

getInferredInteractions.

Specified by:

getInferredInteractions in interface ExtendedPsiXmlInteraction<Participant>

Returns:

a List object.

getId

public int getId()

getId.

Specified by:

getId in interface PsiXmlInteraction<Participant>

Returns:

a int.

setId

public void setId(int id)

setId.

Specified by:

setId in interface PsiXmlInteraction<Participant>

Parameters:

id - a int.

isIntraMolecular

public boolean isIntraMolecular()

isIntraMolecular.

Specified by:

isIntraMolecular in interface PsiXmlInteraction<Participant>

Returns:

a boolean.

setIntraMolecular

public void setIntraMolecular(boolean intra)

setIntraMolecular.

Specified by:

setIntraMolecular in interface PsiXmlInteraction<Participant>

Parameters:

intra - a boolean.

getSourceLocator

public FileSourceLocator getSourceLocator()

The locator of a position in a file. It can be null

Specified by:

getSourceLocator in interface FileSourceContext

Returns:

the file locator

setSourceLocator

public void setSourceLocator(FileSourceLocator locator)

Sets the source locator

Specified by:

setSourceLocator in interface FileSourceContext

Parameters:

locator - : the file locator

getShortName

public String getShortName()

The short name of the interaction. It can be null. Ex: foxc1-flna, ...

Specified by:

getShortName in interface Interaction<Participant>

Returns:

short name of the interaction

setShortName

public void setShortName(String name)

Sets the short name of the interaction

Specified by:

setShortName in interface Interaction<Participant>

Parameters:

name - : short name

getRigid

public String getRigid()

The checksum computed from the rogids from all the proteins involved in the interaction. It is only relevant for protein-protein interactions. This is a shortcut to the first rigid in the list of checksums

Specified by:

getRigid in interface Interaction<Participant>

Returns:

the rigid

setRigid

public void setRigid(String rigid)

Sets the rigid of this interaction. It will remove the previous rigid from the list of checksum and add the new one. If rigid is null, it will remove all the rigid in the list of checksum

Specified by:

setRigid in interface Interaction<Participant>

Parameters:

rigid - : the rigid

getIdentifiers

public Collection<Xref> getIdentifiers()

The identifiers for an interaction. The Collection cannot be null. If the interaction does not have any identifiers (IMEx is not among the identifiers), the method should return an emtpy Collection. Ex: original interaction database accession, ...

Specified by:

getIdentifiers in interface Interaction<Participant>

Returns:

the xrefs

getXrefs

public Collection<Xref> getXrefs()

The external cross references for an interaction. The Collection cannot be null. If the interaction does not have any xrefs, the method should return an emtpy Collection. Ex: GO process xrefs, GO component xrefs, database accession that can identify the interaction, ...

Specified by:

getXrefs in interface Interaction<Participant>

Returns:

the xrefs

getChecksums

public Collection<Checksum> getChecksums()

Set of checksums computed for this interaction.. The Collection cannot be null so when an interaction does not have a checksum, the method should return an empty Collection Ex: rigid:u1FCes02jPb3CGRj1aDkzpbSiuI9606, ...

Specified by:

getChecksums in interface Interaction<Participant>

Returns:

the set of checksums

getAnnotations

public Collection<Annotation> getAnnotations()

The Collection of annotations describing the interaction. The Collection cannot be null. If the interaction does not have any annotations, the method should return an empty Collection. Ex: figure-legend annotations, comments, cautions, ...

Specified by:

getAnnotations in interface Interaction<Participant>

Returns:

the annotations

getUpdatedDate

public Date getUpdatedDate()

The last update date. It can be null if not relevant or not known.

Specified by:

getUpdatedDate in interface Interaction<Participant>

Returns:

the last update date

setUpdatedDate

public void setUpdatedDate(Date updated)

Sets the last update date

Specified by:

setUpdatedDate in interface Interaction<Participant>

Parameters:

updated - : last update date

getCreatedDate

public Date getCreatedDate()

The creation date. It can be null if not relevant or not known.

Specified by:

getCreatedDate in interface Interaction<Participant>

Returns:

the last update date

setCreatedDate

public void setCreatedDate(Date created)

Sets the created date

Specified by:

setCreatedDate in interface Interaction<Participant>

Parameters:

created - : created date

getInteractionType

public CvTerm getInteractionType()

The interaction type is a controlled vocabulary term. It can be null. Ex: direct interaction, association, ...

Specified by:

getInteractionType in interface Interaction<Participant>

Returns:

the interaction type

setInteractionType

public void setInteractionType(CvTerm term)

Sets the interaction type.

Specified by:

setInteractionType in interface Interaction<Participant>

Parameters:

term - : interaction type

toString

public String toString()

toString

Specified by:

toString in interface FileSourceContext

Overrides:

toString in class Object

Returns:

the file source context as a String. If the source locator is not null, it should give the source locator properties