GenericTableTraverserImpl (service-api 3.40.0SP12 API)

java.lang.Object
- com.tencent.tcaplus.client.impl.GenericTableTraverserImpl

All Implemented Interfaces:

GenericTableTraverser, Traverser
```
public class GenericTableTraverserImpl
extends Object
implements GenericTableTraverser
```
the generic-table traverser implementation

Author:

longfeilu

Field Summary

Fields
Modifier and Type	Field and Description
`protected AtomicLong`	`appendedCount` 用于totalLimit控制对于`ListTableTraverser`，appendedCount表示已经完全加载的key的数量，对于`GenericTableTraverser`, appendedCount表示已经加载记录数，
`protected boolean`	`appending` 扩展列表中
`protected CountDownLatch`	`appendingLock` 同步控制
`protected Client`	`client`
`protected int`	`curShard`
`protected TCaplusException`	`err`
`protected static int`	`ERROR_SHARD` shardList 已全部遍历结束，但是遍历器没有停止
`protected List<String>`	`fieldNames`
`protected static org.slf4j.Logger`	`LOGGER`
`protected long`	`offset`
`protected static int`	`OVER` 标示 shard 已遍历结束
`protected static int`	`READY` 标示 shard 未开始遍历
`protected List<Record>`	`records` 正在遍历的列表
`protected List<Record>`	`recordsNext` records 遍历完后， set records = recordsNext, recordsNext = null
`protected Map<Integer,Integer>`	`shardTraverserInfo`
`protected static int`	`STARTED` 标示 shard 正在遍历中
`protected String`	`tableName`
`protected long`	`totalLimit`
`protected long`	`traversedCnt`
`protected com.tencent.tcaplus.client.impl.AbstractTraverser.TraverserState`	`traverserState`
`protected long`	`visitedCount`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Traverser`	`addFieldsName(String... fieldsName)` 批量设置需要获取的字段名
`protected Request`	`baseNextRequest(int cmd)`
`protected void`	`checkInit()`
`String`	`getCursor()` 获取游标
`List<Record>`	`getNextPage()` 获取下一页数据，建议与 `GenericTableTraverser.getCursor()`, `GenericTableTraverser.setCursor(String)` 共同使用。此方法请不要与 `GenericTableTraverser.start()`, `Traverser.startAsync(Future)` 混合使用
`protected int`	`getNextShard()`
`protected void`	`getShardList()`
`boolean`	`isCompleted()` 是否遍历完成
`protected boolean`	`isStopped()`
`protected void`	`refreshNextRequestParam(Response rsp)`
`GenericTableTraverser`	`setCursor(String cursor)` 设置游标，不合法游标将忽略错误
`GenericTableTraverser`	`setLoadOptions(int pageSize)` 加载参数配置
`Traverser`	`setTableName(String tableName)` 设置所要遍历的表名
`Traverser`	`setTotalLimit(long totalLimit)` 设置总共要遍历的记录数
`Iterator<Record>`	`start()` 以同步方式开始遍历
`void`	`startAsync(Future future)` 执行异步遍历，按response进行回调,发生错误时不再获取数据，请自行处理response中的错误信息
`void`	`stop()` 停止遍历，可在遍历过程中停止。调用后不再在加载新数据

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.tencent.tcaplus.client.Traverser
addFieldsName, isCompleted, setTableName, setTotalLimit, stop

- Field Detail
  - READY
```
protected static final int READY
```
    标示 shard 未开始遍历
    
    See Also:
    
    Constant Field Values
  - STARTED
```
protected static final int STARTED
```
    标示 shard 正在遍历中
    
    See Also:
    
    Constant Field Values
  - OVER
```
protected static final int OVER
```
    标示 shard 已遍历结束
    
    See Also:
    
    Constant Field Values
  - ERROR_SHARD
```
protected static final int ERROR_SHARD
```
    shardList 已全部遍历结束，但是遍历器没有停止
    
    See Also:
    
    Constant Field Values
  - LOGGER
```
protected static final org.slf4j.Logger LOGGER
```
  - client
```
protected Client client
```
  - tableName
```
protected String tableName
```
  - fieldNames
```
protected List<String> fieldNames
```
  - shardTraverserInfo
```
protected Map<Integer,Integer> shardTraverserInfo
```
  - totalLimit
```
protected long totalLimit
```
  - curShard
```
protected volatile int curShard
```
  - offset
```
protected long offset
```
  - traversedCnt
```
protected long traversedCnt
```
  - appending
```
protected volatile boolean appending
```
    扩展列表中
  - appendingLock
```
protected volatile CountDownLatch appendingLock
```
    同步控制
  - records
```
protected List<Record> records
```
    正在遍历的列表
  - recordsNext
```
protected List<Record> recordsNext
```
    records 遍历完后， set records = recordsNext, recordsNext = null
  - appendedCount
```
protected final AtomicLong appendedCount
```
    用于totalLimit控制对于ListTableTraverser，appendedCount表示已经完全加载的key的数量，对于GenericTableTraverser, appendedCount表示已经加载记录数，
    
    See Also:
    
    isCompleted()
  - visitedCount
```
protected long visitedCount
```
  - traverserState
```
protected volatile com.tencent.tcaplus.client.impl.AbstractTraverser.TraverserState traverserState
```
  - err
```
protected volatile TCaplusException err
```
- Method Detail
  - start
```
public Iterator<Record> start()
                       throws TCaplusException
