AbstractStoreManager (DataNucleus Core 3.2.11 API)

java.lang.Object
- org.datanucleus.properties.PropertyStore
- - org.datanucleus.store.AbstractStoreManager

All Implemented Interfaces:

StoreManager
```
public abstract class AbstractStoreManager
extends PropertyStore
implements StoreManager
```
An abstract representation of a Store Manager. Manages the persistence of objects to the store. Will be implemented for the type of datastore (RDBMS, ODBMS, etc) in question. The store manager's responsibilities include:
- Creating and/or validating datastore tables according to the persistent classes being accessed by the application.
- Serving as the primary intermediary between ObjectProviders and the database.
- Serving as the base Extent and Query factory.
A store manager's knowledge of its contents is typically not complete. It knows about the classes that it has encountered in its lifetime. The PersistenceManager can make the StoreManager aware of a class, and can check if the StoreManager knows about a particular class.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`autoCreateColumns` Whether to auto create any columns that are missing.
`protected boolean`	`autoCreateConstraints` Whether to auto create any constraints
`protected boolean`	`autoCreateTables` Whether to auto create any tables.
`protected boolean`	`autoCreateWarnOnError` Whether to warn only when any errors occur on auto-create.
`protected ConnectionManager`	`connectionMgr` ConnectionManager
`protected boolean`	`fixedDatastore` Whether this datastore is fixed (no mods to table structure allowed).
`protected FlushProcess`	`flushProcess` The flush process appropriate for this datastore.
`protected static Localiser`	`LOCALISER` Localiser for messages.
`protected NamingFactory`	`namingFactory` Naming factory.
`protected NucleusContext`	`nucleusContext` Nucleus Context.
`protected StorePersistenceHandler`	`persistenceHandler` Persistence handler.
`protected String`	`primaryConnectionFactoryName` Name of primary connection factory.
`protected boolean`	`readOnlyDatastore` Whether this datastore is read only.
`protected StoreSchemaHandler`	`schemaHandler` Schema handler.
`protected String`	`secondaryConnectionFactoryName` Name of secondary connection factory (null if not present).
`protected StoreDataManager`	`storeDataMgr` Manager for the data definition in the datastore.
`protected String`	`storeManagerKey` Key for this StoreManager e.g "rdbms", "db4o"
`protected boolean`	`validateColumns` Whether to validate any columns
`protected boolean`	`validateConstraints` Whether to validate any constraints
`protected boolean`	`validateTables` Whether to validate any tables

