AbstractPersister (weforward-data-api 1.2.2 API)

java.lang.Object
- cn.weforward.data.persister.support.AbstractPersister<E>

类型参数:

E - 持久对象子类

所有已实现的接口:

cn.weforward.common.Nameable, Persister<E>

直接已知子类:

AbstractRemotePersister, MicroservicePersister
```
public abstract class AbstractPersister<E extends Persistent>
extends Object
implements Persister<E>
```
支持缓存的抽象持久器

作者:

daibo

嵌套类概要

嵌套类
限定符和类型类和说明

protected class AbstractPersister.Cache
缓存

嵌套类
限定符和类型	类和说明
`protected class`	`AbstractPersister.Cache` 缓存

字段概要

字段
限定符和类型	字段和说明
`protected static org.slf4j.Logger`	`_Logger` 日志记录器
`protected AbstractPersister.Cache`	`m_Cache` 缓存
`protected Flusher`	`m_Flusher` 刷写器
`protected boolean`	`m_ForOwnerEnabled` 是否只处理当前服务器持久类
`protected cn.weforward.common.sys.IdGenerator.Tick`	`m_IdGenerator` id生成器
`protected List<ChangeListener<E>>`	`m_Listeners` 监听器
`protected String`	`m_Name` 持久器名
`protected boolean`	`m_ReloadEnabled` 是否开始重载接口
`protected int`	`m_VerifyNewIdTrys` 检查新ID有重复时的重试次数（不大于0表示不检查）

构造器概要

构造器
限定符构造器和说明

protected AbstractPersister(String name)

构造器
限定符	构造器和说明
`protected`	`AbstractPersister(String name)`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`void`	`addListener(ChangeListener<E> l)` 添加监听
`void`	`cleanup()` 清理持久器，立刻持久所有标记更新的持久对象
`boolean`	`equals(Object obj)`
`void`	`flush(E object)` 若对象标示为更新的，立刻持久化对象
`E`	`get(String id)` 由ID取得持久对象
`E`	`get(UniteId id)` 由ID取得持久对象
`PersistentCache<E>`	`getCache()`
`Flusher`	`getFlusher()`
`cn.weforward.common.sys.IdGenerator`	`getIdGenerator()` 持久器的ID生成器
`String`	`getName()` 取持久器名称，通常为类名
`UniteId`	`getNewId()` 生成新ID供新建对象使用
`UniteId`	`getNewId(String prefix)` 生成新ID并加上指定前缀
`E`	`getOfCache(String id)` 由缓存取得
`String`	`getPersisterId()` 取得持久器的服务器标识
`int`	`getVerifyNewIdTrys()` 检查新ID有重复时的重试次数（不大于0表示不检查）
`String`	`getVersion(UniteId id)` 取得持久对象持久化后的版本号
`boolean`	`hold(E object)`
`protected abstract boolean`	`innerDelete(String id)` 删除对象
`protected abstract ObjectWithVersion<E>`	`innerLoad(String id)` 装入对象
`protected abstract String`	`innerNew(E object)` 新增的对象（用于持久器在对象未刷写前能进行查询）
`protected abstract String`	`innerSave(E object)` 保存对象状态
`protected String`	`innerSave(E object, String oldVersion)` 保存对象状态
`boolean`	`isDirty(E instance)` 检查缓存中的持久对象是否还处理待刷写状态
`boolean`	`isForOwnerEnabled()` 只处理当前服务器持久类
`boolean`	`isOwner(E obj)` 对象是否属于当前服务器（根据对象持久ID确定）
`boolean`	`isReloadEnabled()` 是否已经启用对象重载功能，还需要业务对象实现以下接口才能收到通知
`void`	`persist(E object)` 立刻保存对象
`protected String`	`persist(E object, String oldVersion)`
`E`	`putOfCache(E object)` 置入缓存
`boolean`	`remove(String id)` 由持久器中删除指定ID的持久对象
`boolean`	`remove(UniteId id)` 由持久器中删除指定ID的持久对象
`void`	`removeListener(ChangeListener<E> l)` 移除监听
`E`	`removeOfCache(String id)` 只由缓存中删除
`cn.weforward.common.ResultPage<E>`	`search(Condition condition)` 条件查询
`cn.weforward.common.ResultPage<E>`	`search(Condition condition, OrderBy orderBy)` 条件查询
`cn.weforward.common.ResultPage<E>`	`search(Date begin, Date end)` 查找在指定时间段内变化（持久化）过的对象 (begin,end]
`Iterator<E>`	`search(String serverId, Date begin, Date end)` 查找在指定时间段内变化（持久化）过的对象
`cn.weforward.common.ResultPage<String>`	`searchOfId(Condition condition)` 条件查询
`cn.weforward.common.ResultPage<E>`	`searchRange(String from, String to)` 查找ID在指定区间内的对象，id>=from and id<=to
`Iterator<E>`	`searchRange(String serverId, String from, String to)` 查找ID在指定区间内的对象，id>=from and id<=to
`void`	`setFlusher(Flusher flusher)`
`boolean`	`setForOwnerEnabled(boolean enabled)` 启用/关闭只处理当前服务器持久类
`void`	`setPersisterId(String id)` 为持久器产生的对象ID加上标识，标识的范围为0x01~0xFF
`void`	`setReachable(boolean enabled)` 是否控制对象单例
`boolean`	`setReloadEnabled(boolean enabled)` 启用/关闭对象重载功能
`void`	`setVerifyNewIdTrys(int verifyNewIdTrys)` 检查新ID有重复时的重试次数（不大于0表示不检查）
`cn.weforward.common.ResultPage<E>`	`startsWith(String prefix)` 查找ID为指定前缀的对象
`String`	`toString()`
`void`	`update(E object)` 标示对象状态已变化，由持久器选择合适的时候刷写

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

