PrimaryKeyValue (AliCloud TableStore SDK for Java 5.17.7 API)

java.lang.Object
- com.alicloud.openservices.tablestore.model.PrimaryKeyValue

所有已实现的接口:

Measurable, Comparable<PrimaryKeyValue>
```
public class PrimaryKeyValue
extends Object
implements Comparable<PrimaryKeyValue>, Measurable
```
Represents the value of a primary key column.
To construct a primary key column of type PrimaryKeyType.INTEGER, use fromLong(long) to initialize it.

To construct a primary key column of type PrimaryKeyType.STRING, use fromString(String) to initialize it.

To construct a primary key column of type PrimaryKeyType.BINARY, use fromBinary(byte[]) to initialize it.

Note: INF_MIN and INF_MAX are special primary key columns that are only used to indicate the range of primary key columns in the SyncClientInterface.getRange(GetRangeRequest) operation. They cannot be used as actual data written to TableStore, nor can they be used as parameters for any read operations other than GetRange.

字段概要

字段
限定符和类型	字段和说明
`static PrimaryKeyValue`	`AUTO_INCREMENT`
`static PrimaryKeyValue`	`AUTO_INCRMENT` 已过时。
`static PrimaryKeyValue`	`INF_MAX` Represents the maximum value of the primary key range, which is only used for the `SyncClientInterface.getRange(GetRangeRequest)` operation to indicate the range of the primary key column.
`static PrimaryKeyValue`	`INF_MIN` Represents the minimum value of the primary key range, which is only used for the `SyncClientInterface.getRange(GetRangeRequest)` operation to indicate the range of the primary key column.

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`static PrimaryKeyValue`	`addOne(PrimaryKeyValue target)`
`byte[]`	`asBinary()` Get the value of the primary key column in binary string type.
`long`	`asLong()` Get the long integer value of the primary key column.
`String`	`asString()` Get the string value of the primary key column.
`byte[]`	`asStringInBytes()`
`int`	`compareTo(PrimaryKeyValue target)` Compare the values of two primary key columns.
`boolean`	`equals(Object o)`
`static PrimaryKeyValue`	`fromBinary(byte[] value)` Construct a primary key column of type `PrimaryKeyType.BINARY`.
`static PrimaryKeyValue`	`fromColumn(ColumnValue value)`
`static PrimaryKeyValue`	`fromLong(long value)` Constructs a primary key column of type `PrimaryKeyType.INTEGER`.
`static PrimaryKeyValue`	`fromString(String value)` Constructs a primary key column of type `PrimaryKeyType.STRING`.
`static PrimaryKeyValue`	`fromString(String value, byte[] rawData)` Constructs a primary key column of type `PrimaryKeyType.STRING`.
`byte`	`getChecksum(byte crc)` Get a checksum using the crc8 algorithm, mainly used to calculate the checksum of a cell
`int`	`getDataSize()` Get the size of the primary key column value, the size calculation formula for each type is: - `PrimaryKeyType.INTEGER`: Constant size of 8 bytes - `PrimaryKeyType.STRING`: Size is the number of bytes after UTF-8 encoding
`int`	`getSize()` 已过时。
`PrimaryKeyType`	`getType()` Get the type of the primary key column.
`int`	`hashCode()`
`boolean`	`isInfMax()` For internal use.
`boolean`	`isInfMin()` For internal use.
`boolean`	`isPlaceHolderForAutoIncr()` For internal use.
`ColumnValue`	`toColumnValue()`
`String`	`toString()`

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

- 字段详细资料
  - INF_MAX
```
public static final PrimaryKeyValue INF_MAX
```
    Represents the maximum value of the primary key range, which is only used for the SyncClientInterface.getRange(GetRangeRequest) operation to indicate the range of the primary key column. It cannot be used as actual data written to TableStore, nor can it be used as a parameter for any read operations other than GetRange.
  - INF_MIN
```
public static final PrimaryKeyValue INF_MIN
```
    Represents the minimum value of the primary key range, which is only used for the SyncClientInterface.getRange(GetRangeRequest) operation to indicate the range of the primary key column. It cannot be used as actual data to be written into TableStore, nor can it be used as a parameter for any read operations other than GetRange.
  - AUTO_INCRMENT
```
@Deprecated
public static final PrimaryKeyValue AUTO_INCRMENT
```
    已过时。
    
    Indicates that the primary key value is retained, and its only purpose is for filling in PK increment columns. When a PK column is set as an increment column, during PutRow or UpdateRow operations, if the user specifies the value of this column as AUTO_INCREMENT, OTS will automatically assign a larger value to this column after the row is successfully written, ensuring that the value of this column is permanently increasing.
  - AUTO_INCREMENT
```
public static final PrimaryKeyValue AUTO_INCREMENT
```
- 方法详细资料
  - getType
