com.alicloud.openservices.tablestore.model

类 RangeIteratorParameter

java.lang.Object

com.alicloud.openservices.tablestore.model.RowQueryCriteria

com.alicloud.openservices.tablestore.model.RangeIteratorParameter

public class RangeIteratorParameter
extends RowQueryCriteria

构造器概要

构造器

构造器和说明
RangeIteratorParameter(RangeRowQueryCriteria criteria)
RangeIteratorParameter(String tableName) Constructs a query condition for a table with the given name.

方法概要

限定符和类型	方法和说明
int	getBufferSize() Get the size of the internal Buffer.
Direction	getDirection() Get the read order of the range query (forward(FORWARD) or backward(BACKWARD)).
PrimaryKey	getExclusiveEndPrimaryKey() Get the primary key value of the right boundary for the range query.
PrimaryKey	getInclusiveStartPrimaryKey() Gets the primary key value of the left boundary for the range query.
int	getMaxCount() The maximum number of rows that the iterator can return
void	setBufferSize(int bufferSize) Set the size of the Buffer.
void	setDirection(Direction direction) Set the read order (FORWARD or BACKWARD) for the range query.
void	setExclusiveEndPrimaryKey(PrimaryKey exclusiveEndPrimaryKey) Range queries require users to specify a range of primary keys.
void	setInclusiveStartPrimaryKey(PrimaryKey inclusiveStartPrimaryKey) A range query requires the user to specify a range of primary keys.
void	setMaxCount(int maxCount) Set the maximum number of rows that this Iterator will return

从类继承的方法 com.alicloud.openservices.tablestore.model.RowQueryCriteria

addColumnsToGet, addColumnsToGet, addColumnsToGet, clearColumnsToGet, copyTo, getCacheBlocks, getColumnsToGet, getEndColumn, getFilter, getMaxVersions, getStartColumn, getTableName, getTimeRange, hasSetCacheBlock, hasSetEndColumn, hasSetFilter, hasSetMaxVersions, hasSetStartColumn, hasSetTimeRange, numColumnsToGet, setCacheBlocks, setEndColumn, setFilter, setMaxVersions, setStartColumn, setTableName, setTimeRange, setTimestamp

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

RangeIteratorParameter

public RangeIteratorParameter(String tableName)

Constructs a query condition for a table with the given name.

参数:

tableName - The name of the table to query.

RangeIteratorParameter

public RangeIteratorParameter(RangeRowQueryCriteria criteria)

方法详细资料

getMaxCount

public int getMaxCount()

The maximum number of rows that the iterator can return. -1 means returning all rows within this range (default value).

返回:

The maximum number of rows returned by this operation.

setMaxCount

public void setMaxCount(int maxCount)

Set the maximum number of rows that this Iterator will return. -1 means returning all rows within this range (default value).

参数:

maxCount - The number of rows to be returned in a single request.

getBufferSize

public int getBufferSize()

Get the size of the internal Buffer.

返回:

The size of the Buffer.

setBufferSize

public void setBufferSize(int bufferSize)

Set the size of the Buffer.

参数:

bufferSize - The size of the Buffer.

getDirection

public Direction getDirection()

Get the read order of the range query (forward(FORWARD) or backward(BACKWARD)).

返回:

Read order

setDirection

public void setDirection(Direction direction)

Set the read order (FORWARD or BACKWARD) for the range query.

参数:

direction - The read order

getInclusiveStartPrimaryKey

public PrimaryKey getInclusiveStartPrimaryKey()

Gets the primary key value of the left boundary for the range query.

返回:

The primary key value of the left boundary for the range query.

setInclusiveStartPrimaryKey

public void setInclusiveStartPrimaryKey(PrimaryKey inclusiveStartPrimaryKey)

A range query requires the user to specify a range of primary keys. This range is a half-open interval that is closed on the left and open on the right. The inclusiveStartPrimaryKey represents the left boundary of this interval. If direction is FORWARD, then inclusiveStartPrimaryKey must be less than exclusiveEndPrimaryKey. If direction is BACKWARD, then inclusiveStartPrimaryKey must be greater than exclusiveEndPrimaryKey. inclusiveStartPrimaryKey must include all primary key columns defined in the table. The values of the columns can be defined as PrimaryKeyValue.INF_MIN or PrimaryKeyValue.INF_MAX to represent the entire range of possible values for that column.

参数:

inclusiveStartPrimaryKey - The primary key value for the left boundary of the range query.

getExclusiveEndPrimaryKey

public PrimaryKey getExclusiveEndPrimaryKey()

Get the primary key value of the right boundary for the range query.

返回:

The primary key value of the right boundary for the range query.

setExclusiveEndPrimaryKey

public void setExclusiveEndPrimaryKey(PrimaryKey exclusiveEndPrimaryKey)

Range queries require users to specify a range of primary keys. This range is a half-open interval that is closed on the left and open on the right, with exclusiveEndPrimaryKey being the right boundary of the interval. If direction is FORWARD, exclusiveEndPrimaryKey must be greater than inclusiveStartPrimaryKey. If direction is BACKWARD, exclusiveEndPrimaryKey must be less than inclusiveStartPrimaryKey. exclusiveEndPrimaryKey must include all primary key columns defined in the table. The values of the columns can be defined as PrimaryKeyValue.INF_MIN or PrimaryKeyValue.INF_MAX to represent the entire range of possible values for that column.

参数:

exclusiveEndPrimaryKey - The primary key value representing the right boundary of the range query.