从接口继承的方法 cn.weforward.data.persister.Persister
searchOfId, searchOfId, searchOfId, searchRangeOfId, searchRangeOfId, startsWithOfId

- 字段详细资料
  - _Logger
```
protected static final org.slf4j.Logger _Logger
```
    日志记录器
  - m_Name
```
protected String m_Name
```
    持久器名
  - m_Cache
```
protected AbstractPersister.Cache m_Cache
```
    缓存
  - m_ReloadEnabled
```
protected boolean m_ReloadEnabled
```
    是否开始重载接口
  - m_ForOwnerEnabled
```
protected boolean m_ForOwnerEnabled
```
    是否只处理当前服务器持久类
  - m_VerifyNewIdTrys
```
protected int m_VerifyNewIdTrys
```
    检查新ID有重复时的重试次数（不大于0表示不检查）
  - m_Flusher
```
protected Flusher m_Flusher
```
    刷写器
  - m_IdGenerator
```
protected cn.weforward.common.sys.IdGenerator.Tick m_IdGenerator
```
    id生成器
  - m_Listeners
```
protected List<ChangeListener<E extends Persistent>> m_Listeners
```
    监听器
- 构造器详细资料
  - AbstractPersister
```
protected AbstractPersister(String name)
```
- 方法详细资料
  - getName
```
public String getName()
```
    从接口复制的说明: Persister
    
    取持久器名称，通常为类名
    
    指定者:
    
    getName 在接口中 cn.weforward.common.Nameable
    
    指定者:
    
    getName 在接口中 Persister<E extends Persistent>
    
    返回:
    
    持久器名称
  - getVerifyNewIdTrys
```
public int getVerifyNewIdTrys()
```
    检查新ID有重复时的重试次数（不大于0表示不检查）
    
    返回:
    
    重试次数
  - setVerifyNewIdTrys
```
public void setVerifyNewIdTrys(int verifyNewIdTrys)
```
    检查新ID有重复时的重试次数（不大于0表示不检查）
    
    参数:
    
    verifyNewIdTrys - 重试次数
  - setReachable
```
public void setReachable(boolean enabled)
```
    是否控制对象单例
    
    参数:
    
    enabled - true/单例，false/非单例
  - isReloadEnabled
```
public boolean isReloadEnabled()
```
    从接口复制的说明: Persister
    
    是否已经启用对象重载功能，还需要业务对象实现以下接口才能收到通知
    
    指定者:
    
    isReloadEnabled 在接口中 Persister<E extends Persistent>
    
    返回:
    
    启用返回true
    
    另请参阅:
    
    Reloadable
  - setReloadEnabled