Fields inherited from class org.datanucleus.properties.PropertyStore
properties

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractStoreManager(String key, ClassLoaderResolver clr, NucleusContext nucleusContext, Map<String,Object> props)` Constructor for a new StoreManager.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addClass(String className, ClassLoaderResolver clr)` Method to add a class to the managed list for this datastore manager.
`void`	`addClasses(String[] classNames, ClassLoaderResolver clr)` Add classes to the persistence model for the datastore.
`void`	`close()` Release of resources.
`protected void`	`deregisterAllStoreData()` Method to deregister all existing store data so that we are managing nothing.
`ApiAdapter`	`getApiAdapter()` Accessor for the API adapter.
`Boolean`	`getBooleanObjectProperty(String name)` Accessor for the specified property as a Boolean.
`boolean`	`getBooleanProperty(String name)` Accessor for the specified property as a boolean.
`boolean`	`getBooleanProperty(String name, boolean resultIfNotSet)` Accessor for the specified property as a boolean.
`String`	`getClassNameForObjectID(Object id, ClassLoaderResolver clr, ExecutionContext ec)` Returns the class corresponding to the given object identity.
`ManagedConnection`	`getConnection(ExecutionContext ec)` Accessor for a connection for the specified ExecutionContext.
`ManagedConnection`	`getConnection(ExecutionContext ec, Map options)` Accessor for a connection for the specified ExecutionContext.
`ManagedConnection`	`getConnection(int isolation_level)` Utility to return a managed connection not tied to any ExecutionContext.
`String`	`getConnectionDriverName()` Convenience accessor for the driver name to use for the connection (if applicable for this datastore).
`Object`	`getConnectionFactory()` Convenience accessor for the factory for the connection (transactional).
`Object`	`getConnectionFactory2()` Convenience accessor for the factory for the connection (non-transactional).
`String`	`getConnectionFactory2Name()` Convenience accessor for the factory name for the connection (non-transactional).
`String`	`getConnectionFactoryName()` Convenience accessor for the factory name for the connection (transactional).
`ConnectionManager`	`getConnectionManager()` Accessor for the connection manager for this store manager.
`String`	`getConnectionPassword()` Convenience accessor for the password to use for the connection.
`String`	`getConnectionURL()` Convenience accessor for the URL for the connection
`String`	`getConnectionUserName()` Convenience accessor for the username to use for the connection
`Date`	`getDatastoreDate()` Get the date/time of the datastore.
`String`	`getDefaultObjectProviderClassName()`
`Extent`	`getExtent(ExecutionContext ec, Class c, boolean subclasses)` Interface to getting an Extent for a class.
`FlushProcess`	`getFlushProcess()` Accessor for the flush process to use with this datastore.
`int`	`getIntProperty(String name)` Accessor for the specified property as an int.
`MetaDataManager`	`getMetaDataManager()`
`NamingFactory`	`getNamingFactory()` Accessor for the schema naming factory.
`NucleusConnection`	`getNucleusConnection(ExecutionContext ec)` Method to return a connection to the user for the ExecutionContext.
`NucleusContext`	`getNucleusContext()` Accessor for the context in which this StoreManager is running
`NucleusSequence`	`getNucleusSequence(ExecutionContext ec, SequenceMetaData seqmd)` Method to return a datastore sequence for this datastore matching the passed sequence MetaData.
`StorePersistenceHandler`	`getPersistenceHandler()` Accessor for the store persistence handler.
`protected Properties`	`getPropertiesForGenerator(AbstractClassMetaData cmd, int absoluteFieldNumber, ExecutionContext ec, SequenceMetaData seqmd, TableGeneratorMetaData tablegenmd)` Method to return the properties to pass to the generator for the specified field.
`Object`	`getProperty(String name)` Method to get the value of a property from the store.
`String`	`getQueryCacheKey()` Accessor for the key used for representing this store manager in the query cache.
`QueryManager`	`getQueryManager()` Accessor for the query manager for this datastore.
`StoreSchemaHandler`	`getSchemaHandler()` Accessor for the store schema handler (if this datastore supports the concept of a schema).
`String`	`getStoreManagerKey()` Accessor for the key for this store manager.
`protected String`	`getStrategyForNative(AbstractClassMetaData cmd, int absFieldNumber)` Method defining which value-strategy to use when the user specifies "native".
`Object`	`getStrategyValue(ExecutionContext ec, AbstractClassMetaData cmd, int absoluteFieldNumber)` Method to retrieve the value for a strategy for a particular field.
`protected Object`	`getStrategyValueForGenerator(ValueGenerator generator, ExecutionContext ec)` Accessor for the next value from the specified generator.
`String`	`getStringProperty(String name)` Accessor for the specified property as a String.
`Collection<String>`	`getSubClassesForClass(String className, boolean includeDescendents, ClassLoaderResolver clr)` Utility to return the names of the classes that are known subclasses of the provided class.
`Collection<String>`	`getSupportedOptions()` Accessor for the supported options in string form.
`ValueGenerationManager`	`getValueGenerationManager()` Accessor for the ValueGenerationManager for obtaining sequences.
`boolean`	`hasProperty(String name)` Accessor for whether a particular property is defined (but may be null).
`boolean`	`isAutoCreateColumns()`
`boolean`	`isAutoCreateConstraints()`
`boolean`	`isAutoCreateTables()`
`boolean`	`isJdbcStore()` Returns whether the datastore is a "JDBC datastore".
`boolean`	`isStrategyDatastoreAttributed(AbstractClassMetaData cmd, int absFieldNumber)` Convenience method to return whether the strategy used by the specified class/member is generated by the datastore (during a persist).
`boolean`	`isValidateColumns()`
`boolean`	`isValidateConstraints()`
`boolean`	`isValidateTables()`
`protected void`	`logConfiguration()` Convenience method to log the configuration of this store manager.
`String`	`manageClassForIdentity(Object id, ClassLoaderResolver clr)` Convenience method to ensure that the class defined by the passed OID/SingleFIeldIdentity is managed by the store.
`boolean`	`managesClass(String className)` Accessor for whether the specified class is managed currently
`protected StoreData`	`newStoreData(ClassMetaData cmd, ClassLoaderResolver clr)` Instantiate a StoreData instance using the provided ClassMetaData and ClassLoaderResolver.
`void`	`printInformation(String category, PrintStream ps)` Method to output the information about the StoreManager.
`protected void`	`registerConnectionFactory()` Register the Connection Factory defined in plugins
`protected void`	`registerConnectionMgr()` Register the default ConnectionManager implementation
`protected void`	`registerStoreData(StoreData data)` Method to register some data with the store.
`void`	`removeAllClasses(ClassLoaderResolver clr)` Remove all classes from the persistence model for the datastore.
`boolean`	`supportsQueryLanguage(String language)` Accessor for whether this query language is supported.
`boolean`	`supportsValueStrategy(String strategy)` Accessor for whether this value strategy is supported.
`void`	`transactionCommitted(ExecutionContext ec)` Method to inform the StoreManager that a transaction has committed for the specified execution context.
`void`	`transactionRolledBack(ExecutionContext ec)` Method to inform the StoreManager that a transaction has rolled back for the specified execution context.
`void`	`transactionStarted(ExecutionContext ec)` Method to inform the StoreManager that a transaction has started for the specified execution context.
`boolean`	`useBackedSCOWrapperForMember(AbstractMemberMetaData mmd, ExecutionContext ec)` Method to return whether the specified member should use a backed SCO wrapper.
`boolean`	`usesBackedSCOWrappers()`

