ColumnCache (sql2java manager 5.6.9 API)

java.lang.Object
- com.gitee.l0km.aocache.CompositeKeyCache<gu.sql2java.BaseBean>
- - gu.sql2java.manager.cache.ColumnCache

所有已实现的接口:

com.gitee.l0km.aocache.AocacheRemovalListener<java.lang.Object[],gu.sql2java.BaseBean>
```
public class ColumnCache
extends com.gitee.l0km.aocache.CompositeKeyCache<gu.sql2java.BaseBean>
implements com.gitee.l0km.aocache.AocacheRemovalListener<java.lang.Object[],gu.sql2java.BaseBean>
```
基于 CompositeKeyCache实现以表的主键(PK)或唯一键(PK)为KEY数据缓存
支持一个或多个字段组成的唯一索引

作者:

guyadong

嵌套类概要
- 从类继承的嵌套类/接口 com.gitee.l0km.aocache.CompositeKeyCache
  com.gitee.l0km.aocache.CompositeKeyCache.ComputeException
- 从接口继承的嵌套类/接口 com.gitee.l0km.aocache.AocacheRemovalListener
  com.gitee.l0km.aocache.AocacheRemovalListener.AocacheRemovalCause, com.gitee.l0km.aocache.AocacheRemovalListener.AocacheRemovalNotification<K,V>

字段概要

字段
限定符和类型	字段和说明
`protected boolean`	`allowFullColumnUpdate` 是否允许全列更新的标志位。
`protected static boolean`	`debug`
`protected BaseTableManager<gu.sql2java.BaseBean>`	`manager`
`protected gu.sql2java.RowMetaData`	`metaData`
`protected com.gitee.l0km.aocache.UpdateStrategy`	`updateStrategy` 当前更新策略

从类继承的字段 com.gitee.l0km.aocache.CompositeKeyCache
childCachesByName, config, DOGET_METHOD, memberKey, name

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`protected void`	`checkArgs(java.lang.Object[] keys)` 检查传入的键数组是否有效。
`protected gu.sql2java.BaseBean`	`compute(java.lang.Object[] keys)`
`protected boolean`	`doSynthesizeIntegralValue(gu.sql2java.BaseBean to, gu.sql2java.BaseBean from)` 执行将源对象 `from` 的属性值更新到目标对象 `to` 的操作。
`boolean`	`equals(java.lang.Object obj)`
`protected java.lang.Object[]`	`getArgs(gu.sql2java.BaseBean bean)` 根据当前缓存的键列ID数组，从传入的BaseBean对象中获取对应的JDBC值，并将这些值存储在一个新数组中返回。
`gu.sql2java.BaseBean`	`getBean(java.lang.Object... keys)` 加载主键或索引(keys)指定的记录,如果缓存中没有则从数据库中查询数据库中没有找到则抛出异常
`gu.sql2java.BaseBean`	`getBeanUnchecked(java.lang.Object... keys)` 加载主键或索引(keys)指定的记录,如果缓存中没有则从数据库中查询数据库中没有找到则返回`null`
`protected java.lang.Object[]`	`getCacheKeysAsJdbcValues(java.lang.String indexName, java.lang.Object... keys)` 根据索引名获取缓存键并将其转换为适用于 JDBC 操作的键数组。
`BaseTableManager<gu.sql2java.BaseBean>`	`getManager()`
`int`	`hashCode()`
`protected boolean`	`isValidArgs(java.lang.Object[] keys)`
`protected gu.sql2java.BaseBean`	`loadfromDatabase(java.lang.Object[] keys)` 从数据库中加载外键指定的记录,没有找到指定的记录则抛出异常`ObjectRetrievalException`
`protected static java.lang.Throwable`	`onComputeException(com.gitee.l0km.aocache.CompositeKeyCache.ComputeException e)` 处理计算缓存值时抛出的异常。
`void`	`onRemoval(com.gitee.l0km.aocache.AocacheRemovalListener.AocacheRemovalNotification<java.lang.Object[],gu.sql2java.BaseBean> notification)`
`void`	`remove(gu.sql2java.BaseBean bean)` 删除cache中指定的记录
`void`	`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(gu.sql2java.BaseBean bean)` 根据默认更新策略向cache中更新数据
`void`	`update(gu.sql2java.BaseBean bean, com.gitee.l0km.aocache.UpdateStrategy updateStrategy, boolean completeBean)` 根据指定的更新策略更新`bean`到指定的缓存对象`cacheMap`

