Package psidev.psi.mi.jami.xml.cache
Interface PsiXmlObjectCache
-
- All Known Implementing Classes:
InMemoryIdentityObjectCache,InMemoryLightIdentityObjectCache
public interface PsiXmlObjectCacheIndex 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 voidclear()Clear registered complexes and object idsSet<ModelledInteraction>clearRegisteredSubComplexes()This method will return all registered complexes and clear them from the indexvoidclose()Close cachebooleancontains(Object o)True if it contains this objectintextractIdForAvailability(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 registeredintextractIdForComplex(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 registeredintextractIdForExperiment(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 registeredintextractIdForFeature(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 registeredintextractIdForInteraction(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 registeredintextractIdForInteractor(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 registeredintextractIdForParticipant(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 registeredintextractIdForVariableParameterValue(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 registeredintgetLastGeneratedId()getLastGeneratedId.booleanhasRegisteredSubComplexes()hasRegisteredSubComplexes.voidregisterSubComplex(ModelledInteraction c)This method will register a complex that is used as an interactorvoidremoveObject(Object o)removeObject.voidresetLastGeneratedIdTo(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- aStringobject.- 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- aExperimentobject.- 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- aInteractorobject.- 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- aInteractionobject.- 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- aEntityobject.- 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- aVariableParameterValueobject.- 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- aFeatureobject.- 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- aComplexobject.- 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- aObjectobject.- Returns:
- a boolean.
-
registerSubComplex
void registerSubComplex(ModelledInteraction c)
This method will register a complex that is used as an interactor- Parameters:
c- aModelledInteractionobject.
-
clearRegisteredSubComplexes
Set<ModelledInteraction> clearRegisteredSubComplexes()
This method will return all registered complexes and clear them from the index- Returns:
- a
Setobject.
-
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.
-
-