Package psidev.psi.mi.jami.enricher.impl.minimal

Class MinimalInteractionEnricher<I extends Interaction>

java.lang.Object

psidev.psi.mi.jami.enricher.impl.minimal.MinimalInteractionEnricher<I>

All Implemented Interfaces:

InteractionEnricher<I>, MIEnricher<I>

Direct Known Subclasses:

FullInteractionEnricher, MinimalInteractionEvidenceEnricher, MinimalInteractionUpdater, MinimalModelledInteractionEnricher

public class MinimalInteractionEnricher<I extends Interaction>
extends Object
implements InteractionEnricher<I>

The enricher for Interactions which can enrich a single interaction or a collection. The interaction enricher has subEnrichers for participants and cvTerms. It has no fetcher.

Since:

28/06/13

Author:

Gabriel Aldam (galdam@ebi.ac.uk)

Constructor Summary

Constructors

Constructor	Description
MinimalInteractionEnricher()

Method Summary

Modifier and Type	Method	Description
void	enrich(I interactionToEnrich)	Enrichment of a single interaction.
void	enrich(I objectToEnrich, I objectSource)	enrich.
void	enrich(Collection<I> objects)	enrich.
CvTermEnricher<CvTerm>	getCvTermEnricher()	Sets the sub enricher for CvTerms.
InteractionEnricherListener<I>	getInteractionEnricherListener()	The listener for changes made to interactions.
ParticipantEnricher	getParticipantEnricher()	The current sub enricher for participants.
protected void	processCreatedDate(I objectToEnrich, I objectSource)	processCreatedDate.
protected void	processIdentifiers(I objectToEnrich, I objectSource)	processIdentifiers.
protected void	processInteractionType(I interactionToEnrich)	processInteractionType.
protected void	processInteractionType(I objectToEnrich, I objectSource)	processInteractionType.
void	processMinimalUpdates(I objectToEnrich, I objectSource)	processMinimalUpdates.
protected void	processOtherProperties(I interactionToEnrich)	The strategy used for enriching the interaction.
protected void	processOtherProperties(I objectToEnrich, I objectSource)	processOtherProperties.
protected void	processParticipants(I interactionToEnrich)	processParticipants.
protected void	processParticipants(I objectToEnrich, I objectSource)	processParticipants.
protected void	processShortName(I objectToEnrich, I objectSource)	processShortName.
protected void	processUpdateDate(I objectToEnrich, I objectSource)	processUpdateDate.
void	setCvTermEnricher(CvTermEnricher<CvTerm> cvTermEnricher)	setCvTermEnricher.
void	setInteractionEnricherListener(InteractionEnricherListener<I> listener)	setInteractionEnricherListener.
void	setParticipantEnricher(ParticipantEnricher participantEnricher)	setParticipantEnricher.

Methods inherited from class java.lang.Object

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

Constructor Detail

MinimalInteractionEnricher

public MinimalInteractionEnricher()

Method Detail

enrich

public void enrich(I interactionToEnrich)
            throws EnricherException

Enrichment of a single interaction.

Specified by:

enrich in interface MIEnricher<I extends Interaction>

Parameters:

interactionToEnrich - The interaction which is to be enriched

Throws:

EnricherException - Thrown if a fetcher encounters problems.

enrich

public void enrich(Collection<I> objects)
            throws EnricherException

enrich.

Specified by:

enrich in interface MIEnricher<I extends Interaction>

Parameters:

objects - a Collection object.

Throws:

EnricherException - if any.

enrich

public void enrich(I objectToEnrich,
                   I objectSource)
            throws EnricherException

enrich.

Specified by:

enrich in interface MIEnricher<I extends Interaction>

Parameters:

objectToEnrich - a I object.

objectSource - a I object.

Throws:

EnricherException - if any.

processMinimalUpdates

public void processMinimalUpdates(I objectToEnrich,
                                  I objectSource)
                           throws EnricherException

processMinimalUpdates.

Parameters:

objectToEnrich - a I object.

objectSource - a I object.

Throws:

EnricherException - if any.

processCreatedDate

protected void processCreatedDate(I objectToEnrich,
                                  I objectSource)
                           throws EnricherException