Methods inherited from class org.datanucleus.properties.PropertyStore
hasPropertyNotNull, setPropertyInternal

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOCALISER
```
protected static final Localiser LOCALISER
```
    Localiser for messages.
  - storeManagerKey
```
protected final String storeManagerKey
```
    Key for this StoreManager e.g "rdbms", "db4o"
  - readOnlyDatastore
```
protected final boolean readOnlyDatastore
```
    Whether this datastore is read only.
  - fixedDatastore
```
protected final boolean fixedDatastore
```
    Whether this datastore is fixed (no mods to table structure allowed).
  - autoCreateTables
```
protected final boolean autoCreateTables
```
    Whether to auto create any tables.
  - autoCreateColumns
```
protected final boolean autoCreateColumns
```
    Whether to auto create any columns that are missing.
  - autoCreateConstraints
```
protected final boolean autoCreateConstraints
```
    Whether to auto create any constraints
  - autoCreateWarnOnError
```
protected final boolean autoCreateWarnOnError
```
    Whether to warn only when any errors occur on auto-create.
  - validateTables
```
protected final boolean validateTables
```
    Whether to validate any tables
  - validateColumns
```
protected final boolean validateColumns
```
    Whether to validate any columns
  - validateConstraints
```
protected final boolean validateConstraints
```
    Whether to validate any constraints
  - nucleusContext
```
protected final NucleusContext nucleusContext
```
    Nucleus Context.
  - storeDataMgr
```
protected StoreDataManager storeDataMgr
```
    Manager for the data definition in the datastore.
  - persistenceHandler
```
protected StorePersistenceHandler persistenceHandler
```
    Persistence handler.
  - flushProcess
```
protected FlushProcess flushProcess
```
    The flush process appropriate for this datastore.
  - schemaHandler
```
protected StoreSchemaHandler schemaHandler
```
    Schema handler.
  - namingFactory
```
protected NamingFactory namingFactory
```
    Naming factory.
  - connectionMgr
```
protected ConnectionManager connectionMgr
```
    ConnectionManager
  - primaryConnectionFactoryName
```
protected String primaryConnectionFactoryName
```
    Name of primary connection factory.
  - secondaryConnectionFactoryName
```
protected String secondaryConnectionFactoryName
```
    Name of secondary connection factory (null if not present). Typically for schema/sequences etc.
- Constructor Detail
  - AbstractStoreManager
```
protected AbstractStoreManager(String key,
                    ClassLoaderResolver clr,
                    NucleusContext nucleusContext,
                    Map<String,Object> props)
```
    Constructor for a new StoreManager. Stores the basic information required for the datastore management.
    
    Parameters:
    key - Key for this StoreManager
    clr - the ClassLoaderResolver
    nucleusContext - The corresponding nucleus context.
    props - Any properties controlling this datastore
- Method Detail
  - registerConnectionMgr
```
protected void registerConnectionMgr()
```
    Register the default ConnectionManager implementation
  - registerConnectionFactory
```
protected void registerConnectionFactory()
```
    Register the Connection Factory defined in plugins
  - close
```
public void close()
```
    Description copied from interface: StoreManager
    
    Release of resources.
    
    Specified by:
    
    close in interface StoreManager
  - getConnectionManager
```
public ConnectionManager getConnectionManager()
```
    Description copied from interface: StoreManager
    
    Accessor for the connection manager for this store manager.
    
    Specified by:
    
    getConnectionManager in interface StoreManager
    
    Returns:
    connection manager
  - getConnection
```
public ManagedConnection getConnection(ExecutionContext ec)
```
    Accessor for a connection for the specified ExecutionContext. If there is an active transaction, a connection from the primary DataSource will be returned. If there is no active transaction, a connection from the secondary DataSource will be returned.
    
    Specified by:
    
    getConnection in interface StoreManager
    
    Parameters:
    ec - ExecutionContext
    
    Returns:
    The Connection
    
    Throws:
    
    NucleusException - Thrown if an error occurs getting the connection
  - getConnection
```
public ManagedConnection getConnection(ExecutionContext ec,
                              Map options)
```
    Accessor for a connection for the specified ExecutionContext. If there is an active transaction, a connection from the primary DataSource will be returned. If there is no active transaction, a connection from the secondary DataSource will be returned.
    
    Specified by:
    
    getConnection in interface StoreManager
    
    Parameters:
    ec - ExecutionContext
    options - Any options for the connection
    
    Returns:
    The Connection
    
    Throws:
    
    NucleusException - Thrown if an error occurs getting the connection
  - getConnection
