Package psidev.psi.mi.jami.xml.cache
Interface PsiXmlObjectCache
-
- All Known Implementing Classes:
InMemoryIdentityObjectCache
,InMemoryLightIdentityObjectCache
public interface PsiXmlObjectCache
Index that can assign/retrieve an id for a given MI object in a compact XML environment- Since:
12/11/13
- Version:
- $Id$
- Author:
- Marine Dumousseau (marine@ebi.ac.uk)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
clear()
Clear registered complexes and object idsSet<ModelledInteraction>
clearRegisteredSubComplexes()
This method will return all registered complexes and clear them from the indexvoid
close()
Close cacheboolean
contains(Object o)
True if it contains this objectint
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 registeredint
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 registeredint
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 registeredint
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 registeredint
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 registeredint
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 registeredint
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 registeredint
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 registeredint
getLastGeneratedId()
getLastGeneratedId.boolean
hasRegisteredSubComplexes()
hasRegisteredSubComplexes.void
registerSubComplex(ModelledInteraction c)
This method will register a complex that is used as an interactorvoid
removeObject(Object o)
removeObject.void
resetLastGeneratedIdTo(int id)
Reset the last generated id to a specific value
-
-
-
Method Detail
-
extractIdForAvailability
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- Parameters:
av
- aString
object.- Returns:
- the id assigned to this object
-
extractIdForExperiment
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- Parameters:
o
- aExperiment
object.- Returns:
- the id assigned to this object
-
extractIdForInteractor
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- Parameters:
o
- aInteractor
object.- Returns:
- the id assigned to this object
-
extractIdForInteraction
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- Parameters:
o
- aInteraction
object.- Returns:
- the id assigned to this object
-
extractIdForParticipant
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- Parameters:
o
- aEntity
object.- Returns:
- the id assigned to this object
-
extractIdForVariableParameterValue
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- Parameters:
o
- aVariableParameterValue
object.- Returns:
- the id assigned to this object
-
extractIdForFeature
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- Parameters:
o
- aFeature
object.- Returns:
- the id assigned to this object
-
extractIdForComplex
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- Parameters:
o
- aComplex
object.- Returns:
- the id assigned to this object
-
clear
void clear()
Clear registered complexes and object ids
-
close
void close()
Close cache
-
contains
boolean contains(Object o)
True if it contains this object- Parameters:
o
- aObject
object.- Returns:
- a boolean.
-
registerSubComplex
void registerSubComplex(ModelledInteraction c)
This method will register a complex that is used as an interactor- Parameters:
c
- aModelledInteraction
object.
-
clearRegisteredSubComplexes
Set<ModelledInteraction> clearRegisteredSubComplexes()
This method will return all registered complexes and clear them from the index- Returns:
- a
Set
object.
-
hasRegisteredSubComplexes
boolean hasRegisteredSubComplexes()
hasRegisteredSubComplexes.
- Returns:
- true if the index has registered som sub complexes, fasle otherwise
-
getLastGeneratedId
int getLastGeneratedId()
getLastGeneratedId.
- Returns:
- the last generated id
-
resetLastGeneratedIdTo
void resetLastGeneratedIdTo(int id)
Reset the last generated id to a specific value- Parameters:
id
- a int.
-
-