```
public boolean setReloadEnabled(boolean enabled)
```
    从接口复制的说明: Persister
    
    启用/关闭对象重载功能
    
    指定者:
    
    setReloadEnabled 在接口中 Persister<E extends Persistent>
    
    参数:
    
    enabled - 启用/关闭
    
    返回:
    
    返回true表示支持此功能的开启，不支持则返回false
  - addListener
```
public void addListener(ChangeListener<E> l)
```
    从接口复制的说明: Persister
    
    添加监听
    
    指定者:
    
    addListener 在接口中 Persister<E extends Persistent>
    
    参数:
    
    l - 监听对象
  - removeListener
```
public void removeListener(ChangeListener<E> l)
```
    从接口复制的说明: Persister
    
    移除监听
    
    指定者:
    
    removeListener 在接口中 Persister<E extends Persistent>
    
    参数:
    
    l - 监听对象
  - isForOwnerEnabled
```
public boolean isForOwnerEnabled()
```
    从接口复制的说明: Persister
    
    只处理当前服务器持久类
    
    指定者:
    
    isForOwnerEnabled 在接口中 Persister<E extends Persistent>
    
    返回:
    
    只处理返回true
  - setForOwnerEnabled
```
public boolean setForOwnerEnabled(boolean enabled)
```
    从接口复制的说明: Persister
    
    启用/关闭只处理当前服务器持久类
    
    指定者:
    
    setForOwnerEnabled 在接口中 Persister<E extends Persistent>
    
    参数:
    
    enabled - 启用/关闭
    
    返回:
    
    返回true表示支持此功能的开启，不支持则返回false
  - setPersisterId
```
public void setPersisterId(String id)
```
    为持久器产生的对象ID加上标识，标识的范围为0x01~0xFF
    
    参数:
    
    id - 服务器标识
  - getPersisterId
```
public String getPersisterId()
```
    从接口复制的说明: Persister
    
    取得持久器的服务器标识
    
    指定者:
    
    getPersisterId 在接口中 Persister<E extends Persistent>
    
    返回:
    
    标识
  - setFlusher
```
public void setFlusher(Flusher flusher)
```
  - getFlusher
```
public Flusher getFlusher()
```
  - startsWith
```
public cn.weforward.common.ResultPage<E> startsWith(String prefix)
```
    从接口复制的说明: Persister
    
    查找ID为指定前缀的对象
    
    指定者:
    
    startsWith 在接口中 Persister<E extends Persistent>
    
    参数:
    
    prefix - ID前缀
    
    返回:
    
    对象结果页
  - search
```
public cn.weforward.common.ResultPage<E> search(Date begin,
                                                Date end)
```
    从接口复制的说明: Persister
    
    查找在指定时间段内变化（持久化）过的对象 (begin,end]
    
    指定者:
    
    search 在接口中 Persister<E extends Persistent>
    
    参数:
    
    begin - 开始时间，若=null则不限制开始时间
    
    end - 结束时间，若=null则为当前时间
    
    返回:
    
    对象结果页
  - searchRange
```
public cn.weforward.common.ResultPage<E> searchRange(String from,
                                                     String to)
```
    从接口复制的说明: Persister
    
    查找ID在指定区间内的对象，id>=from and id<=to
    
    指定者:
    
    searchRange 在接口中 Persister<E extends Persistent>
    
    参数:
    
    from - ID开始点，若为null则不限制开始（但to不能为null）
    
    to - ID结束点，若为null则不限制结束（但from不能为null）
    
    返回:
    
    对象结果页
  - search
```
public Iterator<E> search(String serverId,
                          Date begin,
                          Date end)
```
    从接口复制的说明: Persister
    
    查找在指定时间段内变化（持久化）过的对象
    
    指定者:
    
    search 在接口中 Persister<E extends Persistent>
    
    参数:
    
    serverId - 服务器标识（1~255）
    
    begin - 开始时间，若=null则不限制开始时间
    
    end - 结束时间，若=null则为当前时间
    
    返回:
    
    结果集迭代器
  - searchRange
```
public Iterator<E> searchRange(String serverId,
                               String from,
                               String to)
```
    从接口复制的说明: Persister
    
    查找ID在指定区间内的对象，id>=from and id<=to
    
    指定者:
    
    searchRange 在接口中 Persister<E extends Persistent>
    
    参数:
    
    serverId - 服务器标识
    
    from - ID开始点，若为null则不限制开始（但to不能为null）
    
    to - ID结束点，若为null则不限制结束（但from不能为null）
    
    返回:
    
    结果集迭代器
  - innerLoad
