Persister (weforward-data-api 1.2.2 API)

类型参数:

E - 持久对象

所有超级接口:

cn.weforward.common.Nameable

所有已知实现类:

AbstractPersister, AbstractRemotePersister, MicroservicePersister, MultiPersisterFactory.MultiPersistent, RemoteInvokerPersister
```
public interface Persister<E extends Persistent>
extends cn.weforward.common.Nameable
```
对象持久器接口

作者:

daibo

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`void`	`addListener(ChangeListener<E> l)` 添加监听
`void`	`cleanup()` 清理持久器，立刻持久所有标记更新的持久对象
`void`	`flush(E object)` 若对象标示为更新的，立刻持久化对象
`E`	`get(String id)` 由ID取得持久对象
`E`	`get(UniteId id)` 由ID取得持久对象
`String`	`getName()` 取持久器名称，通常为类名
`UniteId`	`getNewId()` 生成新ID供新建对象使用
`UniteId`	`getNewId(String prefix)` 生成新ID并加上指定前缀
`String`	`getPersisterId()` 取得持久器的服务器标识
`String`	`getVersion(UniteId id)` 取得持久对象持久化后的版本号
`boolean`	`isDirty(E object)` 检查缓存中的持久对象是否还处理待刷写状态
`boolean`	`isForOwnerEnabled()` 只处理当前服务器持久类
`boolean`	`isOwner(E obj)` 对象是否属于当前服务器（根据对象持久ID确定）
`boolean`	`isReloadEnabled()` 是否已经启用对象重载功能，还需要业务对象实现以下接口才能收到通知
`void`	`persist(E object)` 立刻保存对象
`boolean`	`remove(String id)` 由持久器中删除指定ID的持久对象
`boolean`	`remove(UniteId id)` 由持久器中删除指定ID的持久对象
`void`	`removeListener(ChangeListener<E> l)` 移除监听
`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<String>`	`searchOfId(Condition condition, OrderBy orderBy)` 条件查询
`cn.weforward.common.ResultPage<String>`	`searchOfId(Date begin, Date end)` 查找在指定时间段内变化（持久化）过的对象 (begin,end]
`Iterator<String>`	`searchOfId(String serverId, Date begin, Date end)` 查找在指定时间段内变化（持久化）过的对象
`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
`cn.weforward.common.ResultPage<String>`	`searchRangeOfId(String from, String to)` 查找ID在指定区间内的对象，id>=from and id<=to
`Iterator<String>`	`searchRangeOfId(String serverId, String from, String to)` 查找ID在指定区间内的对象，id>=from and id<=to
`boolean`	`setForOwnerEnabled(boolean enabled)` 启用/关闭只处理当前服务器持久类
`boolean`	`setReloadEnabled(boolean enabled)` 启用/关闭对象重载功能
`cn.weforward.common.ResultPage<E>`	`startsWith(String prefix)` 查找ID为指定前缀的对象
`cn.weforward.common.ResultPage<String>`	`startsWithOfId(String prefix)` 查找ID为指定前缀的对象
`void`	`update(E object)` 标示对象状态已变化，由持久器选择合适的时候刷写

- 方法详细资料
  - getName
```
String getName()
```
    取持久器名称，通常为类名
    
    指定者:
    
    getName 在接口中 cn.weforward.common.Nameable
    
    返回:
    
    持久器名称
  - get
```
E get(UniteId id)
```
    由ID取得持久对象
    
    参数:
    
    id - 持久对象ID
    
    返回:
    
    相应的持久对象
  - get
```
E get(String id)
```
    由ID取得持久对象
    
    参数:
    
    id - 持久对象ID
    
    返回:
    
    相应的持久对象
  - remove
```
boolean remove(UniteId id)
```
    由持久器中删除指定ID的持久对象
    
    参数:
    
    id - 持久对象ID
    
    返回:
    
    false表示没有对应的持久对象
  - remove
```
boolean remove(String id)
```
    由持久器中删除指定ID的持久对象
    
    参数:
    
    id - 持久对象ID
    
    返回:
    
    false表示没有对应的持久对象
  - update
```
void update(E object)
```
    标示对象状态已变化，由持久器选择合适的时候刷写
    
    参数:
    
    object - 持久对象
  - persist
```
void persist(E object)
```
    立刻保存对象
    
    参数:
    
    object - 对象
  - isDirty
```
boolean isDirty(E object)
```
    检查缓存中的持久对象是否还处理待刷写状态
    
    参数:
    
    object - 要检查的对象
    
    返回:
    
    有在缓存且是待刷写状态返回true
  - isOwner
```
boolean isOwner(E obj)
```
    对象是否属于当前服务器（根据对象持久ID确定）
    
    参数:
    
    obj - 持久对象
    
    返回:
    
    是属于当前服务器（标识）则返回true，否则false
  - flush
```
void flush(E object)
```
    若对象标示为更新的，立刻持久化对象
    
    参数:
    
    object - 持久对象
  - cleanup
```
void cleanup()
```
    清理持久器，立刻持久所有标记更新的持久对象
  - getPersisterId
```
String getPersisterId()
```
    取得持久器的服务器标识
    
    返回:
    
    标识
  - getNewId
```
UniteId getNewId()
          throws IdDuplicateException
