HyperonPersistenceFactory (pl.decerto:hyperon-persistence 1.12.2 API)

java.lang.Object
- pl.decerto.hyperon.persistence.factory.HyperonPersistenceFactory

```
public class HyperonPersistenceFactory
extends Object
```
This class is responsible for configuring Hyperon Persistence Engine. Before any interaction with it, everything should be setup here. There are few things to setup:
1. dataSource - main application (probably) separate data source with mapped tables, that matches BundleDef. This field is mandatory.
2. hyperonDataSource - additional data source with Hyperon tables.
3. identifierGenerator - if not provided, we will create it for you with default name "gmo_sequence" and alloc pool of 100.
4. bundleCache - it is possible to provide custom cache or use embedded, provided engine.
5. global watcher config - for cache management.
6. basic bundle tables definition, like name, column owner etc.
Engine supports different dialects for Hyperon Persistence dataSource and Hyperon dataSource. It means that, application might be connected to MSSQL and Hyperon Studio on Oracle. By default, Oracle dialect is used.
Example - simple config:
```
 HyperonPersistenceFactory factory = new HyperonPersistenceFactory();
 factory.setHyperonDataSource(hyperonDataSource());
 factory.setDataSource(applicationDataSource());
 
```
With this config, default data will be used as follows:
- autoStartWatchers - false
- sandboxWatcherStartDelay - 10 [seconds]
- sandboxWatcherPause - 3 [seconds]
- sandboxWatcherErrorPause - 60 [seconds]
- defaultProfile - "primary"
- gmoDbDialect - "oracle"
- hiloSequenceName - "gmo_sequence"
- hiloAllocationSize - 100
- cacheName - "gmo"
Example - more common:
```
 HyperonPersistenceFactory factory = new HyperonPersistenceFactory();
 factory.setHyperonDataSource(hyperonDataSource());
 factory.setDataSource(applicationDataSource());
 factory.setAutoStartWatchers(false);
 factory.setDefaultProfile("CUSTOM_PROFILE");
 factory.setGmoDbDialect("mssql2012");
 factory.setHiloSequenceName("persistence_seq");
 factory.setBundleTable("persistence_bundle");
 factory.setBundleColumn("bid");
 factory.setOwnerColumn("parentid");
 factory.setOwnerPropertyColumn("collname");
 
```
Author:

przemek hertel

See Also:

create(), IdentifierDao, IdentifierGenerator, DynamicDao, HyperonPersistenceRuntimeWatcher

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_CACHE_NAME`
`static int`	`DEFAULT_HILO_ALLOC`
`static String`	`DEFAULT_HILO_SEQUENCE`
`static String`	`DEFAULT_PROFILE_NAME`

Constructor Summary

Constructors
Constructor and Description

HyperonPersistenceFactory()

Constructors
Constructor and Description
`HyperonPersistenceFactory()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`BundleService`	`create()` Creates `BundleService` instance based on provided configuration.
`void`	`destroy()` Right now it will just stop watchers.
`BundleCache`	`getCache()` Deprecated. this method might be removed in the future.
`GmoCacheManager`	`getCacheManager()` Get Hyperon Persistence cache manager.
`DaoConfig`	`getConf()` Deprecated. this method might be removed in the future.
`DynamicDao`	`getDao()` Deprecated. this method might be removed in the future.
`String`	`getDefaultProfile()` Gets default profile, used within Hyperon Persistence engine.
`DynamicDao`	`getDynamicDao()` Deprecated. this method might be removed in the future, should not be used outside Hyperon-Persistence.
`String`	`getGmoDbDialect()` Gets separate dialect for Hyperon Persistence engine.
`GmoSandboxLoader`	`getGmoSandboxLoader()` Deprecated. this method might be removed in the future.
`HyperonPersistenceRuntimeWatcher`	`getHyperonPersistenceWatcher()` Gets Hyperon Persistence engine watcher.
`IdentifierGenerator`	`getIdentifierGenerator()` Deprecated. This method might be removed in the future.
`GmoSandboxDao`	`getSandboxDao()` Deprecated. Will be removed in the future.
`void`	`setAutoStartWatchers(boolean autoStartWatchers)` Setup flag, that controls watcher on `create()`.
`void`	`setBundleColumn(String bundleColumn)` Setup column name for bundle reference (foreign key to bundle id).
`void`	`setBundleTable(String bundleTable)` Setup bundle table name.
`void`	`setCache(BundleCache cache)` Setup custom cache for bundle storage, that is used within `BundleService` implementation for boosting performance.
`void`	`setCacheName(String cacheName)` Setup custom cache name for `BundleCache` implementation, for cache manager (if there is any).
`void`	`setDatabaseFetchStatsCache(DatabaseFetchStatsCache statsCache)` Setup custom cache for database fetch statistic storage, that is used within `BundleService`.
`void`	`setDataSource(DataSource dataSource)` Setup `dataSource`, to which Hyperon Persistence engine should be connected to.
`void`	`setDefaultProfile(String defaultProfile)` Setup default profile for Hyperon Persistence engine.
`void`	`setGmoDbDialect(String gmoDbDialect)` Setup separate dialect for Hyperon Persistence engine from Hyperon Engine (runtime).
`void`	`setHiloAllocationSize(int hiloAllocationSize)` Setup allocation size for `identifierGenerator`.
`void`	`setHiloSequenceName(String hiloSequenceName)` Setup sequence name for `identifierGenerator`.
`void`	`setHyperonDataSource(DataSource hyperonDataSource)` Setup `hyperonDataSource`, to which Hyperon Persistence engine should be connected to.
`void`	`setIdentifierGenerator(IdentifierGenerator identifierGenerator)` Setup custom identifier generator, that will be used by Hyperon Persistence Engine.
`void`	`setOwnerColumn(String ownerColumn)` Setup column name owner/parent reference (foreign key to owner id).
`void`	`setOwnerPropertyColumn(String ownerPropertyColumn)` Setup column name, that will hold mapping to owner property name.
`void`	`setSandboxWatcherErrorPause(int sandboxWatcherErrorPause)` Setup sandbox watcher error pause in seconds.
`void`	`setSandboxWatcherPause(int sandboxWatcherPause)` Setup sandbox watcher pause in seconds.
`void`	`setSandboxWatcherStartDelay(int sandboxWatcherStartDelay)` Setup sandbox watcher start delay in seconds.
`void`	`setSchema(String schema)` Setup schema for `dataSource`.
`void`	`setUseColumnMetadataCache(boolean useColumnMetadataCache)` true if table metadata should be used, false otherwise
`void`	`startSandboxWatcher()` This method is called during BundleService creation `create()`, if `autoStartWatchers == true`.
`void`	`stopSandboxWatcher()` It will stop watcher, if `persistenceRuntimeWatcher` was defined.

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

- Field Detail
  - DEFAULT_HILO_SEQUENCE
```
public static final String DEFAULT_HILO_SEQUENCE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HILO_ALLOC
```
public static final int DEFAULT_HILO_ALLOC
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CACHE_NAME
```
public static final String DEFAULT_CACHE_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PROFILE_NAME
```
public static final String DEFAULT_PROFILE_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HyperonPersistenceFactory
```
public HyperonPersistenceFactory()
```
- Method Detail
  - create
```
public BundleService create()
```
    Creates BundleService instance based on provided configuration. The most important aspect is to setup dataSource with setDataSource(DataSource). Other fields are optional and BundleService will be created with default configuration. Before this method might be called, there is possibility to setup some custom configuration with provided setters in this class.
    
    Returns:
    
    ready to use bundle service instance
    
    Throws:
    
    HyperonPersistenceException - if dataSource is null
  - startSandboxWatcher
```
public void startSandboxWatcher()
```
    This method is called during BundleService creation create(), if autoStartWatchers == true. If not, then it can be invoked manually here.
    
    See Also:
    
    HyperonPersistenceRuntimeWatcher, WatcherConfig
  - stopSandboxWatcher
```
public void stopSandboxWatcher()
```
    It will stop watcher, if persistenceRuntimeWatcher was defined.
  - destroy
```
public void destroy()
```
    Right now it will just stop watchers.
    
    See Also:
    
    stopSandboxWatcher()
  - setDataSource
```
public void setDataSource(DataSource dataSource)
```
    Setup dataSource, to which Hyperon Persistence engine should be connected to. In most cases it will be separate application dataSource.
    
    Parameters:
    
    dataSource - application data source
  - setHyperonDataSource
```
public void setHyperonDataSource(DataSource hyperonDataSource)
```
    Setup hyperonDataSource, to which Hyperon Persistence engine should be connected to. If not provided, then during create(), the same dataSource will be used.
    
    Parameters:
    
    hyperonDataSource - Hyperon Studio data source
  - setHiloAllocationSize
```
public void setHiloAllocationSize(int hiloAllocationSize)
```
    Setup allocation size for identifierGenerator. If not provided, default will be used - 100
    
    Parameters:
    
    hiloAllocationSize - allocation size for identifier generator
  - setHiloSequenceName
