程序包 ohos.data.distributed.common

接口 KvStoreResultSet

public interface KvStoreResultSet

Provide methods to obtain the result set of the KvStore database.

The result set is created by using the getResultSet method in the DeviceKvStore class. This interface also provides methods for moving the data read position in the result set.

从以下版本开始:

1

SystemCapability

SystemCapability.Data#DATA_DISTRIBUTEDDATAMGR

方法概要

限定符和类型	方法	说明
Entry	getEntry()	Obtains a key-value pair.
int	getRowCount()	Obtains the number of lines in a result set.
int	getRowIndex()	Obtains the current read position in a result set.
boolean	goToFirstRow()	Moves the read position to the first line.
boolean	goToLastRow()	Moves the read position to the last line.
boolean	goToNextRow()	Moves the read position to the next line.
boolean	goToPreviousRow()	Moves the read position to the previous line.
boolean	goToRow(int rowIndex)	Moves the read position from 0 to an absolute position.
boolean	isAtFirstRow()	Checks whether the read position is the first line.
boolean	isAtLastRow()	Checks whether the read position is the last line.
boolean	isEnded()	Checks whether the read position is after the last line.
boolean	isStarted()	Checks whether the read position is before the first line.
boolean	skipRow(int offset)	Moves the read position by a relative offset to the current position.

方法详细资料

getRowCount

int getRowCount()

Obtains the number of lines in a result set.

返回:

Returns the number of lines.

从以下版本开始:

1

getRowIndex

int getRowIndex()

Obtains the current read position in a result set.

返回:

Returns the current read position. The read position starts with 0.

从以下版本开始:

1

goToFirstRow

boolean goToFirstRow()

Moves the read position to the first line.

If the result set is empty, false is returned.

返回:

Returns true if the operation succeeds; return false otherwise.

从以下版本开始:

1

goToLastRow

boolean goToLastRow()

Moves the read position to the last line.

If the result set is empty, false is returned.

返回:

Returns true if the operation succeeds; return false otherwise.

从以下版本开始:

1

goToNextRow

boolean goToNextRow()

Moves the read position to the next line.

If the result set is empty or the data in the last line is being read, false is returned.

返回:

Returns true if the operation succeeds; return false otherwise.

从以下版本开始:

1

goToPreviousRow

boolean goToPreviousRow()

Moves the read position to the previous line.

If the result set is empty or the data in the first line is being read, false is returned.

返回:

Returns true if the operation succeeds; return false otherwise.

从以下版本开始:

1

skipRow

boolean skipRow(int offset)

Moves the read position by a relative offset to the current position.

参数:

offset - Indicates the relative offset to the current position. A negative offset indicates moving backwards, and a positive offset indicates moving forewards. For example, if the current position is entry 1 and this offset is 2, the destination position will be entry 3; if the current position is entry 3 and this offset is -2, the destination position will be entry 1. The valid final position after moving forwards starts with 0. If the final position is invalid, false will be returned.

返回:

Returns true if the operation succeeds; return false otherwise.

从以下版本开始:

1

goToRow

boolean goToRow(int rowIndex)

Moves the read position from 0 to an absolute position.

参数:

rowIndex - Indicates the absolute position.

返回:

Returns true if the operation succeeds; return false otherwise.

从以下版本开始:

1

isAtFirstRow

boolean isAtFirstRow()

Checks whether the read position is the first line.

返回:

Returns true if the read position is the first line; returns false otherwise.

从以下版本开始:

1

isAtLastRow

boolean isAtLastRow()

Checks whether the read position is the last line.

返回:

Returns true if the read position is the last line; returns false otherwise.

从以下版本开始:

1

isStarted

boolean isStarted()

Checks whether the read position is before the first line.

返回:

Returns true if the read position is before the first line; returns false otherwise.

从以下版本开始:

1

isEnded

boolean isEnded()

Checks whether the read position is after the last line.

返回:

Returns true if the read position is after the last line; returns false otherwise.

从以下版本开始:

1

getEntry

Entry getEntry()

Obtains a key-value pair.

返回:

Returns a key-value pair.

从以下版本开始:

1