```
    生成新ID供新建对象使用
    
    返回:
    
    新的ID
    
    抛出:
    
    IdDuplicateException - id重复异常
  - getNewId
```
UniteId getNewId(String prefix)
          throws IdDuplicateException
```
    生成新ID并加上指定前缀
    
    参数:
    
    prefix - ID前缀
    
    返回:
    
    新的ID
    
    抛出:
    
    IdDuplicateException - id重复异常
  - getVersion
```
String getVersion(UniteId id)
```
    取得持久对象持久化后的版本号
    
    参数:
    
    id - 持久对象ID
    
    返回:
    
    返回版本号，若不找这ID的对象则返回null，若不支持版本号则返回空字串（""）
  - isReloadEnabled
```
boolean isReloadEnabled()
```
    是否已经启用对象重载功能，还需要业务对象实现以下接口才能收到通知
    
    返回:
    
    启用返回true
    
    另请参阅:
    
    Reloadable
  - setReloadEnabled
```
boolean setReloadEnabled(boolean enabled)
```
    启用/关闭对象重载功能
    
    参数:
    
    enabled - 启用/关闭
    
    返回:
    
    返回true表示支持此功能的开启，不支持则返回false
  - isForOwnerEnabled
```
boolean isForOwnerEnabled()
```
    只处理当前服务器持久类
    
    返回:
    
    只处理返回true
  - setForOwnerEnabled
```
boolean setForOwnerEnabled(boolean enabled)
```
    启用/关闭只处理当前服务器持久类
    
    参数:
    
    enabled - 启用/关闭
    
    返回:
    
    返回true表示支持此功能的开启，不支持则返回false
  - startsWith
```
cn.weforward.common.ResultPage<E> startsWith(String prefix)
```
    查找ID为指定前缀的对象
    
    参数:
    
    prefix - ID前缀
    
    返回:
    
    对象结果页
  - startsWithOfId
```
cn.weforward.common.ResultPage<String> startsWithOfId(String prefix)
```
    查找ID为指定前缀的对象
    
    参数:
    
    prefix - ID前缀
    
    返回:
    
    对象结果页
  - search
```
cn.weforward.common.ResultPage<E> search(Date begin,
                                         Date end)
```
    查找在指定时间段内变化（持久化）过的对象 (begin,end]
    
    参数:
    
    begin - 开始时间，若=null则不限制开始时间
    
    end - 结束时间，若=null则为当前时间
    
    返回:
    
    对象结果页
  - searchOfId
```
cn.weforward.common.ResultPage<String> searchOfId(Date begin,
                                                  Date end)
```
    查找在指定时间段内变化（持久化）过的对象 (begin,end]
    
    参数:
    
    begin - 开始时间，若=null则不限制开始时间
    
    end - 结束时间，若=null则为当前时间
    
    返回:
    
    对象ID形式的结果页
  - searchRange
```
cn.weforward.common.ResultPage<E> searchRange(String from,
                                              String to)
