org.apache.hadoop.hbase.client

Class MutableRegionInfo

java.lang.Object

org.apache.hadoop.hbase.client.MutableRegionInfo

All Implemented Interfaces:

Comparable<RegionInfo>, RegionInfo

@InterfaceAudience.Private
class MutableRegionInfo
extends Object
implements RegionInfo

An implementation of RegionInfo that adds mutable methods so can build a RegionInfo instance. Package private. Use RegionInfoBuilder creating instances of RegionInfos.

Field Summary

Fields

Modifier and Type	Field and Description
private String	encodedName
private byte[]	encodedNameAsBytes
private byte[]	endKey
private int	hashCode
private static org.slf4j.Logger	LOG
private static int	MAX_REPLICA_ID
private boolean	offLine The new format for a region name contains its encodedName at the end.
private long	regionId
private byte[]	regionName
private int	replicaId
private boolean	split
private byte[]	startKey
private TableName	tableName

Fields inherited from interface org.apache.hadoop.hbase.client.RegionInfo

COMPARATOR, DEFAULT_REPLICA_ID, ENC_SEPARATOR, INVALID_REGION_NAME_FORMAT_MESSAGE, MD5_HEX_LENGTH, REPLICA_ID_DELIMITER, REPLICA_ID_FORMAT, UNDEFINED

Constructor Summary

Constructors

Constructor and Description
MutableRegionInfo(long regionId, TableName tableName, int replicaId) Package private constructor used constructing MutableRegionInfo for the first meta regions
MutableRegionInfo(TableName tableName, byte[] startKey, byte[] endKey, boolean split, long regionId, int replicaId, boolean offLine)

Method Summary

Modifier and Type	Method and Description
private static byte[]	checkEndKey(byte[] endKey)
private static int	checkReplicaId(int regionId)
private static byte[]	checkStartKey(byte[] startKey)
private static TableName	checkTableName(TableName tableName)
boolean	containsRange(byte[] rangeStartKey, byte[] rangeEndKey) Returns true if the given inclusive range of rows is fully contained by this region.
boolean	containsRow(byte[] row) Return true if the given row falls in this region.
boolean	equals(Object o)
private static int	generateHashCode(TableName tableName, byte[] startKey, byte[] endKey, long regionId, int replicaId, boolean offLine, byte[] regionName)
String	getEncodedName()
byte[]	getEncodedNameAsBytes()
byte[]	getEndKey()
long	getRegionId()
byte[]	getRegionName()
String	getRegionNameAsString()
int	getReplicaId() Returns the region replica id
String	getShortNameToLog()
byte[]	getStartKey()
TableName	getTable() Get current table name of the region
int	hashCode()
boolean	isMetaRegion()
boolean	isOffline() Deprecated. since 3.0.0 and will be removed in 4.0.0
boolean	isSplit()
boolean	isSplitParent() Deprecated. since 3.0.0 and will be removed in 4.0.0, Use isSplit() instead.
MutableRegionInfo	setOffline(boolean offLine) The parent of a region split is offline while split daughters hold references to the parent.
MutableRegionInfo	setSplit(boolean split)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.hbase.client.RegionInfo

areAdjacent, compareTo, createMobRegionInfo, createRegionName, createRegionName, createRegionName, createRegionName, createRegionName, encodeRegionName, getRegionNameAsString, getRegionNameAsString, getShortNameToLog, getShortNameToLog, getStartKey, getTable, hasEncodedName, isAdjacent, isDegenerate, isEncodedRegionName, isFirst, isLast, isNext, isOverlap, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFromOrNull, parseFromOrNull, parseRegionName, parseRegionNameOrReturnNull, prettyPrint, toByteArray, toDelimitedByteArray, toDelimitedByteArray

Field Detail

LOG

private static final org.slf4j.Logger LOG

MAX_REPLICA_ID

private static final int MAX_REPLICA_ID

See Also:

Constant Field Values

offLine

private boolean offLine

The new format for a region name contains its encodedName at the end. The encoded name also serves as the directory name for the region in the filesystem. New region name format: <tablename>,,<startkey>,<regionIdTimestamp>.<encodedName>. where, <encodedName> is a hex version of the MD5 hash of <tablename>,<startkey>,<regionIdTimestamp> The old region name format: <tablename>,<startkey>,<regionIdTimestamp> For region names in the old format, the encoded name is a 32-bit JenkinsHash integer value (in its decimal notation, string form).

**NOTE** The first hbase:meta region, and regions created by an older version of HBase (0.20 or prior) will continue to use the old region name format.

split

private boolean split

regionId

private final long regionId

replicaId

private final int replicaId

regionName

private final byte[] regionName

startKey

private final byte[] startKey