从类继承的方法 com.gitee.l0km.aocache.CompositeKeyCache
checkArgs4Key, clearCache, getByNameIfPresent, getByNameIfPresent0, getCacheOrCompute, getCacheOrComputeByName, getCacheSizeByName, getChildCaches, getIfPresent, getIfPresentUncheck0, getIfPresentUncheck0, getName, hasValidArgs, isValidWrapKey, keysOfCache, onCacheDone, readLock, readUnlock, removeCache, removeCache, removeCacheByName, size, updateCache, writeLock, writeUnlock

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

- 字段详细资料
  - debug
```
protected static boolean debug
```
  - metaData
```
protected final gu.sql2java.RowMetaData metaData
```
  - updateStrategy
```
protected final com.gitee.l0km.aocache.UpdateStrategy updateStrategy
```
    当前更新策略
  - manager
```
protected final BaseTableManager<gu.sql2java.BaseBean> manager
```
  - allowFullColumnUpdate
```
protected final boolean allowFullColumnUpdate
```
    是否允许全列更新的标志位。
    
    该标志位的值根据表的元数据中是否存在自动更新列来确定，
    
    如果表没有自动更新列，则允许全列更新。
- 方法详细资料
  - getArgs
```
protected java.lang.Object[] getArgs(gu.sql2java.BaseBean bean)
```
    根据当前缓存的键列ID数组，从传入的BaseBean对象中获取对应的JDBC值，并将这些值存储在一个新数组中返回。
    
    指定者:
    
    getArgs 在类中 com.gitee.l0km.aocache.CompositeKeyCache<gu.sql2java.BaseBean>
    
    参数:
    
    bean - 包含数据的BaseBean对象，不能为 null。
    
    返回:
    
    包含键列对应JDBC值的数组，数组长度与键列数量相同。
  - isValidArgs
```
protected boolean isValidArgs(java.lang.Object[] keys)
```
    指定者:
    
    isValidArgs 在类中 com.gitee.l0km.aocache.CompositeKeyCache<gu.sql2java.BaseBean>
  - checkArgs
```
protected void checkArgs(java.lang.Object[] keys)
                  throws gu.sql2java.exception.ObjectRetrievalException
```
    检查传入的键数组是否有效。
    该方法会检查键数组是否为 null，以及其长度是否与当前索引或主键的列数匹配。
    如果键数组中存在 null 值，会抛出 ObjectRetrievalException 异常。
    
    覆盖:
    
    checkArgs 在类中 com.gitee.l0km.aocache.CompositeKeyCache<gu.sql2java.BaseBean>
    
    参数:
    
    keys - 待检查的键数组，用于表示数据库记录的唯一索引或主键值。
    
    抛出:
    
    gu.sql2java.exception.ObjectRetrievalException - 如果键数组包含 null 值。
  - doSynthesizeIntegralValue
```
protected boolean doSynthesizeIntegralValue(gu.sql2java.BaseBean to,
                                            gu.sql2java.BaseBean from)
```
    执行将源对象 from 的属性值更新到目标对象 to 的操作。
    如果表没有自动更新列，则遍历所有字段执行更新操作。
    对于主键字段，如果源对象的主键值为空，则不更新目标对象的主键字段。
    更新完成后，会对目标对象和源对象的修改标记进行重置。
    
    覆盖:
    
    doSynthesizeIntegralValue 在类中 com.gitee.l0km.aocache.CompositeKeyCache<gu.sql2java.BaseBean>
    
    参数:
    
    to - 目标对象，用于接收更新后的属性值。
    
    from - 源对象，提供待更新的属性值。
    
    返回:
    
    如果执行了更新操作返回 true，否则返回 false。
  - compute
```
protected gu.sql2java.BaseBean compute(java.lang.Object[] keys)
                                throws java.lang.Exception
```
    指定者:
    
    compute 在类中 com.gitee.l0km.aocache.CompositeKeyCache<gu.sql2java.BaseBean>
    
    抛出:
    
    java.lang.Exception
  - loadfromDatabase
```
protected gu.sql2java.BaseBean loadfromDatabase(java.lang.Object[] keys)
                                         throws gu.sql2java.exception.RuntimeDaoException,
                                                gu.sql2java.exception.ObjectRetrievalException
```
    从数据库中加载外键指定的记录,没有找到指定的记录则抛出异常ObjectRetrievalException
    
    参数:
    
    keys -
    
    返回:
    
    BaseBean
    
    抛出:
    
    gu.sql2java.exception.RuntimeDaoException
    
    gu.sql2java.exception.ObjectRetrievalException
  - getCacheKeysAsJdbcValues