```
    查找ID在指定区间内的对象，id>=from and id<=to
    
    参数:
    
    from - ID开始点，若为null则不限制开始（但to不能为null）
    
    to - ID结束点，若为null则不限制结束（但from不能为null）
    
    返回:
    
    对象结果页
  - searchRangeOfId
```
cn.weforward.common.ResultPage<String> searchRangeOfId(String from,
                                                       String to)
```
    查找ID在指定区间内的对象，id>=from and id<=to
    
    参数:
    
    from - ID开始点，若为null则不限制开始（但to不能为null）
    
    to - ID结束点，若为null则不限制结束（但from不能为null）
    
    返回:
    
    对象ID形式的结果页
  - search
```
Iterator<E> search(String serverId,
                   Date begin,
                   Date end)
```
    查找在指定时间段内变化（持久化）过的对象
    
    参数:
    
    serverId - 服务器标识（1~255）
    
    begin - 开始时间，若=null则不限制开始时间
    
    end - 结束时间，若=null则为当前时间
    
    返回:
    
    结果集迭代器
  - searchOfId
```
Iterator<String> searchOfId(String serverId,
                            Date begin,
                            Date end)
```
    查找在指定时间段内变化（持久化）过的对象
    
    参数:
    
    serverId - 服务器标识（1~255）
    
    begin - 开始时间，若=null则不限制开始时间
    
    end - 结束时间，若=null则为当前时间
    
    返回:
    
    结果集迭代器
  - searchRange
```
Iterator<E> searchRange(String serverId,
                        String from,
                        String to)
```
    查找ID在指定区间内的对象，id>=from and id<=to
    
    参数:
    
    serverId - 服务器标识
    
    from - ID开始点，若为null则不限制开始（但to不能为null）
    
    to - ID结束点，若为null则不限制结束（但from不能为null）
    
    返回:
    
    结果集迭代器
  - searchRangeOfId
```
Iterator<String> searchRangeOfId(String serverId,
                                 String from,
                                 String to)
```
    查找ID在指定区间内的对象，id>=from and id<=to
    
    参数:
    
    serverId - 服务器标识
    
    from - ID开始点，若为null则不限制开始（但to不能为null）
    
    to - ID结束点，若为null则不限制结束（但from不能为null）
    
    返回:
    
    结果集迭代器
  - search
```
cn.weforward.common.ResultPage<E> search(Condition condition)
```
    条件查询
    
    参数:
    
    condition - 条件 ConditionUtil
    
    返回:
    
    对象结果页
  - searchOfId
```
cn.weforward.common.ResultPage<String> searchOfId(Condition condition)
```
    条件查询
    
    参数:
    
    condition - 条件 ConditionUtil
    
    返回:
    
    对象结果页
  - search
```
cn.weforward.common.ResultPage<E> search(Condition condition,
                                         OrderBy orderBy)
```
    条件查询
    
    参数:
    
    condition - 条件 ConditionUtil
    
    orderBy - 排序 OrderByUtil
    
    返回:
    
    对象结果页
  - searchOfId
```
cn.weforward.common.ResultPage<String> searchOfId(Condition condition,
                                                  OrderBy orderBy)
```
    条件查询
    
    参数:
    
    condition - 条件 ConditionUtil
    
    orderBy - 排序 OrderByUtil
    
    返回:
    
    对象结果页
  - addListener
```
void addListener(ChangeListener<E> l)
```
    添加监听
    
    参数:
    
    l - 监听对象
  - removeListener
```
void removeListener(ChangeListener<E> l)
```
    移除监听
    
    参数:
    
    l - 监听对象

接口 Persister<E extends Persistent>

方法概要

方法详细资料

getName

get

get

remove

remove

update

persist

isDirty

isOwner

flush

cleanup

getPersisterId

getNewId

getNewId

getVersion

isReloadEnabled

setReloadEnabled

isForOwnerEnabled

setForOwnerEnabled

startsWith

startsWithOfId

search

searchOfId

searchRange

searchRangeOfId

search

searchOfId

searchRange

searchRangeOfId

search

searchOfId

search

searchOfId

addListener

removeListener