```
public ManagedConnection getConnection(int isolation_level)
```
    Utility to return a managed connection not tied to any ExecutionContext. This returns a connection from the secondary DataSource (e.g. javax.jdo.option.connectionFactory2Name), if it is provided. Typically called for getting a connection for use with schema operations, or for accessing sequences.
    
    Parameters:
    isolation_level - The transaction isolation scheme to use e.g Connection.TRANSACTION_NONE Pass in -1 if just want the default
    
    Returns:
    The Connection to the datastore
    
    Throws:
    
    NucleusException - if an error occurs getting the connection
  - getConnectionDriverName
```
public String getConnectionDriverName()
```
    Convenience accessor for the driver name to use for the connection (if applicable for this datastore).
    
    Specified by:
    
    getConnectionDriverName in interface StoreManager
    
    Returns:
    Driver name for the connection
  - getConnectionURL
```
public String getConnectionURL()
```
    Convenience accessor for the URL for the connection
    
    Specified by:
    
    getConnectionURL in interface StoreManager
    
    Returns:
    Connection URL
  - getConnectionUserName
```
public String getConnectionUserName()
```
    Convenience accessor for the username to use for the connection
    
    Specified by:
    
    getConnectionUserName in interface StoreManager
    
    Returns:
    Username
  - getConnectionPassword
```
public String getConnectionPassword()
```
    Convenience accessor for the password to use for the connection. Will perform decryption if the persistence property "datanucleus.ConnectionPasswordDecrypter" has also been specified.
    
    Specified by:
    
    getConnectionPassword in interface StoreManager
    
    Returns:
    Password
  - getConnectionFactory
```
public Object getConnectionFactory()
```
    Convenience accessor for the factory for the connection (transactional).
    
    Specified by:
    
    getConnectionFactory in interface StoreManager
    
    Returns:
    Connection Factory (transactional)
  - getConnectionFactoryName
```
public String getConnectionFactoryName()
```
    Convenience accessor for the factory name for the connection (transactional).
    
    Specified by:
    
    getConnectionFactoryName in interface StoreManager
    
    Returns:
    Connection Factory name (transactional)
  - getConnectionFactory2
```
public Object getConnectionFactory2()
```
    Convenience accessor for the factory for the connection (non-transactional).
    
    Specified by:
    
    getConnectionFactory2 in interface StoreManager
    
    Returns:
    Connection Factory (non-transactional)
  - getConnectionFactory2Name
```
public String getConnectionFactory2Name()
```
    Convenience accessor for the factory name for the connection (non-transactional).
    
    Specified by:
    
    getConnectionFactory2Name in interface StoreManager
    
    Returns:
    Connection Factory name (non-transactional)
  - isAutoCreateTables
```
public boolean isAutoCreateTables()
```
    Specified by:
    
    isAutoCreateTables in interface StoreManager
  - isAutoCreateColumns
```
public boolean isAutoCreateColumns()
```
    Specified by:
    
    isAutoCreateColumns in interface StoreManager
  - isAutoCreateConstraints
```
public boolean isAutoCreateConstraints()
```
    Specified by:
    
    isAutoCreateConstraints in interface StoreManager
  - isValidateTables
```
public boolean isValidateTables()
```
  - isValidateColumns
```
public boolean isValidateColumns()
```
  - isValidateConstraints
```
public boolean isValidateConstraints()
```
  - isJdbcStore
```
public boolean isJdbcStore()
```
    Description copied from interface: StoreManager
    
    Returns whether the datastore is a "JDBC datastore". If it is then the JDO spec needs to return a connection that implements java.sql.Connection. RDBMS is the only one that will return true from here (or certainly as we can foresee now).
    
    Specified by:
    
    isJdbcStore in interface StoreManager
    
    Returns:
    Whether this is a JDBC datastore
  - getPersistenceHandler
```
public StorePersistenceHandler getPersistenceHandler()
```
    Description copied from interface: StoreManager
    
    Accessor for the store persistence handler.
    
    Specified by:
    
    getPersistenceHandler in interface StoreManager
    
    Returns:
    Store persistence handler.
  - getFlushProcess
```
public FlushProcess getFlushProcess()
```
    Description copied from interface: StoreManager
    
    Accessor for the flush process to use with this datastore.
    
    Specified by:
    
    getFlushProcess in interface StoreManager
    
    Returns:
    The flush process
  - getQueryManager
```
public QueryManager getQueryManager()
```
    Description copied from interface: StoreManager
    
    Accessor for the query manager for this datastore.
    
    Specified by:
    
    getQueryManager in interface StoreManager
    
    Returns:
    Query Manager for this store
  - getSchemaHandler
```
public StoreSchemaHandler getSchemaHandler()
```
    Description copied from interface: StoreManager
    
    Accessor for the store schema handler (if this datastore supports the concept of a schema).
    
    Specified by:
    
    getSchemaHandler in interface StoreManager
    
    Returns:
    Store schema handler.
  - getNamingFactory
