ColumnCache (sql2java manager 5.3.10-patch1 API)

java.lang.Object
- gu.sql2java.manager.cache.ColumnCache<B>

类型参数:

B - 数据库记录对象类型(Java Bean)

所有已实现的接口:

com.google.common.cache.RemovalListener<java.lang.Object[],B>, gu.sql2java.Constant
```
public class ColumnCache<B extends gu.sql2java.BaseBean>
extends java.lang.Object
implements com.google.common.cache.RemovalListener<java.lang.Object[],B>, gu.sql2java.Constant
```
基于 LoadingCache实现表数据缓存,并可以通过TableListener实现缓存数据自动更新
支持一个或多个column组成的唯一索引

作者:

guyadong

嵌套类概要
- 从接口继承的嵌套类/接口 gu.sql2java.Constant
  gu.sql2java.Constant.JdbcProperty, gu.sql2java.Constant.UpdateStrategy

字段概要

字段
限定符和类型	字段和说明
`protected static boolean`	`debug`
`protected long`	`duration`
`protected java.lang.String`	`indexName`
`protected BaseTableManager<B>`	`manager`
`protected java.lang.Long`	`maximumSize`
`protected gu.sql2java.RowMetaData`	`metaData`
`protected java.util.concurrent.TimeUnit`	`unit`
`protected gu.sql2java.Constant.UpdateStrategy`	`updateStrategy` 当前更新策略

从接口继承的字段 gu.sql2java.Constant
DEFAULT_ALIAS, DEFAULT_CACHE_MAXIMUMSIZE, DEFAULT_DURATION, DEFAULT_STRATEGY, DEFAULT_TIME_UNIT, FIELD_INITIALIZED, FIELD_MODIFIED, FIELD_NEW, INSERT_VALUES_SUFFIX, PAGE_QUERY_SUFFIX, PRODUCT_NAME_MYSQL, PRODUCT_NAME_PHOENIX, 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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`equals(java.lang.Object obj)`
`B`	`getBean(java.lang.Object... keys)` 加载主键或索引(keys)指定的记录,如果缓存中没有则从数据库中查询数据库中没有找到则抛出异常
`B`	`getBeanUnchecked(java.lang.Object... keys)` 加载主键或索引(keys)指定的记录,如果缓存中没有则从数据库中查询数据库中没有找到则返回`null`
`BaseTableManager<B>`	`getManager()`
`int`	`hashCode()`
`boolean`	`hasValidKey(B bean)` 判断指定的数据库记录是否包含有效的key值
`protected B`	`loadfromDatabase(java.lang.Object[] keys)` 从数据库中加载外键指定的记录,没有找到指定的记录则抛出异常`ObjectRetrievalException`
`void`	`onRemoval(com.google.common.cache.RemovalNotification<java.lang.Object[],B> notification)`
`B`	`remove(B bean)` 删除cache中指定的记录
`B`	`removeCached(java.lang.Object... keys)` 删除cache中索引(keys)指定的记录
`static void`	`setDebug(boolean debug)` set debug flag that determine if output log message,default : false
`java.lang.String`	`toString()`
`void`	`update(B bean)` 根据默认更新策略向cache中更新数据
`void`	`update(B bean, gu.sql2java.Constant.UpdateStrategy updateStrategy)` 根据指定的更新策略更新`bean`到指定的缓存对象`cacheMap`

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

- 字段详细资料
  - metaData
```
protected final gu.sql2java.RowMetaData metaData
```
  - updateStrategy
```
protected final gu.sql2java.Constant.UpdateStrategy updateStrategy
```
    当前更新策略
  - maximumSize
```
protected final java.lang.Long maximumSize
```
  - duration
```
protected final long duration
```
  - unit
```
protected final java.util.concurrent.TimeUnit unit
```
  - manager
```
protected final BaseTableManager<B extends gu.sql2java.BaseBean> manager
```
  - indexName
```
protected final java.lang.String indexName
```
  - debug
```
protected static boolean debug
```
- 方法详细资料
  - loadfromDatabase
```
protected B loadfromDatabase(java.lang.Object[] keys)
                      throws gu.sql2java.exception.RuntimeDaoException,
                             gu.sql2java.exception.ObjectRetrievalException
```
    从数据库中加载外键指定的记录,没有找到指定的记录则抛出异常ObjectRetrievalException
    
    参数:
    
    keys -
    
    返回:
    
    B
    
    抛出:
    
    gu.sql2java.exception.RuntimeDaoException
    
    gu.sql2java.exception.ObjectRetrievalException
  - getBean
```
public B getBean(java.lang.Object... keys)
          throws gu.sql2java.exception.ObjectRetrievalException
```
    加载主键或索引(keys)指定的记录,如果缓存中没有则从数据库中查询
    数据库中没有找到则抛出异常
    
    参数:
    
    keys - value of primary or index keys
    
    返回:
    
    B
    
    抛出:
    
    gu.sql2java.exception.ObjectRetrievalException
  - getBeanUnchecked
```
public B getBeanUnchecked(java.lang.Object... keys)
```
    加载主键或索引(keys)指定的记录,如果缓存中没有则从数据库中查询
    数据库中没有找到则返回null
    
    参数:
    
    keys - primary keys
    
    返回:
    
    B
  - hasValidKey
```
public boolean hasValidKey(B bean)
```
    判断指定的数据库记录是否包含有效的key值
    
    返回:
    
    如果所有的key字段都不为null则返回true,否则返回false
  - remove
```
public B remove(B bean)
```
    删除cache中指定的记录
    
    返回:
    
    the previous B associated with keys of bean, or null if there was no mapping for key.
  - removeCached
```
public B removeCached(java.lang.Object... keys)
```
    删除cache中索引(keys)指定的记录
    
    参数:
    
    keys - value of primary or index keys
    
    返回:
    
    the previous B associated with keys of bean, or null if there was no mapping for key.
  - update
```
public void update(B bean,
                   gu.sql2java.Constant.UpdateStrategy updateStrategy)
```
    根据指定的更新策略更新bean到指定的缓存对象cacheMap
    
    updateStrategy - 更新策略
  - update
```
public void update(B bean)
```
    根据默认更新策略向cache中更新数据
  - onRemoval
```
public void onRemoval(com.google.common.cache.RemovalNotification<java.lang.Object[],B> notification)
```
    指定者:
    
    onRemoval 在接口中 com.google.common.cache.RemovalListener<java.lang.Object[],B extends gu.sql2java.BaseBean>
  - getManager
```
public BaseTableManager<B> getManager()
```
    返回:
    
    native manager
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    覆盖:
    
    equals 在类中 java.lang.Object
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
  - setDebug
```
public static void setDebug(boolean debug)
```
    set debug flag that determine if output log message,default : false
    
    参数:
    
    debug - flag for debug message output

类 ColumnCache<B extends gu.sql2java.BaseBean>

嵌套类概要

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

字段概要

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

方法概要

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

字段详细资料

metaData

updateStrategy

maximumSize

duration

unit

manager

indexName

debug

方法详细资料

loadfromDatabase

getBean

getBeanUnchecked

hasValidKey

remove

removeCached

update

update

onRemoval

getManager

hashCode

equals

toString

setDebug