```
protected abstract ObjectWithVersion<E> innerLoad(String id)
```
    装入对象
    
    参数:
    
    id - 对象ID
    
    返回:
    
    所加载的对象项及其版本号，没有则返回null
  - innerSave
```
protected abstract String innerSave(E object)
```
    保存对象状态
    
    参数:
    
    object - 对象
    
    返回:
    
    对象保存后版本号
  - innerNew
```
protected abstract String innerNew(E object)
```
    新增的对象（用于持久器在对象未刷写前能进行查询）
    
    参数:
    
    object - 新增的对象
    
    返回:
    
    创建后的版本号
  - innerDelete
```
protected abstract boolean innerDelete(String id)
```
    删除对象
    
    参数:
    
    id - 对象ID
    
    返回:
    
    成功/失败
  - innerSave
```
protected String innerSave(E object,
                           String oldVersion)
```
    保存对象状态
    
    参数:
    
    object - 对象
    
    oldVersion - 持久化前的版本号
    
    返回:
    
    对象保存后版本号
  - isOwner
```
public boolean isOwner(E obj)
```
    从接口复制的说明: Persister
    
    对象是否属于当前服务器（根据对象持久ID确定）
    
    指定者:
    
    isOwner 在接口中 Persister<E extends Persistent>
    
    参数:
    
    obj - 持久对象
    
    返回:
    
    是属于当前服务器（标识）则返回true，否则false
  - getNewId
```
public final UniteId getNewId()
                       throws IdDuplicateException
```
    从接口复制的说明: Persister
    
    生成新ID供新建对象使用
    
    指定者:
    
    getNewId 在接口中 Persister<E extends Persistent>
    
    返回:
    
    新的ID
    
    抛出:
    
    IdDuplicateException - id重复异常
  - getNewId
```
public UniteId getNewId(String prefix)
                 throws IdDuplicateException
```
    从接口复制的说明: Persister
    
    生成新ID并加上指定前缀
    
    指定者:
    
    getNewId 在接口中 Persister<E extends Persistent>
    
    参数:
    
    prefix - ID前缀
    
    返回:
    
    新的ID
    
    抛出:
    
    IdDuplicateException - id重复异常
  - getOfCache
```
public E getOfCache(String id)
```
    由缓存取得
    
    参数:
    
    id - 对象id
    
    返回:
    
    对象
  - hold
```
public boolean hold(E object)
```
  - putOfCache
```
public E putOfCache(E object)
```
    置入缓存
    
    参数:
    
    object - 要进入缓存的对象实例
    
    返回:
    
    在缓冲被替换掉的对象实例
  - removeOfCache
```
public E removeOfCache(String id)
```
    只由缓存中删除
    
    参数:
    
    id - 缓存项标识
    
    返回:
    
    有则删除且返回删除的项
  - cleanup
```
public void cleanup()
```
    从接口复制的说明: Persister
    
    清理持久器，立刻持久所有标记更新的持久对象
    
    指定者:
    
    cleanup 在接口中 Persister<E extends Persistent>
  - flush
```
public void flush(E object)
```
    从接口复制的说明: Persister
    
    若对象标示为更新的，立刻持久化对象
    
    指定者:
    
    flush 在接口中 Persister<E extends Persistent>
    
    参数:
    
    object - 持久对象
  - get
```
public E get(String id)
```
    从接口复制的说明: Persister
    
    由ID取得持久对象
    
    指定者:
    
    get 在接口中 Persister<E extends Persistent>
    
    参数:
    
    id - 持久对象ID
    
    返回:
    
    相应的持久对象
  - get
```
public E get(UniteId id)
```
    从接口复制的说明: Persister
    
    由ID取得持久对象
    
    指定者:
    
    get 在接口中 Persister<E extends Persistent>
    
    参数:
    
    id - 持久对象ID
    
    返回:
    
    相应的持久对象
  - remove
```
public boolean remove(String id)
```
    从接口复制的说明: Persister
    
    由持久器中删除指定ID的持久对象
    
    指定者:
    
    remove 在接口中 Persister<E extends Persistent>
    
    参数:
    
    id - 持久对象ID
    
    返回:
    
    false表示没有对应的持久对象
  - remove