```
public NamingFactory getNamingFactory()
```
    Description copied from interface: StoreManager
    
    Accessor for the schema naming factory.
    
    Specified by:
    
    getNamingFactory in interface StoreManager
    
    Returns:
    Naming factory.
  - getNucleusSequence
```
public NucleusSequence getNucleusSequence(ExecutionContext ec,
                                 SequenceMetaData seqmd)
```
    Method to return a datastore sequence for this datastore matching the passed sequence MetaData.
    
    Specified by:
    
    getNucleusSequence in interface StoreManager
    
    Parameters:
    ec - execution context
    seqmd - SequenceMetaData
    
    Returns:
    The Sequence
  - getNucleusConnection
```
public NucleusConnection getNucleusConnection(ExecutionContext ec)
```
    Description copied from interface: StoreManager
    
    Method to return a connection to the user for the ExecutionContext. Typically provides a wrapper to the currently in-use ManagedConnection.
    
    Specified by:
    
    getNucleusConnection in interface StoreManager
    
    Parameters:
    ec - execution context
    
    Returns:
    The datastore Connection
  - getValueGenerationManager
```
public ValueGenerationManager getValueGenerationManager()
```
    Description copied from interface: StoreManager
    
    Accessor for the ValueGenerationManager for obtaining sequences.
    
    Specified by:
    
    getValueGenerationManager in interface StoreManager
    
    Returns:
    The ValueGenerationManagerr for this datastore
  - getApiAdapter
```
public ApiAdapter getApiAdapter()
```
    Description copied from interface: StoreManager
    
    Accessor for the API adapter.
    
    Specified by:
    
    getApiAdapter in interface StoreManager
    
    Returns:
    API adapter
  - getStoreManagerKey
```
public String getStoreManagerKey()
```
    Description copied from interface: StoreManager
    
    Accessor for the key for this store manager.
    
    Specified by:
    
    getStoreManagerKey in interface StoreManager
    
    Returns:
    StoreManager key
  - getQueryCacheKey
```
public String getQueryCacheKey()
```
    Description copied from interface: StoreManager
    
    Accessor for the key used for representing this store manager in the query cache.
    
    Specified by:
    
    getQueryCacheKey in interface StoreManager
    
    Returns:
    Key for the query cache
  - getNucleusContext
```
public NucleusContext getNucleusContext()
```
    Description copied from interface: StoreManager
    
    Accessor for the context in which this StoreManager is running
    
    Specified by:
    
    getNucleusContext in interface StoreManager
    
    Returns:
    Returns the context.
  - getMetaDataManager
```
public MetaDataManager getMetaDataManager()
```
  - getDatastoreDate
```
public Date getDatastoreDate()
```
    Description copied from interface: StoreManager
    
    Get the date/time of the datastore.
    
    Specified by:
    
    getDatastoreDate in interface StoreManager
    
    Returns:
    Date/time of the datastore
  - registerStoreData
```
protected void registerStoreData(StoreData data)
```
    Method to register some data with the store. This will also register the data with the starter process.
    
    Parameters:
    data - The StoreData to add
  - deregisterAllStoreData
```
protected void deregisterAllStoreData()
```
    Method to deregister all existing store data so that we are managing nothing.
  - logConfiguration
```
protected void logConfiguration()
```
    Convenience method to log the configuration of this store manager.
  - printInformation
```
public void printInformation(String category,
                    PrintStream ps)
                      throws Exception
```
    Method to output the information about the StoreManager. Supports the category "DATASTORE".
    
    Specified by:
    
    printInformation in interface StoreManager
    
    Parameters:
    category - Category of information
    ps - PrintStream
    
    Throws:
    
    Exception - Thrown if an error occurs in the output process
  - managesClass
```
public boolean managesClass(String className)
```
    Description copied from interface: StoreManager
    
    Accessor for whether the specified class is managed currently
    
    Specified by:
    
    managesClass in interface StoreManager
    
    Parameters:
    className - The name of the class
    
    Returns:
    Whether it is managed
  - addClass
```
public void addClass(String className,
            ClassLoaderResolver clr)
```
    Description copied from interface: StoreManager
    
    Method to add a class to the managed list for this datastore manager.
    
    Specified by:
    
    addClass in interface StoreManager
    
    Parameters:
    className - Name of the class
    clr - The ClassLoaderResolver
  - addClasses
```
public void addClasses(String[] classNames,
              ClassLoaderResolver clr)
```
    Description copied from interface: StoreManager
    
    Add classes to the persistence model for the datastore.
    This method is primarily useful for applications that wish to perform all of their datastore initialization up front, rather than wait for the runtime to do it on-demand.
    
    Specified by:
    
    addClasses in interface StoreManager
    
    Parameters:
    classNames - The class(es) to be added.
    clr - The ClassLoaderResolver
  - newStoreData
