org.intermine.api
Class InterMineAPI

java.lang.Object
  org.intermine.api.InterMineAPI

public class InterMineAPI
extends java.lang.Object

InterMineAPI provides access to manager objects for the main parts of an InterMine application: the production ObjectStore, the userprofile (via ProfileManager), template queries, bags and tags. There should be one InterMineAPI object per application.

Constructor Summary

InterMineAPI(ObjectStore objectStore, ObjectStoreWriter userProfileWriter, java.util.Map<java.lang.String,java.util.List<FieldDescriptor>> classKeys, BagQueryConfig bagQueryConfig, ObjectStoreSummary oss)
Construct an InterMine API object.

Method Summary

BagManager	getBagManager()
BagQueryConfig	getBagQueryConfig()
BagQueryRunner	getBagQueryRunner()
java.util.Map<java.lang.String,java.util.List<FieldDescriptor>>	getClassKeys()
Model	getModel()
ObjectStore	getObjectStore()
ObjectStoreSummary	getObjectStoreSummary()
PathQueryExecutor	getPathQueryExecutor(Profile profile)
ProfileManager	getProfileManager()
TagManager	getTagManager()
TemplateManager	getTemplateManager()
TemplateSummariser	getTemplateSummariser()
WebResultsExecutor	getWebResultsExecutor(Profile profile)

Methods inherited from class java.lang.Object

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

Constructor Detail

InterMineAPI

public InterMineAPI(ObjectStore objectStore,
                    ObjectStoreWriter userProfileWriter,
                    java.util.Map<java.lang.String,java.util.List<FieldDescriptor>> classKeys,
                    BagQueryConfig bagQueryConfig,
                    ObjectStoreSummary oss)

Construct an InterMine API object.

Parameters:

objectStore - the production database

userProfileWriter - a writer for the userprofile database

classKeys - the class keys

bagQueryConfig - configured bag queries used by BagQueryRunner

oss - summary information for the ObjectStore

Method Detail

getObjectStore

public ObjectStore getObjectStore()

Returns:

the objectStore

getModel

public Model getModel()

Returns:

the model

getProfileManager

public ProfileManager getProfileManager()

Returns:

the profileManager

getTemplateManager

public TemplateManager getTemplateManager()

Returns:

the templateManager

getBagManager

public BagManager getBagManager()

Returns:

the bagManager

getTagManager

public TagManager getTagManager()

Returns:

the TagManager

getTemplateSummariser

public TemplateSummariser getTemplateSummariser()

Returns:

the templateSummariser

getWebResultsExecutor

public WebResultsExecutor getWebResultsExecutor(Profile profile)

Parameters:

profile - the user that is executing the query

Returns:

the webResultsExecutor

getPathQueryExecutor

public PathQueryExecutor getPathQueryExecutor(Profile profile)

Parameters:

profile - the user that is executing the query

Returns:

the pathQueryExecutor

getBagQueryRunner

public BagQueryRunner getBagQueryRunner()

Returns:

the bagQueryRunner

getObjectStoreSummary

public ObjectStoreSummary getObjectStoreSummary()

Returns:

the oss

getClassKeys

public java.util.Map<java.lang.String,java.util.List<FieldDescriptor>> getClassKeys()

Returns:

the classKeys

getBagQueryConfig

public BagQueryConfig getBagQueryConfig()

Returns:

the bagQueryConfig