CacheManager (sql2java manager 5.5.0-patch2 API)

java.lang.Object
- gu.sql2java.manager.BaseTableManager<gu.sql2java.BaseBean>
- - gu.sql2java.manager.cache.CacheManager

所有已实现的接口:

gu.sql2java.Constant, gu.sql2java.SqlRunner, gu.sql2java.TableManager<gu.sql2java.BaseBean>
```
public class CacheManager
extends BaseTableManager<gu.sql2java.BaseBean>
```
cache implementation for BaseTableManager

作者:

guyadong

嵌套类概要
- 从类继承的嵌套类/接口 gu.sql2java.manager.BaseTableManager
  BaseTableManager.DeleteBeanAction, BaseTableManager.DeleteRuleListener<F extends gu.sql2java.BaseBean>, BaseTableManager.Event
- 从接口继承的嵌套类/接口 gu.sql2java.TableManager
  gu.sql2java.TableManager.Action<B>, gu.sql2java.TableManager.DoEach<B>
- 从接口继承的嵌套类/接口 gu.sql2java.Constant
  gu.sql2java.Constant.JdbcProperty, gu.sql2java.Constant.RowLockType, gu.sql2java.Constant.UpdateStrategy

字段概要
- 从类继承的字段 gu.sql2java.manager.BaseTableManager
  metaData
- 从接口继承的字段 gu.sql2java.Constant
  DEFAULT_ALIAS, DEFAULT_CACHE_MAXIMUMSIZE, DEFAULT_DURATION, DEFAULT_STRATEGY, DEFAULT_TIME_UNIT, FIELD_INITIALIZED, FIELD_MODIFIED, FIELD_NEW, INSERT_VALUES_SUFFIX, NO_DBCOLUMN_FIELDS, PAGE_QUERY_SUFFIX, PRODUCT_NAME_MYSQL, PRODUCT_NAME_PHOENIX, PRODUCT_NAME_SQLite, RETRIEVE_SUFFIX, SEARCH_ENDING_LIKE, SEARCH_EXACT, SEARCH_LIKE, SEARCH_STARTING_LIKE, SQL_LIKE_WILDCARD, STATE_BIT_MASK, STATE_BIT_NUM, STATE_BIT_SHIFT, STATEMENT_SUFFIX

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`protected int`	`actionOnResultSet(java.sql.ResultSet rs, int[] fieldList, int startRow, int numRows, gu.sql2java.TableManager.Action<gu.sql2java.BaseBean> action)` decode a resultset and call action
`void`	`clear()`
`static com.gitee.l0km.aocache.config.CacheConfig`	`createCacheConfig(java.lang.Long maximumSize, java.lang.Long duration, java.util.concurrent.TimeUnit unit, java.lang.Boolean weakValues)` 创建缓存配置对象。
`protected boolean`	`doExistsPrimaryKey(java.lang.Object... keys)`
`protected gu.sql2java.BaseBean`	`doLoadByPrimaryKeyChecked(java.lang.Object... keys)`
`protected gu.sql2java.BaseBean`	`doLoadUniqueByIndex(java.lang.String indexName, java.lang.Object... indexValues)`
`protected gu.sql2java.BaseBean`	`doLoadUniqueByIndexChecked(java.lang.String indexName, java.lang.Object... indexValues)`
`<B extends gu.sql2java.BaseBean> B`	`getCache(java.lang.Object... keys)`
`<B extends gu.sql2java.BaseBean> B`	`getCacheByIndex(java.lang.String indexName, java.lang.Object... keys)`
`java.util.Map<java.lang.String,gu.sql2java.TableListener<gu.sql2java.BaseBean>>`	`getForeignKeyDeleteListeners()`
`gu.sql2java.ListenerContainer<gu.sql2java.BaseBean>`	`getListenerContainer()`
`static gu.sql2java.TableManager<?>`	`makeCacheInstance(java.lang.String tablename, gu.sql2java.Constant.UpdateStrategy updateStrategy, long maximumSize, long duration, java.util.concurrent.TimeUnit unit)` 已过时。 replaced by `makeCacheInstance(String, com.gitee.l0km.aocache.UpdateStrategy, long, long, TimeUnit)`
`static gu.sql2java.TableManager<?>`	`makeCacheInstance(java.lang.String tablename, com.gitee.l0km.aocache.UpdateStrategy updateStrategy, com.gitee.l0km.aocache.config.CacheConfig config)` create a instance of DeviceCacheManager
`static gu.sql2java.TableManager<?>`	`makeCacheInstance(java.lang.String tablename, com.gitee.l0km.aocache.UpdateStrategy updateStrategy, long maximumSize, long duration, java.util.concurrent.TimeUnit unit)` create a instance of DeviceCacheManager
`void`	`removeCached(java.lang.Object... primaryKeys)` 删除cache中主键(keys)指定的记录
`void`	`removeCachedByIndex(java.lang.String indexName, java.lang.Object... indexKeys)` 根据索引名删除缓存中索引值(keys)指定的记录
`long`	`size()` 获取缓存的大小。
`long`	`sizeof(java.lang.String indexName)` 获取指定索引名称对应的缓存大小。
`java.lang.String`	`toString()`

