com.alicloud.openservices.tablestore.model

类 PrimaryKey

java.lang.Object

com.alicloud.openservices.tablestore.model.PrimaryKey

所有已实现的接口:

Jsonizable, Measurable, Comparable<PrimaryKey>

public class PrimaryKey
extends Object
implements Comparable<PrimaryKey>, Jsonizable, Measurable

In TableStore, each row of data contains a primary key (PrimaryKey), which is composed of multiple primary key columns (PrimaryKeyColumn). Each primary key column includes the name of the primary key column and the value of the primary key column (PrimaryKeyValue).

The number of primary key columns included in the primary key and their order are consistent with what is defined in the TableMeta when creating the table.

构造器概要

构造器

构造器和说明
PrimaryKey() internal use
PrimaryKey(List<PrimaryKeyColumn> primaryKey) Constructor.
PrimaryKey(PrimaryKeyColumn[] primaryKey) Constructor.

方法概要

限定符和类型	方法和说明
int	compareTo(PrimaryKey target) Compare two primary keys.
boolean	contains(String name) Check if the primary key contains a primary key column with this name.
boolean	equals(Object o)
int	getDataSize() Get the total data size of the row primary key, which includes the names and values of all primary key columns.
PrimaryKeyColumn	getPrimaryKeyColumn(int index) Get the corresponding primary key column by position.
PrimaryKeyColumn	getPrimaryKeyColumn(String name) Get the primary key column of a specified name.
PrimaryKeyColumn[]	getPrimaryKeyColumns() Get all the primary key columns.
Map<String,PrimaryKeyColumn>	getPrimaryKeyColumnsMap() Get the Map of primary key column names to primary key columns.
int	getSize() 已过时。
int	hashCode()
boolean	isEmpty() Checks if the primary key is empty, meaning it does not contain any primary key columns.
String	jsonize()
void	jsonize(StringBuilder sb, String newline)
int	size() Returns the number of primary key columns.
String	toString()

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

构造器详细资料

PrimaryKey

public PrimaryKey(PrimaryKeyColumn[] primaryKey)

Constructor.

The primary key column array passed in must not be a null pointer. The number of primary key columns and their order in the array must be consistent with what was defined in the TableMeta when the table was created.

参数:

primaryKey - All the primary key columns included in this primary key

PrimaryKey

public PrimaryKey(List<PrimaryKeyColumn> primaryKey)

Constructor.

The primary key column list passed in must not be a null pointer. The number of primary key columns and their order in the list must match the definition in TableMeta when the table was created.

参数:

primaryKey -

PrimaryKey

public PrimaryKey()

internal use

方法详细资料

getPrimaryKeyColumn

public PrimaryKeyColumn getPrimaryKeyColumn(String name)

Get the primary key column of a specified name.

Returns null if the primary key column with the specified name is not found.

If the list of primary key columns passed during initialization contains primary key columns with the same name, it is not guaranteed which specific primary key column value corresponding to the name will be returned.

参数:

name - The name of the primary key column

返回:

Returns the value of the corresponding primary key column if it exists; otherwise, returns null

getPrimaryKeyColumn

public PrimaryKeyColumn getPrimaryKeyColumn(int index)

Get the corresponding primary key column by position.

The number of primary key columns included in the primary key and the order of the primary key columns are consistent with what is defined in TableMeta when creating the table.

If the corresponding position does not exist, an IllegalArgumentException will be thrown.

参数:

index - The position of the primary key column

返回:

The primary key column corresponding to the specific position

getPrimaryKeyColumns

public PrimaryKeyColumn[] getPrimaryKeyColumns()

Get all the primary key columns.

The number of primary key columns included in the primary key and their order are consistent with the definition in TableMeta when creating the table.

返回:

all the primary key columns

getPrimaryKeyColumnsMap

public Map<String,PrimaryKeyColumn> getPrimaryKeyColumnsMap()

Get the Map of primary key column names to primary key columns.

If the primary key column list passed during initialization contains primary key columns with the same name, only one of these columns will be returned in the resulting Map.

返回:

the Map of primary key column names to primary key columns

contains

public boolean contains(String name)

Check if the primary key contains a primary key column with this name.

参数:

name - The name of the primary key column

返回:

Returns true if it contains, otherwise returns false

size

public int size()

Returns the number of primary key columns.

返回:

the number of primary key columns

isEmpty

public boolean isEmpty()

Checks if the primary key is empty, meaning it does not contain any primary key columns.

返回:

Returns true if the primary key is empty; otherwise, returns false.

getSize

@Deprecated
public int getSize()

已过时。

getDataSize

public int getDataSize()

Get the total data size of the row primary key, which includes the names and values of all primary key columns.

指定者:

getDataSize 在接口中 Measurable

返回:

the total data size of the row primary key

compareTo

public int compareTo(PrimaryKey target)

Compare two primary keys.

The two primary keys being compared must have the same schema, meaning the number of columns, primary key names, and order must be completely consistent.

指定者:

compareTo 在接口中 Comparable<PrimaryKey>

参数:

target -

返回:

Comparison result

toString

public String toString()

覆盖:

toString 在类中 Object

equals

public boolean equals(Object o)

覆盖:

equals 在类中 Object

hashCode

public int hashCode()

覆盖:

hashCode 在类中 Object

jsonize

public String jsonize()

指定者:

jsonize 在接口中 Jsonizable

jsonize

public void jsonize(StringBuilder sb,
                    String newline)

指定者:

jsonize 在接口中 Jsonizable