Package psidev.psi.mi.jami.xml.model.reference.xml300

Class AbstractEntityRef<T extends Feature>

java.lang.Object

psidev.psi.mi.jami.xml.model.reference.AbstractXmlIdReference

psidev.psi.mi.jami.xml.model.reference.xml300.AbstractEntityRef<T>

All Implemented Interfaces:

FileSourceContext, Entity<T>, ExtendedPsiXmlEntity<T>, XmlIdReference

Direct Known Subclasses:

AbstractParticipantRef

public abstract class AbstractEntityRef<T extends Feature>
extends AbstractXmlIdReference
implements ExtendedPsiXmlEntity<T>

Abstract entity reference

Since:

11/10/13

Version:

$Id$

Author:

Marine Dumousseau (marine@ebi.ac.uk)

Field Summary

Fields inherited from class psidev.psi.mi.jami.xml.model.reference.AbstractXmlIdReference

ref

Constructor Summary

Constructors

Constructor	Description
AbstractEntityRef(int ref)	Constructor for AbstractEntityRef.

Method Summary

Modifier and Type	Method	Description
boolean	addAllFeatures(Collection<? extends T> features)	This method will add all features and set the entity of the new features to this current entity
boolean	addFeature(T feature)	addFeature.
Collection<CausalRelationship>	getCausalRelationships()	getCausalRelationships.
EntityInteractorChangeListener	getChangeListener()	getChangeListener.
protected ExtendedPsiXmlEntity<T>	getDelegate()	Getter for the field delegate.
Collection<T>	getFeatures()	getFeatures.
int	getId()	getId.
Interactor	getInteractor()	getInteractor.
Stoichiometry	getStoichiometry()	getStoichiometry.
protected abstract void	initialiseParticipantDelegate()	initialiseParticipantDelegate.
boolean	removeAllFeatures(Collection<? extends T> features)	This method will remove all the features and set the entity of the removed features to null.
boolean	removeFeature(T feature)	removeFeature.
void	setChangeListener(EntityInteractorChangeListener listener)	Sets the entity change listener
protected void	setDelegate(ExtendedPsiXmlEntity<T> delegate)	Setter for the field delegate.
void	setId(int id)	setId.
void	setInteractor(Interactor interactor)	Sets the interactor
void	setStoichiometry(Integer stoichiometry)	Sets the mean stoichiometry for this participant.
void	setStoichiometry(Stoichiometry stoichiometry)	setStoichiometry.
String	toString()	toString

Methods inherited from class psidev.psi.mi.jami.xml.model.reference.AbstractXmlIdReference

getRef, registerForResolution

Methods inherited from class java.lang.Object

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

Methods inherited from interface psidev.psi.mi.jami.datasource.FileSourceContext

getSourceLocator, setSourceLocator

Methods inherited from interface psidev.psi.mi.jami.xml.model.reference.XmlIdReference

resolve

Constructor Detail

AbstractEntityRef

public AbstractEntityRef(int ref)

Constructor for AbstractEntityRef.

Parameters:

ref - a int.

Method Detail

getInteractor

public Interactor getInteractor()

getInteractor.

Specified by:

getInteractor in interface Entity<T extends Feature>

Returns:

a Interactor object.

setInteractor

public void setInteractor(Interactor interactor)

Sets the interactor

Specified by:

setInteractor in interface Entity<T extends Feature>

Parameters:

interactor - : interactor

getCausalRelationships

public Collection<CausalRelationship> getCausalRelationships()

getCausalRelationships.

Specified by:

getCausalRelationships in interface Entity<T extends Feature>

Returns:

a Collection object.

getStoichiometry

public Stoichiometry getStoichiometry()

getStoichiometry.

Specified by:

getStoichiometry in interface Entity<T extends Feature>

Returns:

a Stoichiometry object.

setStoichiometry

public void setStoichiometry(Integer stoichiometry)

Sets the mean stoichiometry for this participant.

Specified by:

setStoichiometry in interface Entity<T extends Feature>

Parameters:

stoichiometry - : mean stoichiometry value

setStoichiometry

public void setStoichiometry(Stoichiometry stoichiometry)

setStoichiometry.

Specified by:

setStoichiometry in interface Entity<T extends Feature>

Parameters:

stoichiometry - a Stoichiometry object.

getFeatures

public Collection<T> getFeatures()

getFeatures.

Specified by:

getFeatures in interface Entity<T extends Feature>

Returns:

a Collection object.

getChangeListener

public EntityInteractorChangeListener getChangeListener()

getChangeListener.

Specified by:

getChangeListener in interface Entity<T extends Feature>

Returns:

a EntityInteractorChangeListener object.

setChangeListener

public void setChangeListener(EntityInteractorChangeListener listener)

Sets the entity change listener

Specified by:

setChangeListener in interface Entity<T extends Feature>

Parameters:

listener - : the entity change listener

addFeature

public boolean addFeature(T feature)

addFeature.

Specified by:

addFeature in interface Entity<T extends Feature>

Parameters:

feature - a T object.

Returns:

a boolean.

removeFeature

public boolean removeFeature(T feature)

removeFeature.

Specified by:

removeFeature in interface Entity<T extends Feature>

Parameters:

feature - a T object.

Returns:

a boolean.

addAllFeatures

public boolean addAllFeatures(Collection<? extends T> features)

This method will add all features and set the entity of the new features to this current entity

Specified by:

addAllFeatures in interface Entity<T extends Feature>

Parameters:

features - : features to add

Returns:

true if features are added to the list of features

removeAllFeatures

public boolean removeAllFeatures(Collection<? extends T> features)

This method will remove all the features and set the entity of the removed features to null.

Specified by:

removeAllFeatures in interface Entity<T extends Feature>

Parameters:

features - : features to remove

Returns:

true if features are removed from the list of features

setId

public void setId(int id)

setId.

Specified by:

setId in interface ExtendedPsiXmlEntity<T extends Feature>

Parameters:

id - a int.

getId

public int getId()

getId.

Specified by:

getId in interface ExtendedPsiXmlEntity<T extends Feature>

Returns:

a int.

toString

public String toString()

toString

Specified by:

toString in interface FileSourceContext

Overrides:

toString in class AbstractXmlIdReference

Returns:

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

initialiseParticipantDelegate

protected abstract void initialiseParticipantDelegate()

initialiseParticipantDelegate.

getDelegate

protected ExtendedPsiXmlEntity<T> getDelegate()

Getter for the field delegate.

Returns:

a ExtendedPsiXmlSource object.

setDelegate

protected void setDelegate(ExtendedPsiXmlEntity<T> delegate)

Setter for the field delegate.

Parameters:

delegate - a ExtendedPsiXmlSource object.