```
public void setHiloSequenceName(String hiloSequenceName)
```
    Setup sequence name for identifierGenerator. If not provided, default will be used - "gmo_sequence"
    
    Parameters:
    
    hiloSequenceName - sequence name for identifier generator
  - setSchema
```
public void setSchema(String schema)
```
    Setup schema for dataSource. If not provided, no schema will be used in queries.
    
    Parameters:
    
    schema - for hyperon peristence engine used in queries
    
    See Also:
    
    DaoConfig.setSchema(String)
  - setBundleColumn
```
public void setBundleColumn(String bundleColumn)
```
    Setup column name for bundle reference (foreign key to bundle id). If not provided, default will be used - "bundle_id".
    
    Parameters:
    
    bundleColumn - column name referencing bundle
    
    See Also:
    
    DaoConfig.DEFAULT_BUNDLE_FK
  - setOwnerColumn
```
public void setOwnerColumn(String ownerColumn)
```
    Setup column name owner/parent reference (foreign key to owner id). If not provided, default will be used - "owner_id".
    
    Parameters:
    
    ownerColumn - column name referencing owner
    
    See Also:
    
    DaoConfig.DEFAULT_PARENT_FK
  - setOwnerPropertyColumn
```
public void setOwnerPropertyColumn(String ownerPropertyColumn)
```
    Setup column name, that will hold mapping to owner property name. If not provided, default will be used - "owner_prop".
    
    Parameters:
    
    ownerPropertyColumn - column name mapping for owner property
    
    See Also:
    
    DaoConfig.DEFAULT_PROP_COLUMN
  - setBundleTable
```
public void setBundleTable(String bundleTable)
```
    Setup bundle table name. If not provided, default will be used - "bundle".
    
    Parameters:
    
    bundleTable - bundle table name
    
    See Also:
    
    DaoConfig.DEFAULT_BUNDLE_TABLE
  - getSandboxDao
```
@Deprecated
public GmoSandboxDao getSandboxDao()
```
    Deprecated. Will be removed in the future.
    
    Returns:
    
    gmo sandbox dao
  - getIdentifierGenerator
```
@Deprecated
public IdentifierGenerator getIdentifierGenerator()
```
    Deprecated. This method might be removed in the future.
    
    Gets identifier generator used by Hyperon Persistence Engine. Probably, there will be no need for using this.
    
    Returns:
    
    id generator
  - setIdentifierGenerator
```
public void setIdentifierGenerator(IdentifierGenerator identifierGenerator)
```
    Setup custom identifier generator, that will be used by Hyperon Persistence Engine. If not provided, nested implementation HiLoSequenceGenerator will be used.
    
    Parameters:
    
    identifierGenerator - custom implementation of id generator
    
    See Also:
    
    IdentifierGenerator, HiLoSequenceGenerator
  - setCache
```
public void setCache(BundleCache cache)
```
    Setup custom cache for bundle storage, that is used within BundleService implementation for boosting performance.
    
    Parameters:
    
    cache - custom cache implementation
    
    See Also:
    
    BundleCache, EhcacheBundleCache, MapBundleCache
  - getCache
```
@Deprecated
public BundleCache getCache()
```
    Deprecated. this method might be removed in the future.
    
    Gets bundle cache.
    
    Returns:
    
    bundle cache
    
    See Also:
    
    GmoCacheManager
  - setCacheName
```
public void setCacheName(String cacheName)
```
    Setup custom cache name for BundleCache implementation, for cache manager (if there is any). By default, Hyperon Persistence engine uses EhcacheBundleCache with Ehcache implementation with default cache name - "gmo"
    
    Parameters:
    
    cacheName - cache name for cache manager
    
    See Also:
    
    BundleCache, EhcacheBundleCache
  - getDefaultProfile
```
public String getDefaultProfile()
```
    Gets default profile, used within Hyperon Persistence engine.
    
    Returns:
    
    default profile
  - setDefaultProfile
```
public void setDefaultProfile(String defaultProfile)
```
    Setup default profile for Hyperon Persistence engine. If not provided, default will be used - "primary"
    
    Parameters:
    
    defaultProfile - profile to be used
  - getConf
```
@Deprecated
public DaoConfig getConf()
```
    Deprecated. this method might be removed in the future.
    
    Returns:
    
    dao config
  - setSandboxWatcherErrorPause
