org.eclipse.emf.cdo.server.db
Interface IDBStore

All Superinterfaces:
IDBConnectionProvider, IStore, IStore.CanHandleClientAssignedIDs

public interface IDBStore
extends IStore, IDBConnectionProvider, IStore.CanHandleClientAssignedIDs

The main entry point to the API of CDO's proprietary object/relational mapper.

No Implement
This interface is not intended to be implemented by clients.
No Extend
This interface is not intended to be extended by clients.

Nested Class Summary
static interface IDBStore.Props
          Contains symbolic constants that specifiy valid keys of DB store properties.
static interface IDBStore.TableVisitor
          Called back from visitAllTables(Connection, TableVisitor) for all tables in the database.
 
Nested classes/interfaces inherited from interface org.eclipse.emf.cdo.server.IStore
IStore.CanHandleClientAssignedIDs, IStore.ChangeFormat, IStore.RevisionParallelism, IStore.RevisionTemporality
 
Method Summary
 IDBDatabase getDatabase()
           
 IDBAdapter getDBAdapter()
           
 IDBSchema getDBSchema()
           
 int getIDColumnLength()
           
 IIDHandler getIDHandler()
           
 IMappingStrategy getMappingStrategy()
           
 IMetaDataManager getMetaDataManager()
          Get the meta data manager associated with this DBStore.
 Map<String,String> getProperties()
           
 IDBStoreAccessor getReader(ISession session)
          Returns a reader that can be used to read from this store in the context of the given session.
 IDBStoreAccessor getWriter(ITransaction transaction)
          Returns a writer that can be used to write to this store in the context of the given view.
 void visitAllTables(Connection connection, IDBStore.TableVisitor visitor)
           
 
Methods inherited from interface org.eclipse.emf.cdo.server.IStore
createObjectID, getCreationTime, getIndicatingCommitDistributor, getLastBranchID, getLastCommitTime, getLastLocalBranchID, getLastNonLocalCommitTime, getObjectIDTypes, getPersistentProperties, getRepository, getRevisionParallelism, getRevisionTemporality, getSupportedChangeFormats, getSupportedRevisionParallelisms, getSupportedRevisionTemporalities, getType, isFirstStart, removePersistentProperties, setPersistentProperties
 
Methods inherited from interface org.eclipse.net4j.db.IDBConnectionProvider
getConnection
 

Method Detail

getMappingStrategy

IMappingStrategy getMappingStrategy()
Since:
2.0

getIDHandler

IIDHandler getIDHandler()
Since:
4.0

getDatabase

IDBDatabase getDatabase()
Since:
4.2

getDBAdapter

IDBAdapter getDBAdapter()

getDBSchema

IDBSchema getDBSchema()

getIDColumnLength

int getIDColumnLength()
Since:
4.2

getProperties

Map<String,String> getProperties()
Since:
4.2

visitAllTables

void visitAllTables(Connection connection,
                    IDBStore.TableVisitor visitor)
Since:
4.2

getMetaDataManager

IMetaDataManager getMetaDataManager()
Get the meta data manager associated with this DBStore.

Since:
2.0

getReader

IDBStoreAccessor getReader(ISession session)
Description copied from interface: IStore
Returns a reader that can be used to read from this store in the context of the given session.

Specified by:
getReader in interface IStore
Parameters:
session - The session that should be used as a context for read access or null. The store implementor is free to interpret and use the session in a manner suitable for him or ignore it at all. It is meant only as a hint. Implementor can use it as a key into a cache and/or register a LifecycleEventAdapter with it to intercept cleanup on session close. Note however that the session can be null, for example during startup of the server while the repositories are initialized but before any user session has been opened.
Returns:
a reader that can be used to read from this store in the context of the given session, never null.
Since:
2.0

getWriter

IDBStoreAccessor getWriter(ITransaction transaction)
Description copied from interface: IStore
Returns a writer that can be used to write to this store in the context of the given view. The given view is always marked as a transaction.

Specified by:
getWriter in interface IStore
Parameters:
transaction - The view that must be used as a context for write access. The store implementor is free to interpret and use the view in a manner suitable for him or ignore it at all. It is meant only as a hint. Implementor can use it as a key into a cache and/or register a LifecycleEventAdapter with it to intercept cleanup on view close.
Returns:
a writer that can be used to write to this store in the context of the given view, never null.
Since:
2.0


Copyright (c) 2011, 2012 Eike Stepper (Berlin, Germany) and others.