从类继承的方法 gu.sql2java.manager.BaseTableManager
addIfAbsent, addJunction, addJunction, addJunction, bindForeignKeyListenerForDeleteRule, checkCycleOfSelfRef, checkCycleOfSelfRef, checkDuplicate, checkDuplicateByPk, childListOfSelfRef, childListOfSelfRef, childrenOfBeansOfSelfRef, childrenOfPksOfSelfRef, childrenOfSelfRef, childrenOfSelfRef, countAll, countUsingTemplate, countUsingTemplate, countWhere, createBean, createBean, delete, delete, delete, deleteAll, deleteByIndex, deleteByIndexForIndices, deleteByIndexForIndices, deleteByPks, deleteByPks, deleteByPrimaryKey, deleteByWhere, deleteImportedBeans, deleteImportedBeans, deleteImportedBeans, deleteJunction, deleteJunction, deleteJunction, deleteUsingTemplate, equals, existsByPrimaryKey, existsPrimaryKey, fastInsert, foreach, foreachByJoinWhere, foreachByWhere, freeConnection, getColumnValue, getConnection, getDataSourceConfig, getGeometryDataCodec, getImportedBeans, getImportedBeans, getImportedBeansAsList, getImportedBeansAsList, getImportedBeansAsList, getManager, getMetaData, getReferencedBean, hashCode, insert, isCycleOfSelfRef, isCycleOfSelfRef, levelOfSelfRef, levelOfSelfRef, listOfSelfRef, listOfSelfRef, loadAll, loadAll, loadAll, loadAll, loadAllAsList, loadAllAsList, loadByForeignKeyAsList, loadByIndex, loadByIndexAsList, loadByIndexForIndices, loadByIndexForIndices, loadByJoinWhereAsList, loadByJoinWhereAsList, loadByJoinWhereAsList, loadByJoinWhereAsList, loadByJoinWhereForAction, loadByPks, loadByPks, loadByPreparedStatementAsList, loadByPrimaryKey, loadByPrimaryKey, loadByPrimaryKeyChecked, loadByPrimaryKeyChecked, loadByWhere, loadByWhere, loadByWhere, loadByWhere, loadByWhere, loadByWhere, loadByWhereAsList, loadByWhereAsList, loadByWhereAsList, loadByWhereForAction, loadColumnAsList, loadUniqueByIndex, loadUniqueByIndexChecked, loadUniqueUsingTemplate, loadUniqueUsingTemplateChecked, loadUsingTemplate, loadUsingTemplate, loadUsingTemplate, loadUsingTemplate, loadUsingTemplate, loadUsingTemplate, loadUsingTemplateAsList, loadUsingTemplateAsList, loadUsingTemplateAsList, loadViaJunctionAsList, loadViaJunctionAsList, loadViaJunctionTableAsList, lockAndUpdate, lockAndUpdate, lockAndUpdate, registerListener, rowCountOf, rowCountWhere, runAsTransaction, runAsTransaction, runSql, runSql, runSqlAsList, runSqlAsList, runSqlAsList, runSqlForMap, runSqlForValue, runWithNoPage, runWithNoPage, save, save, save, saveAsTransaction, saveAsTransaction, saveFully, saveFullyAsTransaction, setColumnValue, setImportedBeans, setImportedBeans, setReferencedBean, setValueIfNonEqual, setValueIfNonNull, setWhereCheckFlag, topOfSelfRef, topOfSelfRef, toPrimaryKeyList, toPrimaryKeyList, tryLockRows, unbindForeignKeyListenerForDeleteRule, unregisterListener, update, updateWithCondition

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 方法详细资料
  - makeCacheInstance
```
public static final gu.sql2java.TableManager<?> makeCacheInstance(java.lang.String tablename,
                                                                  com.gitee.l0km.aocache.UpdateStrategy updateStrategy,
                                                                  com.gitee.l0km.aocache.config.CacheConfig config)
```
    create a instance of DeviceCacheManager
    
    参数:
    
    tablename -
    
    updateStrategy - cache update strategy,determined by RowMetaData.hasAutoUpdateColumn if null,see also ColumnCache
    
    config - cache config,com.gitee.l0km.aocache.CompositeKeyCache#DEFAULT_DOGET_CONFIG be used if null
    
    从以下版本开始:
    
    3.34.0
  - makeCacheInstance