```
    Description copied from interface: GenericTableTraverser
    
    以同步方式开始遍历
    
    Specified by:
    
    start in interface GenericTableTraverser
    
    Returns:
    
    遍历迭代器
    
    Throws:
    
    TCaplusException
  - startAsync
```
public void startAsync(Future future)
                throws TCaplusException
```
    Description copied from interface: Traverser
    
    执行异步遍历，按response进行回调,发生错误时不再获取数据，请自行处理response中的错误信息
    
    Specified by:
    
    startAsync in interface Traverser
    
    Parameters:
    
    future - 用户回调方法
    
    Throws:
    
    TCaplusException
    
    See Also:
    
    Traverser.startAsync(Future)
  - setLoadOptions
```
public GenericTableTraverser setLoadOptions(int pageSize)
```
    Description copied from interface: GenericTableTraverser
    
    加载参数配置
    
    Specified by:
    
    setLoadOptions in interface GenericTableTraverser
    
    Parameters:
    
    pageSize - > 0 分页大小，每次请求获取的记录条数，每次提前加载一页数据
    
    Returns:
    
    this
  - setCursor
```
public GenericTableTraverser setCursor(String cursor)
```
    Description copied from interface: GenericTableTraverser
    
    设置游标，不合法游标将忽略错误
    
    Specified by:
    
    setCursor in interface GenericTableTraverser
    
    Parameters:
    
    cursor - format: curShard offset ...shardList
    
    Returns:
    
    this
  - getCursor
```
public String getCursor()
```
    Description copied from interface: GenericTableTraverser
    
    获取游标
    
    Specified by:
    
    getCursor in interface GenericTableTraverser
    
    Returns:
    
    format: curShard offset ...shardList
  - getNextPage
```
public List<Record> getNextPage()
```
    Description copied from interface: GenericTableTraverser
    
    获取下一页数据，建议与 GenericTableTraverser.getCursor(), GenericTableTraverser.setCursor(String) 共同使用。此方法请不要与 GenericTableTraverser.start(), Traverser.startAsync(Future) 混合使用
    
    Specified by:
    
    getNextPage in interface GenericTableTraverser
    
    Returns:
    
    数据记录
  - getShardList
```
protected void getShardList()
```
  - refreshNextRequestParam
```
protected void refreshNextRequestParam(Response rsp)
```
  - baseNextRequest
```
protected Request baseNextRequest(int cmd)
```
  - stop
```
public void stop()
```
    Description copied from interface: Traverser
    
    停止遍历，可在遍历过程中停止。调用后不再在加载新数据
    
    Specified by:
    
    stop in interface Traverser
  - setTableName
```
public Traverser setTableName(String tableName)
```
    Description copied from interface: Traverser
    
    设置所要遍历的表名
    
    Specified by:
    
    setTableName in interface Traverser
    
    Parameters:
    
    tableName - 表名
    
    Returns:
    
    this
  - getNextShard
```
protected int getNextShard()
```
  - addFieldsName
```
public Traverser addFieldsName(String... fieldsName)
```
    Description copied from interface: Traverser
    
    批量设置需要获取的字段名
    
    Specified by:
    
    addFieldsName in interface Traverser
    
    Parameters:
    
    fieldsName - 字段名列表
    
    Returns:
    
    this
  - setTotalLimit
```
public Traverser setTotalLimit(long totalLimit)
```
    Description copied from interface: Traverser
    
    设置总共要遍历的记录数
    
    Specified by:
    
    setTotalLimit in interface Traverser
    
    Parameters:
    
    totalLimit - 总共要遍历的记录数
    
    Returns:
    
    this
  - isStopped
```
protected boolean isStopped()
```
  - isCompleted
```
public boolean isCompleted()
```
    Description copied from interface: Traverser
    
    是否遍历完成
    
    Specified by:
    
    isCompleted in interface Traverser
    
    Returns:
    
    true 完成 | false 未完成
  - checkInit
```
protected void checkInit()
```

Class GenericTableTraverserImpl

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.tencent.tcaplus.client.Traverser

Field Detail

READY

STARTED

OVER

ERROR_SHARD

LOGGER

client

tableName

fieldNames

shardTraverserInfo

totalLimit

curShard

offset

traversedCnt

appending

appendingLock

records

recordsNext

appendedCount

visitedCount

traverserState

err

Method Detail

start

startAsync

setLoadOptions

setCursor

getCursor

getNextPage

getShardList

refreshNextRequestParam

baseNextRequest

stop

setTableName

getNextShard

addFieldsName

setTotalLimit

isStopped

isCompleted

checkInit