```
protected StoreData newStoreData(ClassMetaData cmd,
                     ClassLoaderResolver clr)
```
    Instantiate a StoreData instance using the provided ClassMetaData and ClassLoaderResolver. Override this method if you want to instantiate a subclass of StoreData.
    
    Parameters:
    cmd - MetaData for the class
    clr - ClassLoader resolver
  - removeAllClasses
```
public void removeAllClasses(ClassLoaderResolver clr)
```
    Description copied from interface: StoreManager
    
    Remove all classes from the persistence model for the datastore. This empties the datastore of all datastore objects managed by us. All objects of types not managed are left untouched. In the case of RDBMS this means drop all tables for types managed by us.
    
    Specified by:
    
    removeAllClasses in interface StoreManager
    
    Parameters:
    clr - The ClassLoaderResolver
  - manageClassForIdentity
```
public String manageClassForIdentity(Object id,
                            ClassLoaderResolver clr)
```
    Description copied from interface: StoreManager
    
    Convenience method to ensure that the class defined by the passed OID/SingleFIeldIdentity is managed by the store.
    
    Specified by:
    
    manageClassForIdentity in interface StoreManager
    
    Parameters:
    id - OID
    clr - ClassLoader resolver
    
    Returns:
    The class name of the class associated to this identity
  - getExtent
```
public Extent getExtent(ExecutionContext ec,
               Class c,
               boolean subclasses)
```
    Description copied from interface: StoreManager
    
    Interface to getting an Extent for a class.
    
    Specified by:
    
    getExtent in interface StoreManager
    
    Parameters:
    ec - execution context
    c - The class requiring the Extent
    subclasses - Whether to include subclasses of 'c'
    
    Returns:
    The Extent.
  - supportsQueryLanguage
```
public boolean supportsQueryLanguage(String language)
```
    Description copied from interface: StoreManager
    
    Accessor for whether this query language is supported.
    
    Specified by:
    
    supportsQueryLanguage in interface StoreManager
    
    Parameters:
    language - The language
    
    Returns:
    Whether it is supported.
  - supportsValueStrategy
```
public boolean supportsValueStrategy(String strategy)
```
    Accessor for whether this value strategy is supported.
    
    Specified by:
    
    supportsValueStrategy in interface StoreManager
    
    Parameters:
    strategy - The strategy
    
    Returns:
    Whether it is supported.
  - getClassNameForObjectID
```
public String getClassNameForObjectID(Object id,
                             ClassLoaderResolver clr,
                             ExecutionContext ec)
```
    Description copied from interface: StoreManager
    
    Returns the class corresponding to the given object identity. If the object is an OID (datastore-identity), return the PC class specified in the identity. If the object is SingleFieldIdentity, return the PC class specified in the identity If the object is an AppID PK, return the PC class that uses it. If the object is a SCOID, return the SCO class. If the object is a persistable class, return the class.
    
    Specified by:
    
    getClassNameForObjectID in interface StoreManager
    
    Parameters:
    id - The identity of some object.
    clr - ClassLoader resolver
    ec - execution context
    
    Returns:
    For datastore identity, return the class of the corresponding object. For application identity, return the class of the corresponding object or null if object does not exist.
  - isStrategyDatastoreAttributed
```
public boolean isStrategyDatastoreAttributed(AbstractClassMetaData cmd,
                                    int absFieldNumber)
```
    Convenience method to return whether the strategy used by the specified class/member is generated by the datastore (during a persist).
    
    Specified by:
    
    isStrategyDatastoreAttributed in interface StoreManager
    
    Parameters:
    cmd - Metadata for the class
    absFieldNumber - Absolute field number for the field (or -1 if datastore id)
    
    Returns:
    Whether the strategy is generated in the datastore
  - getStrategyValue
```
public Object getStrategyValue(ExecutionContext ec,
                      AbstractClassMetaData cmd,
                      int absoluteFieldNumber)
```
    Description copied from interface: StoreManager
    
    Method to retrieve the value for a strategy for a particular field.
    
    Specified by:
    
    getStrategyValue in interface StoreManager
    
    Parameters:
    ec - execution context
    cmd - AbstractClassMetaData for the class
    absoluteFieldNumber - The field number
    
    Returns:
    The value
  - getStrategyForNative
```
protected String getStrategyForNative(AbstractClassMetaData cmd,
                          int absFieldNumber)
```
    Method defining which value-strategy to use when the user specifies "native". This will return as follows
    - If your field is Numeric-based (or datastore-id with numeric or no jdbc-type) then chooses the first one that is supported of "identity", "sequence", "increment", otherwise exception.
    - Otherwise your field is String-based then chooses "uuid-hex".
    If your store plugin requires something else then override this
    Parameters:
    cmd - Class requiring the strategy
    absFieldNumber - Field of the class
    
    Returns:
    The strategy used when "native" is specified
  - getStrategyValueForGenerator