```
public static final gu.sql2java.TableManager<?> makeCacheInstance(java.lang.String tablename,
                                                                  com.gitee.l0km.aocache.UpdateStrategy updateStrategy,
                                                                  long maximumSize,
                                                                  long duration,
                                                                  java.util.concurrent.TimeUnit unit)
```
    create a instance of DeviceCacheManager
    
    参数:
    
    tablename -
    
    updateStrategy - cache update strategy,determined by RowMetaData.hasAutoUpdateColumn if null,see also ColumnCache
    
    maximumSize - maximum capacity of cache ,Constant.DEFAULT_CACHE_MAXIMUMSIZE be used if null or <=0,see also CacheBuilder.maximumSize(long)
    
    duration - cache data expired time,Constant.DEFAULT_DURATION be used if null or <=0,see also CacheBuilder.expireAfterAccess(long, TimeUnit)
    
    unit - time unit for duration,Constant.DEFAULT_TIME_UNIT be used if null,see also CacheBuilder.expireAfterAccess(long, TimeUnit)
    
    从以下版本开始:
    
    3.34.0
  - makeCacheInstance
```
public static final gu.sql2java.TableManager<?> makeCacheInstance(java.lang.String tablename,
                                                                  gu.sql2java.Constant.UpdateStrategy updateStrategy,
                                                                  long maximumSize,
                                                                  long duration,
                                                                  java.util.concurrent.TimeUnit unit)
```
    已过时。 replaced by makeCacheInstance(String, com.gitee.l0km.aocache.UpdateStrategy, long, long, TimeUnit)
    
    create a instance of DeviceCacheManager
    
    参数:
    
    tablename -
    
    updateStrategy - cache update strategy, determined by RowMetaData.hasAutoUpdateColumn if null,see also ColumnCache
    
    maximumSize - maximum capacity of cache ,Constant.DEFAULT_CACHE_MAXIMUMSIZE be used if null or <=0,see also CacheBuilder.maximumSize(long)
    
    duration - cache data expired time,Constant.DEFAULT_DURATION be used if null or <=0,see also CacheBuilder.expireAfterAccess(long, TimeUnit)
    
    unit - time unit for duration,Constant.DEFAULT_TIME_UNIT be used if null,see also CacheBuilder.expireAfterAccess(long, TimeUnit)
  - createCacheConfig
```
public static com.gitee.l0km.aocache.config.CacheConfig createCacheConfig(java.lang.Long maximumSize,
                                                                          java.lang.Long duration,
                                                                          java.util.concurrent.TimeUnit unit,
                                                                          java.lang.Boolean weakValues)
```
    创建缓存配置对象。
    如果传入的 maximumSize 为 null 或小于等于 0，则使用 Constant.DEFAULT_CACHE_MAXIMUMSIZE；
    如果传入的 duration 为 null 或小于等于 0，则使用 Constant.DEFAULT_DURATION；
    如果传入的 unit 为 null，则使用 Constant.DEFAULT_TIME_UNIT。
    最终创建的缓存配置对象将设置弱引用值、最大容量和写入后过期时间。
    
    参数:
    
    maximumSize - 缓存的最大容量，若为 null 或小于等于 0，使用默认值。
    
    duration - 缓存数据的过期时间，若为 null 或小于等于 0，使用默认值。
    
    unit - 过期时间的时间单位，若为 null，使用默认值。
    
    weakValues - 是否启用弱引用值，若为 null，使用默认值 true。
    
    返回:
    
    一个配置好的 CacheConfig 实例。
  - doLoadByPrimaryKeyChecked
```
protected gu.sql2java.BaseBean doLoadByPrimaryKeyChecked(java.lang.Object... keys)
                                                  throws gu.sql2java.exception.RuntimeDaoException,
                                                         gu.sql2java.exception.ObjectRetrievalException
```
    覆盖:
    
    doLoadByPrimaryKeyChecked 在类中 BaseTableManager<gu.sql2java.BaseBean>
    
    抛出:
    
    gu.sql2java.exception.RuntimeDaoException
    
    gu.sql2java.exception.ObjectRetrievalException
  - doExistsPrimaryKey
```
protected boolean doExistsPrimaryKey(java.lang.Object... keys)
                              throws gu.sql2java.exception.RuntimeDaoException
```
    覆盖:
    
    doExistsPrimaryKey 在类中 BaseTableManager<gu.sql2java.BaseBean>
    
    抛出:
    
    gu.sql2java.exception.RuntimeDaoException
  - actionOnResultSet
