com.alicloud.openservices.tablestore.model

Class PrimaryKey

java.lang.Object

com.alicloud.openservices.tablestore.model.PrimaryKey

All Implemented Interfaces:

Jsonizable, Measurable, Comparable<PrimaryKey>

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

TableStore中每行数据都包含主键(PrimaryKey)， 主键由多列主键列构成(PrimaryKeyColumn)， 每一个主键列包含主键列名称和主键列的值PrimaryKeyValue。

主键中包含的主键列的个数以及主键列的顺序与创建表时TableMeta中定义的一致。

Constructor Summary

Constructors

Constructor and Description
PrimaryKey() internal use
PrimaryKey(List<PrimaryKeyColumn> primaryKey) 构造函数。
PrimaryKey(PrimaryKeyColumn[] primaryKey) 构造函数。

Method Summary

Modifier and Type	Method and Description
int	compareTo(PrimaryKey target) 比较两个主键。
boolean	contains(String name) 检查主键中是否有该名称的主键列。
boolean	equals(Object o)
int	getDataSize() 获取行主键的数据大小总和，大小总和包括所有主键列的名称和值。
PrimaryKeyColumn	getPrimaryKeyColumn(int index) 按位置获取对应的主键列。
PrimaryKeyColumn	getPrimaryKeyColumn(String name) 获取某个指定名称的主键列。
PrimaryKeyColumn[]	getPrimaryKeyColumns() 获取所有的主键列。
Map<String,PrimaryKeyColumn>	getPrimaryKeyColumnsMap() 获取主键列名称与主键列映射的Map。
int	getSize() Deprecated.
int	hashCode()
boolean	isEmpty() 该主键是否为空，若主键未包含任何主键列则代表该主键为空。
String	jsonize()
void	jsonize(StringBuilder sb, String newline)
int	size() 返回主键列的个数。
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PrimaryKey

public PrimaryKey(PrimaryKeyColumn[] primaryKey)

构造函数。

传入的主键列数组不能为null pointer，主键列的个数以及主键列在数组中的顺序必须与创建表时TableMeta中定义的一致。

Parameters:

primaryKey - 该主键包含的所有主键列

PrimaryKey

public PrimaryKey(List<PrimaryKeyColumn> primaryKey)

构造函数。

传入的主键列列表不能为null pointer，主键列的个数以及主键列在列表中的顺序必须与创建表时TableMeta中定义的一致。

Parameters:

primaryKey -

PrimaryKey

public PrimaryKey()

internal use

Method Detail

getPrimaryKeyColumn

public PrimaryKeyColumn getPrimaryKeyColumn(String name)

获取某个指定名称的主键列。

若找不到该名称的主键列，则返回null。

若初始化时传入的主键列列表包含相同名称的主键列，则不保证返回具体哪个对应名称的主键列的值。

Parameters:

name - 主键列的名称

Returns:

若存在则返回对应的主键列的值，否则返回null

getPrimaryKeyColumn

public PrimaryKeyColumn getPrimaryKeyColumn(int index)

按位置获取对应的主键列。

主键中包含的主键列的个数以及主键列的顺序与创建表时TableMeta中定义的一致。

若对应的位置不存在，会抛出IllegalArgumentException异常。

Parameters:

index - 主键列的位置

Returns:

具体位置对应的主键列

getPrimaryKeyColumns

public PrimaryKeyColumn[] getPrimaryKeyColumns()

获取所有的主键列。

主键中包含的主键列的个数以及主键列的顺序与创建表时TableMeta中定义的一致。

Returns:

所有的主键列

getPrimaryKeyColumnsMap

public Map<String,PrimaryKeyColumn> getPrimaryKeyColumnsMap()

获取主键列名称与主键列映射的Map。

若初始化时传入的主键列列表包含相同名称的主键列，则返回的Map中只会返回其中的一列。

Returns:

主键列名称与主键列映射的Map

contains

public boolean contains(String name)

检查主键中是否有该名称的主键列。

Parameters:

name - 主键列的名称

Returns:

若包含则返回true，否则返回false

size

public int size()

返回主键列的个数。

Returns:

主键列的个数

isEmpty

public boolean isEmpty()

该主键是否为空，若主键未包含任何主键列则代表该主键为空。

Returns:

若主键为空则返回true，否则返回false

getSize

@Deprecated
public int getSize()

Deprecated.

getDataSize

public int getDataSize()

获取行主键的数据大小总和，大小总和包括所有主键列的名称和值。

Specified by:

getDataSize in interface Measurable

Returns:

行主键的数据大小总和

compareTo

public int compareTo(PrimaryKey target)

比较两个主键。

对比的两个主键必须为相同的schema，即列数、主键名称和顺序都完全一致。

Specified by:

compareTo in interface Comparable<PrimaryKey>

Parameters:

target -

Returns:

比较结果

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

jsonize

public String jsonize()

Specified by:

jsonize in interface Jsonizable

jsonize

public void jsonize(StringBuilder sb,
                    String newline)

Specified by:

jsonize in interface Jsonizable