Package psidev.psi.mi.jami.xml.cache

Class InMemoryLightIdentityObjectCache

java.lang.Object

psidev.psi.mi.jami.xml.cache.InMemoryLightIdentityObjectCache

All Implemented Interfaces:

PsiXmlObjectCache

public class InMemoryLightIdentityObjectCache
extends Object
implements PsiXmlObjectCache

It keeps a in memory cache of objects having an id. The cache is based on a in memory Identity map. It will only keep experiments, interactions, features and participants in memory. It will ignore interactors and availability

Since:

19/11/13

Version:

$Id$

Author:

Marine Dumousseau (marine@ebi.ac.uk)

Constructor Summary

Constructors

Constructor	Description
InMemoryLightIdentityObjectCache()	Constructor for InMemoryLightIdentityObjectCache.

Method Summary

Modifier and Type	Method	Description
void	clear()	clear.
Set<ModelledInteraction>	clearRegisteredSubComplexes()	This method will return all registered complexes and clear them from the index
void	close()	Close cache
boolean	contains(Object o)	True if it contains this object
int	extractIdForAvailability(String av)	This method will extract the id for this object if it is already registered, assign an id and register the object if not already registered
int	extractIdForComplex(Complex o)	This method will extract the id for this object if it is already registered, assign an id and register the object if not already registered
int	extractIdForExperiment(Experiment o)	This method will extract the id for this object if it is already registered, assign an id and register the object if not already registered
int	extractIdForFeature(Feature o)	This method will extract the id for this object if it is already registered, assign an id and register the object if not already registered
int	extractIdForInteraction(Interaction o)	This method will extract the id for this object if it is already registered, assign an id and register the object if not already registered
int	extractIdForInteractor(Interactor o)	This method will extract the id for this object if it is already registered, assign an id and register the object if not already registered
int	extractIdForParticipant(Entity o)	This method will extract the id for this object if it is already registered, assign an id and register the object if not already registered
int	extractIdForVariableParameterValue(VariableParameterValue o)	This method will extract the id for this object if it is already registered, assign an id and register the object if not already registered
int	getLastGeneratedId()	getLastGeneratedId.
boolean	hasRegisteredSubComplexes()	hasRegisteredSubComplexes.
void	registerSubComplex(ModelledInteraction c)	This method will register a complex that is used as an interactor
void	removeObject(Object o)	removeObject.
void	resetLastGeneratedIdTo(int id)	Reset the last generated id to a specific value

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemoryLightIdentityObjectCache

public InMemoryLightIdentityObjectCache()

Constructor for InMemoryLightIdentityObjectCache.

Method Detail

extractIdForAvailability

public int extractIdForAvailability(String av)

This method will extract the id for this object if it is already registered, assign an id and register the object if not already registered

Specified by:

extractIdForAvailability in interface PsiXmlObjectCache

Parameters:

av - a String object.

Returns:

the id assigned to this object

extractIdForExperiment

public int extractIdForExperiment(Experiment o)

This method will extract the id for this object if it is already registered, assign an id and register the object if not already registered

Specified by:

extractIdForExperiment in interface PsiXmlObjectCache

Parameters:

o - a Experiment object.

Returns:

the id assigned to this object

extractIdForInteractor

public int extractIdForInteractor(Interactor o)

This method will extract the id for this object if it is already registered, assign an id and register the object if not already registered

Specified by:

extractIdForInteractor in interface PsiXmlObjectCache

Parameters:

o - a Interactor object.

Returns:

the id assigned to this object

extractIdForInteraction

public int extractIdForInteraction(Interaction o)

This method will extract the id for this object if it is already registered, assign an id and register the object if not already registered

Specified by:

extractIdForInteraction in interface PsiXmlObjectCache

Parameters:

o - a Interaction object.

Returns:

the id assigned to this object

extractIdForParticipant

public int extractIdForParticipant(Entity o)

This method will extract the id for this object if it is already registered, assign an id and register the object if not already registered

Specified by:

extractIdForParticipant in interface PsiXmlObjectCache

Parameters:

o - a Entity object.

Returns:

the id assigned to this object

extractIdForFeature

public int extractIdForFeature(Feature o)

This method will extract the id for this object if it is already registered, assign an id and register the object if not already registered

Specified by:

extractIdForFeature in interface PsiXmlObjectCache

Parameters:

o - a Feature object.

Returns:

the id assigned to this object

extractIdForVariableParameterValue

public int extractIdForVariableParameterValue(VariableParameterValue o)

This method will extract the id for this object if it is already registered, assign an id and register the object if not already registered

Specified by:

extractIdForVariableParameterValue in interface PsiXmlObjectCache

Parameters:

o - a VariableParameterValue object.

Returns:

the id assigned to this object

extractIdForComplex

public int extractIdForComplex(Complex o)

This method will extract the id for this object if it is already registered, assign an id and register the object if not already registered

Specified by:

extractIdForComplex in interface PsiXmlObjectCache

Parameters:

o - a Complex object.

Returns:

the id assigned to this object

clear

public void clear()

clear.

Specified by:

clear in interface PsiXmlObjectCache

close

public void close()

Close cache

Specified by:

close in interface PsiXmlObjectCache

contains

public boolean contains(Object o)

True if it contains this object

Specified by:

contains in interface PsiXmlObjectCache

Parameters:

o - a Object object.

Returns:

a boolean.

registerSubComplex

public void registerSubComplex(ModelledInteraction c)

This method will register a complex that is used as an interactor

Specified by:

registerSubComplex in interface PsiXmlObjectCache

Parameters:

c - a ModelledInteraction object.

clearRegisteredSubComplexes

public Set<ModelledInteraction> clearRegisteredSubComplexes()

This method will return all registered complexes and clear them from the index

Specified by:

clearRegisteredSubComplexes in interface PsiXmlObjectCache

Returns:

a Set object.

hasRegisteredSubComplexes

public boolean hasRegisteredSubComplexes()

hasRegisteredSubComplexes.

Specified by:

hasRegisteredSubComplexes in interface PsiXmlObjectCache

Returns:

true if the index has registered som sub complexes, fasle otherwise

removeObject

public void removeObject(Object o)

removeObject.

Specified by:

removeObject in interface PsiXmlObjectCache

Parameters:

o - a Object object.

getLastGeneratedId

public int getLastGeneratedId()

getLastGeneratedId.

Specified by:

getLastGeneratedId in interface PsiXmlObjectCache

Returns:

the last generated id

resetLastGeneratedIdTo

public void resetLastGeneratedIdTo(int id)

Reset the last generated id to a specific value

Specified by:

resetLastGeneratedIdTo in interface PsiXmlObjectCache

Parameters:

id - a int.