```
protected int actionOnResultSet(java.sql.ResultSet rs,
                                int[] fieldList,
                                int startRow,
                                int numRows,
                                gu.sql2java.TableManager.Action<gu.sql2java.BaseBean> action)
                         throws gu.sql2java.exception.DaoException
```
    从类复制的说明: BaseTableManager
    
    decode a resultset and call action
    
    覆盖:
    
    actionOnResultSet 在类中 BaseTableManager<gu.sql2java.BaseBean>
    
    参数:
    
    rs - the resultset to decode
    
    fieldList - table of the field's associated constants
    
    startRow - the start row to be used (first row = 1, last row = -1)
    
    numRows - the number of rows to be retrieved (all rows = a negative number)
    
    action - interface obj for do something
    
    返回:
    
    the count dealt by action
    
    抛出:
    
    gu.sql2java.exception.DaoException
  - doLoadUniqueByIndex
```
protected gu.sql2java.BaseBean doLoadUniqueByIndex(java.lang.String indexName,
                                                   java.lang.Object... indexValues)
                                            throws gu.sql2java.exception.RuntimeDaoException
```
    覆盖:
    
    doLoadUniqueByIndex 在类中 BaseTableManager<gu.sql2java.BaseBean>
    
    抛出:
    
    gu.sql2java.exception.RuntimeDaoException
  - doLoadUniqueByIndexChecked
```
protected gu.sql2java.BaseBean doLoadUniqueByIndexChecked(java.lang.String indexName,
                                                          java.lang.Object... indexValues)
                                                   throws gu.sql2java.exception.ObjectRetrievalException
```
    覆盖:
    
    doLoadUniqueByIndexChecked 在类中 BaseTableManager<gu.sql2java.BaseBean>
    
    抛出:
    
    gu.sql2java.exception.ObjectRetrievalException
  - getForeignKeyDeleteListeners
```
public java.util.Map<java.lang.String,gu.sql2java.TableListener<gu.sql2java.BaseBean>> getForeignKeyDeleteListeners()
```
    覆盖:
    
    getForeignKeyDeleteListeners 在类中 BaseTableManager<gu.sql2java.BaseBean>
    
    返回:
    
    map with foreignKey name TO TableListener
  - getListenerContainer
```
public gu.sql2java.ListenerContainer<gu.sql2java.BaseBean> getListenerContainer()
```
    指定者:
    
    getListenerContainer 在接口中 gu.sql2java.TableManager<gu.sql2java.BaseBean>
    
    覆盖:
    
    getListenerContainer 在类中 BaseTableManager<gu.sql2java.BaseBean>
  - removeCached
```
public void removeCached(java.lang.Object... primaryKeys)
```
    删除cache中主键(keys)指定的记录
    
    参数:
    
    primaryKeys - 主键值
    
    从以下版本开始:
    
    3.30.0
  - removeCachedByIndex
```
public void removeCachedByIndex(java.lang.String indexName,
                                java.lang.Object... indexKeys)
```
    根据索引名删除缓存中索引值(keys)指定的记录
    
    参数:
    
    indexName - 索引名
    
    indexKeys - 索引对象的字段值
    
    从以下版本开始:
    
    3.30.0
  - sizeof
```
public long sizeof(java.lang.String indexName)
```
    获取指定索引名称对应的缓存大小。
    
    参数:
    
    indexName - 索引名称
    
    返回:
    
    缓存大小
    
    从以下版本开始:
    
    3.34.0
  - size
```
public long size()
```
    获取缓存的大小。
    
    返回:
    
    缓存的大小
    
    从以下版本开始:
    
    3.34.0
  - getCacheByIndex
```
public <B extends gu.sql2java.BaseBean> B getCacheByIndex(java.lang.String indexName,
                                                          java.lang.Object... keys)
```
  - getCache
```
public <B extends gu.sql2java.BaseBean> B getCache(java.lang.Object... keys)
```
  - clear
```
public void clear()
```
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 BaseTableManager<gu.sql2java.BaseBean>

类 CacheManager

嵌套类概要

从类继承的嵌套类/接口 gu.sql2java.manager.BaseTableManager

从接口继承的嵌套类/接口 gu.sql2java.TableManager

从接口继承的嵌套类/接口 gu.sql2java.Constant

字段概要

从类继承的字段 gu.sql2java.manager.BaseTableManager

从接口继承的字段 gu.sql2java.Constant

方法概要

从类继承的方法 gu.sql2java.manager.BaseTableManager

从类继承的方法 java.lang.Object

方法详细资料

makeCacheInstance

makeCacheInstance

makeCacheInstance

createCacheConfig

doLoadByPrimaryKeyChecked

doExistsPrimaryKey

actionOnResultSet

doLoadUniqueByIndex

doLoadUniqueByIndexChecked

getForeignKeyDeleteListeners

getListenerContainer

removeCached

removeCachedByIndex

sizeof

size

getCacheByIndex

getCache

clear

toString