endKey

private final byte[] endKey

hashCode

private final int hashCode

encodedName

private final String encodedName

encodedNameAsBytes

private final byte[] encodedNameAsBytes

tableName

private final TableName tableName

Constructor Detail

MutableRegionInfo

MutableRegionInfo(long regionId,
                  TableName tableName,
                  int replicaId)

Package private constructor used constructing MutableRegionInfo for the first meta regions

MutableRegionInfo

MutableRegionInfo(TableName tableName,
                  byte[] startKey,
                  byte[] endKey,
                  boolean split,
                  long regionId,
                  int replicaId,
                  boolean offLine)

Method Detail

generateHashCode

private static int generateHashCode(TableName tableName,
                                    byte[] startKey,
                                    byte[] endKey,
                                    long regionId,
                                    int replicaId,
                                    boolean offLine,
                                    byte[] regionName)

checkStartKey

private static byte[] checkStartKey(byte[] startKey)

checkEndKey

private static byte[] checkEndKey(byte[] endKey)

checkTableName

private static TableName checkTableName(TableName tableName)

checkReplicaId

private static int checkReplicaId(int regionId)

getShortNameToLog

public String getShortNameToLog()

Specified by:

getShortNameToLog in interface RegionInfo

Returns:

Return a short, printable name for this region (usually encoded name) for us logging.

getRegionId

public long getRegionId()

Specified by:

getRegionId in interface RegionInfo

Returns:

the regionId

getRegionName

public byte[] getRegionName()

Specified by:

getRegionName in interface RegionInfo

Returns:

the regionName as an array of bytes.

See Also:

getRegionNameAsString()

getRegionNameAsString

public String getRegionNameAsString()

Specified by:

getRegionNameAsString in interface RegionInfo

Returns:

Region name as a String for use in logging, etc.

getEncodedName

public String getEncodedName()

Specified by:

getEncodedName in interface RegionInfo

Returns:

the encoded region name

getEncodedNameAsBytes

public byte[] getEncodedNameAsBytes()

Specified by:

getEncodedNameAsBytes in interface RegionInfo

Returns:

the encoded region name as an array of bytes.

getStartKey

public byte[] getStartKey()

Specified by:

getStartKey in interface RegionInfo

Returns:

the startKey

getEndKey

public byte[] getEndKey()

Specified by:

getEndKey in interface RegionInfo

Returns:

the endKey

getTable

public TableName getTable()

Get current table name of the region

Specified by:

getTable in interface RegionInfo

Returns:

TableName

containsRange

public boolean containsRange(byte[] rangeStartKey,
                             byte[] rangeEndKey)

Returns true if the given inclusive range of rows is fully contained by this region. For example, if the region is foo,a,g and this is passed ["b","c"] or ["a","c"] it will return true, but if this is passed ["b","z"] it will return false.

Specified by:

containsRange in interface RegionInfo

Returns:

true if the given inclusive range of rows is fully contained by this region. For example, if the region is foo,a,g and this is passed ["b","c"] or ["a","c"] it will return true, but if this is passed ["b","z"] it will return false.

Throws:

IllegalArgumentException - if the range passed is invalid (ie. end < start)

containsRow

public boolean containsRow(byte[] row)

Return true if the given row falls in this region.

Specified by:

containsRow in interface RegionInfo

Returns:

true if the given row falls in this region.

isMetaRegion

public boolean isMetaRegion()

Specified by:

isMetaRegion in interface RegionInfo

Returns:

true if this region is a meta region

isSplit

public boolean isSplit()

Specified by:

isSplit in interface RegionInfo

Returns:

True if has been split and has daughters.

setSplit

public MutableRegionInfo setSplit(boolean split)

Parameters:

split - set split status

Returns:

MutableRegionInfo

isOffline

@Deprecated
public boolean isOffline()

Deprecated. since 3.0.0 and will be removed in 4.0.0

Specified by:

isOffline in interface RegionInfo

Returns:

True if this region is offline.

See Also:

HBASE-25210

setOffline

public MutableRegionInfo setOffline(boolean offLine)

The parent of a region split is offline while split daughters hold references to the parent. Offlined regions are closed.

Parameters:

offLine - Set online/offline status.

Returns:

MutableRegionInfo

isSplitParent

@Deprecated
public boolean isSplitParent()

Deprecated. since 3.0.0 and will be removed in 4.0.0, Use isSplit() instead.

Specified by:

isSplitParent in interface RegionInfo

Returns:

True if this is a split parent region.

See Also:

HBASE-25210

getReplicaId

public int getReplicaId()

Returns the region replica id

Specified by:

getReplicaId in interface RegionInfo

Returns:

returns region replica id

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()