```
public void setSandboxWatcherErrorPause(int sandboxWatcherErrorPause)
```
    Setup sandbox watcher error pause in seconds. If not provided, default value will be used 60.
    
    Parameters:
    
    sandboxWatcherErrorPause - error pause in seconds
  - setSandboxWatcherPause
```
public void setSandboxWatcherPause(int sandboxWatcherPause)
```
    Setup sandbox watcher pause in seconds. If not provided, default value will be used 3.
    
    Parameters:
    
    sandboxWatcherPause - watcher pause in seconds
  - setSandboxWatcherStartDelay
```
public void setSandboxWatcherStartDelay(int sandboxWatcherStartDelay)
```
    Setup sandbox watcher start delay in seconds. If not provided, default value will be used 10.
    
    Parameters:
    
    sandboxWatcherStartDelay - start delay of watcher
  - getCacheManager
```
public GmoCacheManager getCacheManager()
```
    Get Hyperon Persistence cache manager.
    
    Returns:
    
    cache manager
  - getDao
```
@Deprecated
public DynamicDao getDao()
```
    Deprecated. this method might be removed in the future.
    
    Returns:
    
    dynamic dao
  - getGmoSandboxLoader
```
@Deprecated
public GmoSandboxLoader getGmoSandboxLoader()
```
    Deprecated. this method might be removed in the future.
    
    Returns:
    
    Hyperon persistence context service
  - setAutoStartWatchers
```
public void setAutoStartWatchers(boolean autoStartWatchers)
```
    Setup flag, that controls watcher on create(). If true, then watcher will start. If false (default), then watcher won't start. Watcher can be manually started using startSandboxWatcher()
    
    Parameters:
    
    autoStartWatchers - control flag
  - getHyperonPersistenceWatcher
```
public HyperonPersistenceRuntimeWatcher getHyperonPersistenceWatcher()
```
    Gets Hyperon Persistence engine watcher.
    
    Returns:
    
    watcher
  - getGmoDbDialect
```
public String getGmoDbDialect()
```
    Gets separate dialect for Hyperon Persistence engine.
    
    Returns:
    
    supported dialect
  - setGmoDbDialect
```
public void setGmoDbDialect(String gmoDbDialect)
```
    Setup separate dialect for Hyperon Persistence engine from Hyperon Engine (runtime). Allowed dialects are:
    - oracle
    - hsqldb
    - h2
    - mssql2012
    - postgresql
    If gmoDbDialect is not setup, then default dialect is used for queries - oracle.
    Parameters:
    
    gmoDbDialect - supported dialect
    
    See Also:
    
    IdentifierDao
  - setDatabaseFetchStatsCache
```
public void setDatabaseFetchStatsCache(DatabaseFetchStatsCache statsCache)
```
    Setup custom cache for database fetch statistic storage, that is used within BundleService. DynamicDao, DynamicRowMapper. Cache is used to resolve specific SQL queries when bundle mappings are changed.
    
    Parameters:
    
    statsCache - custom cache implementation
    
    See Also:
    
    DatabaseFetchStatsSetCacheImpl, Bundle, BundleDef
  - getDynamicDao
```
@Deprecated
public DynamicDao getDynamicDao()
```
    Deprecated. this method might be removed in the future, should not be used outside Hyperon-Persistence.
    
    Returns:
    
    DAO with bundle CRUD methods
  - setUseColumnMetadataCache
```
public void setUseColumnMetadataCache(boolean useColumnMetadataCache)
```
    true if table metadata should be used, false otherwise

Class HyperonPersistenceFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_HILO_SEQUENCE

DEFAULT_HILO_ALLOC

DEFAULT_CACHE_NAME

DEFAULT_PROFILE_NAME

Constructor Detail

HyperonPersistenceFactory

Method Detail

create

startSandboxWatcher

stopSandboxWatcher

destroy

setDataSource

setHyperonDataSource

setHiloAllocationSize

setHiloSequenceName

setSchema

setBundleColumn

setOwnerColumn

setOwnerPropertyColumn

setBundleTable

getSandboxDao

getIdentifierGenerator

setIdentifierGenerator

setCache

getCache

setCacheName

getDefaultProfile

setDefaultProfile

getConf

setSandboxWatcherErrorPause

setSandboxWatcherPause

setSandboxWatcherStartDelay

getCacheManager

getDao

getGmoSandboxLoader

setAutoStartWatchers

getHyperonPersistenceWatcher

getGmoDbDialect

setGmoDbDialect

setDatabaseFetchStatsCache

getDynamicDao

setUseColumnMetadataCache