```
protected Object getStrategyValueForGenerator(ValueGenerator generator,
                                  ExecutionContext ec)
```
    Accessor for the next value from the specified generator. This implementation simply returns generator.next(). Any case where the generator requires datastore connections should override this method.
    
    Parameters:
    generator - The generator
    ec - execution context
    
    Returns:
    The next value.
  - getPropertiesForGenerator
```
protected Properties getPropertiesForGenerator(AbstractClassMetaData cmd,
                                   int absoluteFieldNumber,
                                   ExecutionContext ec,
                                   SequenceMetaData seqmd,
                                   TableGeneratorMetaData tablegenmd)
```
    Method to return the properties to pass to the generator for the specified field. Will define the following properties "class-name", "root-class-name", "field-name" (if for a field), "sequence-name", "key-initial-value", "key-cache-size", "sequence-table-name", "sequence-schema-name", "sequence-catalog-name", "sequence-name-column-name", "sequence-nextval-column-name". In addition any extension properties on the respective field or datastore-identity are also passed through as properties.
    
    Parameters:
    cmd - MetaData for the class
    absoluteFieldNumber - Number of the field (-1 = datastore identity)
    ec - execution context
    seqmd - Any sequence metadata
    tablegenmd - Any table generator metadata
    
    Returns:
    The properties to use for this field
  - getSubClassesForClass
```
public Collection<String> getSubClassesForClass(String className,
                                       boolean includeDescendents,
                                       ClassLoaderResolver clr)
```
    Description copied from interface: StoreManager
    
    Utility to return the names of the classes that are known subclasses of the provided class. Actually uses the MetaDataManager for determining what is a subclass since the MetaData is often registered before being needed by the Store.
    
    Specified by:
    
    getSubClassesForClass in interface StoreManager
    
    Parameters:
    className - Class for which we search for subclasses.
    includeDescendents - Whether to include subclasses of subclasses etc
    clr - The ClassLoaderResolver
    
    Returns:
    Set of classes that are subclasses of the input class. TODO Use method in MetaDataManager and remove this
  - getSupportedOptions
```
public Collection<String> getSupportedOptions()
```
    Accessor for the supported options in string form. Typical values specified here are :-
    - ApplicationIdentity - if the datastore supports application identity
    - DatastoreIdentity - if the datastore supports datastore identity
    - ORM - if the datastore supports (some) ORM concepts
    - TransactionIsolationLevel.read-committed - if supporting this txn isolation level
    - TransactionIsolationLevel.read-uncommitted - if supporting this txn isolation level
    - TransactionIsolationLevel.repeatable-read - if supporting this txn isolation level
    - TransactionIsolationLevel.serializable - if supporting this txn isolation level
    - TransactionIsolationLevel.snapshot - if supporting this txn isolation level
    - Query.Cancel - if supporting cancelling of queries
    - Query.Timeout - if supporting timeout of queries
    Specified by:
    
    getSupportedOptions in interface StoreManager
  - hasProperty
```
public boolean hasProperty(String name)
```
    Description copied from class: PropertyStore
    
    Accessor for whether a particular property is defined (but may be null).
    
    Specified by:
    
    hasProperty in interface StoreManager
    
    Overrides:
    
    hasProperty in class PropertyStore
    
    Parameters:
    name - Property name
    
    Returns:
    Whether the property is defined
  - getProperty
```
public Object getProperty(String name)
```
    Description copied from class: PropertyStore
    
    Method to get the value of a property from the store.
    
    Specified by:
    
    getProperty in interface StoreManager
    
    Overrides:
    
    getProperty in class PropertyStore
    
    Parameters:
    name - Name of the property
    
    Returns:
    Its value (or null)
  - getIntProperty
```
public int getIntProperty(String name)
```
    Description copied from class: PropertyStore
    
    Accessor for the specified property as an int. If the specified property isn't found returns 0.
    
    Specified by:
    
    getIntProperty in interface StoreManager
    
    Overrides:
    
    getIntProperty in class PropertyStore
    
    Parameters:
    name - Name of the property
    
    Returns:
    Int value for the property
  - getStringProperty
```
public String getStringProperty(String name)
```
    Description copied from class: PropertyStore
    
    Accessor for the specified property as a String. If the specified property isn't found returns null.
    
    Specified by:
    
    getStringProperty in interface StoreManager
    
    Overrides:
    
    getStringProperty in class PropertyStore
    
    Parameters:
    name - Name of the property
    
    Returns:
    String value for the property
  - getBooleanProperty
```
public boolean getBooleanProperty(String name)
```
    Description copied from class: PropertyStore
    
    Accessor for the specified property as a boolean. If the specified property isn't found returns false.
    
    Specified by:
    
    getBooleanProperty in interface StoreManager
    
    Overrides:
    
    getBooleanProperty in class PropertyStore
    
    Parameters:
    name - Name of the property
    
    Returns:
    Boolean value for the property
  - getBooleanProperty