processCreatedDate.

Parameters:

objectToEnrich - a I object.

objectSource - a I object.

Throws:

EnricherException - if any.

processUpdateDate

protected void processUpdateDate(I objectToEnrich,
                                 I objectSource)
                          throws EnricherException

processUpdateDate.

Parameters:

objectToEnrich - a I object.

objectSource - a I object.

Throws:

EnricherException - if any.

processShortName

protected void processShortName(I objectToEnrich,
                                I objectSource)
                         throws EnricherException

processShortName.

Parameters:

objectToEnrich - a I object.

objectSource - a I object.

Throws:

EnricherException - if any.

processOtherProperties

protected void processOtherProperties(I objectToEnrich,
                                      I objectSource)
                               throws EnricherException

processOtherProperties.

Parameters:

objectToEnrich - a I object.

objectSource - a I object.

Throws:

EnricherException - if any.

processIdentifiers

protected void processIdentifiers(I objectToEnrich,
                                  I objectSource)
                           throws EnricherException

processIdentifiers.

Parameters:

objectToEnrich - a I object.

objectSource - a I object.

Throws:

EnricherException - if any.

processParticipants

protected void processParticipants(I objectToEnrich,
                                   I objectSource)
                            throws EnricherException

processParticipants.

Parameters:

objectToEnrich - a I object.

objectSource - a I object.

Throws:

EnricherException - if any.

processInteractionType

protected void processInteractionType(I objectToEnrich,
                                      I objectSource)
                               throws EnricherException

processInteractionType.

Parameters:

objectToEnrich - a I object.

objectSource - a I object.

Throws:

EnricherException - if any.

setCvTermEnricher

public void setCvTermEnricher(CvTermEnricher<CvTerm> cvTermEnricher)

setCvTermEnricher.

The current sub enricher for CvTerms.

Specified by:

setCvTermEnricher in interface InteractionEnricher<I extends Interaction>

Parameters:

cvTermEnricher - a CvTermEnricher object.

getCvTermEnricher

public CvTermEnricher<CvTerm> getCvTermEnricher()

Sets the sub enricher for CvTerms.

Specified by:

getCvTermEnricher in interface InteractionEnricher<I extends Interaction>

Returns:

The enricher for CvTerms. Can be null.

setParticipantEnricher

public void setParticipantEnricher(ParticipantEnricher participantEnricher)

setParticipantEnricher.

Sets the sub enricher for participants.

Specified by:

setParticipantEnricher in interface InteractionEnricher<I extends Interaction>

Parameters:

participantEnricher - a ParticipantEnricher object.

getParticipantEnricher

public ParticipantEnricher getParticipantEnricher()

The current sub enricher for participants.

Specified by:

getParticipantEnricher in interface InteractionEnricher<I extends Interaction>

Returns:

The enricher for participants. Can be null.

getInteractionEnricherListener

public InteractionEnricherListener<I> getInteractionEnricherListener()

The listener for changes made to interactions.

Specified by:

getInteractionEnricherListener in interface InteractionEnricher<I extends Interaction>

Returns:

The listener for interaction changes. Can be null.

setInteractionEnricherListener

public void setInteractionEnricherListener(InteractionEnricherListener<I> listener)

setInteractionEnricherListener.

Sets the listener to be used when interactions are changed.

Specified by:

setInteractionEnricherListener in interface InteractionEnricher<I extends Interaction>

Parameters:

listener - a InteractionEnricherListener object.

processInteractionType

protected void processInteractionType(I interactionToEnrich)
                               throws EnricherException

processInteractionType.

Parameters:

interactionToEnrich - a I object.

Throws:

EnricherException - if any.

processParticipants

protected void processParticipants(I interactionToEnrich)
                            throws EnricherException

processParticipants.

Parameters:

interactionToEnrich - a I object.

Throws:

EnricherException - if any.

processOtherProperties

protected void processOtherProperties(I interactionToEnrich)
                               throws EnricherException

The strategy used for enriching the interaction. Can be overwritten to change the behaviour.

Parameters:

interactionToEnrich - The interaction being enriched.

Throws:

EnricherException - Thrown if a fetcher encounters a problem.