```
public PrimaryKeyType getType()
```
    Get the type of the primary key column.
    
    返回:
    
    The type of the primary key column.
  - getSize
```
@Deprecated
public int getSize()
```
    已过时。
  - getDataSize
```
public int getDataSize()
```
    Get the size of the primary key column value, the size calculation formula for each type is: - PrimaryKeyType.INTEGER: Constant size of 8 bytes - PrimaryKeyType.STRING: Size is the number of bytes after UTF-8 encoding
    
    指定者:
    
    getDataSize 在接口中 Measurable
    
    返回:
    
    The size of the value
  - fromString
```
public static PrimaryKeyValue fromString(String value)
```
    Constructs a primary key column of type PrimaryKeyType.STRING.
    Note: The value cannot be a null pointer.
    
    参数:
    
    value - The value of string type.
    
    返回:
    
    The generated object
  - fromString
```
public static PrimaryKeyValue fromString(String value,
                                         byte[] rawData)
```
    Constructs a primary key column of type PrimaryKeyType.STRING.
    Note: The value cannot be a null pointer.
    
    参数:
    
    value - The value of string type.
    
    rawData - The raw bytes for utf-8 string.
    
    返回:
    
    The generated object
  - fromLong
```
public static PrimaryKeyValue fromLong(long value)
```
    Constructs a primary key column of type PrimaryKeyType.INTEGER.
    
    参数:
    
    value - The long integer value.
    
    返回:
    
    The generated object
  - fromBinary
```
public static PrimaryKeyValue fromBinary(byte[] value)
```
    Construct a primary key column of type PrimaryKeyType.BINARY.
    Note: The value cannot be a null pointer.
    
    参数:
    
    value - The value of binary string type.
    
    返回:
    
    The generated object
  - fromColumn
```
public static PrimaryKeyValue fromColumn(ColumnValue value)
```
  - getChecksum
```
public byte getChecksum(byte crc)
                 throws IOException
```
    Get a checksum using the crc8 algorithm, mainly used to calculate the checksum of a cell
    
    参数:
    
    crc -
    
    返回:
    
    checksum
    
    抛出:
    
    IOException
  - toColumnValue
```
public ColumnValue toColumnValue()
                          throws IOException
```
    抛出:
    
    IOException
  - asString
```
public String asString()
```
    Get the string value of the primary key column.
    Currently, the value can only be obtained when the data type is PrimaryKeyType.STRING.
    
    返回:
    
    The string value
  - asStringInBytes
```
public byte[] asStringInBytes()
```
  - asLong
```
public long asLong()
```
    Get the long integer value of the primary key column.
    Currently, the value can only be obtained when the data type is PrimaryKeyType.INTEGER.
    
    返回:
    
    Long integer value
  - asBinary
```
public byte[] asBinary()
```
    Get the value of the primary key column in binary string type.
    Currently, the value can only be obtained when the data type is PrimaryKeyType.BINARY.
    
    返回:
    
    The value in binary string type
  - isInfMin
```
public boolean isInfMin()
```
    For internal use. DO NOT USE.
    
    返回:
    
    true if it is INF_MIN
  - isInfMax
```
public boolean isInfMax()
```
    For internal use. DO NOT USE.
    
    返回:
    
    true if it is INF_MAX
  - isPlaceHolderForAutoIncr
```
public boolean isPlaceHolderForAutoIncr()
```
    For internal use. DO NOT USE.
    
    返回:
    
    true if it is AUTO_INCREMENT
  - equals
```
public boolean equals(Object o)
```
    覆盖:
    
    equals 在类中 Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 Object
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - compareTo
```
public int compareTo(PrimaryKeyValue target)
```
    Compare the values of two primary key columns.
    Note: Primary key columns of different types cannot be compared.
    
    INF_MIN and INF_MAX can be compared with other types of primary key columns, and INF_MIN is smaller than any value of any primary key column type, while INF_MAX is greater than any value of any primary key column type.
    
    指定者:
    
    compareTo 在接口中 Comparable<PrimaryKeyValue>
    
    参数:
    
    target -
    
    返回:
    
    If greater, the return value is greater than 0; if equal, returns 0; if less, the return value is less than 0
  - addOne
```
public static PrimaryKeyValue addOne(PrimaryKeyValue target)
```

类 PrimaryKeyValue

字段概要

方法概要

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

字段详细资料

INF_MAX

INF_MIN

AUTO_INCRMENT

AUTO_INCREMENT

方法详细资料

getType

getSize

getDataSize

fromString

fromString

fromLong

fromBinary

fromColumn

getChecksum

toColumnValue

asString

asStringInBytes

asLong

asBinary

isInfMin

isInfMax

isPlaceHolderForAutoIncr

equals

hashCode

toString

compareTo

addOne