```
protected java.lang.Object[] getCacheKeysAsJdbcValues(java.lang.String indexName,
                                                      java.lang.Object... keys)
```
    根据索引名获取缓存键并将其转换为适用于 JDBC 操作的键数组。
    如果传入的索引名与当前缓存的名称相同，则直接使用当前缓存的元数据将键值转换为 JDBC 值；
    若索引名不同，则从子缓存中查找对应的 ColumnCache 对象，再使用其元数据进行转换。
    
    参数:
    
    indexName - 索引名，为 null 时表示主键索引
    
    keys - 索引对应的键值
    
    返回:
    
    转换后适用于 JDBC 操作的键数组
    
    抛出:
    
    java.lang.NullPointerException - 当 indexName 为 null 或未找到对应的索引缓存时抛出
    
    从以下版本开始:
    
    3.35.0
  - getBean
```
public gu.sql2java.BaseBean 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 gu.sql2java.BaseBean getBeanUnchecked(java.lang.Object... keys)
```
    加载主键或索引(keys)指定的记录,如果缓存中没有则从数据库中查询
    数据库中没有找到则返回null
    
    参数:
    
    keys - primary keys
    
    返回:
    
    B
  - remove
```
public void remove(gu.sql2java.BaseBean bean)
```
    删除cache中指定的记录
  - removeCached
```
public void removeCached(java.lang.Object... keys)
```
    删除cache中索引(keys)指定的记录
    
    参数:
    
    keys - value of primary or index keys
  - update
```
public void update(gu.sql2java.BaseBean bean,
                   com.gitee.l0km.aocache.UpdateStrategy updateStrategy,
                   boolean completeBean)
```
    根据指定的更新策略更新bean到指定的缓存对象cacheMap
    
    updateStrategy - 更新策略
    
    completeBean - bean是否为完整对象，如果是完整对象，则更新所有字段，否则只更新修改过的字段
  - update
```
public void update(gu.sql2java.BaseBean bean)
```
    根据默认更新策略向cache中更新数据
  - onRemoval
```
public void onRemoval(com.gitee.l0km.aocache.AocacheRemovalListener.AocacheRemovalNotification<java.lang.Object[],gu.sql2java.BaseBean> notification)
```
    指定者:
    
    onRemoval 在接口中 com.gitee.l0km.aocache.AocacheRemovalListener<java.lang.Object[],gu.sql2java.BaseBean>
  - getManager
```
public BaseTableManager<gu.sql2java.BaseBean> 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
  - onComputeException
```
protected static java.lang.Throwable onComputeException(com.gitee.l0km.aocache.CompositeKeyCache.ComputeException e)
                                                 throws gu.sql2java.exception.RuntimeDaoException,
                                                        gu.sql2java.exception.ObjectRetrievalException
```
    处理计算缓存值时抛出的异常。
    该方法会尝试抛出异常的根本原因，如果根本原因是 ObjectRetrievalException 或 RuntimeDaoException，则直接抛出；
    否则，将该异常作为结果返回。
    
    参数:
    
    e - 计算缓存值时抛出的异常对象，类型为 CompositeKeyCache.ComputeException。
    
    返回:
    
    如果异常的根本原因不是 ObjectRetrievalException 或 RuntimeDaoException，则返回该根本异常；否则无返回值。
    
    抛出:
    
    gu.sql2java.exception.RuntimeDaoException - 如果异常的根本原因是 RuntimeDaoException。
    
    gu.sql2java.exception.ObjectRetrievalException - 如果异常的根本原因是 ObjectRetrievalException。
  - 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

嵌套类概要

从类继承的嵌套类/接口 com.gitee.l0km.aocache.CompositeKeyCache

从接口继承的嵌套类/接口 com.gitee.l0km.aocache.AocacheRemovalListener

字段概要

从类继承的字段 com.gitee.l0km.aocache.CompositeKeyCache

方法概要

从类继承的方法 com.gitee.l0km.aocache.CompositeKeyCache

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

字段详细资料

debug

metaData

updateStrategy

manager

allowFullColumnUpdate

方法详细资料

getArgs

isValidArgs

checkArgs

doSynthesizeIntegralValue

compute

loadfromDatabase

getCacheKeysAsJdbcValues

getBean

getBeanUnchecked

remove

removeCached

update

update

onRemoval

getManager

hashCode

equals

toString

onComputeException

setDebug