```
public boolean getBooleanProperty(String name,
                         boolean resultIfNotSet)
```
    Description copied from class: PropertyStore
    
    Accessor for the specified property as a boolean.
    
    Specified by:
    
    getBooleanProperty in interface StoreManager
    
    Overrides:
    
    getBooleanProperty in class PropertyStore
    
    Parameters:
    name - Name of the property
    resultIfNotSet - The value to return if no value for the specified property is found.
    
    Returns:
    Boolean value for the property
  - getBooleanObjectProperty
```
public Boolean getBooleanObjectProperty(String name)
```
    Description copied from class: PropertyStore
    
    Accessor for the specified property as a Boolean. If the specified property isn't found returns false.
    
    Specified by:
    
    getBooleanObjectProperty in interface StoreManager
    
    Overrides:
    
    getBooleanObjectProperty in class PropertyStore
    
    Parameters:
    name - Name of the property
    
    Returns:
    Boolean value for the property (or null if not present)
  - transactionStarted
```
public void transactionStarted(ExecutionContext ec)
```
    Description copied from interface: StoreManager
    
    Method to inform the StoreManager that a transaction has started for the specified execution context. This allows the StoreManager to initialise any objects as required.
    
    Specified by:
    
    transactionStarted in interface StoreManager
    
    Parameters:
    ec - ExecutionContext
  - transactionCommitted
```
public void transactionCommitted(ExecutionContext ec)
```
    Description copied from interface: StoreManager
    
    Method to inform the StoreManager that a transaction has committed for the specified execution context. This allows the StoreManager to close any objects as required.
    
    Specified by:
    
    transactionCommitted in interface StoreManager
    
    Parameters:
    ec - ExecutionContext
  - transactionRolledBack
```
public void transactionRolledBack(ExecutionContext ec)
```
    Description copied from interface: StoreManager
    
    Method to inform the StoreManager that a transaction has rolled back for the specified execution context. This allows the StoreManager to close any objects as required.
    
    Specified by:
    
    transactionRolledBack in interface StoreManager
    
    Parameters:
    ec - ExecutionContext
  - usesBackedSCOWrappers
```
public boolean usesBackedSCOWrappers()
```
  - useBackedSCOWrapperForMember
```
public boolean useBackedSCOWrapperForMember(AbstractMemberMetaData mmd,
                                   ExecutionContext ec)
```
    Description copied from interface: StoreManager
    
    Method to return whether the specified member should use a backed SCO wrapper.
    
    Specified by:
    
    useBackedSCOWrapperForMember in interface StoreManager
    
    Parameters:
    mmd - Metadata for the member
    ec - ExecutionContext
    
    Returns:
    Whether to use a back SCO wrapper (false means use a simple SCO wrapper).
  - getDefaultObjectProviderClassName
```
public String getDefaultObjectProviderClassName()
```
    Specified by:
    
    getDefaultObjectProviderClassName in interface StoreManager

Class AbstractStoreManager

Field Summary

Fields inherited from class org.datanucleus.properties.PropertyStore

Constructor Summary

Method Summary

Methods inherited from class org.datanucleus.properties.PropertyStore

Methods inherited from class java.lang.Object

Field Detail

LOCALISER

storeManagerKey

readOnlyDatastore

fixedDatastore

autoCreateTables

autoCreateColumns

autoCreateConstraints

autoCreateWarnOnError

validateTables

validateColumns

validateConstraints

nucleusContext

storeDataMgr

persistenceHandler

flushProcess

schemaHandler

namingFactory

connectionMgr

primaryConnectionFactoryName

secondaryConnectionFactoryName

Constructor Detail

AbstractStoreManager

Method Detail

registerConnectionMgr

registerConnectionFactory

close

getConnectionManager

getConnection

getConnection

getConnection

getConnectionDriverName

getConnectionURL

getConnectionUserName

getConnectionPassword

getConnectionFactory

getConnectionFactoryName

getConnectionFactory2

getConnectionFactory2Name

isAutoCreateTables

isAutoCreateColumns

isAutoCreateConstraints

isValidateTables

isValidateColumns

isValidateConstraints

isJdbcStore

getPersistenceHandler

getFlushProcess

getQueryManager

getSchemaHandler

getNamingFactory

getNucleusSequence

getNucleusConnection

getValueGenerationManager

getApiAdapter

getStoreManagerKey

getQueryCacheKey

getNucleusContext

getMetaDataManager

getDatastoreDate

registerStoreData

deregisterAllStoreData

logConfiguration

printInformation

managesClass

addClass

addClasses

newStoreData

removeAllClasses

manageClassForIdentity

getExtent

supportsQueryLanguage

supportsValueStrategy