```
public boolean remove(UniteId id)
```
    从接口复制的说明: Persister
    
    由持久器中删除指定ID的持久对象
    
    指定者:
    
    remove 在接口中 Persister<E extends Persistent>
    
    参数:
    
    id - 持久对象ID
    
    返回:
    
    false表示没有对应的持久对象
  - update
```
public void update(E object)
```
    从接口复制的说明: Persister
    
    标示对象状态已变化，由持久器选择合适的时候刷写
    
    指定者:
    
    update 在接口中 Persister<E extends Persistent>
    
    参数:
    
    object - 持久对象
  - persist
```
public void persist(E object)
```
    从接口复制的说明: Persister
    
    立刻保存对象
    
    指定者:
    
    persist 在接口中 Persister<E extends Persistent>
    
    参数:
    
    object - 对象
  - getCache
```
public PersistentCache<E> getCache()
```
  - persist
```
protected String persist(E object,
                         String oldVersion)
```
  - isDirty
```
public boolean isDirty(E instance)
```
    从接口复制的说明: Persister
    
    检查缓存中的持久对象是否还处理待刷写状态
    
    指定者:
    
    isDirty 在接口中 Persister<E extends Persistent>
    
    参数:
    
    instance - 要检查的对象
    
    返回:
    
    有在缓存且是待刷写状态返回true
  - search
```
public cn.weforward.common.ResultPage<E> search(Condition condition)
```
    从接口复制的说明: Persister
    
    条件查询
    
    指定者:
    
    search 在接口中 Persister<E extends Persistent>
    
    参数:
    
    condition - 条件 ConditionUtil
    
    返回:
    
    对象结果页
  - searchOfId
```
public cn.weforward.common.ResultPage<String> searchOfId(Condition condition)
```
    从接口复制的说明: Persister
    
    条件查询
    
    指定者:
    
    searchOfId 在接口中 Persister<E extends Persistent>
    
    参数:
    
    condition - 条件 ConditionUtil
    
    返回:
    
    对象结果页
  - search
```
public cn.weforward.common.ResultPage<E> search(Condition condition,
                                                OrderBy orderBy)
```
    从接口复制的说明: Persister
    
    条件查询
    
    指定者:
    
    search 在接口中 Persister<E extends Persistent>
    
    参数:
    
    condition - 条件 ConditionUtil
    
    orderBy - 排序 OrderByUtil
    
    返回:
    
    对象结果页
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - equals
```
public boolean equals(Object obj)
```
    覆盖:
    
    equals 在类中 Object
  - getVersion
```
public String getVersion(UniteId id)
```
    从接口复制的说明: Persister
    
    取得持久对象持久化后的版本号
    
    指定者:
    
    getVersion 在接口中 Persister<E extends Persistent>
    
    参数:
    
    id - 持久对象ID
    
    返回:
    
    返回版本号，若不找这ID的对象则返回null，若不支持版本号则返回空字串（""）
  - getIdGenerator
```
public cn.weforward.common.sys.IdGenerator getIdGenerator()
```
    持久器的ID生成器
    
    返回:
    
    生成器

类 AbstractPersister<E extends Persistent>

嵌套类概要

字段概要

构造器概要

方法概要

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

从接口继承的方法 cn.weforward.data.persister.Persister

字段详细资料

_Logger

m_Name

m_Cache

m_ReloadEnabled

m_ForOwnerEnabled

m_VerifyNewIdTrys

m_Flusher

m_IdGenerator

m_Listeners

构造器详细资料

AbstractPersister

方法详细资料

getName

getVerifyNewIdTrys

setVerifyNewIdTrys

setReachable

isReloadEnabled

setReloadEnabled

addListener

removeListener

isForOwnerEnabled

setForOwnerEnabled

setPersisterId

getPersisterId

setFlusher

getFlusher

startsWith

search

searchRange

search

searchRange

innerLoad

innerSave

innerNew

innerDelete

innerSave

isOwner

getNewId

getNewId

getOfCache

hold

putOfCache

removeOfCache

cleanup

flush

get

get

remove

remove

update

persist

getCache

persist

isDirty

search

searchOfId

search

toString

equals

getVersion

getIdGenerator