org.apache.hadoop.hbase
Class HRegionInfo

java.lang.Object
  org.apache.hadoop.io.VersionedWritable
      org.apache.hadoop.hbase.HRegionInfo

All Implemented Interfaces:

java.lang.Comparable<HRegionInfo>, org.apache.hadoop.io.Writable, org.apache.hadoop.io.WritableComparable<HRegionInfo>

public class HRegionInfo
extends org.apache.hadoop.io.VersionedWritable
implements org.apache.hadoop.io.WritableComparable<HRegionInfo>

HRegion information. Contains HRegion id, start and end keys, a reference to this HRegions' table descriptor, etc.

Field Summary

static int	DELIMITER delimiter used between portions of a region name
static HRegionInfo	FIRST_META_REGIONINFO HRegionInfo for first meta region
static int	MD5_HEX_LENGTH
static java.lang.String	NO_HASH
static HRegionInfo	ROOT_REGIONINFO HRegionInfo for root region
protected HTableDescriptor	tableDesc

Constructor Summary

HRegionInfo()
Default constructor - creates empty object

HRegionInfo(HRegionInfo other)
Costruct a copy of another HRegionInfo

HRegionInfo(HTableDescriptor tableDesc, byte[] startKey, byte[] endKey)
Construct HRegionInfo with explicit parameters

HRegionInfo(HTableDescriptor tableDesc, byte[] startKey, byte[] endKey, boolean split)
Construct HRegionInfo with explicit parameters

HRegionInfo(HTableDescriptor tableDesc, byte[] startKey, byte[] endKey, boolean split, long regionid)
Construct HRegionInfo with explicit parameters

Method Summary

int	compareTo(HRegionInfo o)
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.
static byte[]	createRegionName(byte[] tableName, byte[] startKey, byte[] id, boolean newFormat) Make a region name of passed parameters.
static byte[]	createRegionName(byte[] tableName, byte[] startKey, long regionid, boolean newFormat) Make a region name of passed parameters.
static byte[]	createRegionName(byte[] tableName, byte[] startKey, java.lang.String id, boolean newFormat) Make a region name of passed parameters.
static java.lang.String	encodeRegionName(byte[] regionName)
boolean	equals(java.lang.Object o)
KeyValue.KVComparator	getComparator()
java.lang.String	getEncodedName()
byte[]	getEncodedNameAsBytes()
byte[]	getEndKey()
long	getRegionId()
byte[]	getRegionName()
java.lang.String	getRegionNameAsString()
byte[]	getStartKey()
HTableDescriptor	getTableDesc()
static byte[]	getTableName(byte[] regionName) Gets the table name from the specified region name.
byte	getVersion()
int	hashCode()
boolean	isMetaRegion()
boolean	isMetaTable()
boolean	isOffline()
boolean	isRootRegion()
boolean	isSplit()
boolean	isSplitParent()
static byte[][]	parseRegionName(byte[] regionName) Separate elements of a regionName.
static java.lang.String	prettyPrint(java.lang.String encodedRegionName) Use logging.
void	readFields(java.io.DataInput in)
void	setOffline(boolean offLine) The parent of a region split is offline while split daughters hold references to the parent.
void	setSplit(boolean split)
void	setTableDesc(HTableDescriptor newDesc)
java.lang.String	toString()
void	write(java.io.DataOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

MD5_HEX_LENGTH

public static final int MD5_HEX_LENGTH

See Also:

Constant Field Values

DELIMITER

public static final int DELIMITER

delimiter used between portions of a region name

See Also:

Constant Field Values

ROOT_REGIONINFO

public static final HRegionInfo ROOT_REGIONINFO

HRegionInfo for root region

FIRST_META_REGIONINFO

public static final HRegionInfo FIRST_META_REGIONINFO

HRegionInfo for first meta region

tableDesc

protected HTableDescriptor tableDesc

NO_HASH

public static final java.lang.String NO_HASH

Constructor Detail

HRegionInfo

public HRegionInfo()

Default constructor - creates empty object

HRegionInfo

public HRegionInfo(HTableDescriptor tableDesc,
                   byte[] startKey,
                   byte[] endKey)
            throws java.lang.IllegalArgumentException

Construct HRegionInfo with explicit parameters

Parameters:

tableDesc - the table descriptor

startKey - first key in region

endKey - end of key range

Throws:

java.lang.IllegalArgumentException

HRegionInfo

public HRegionInfo(HTableDescriptor tableDesc,
                   byte[] startKey,
                   byte[] endKey,
                   boolean split)
            throws java.lang.IllegalArgumentException

Construct HRegionInfo with explicit parameters

Parameters:

tableDesc - the table descriptor

startKey - first key in region

endKey - end of key range

split - true if this region has split and we have daughter regions regions that may or may not hold references to this region.

Throws:

java.lang.IllegalArgumentException

HRegionInfo

public HRegionInfo(HTableDescriptor tableDesc,
                   byte[] startKey,
                   byte[] endKey,
                   boolean split,
                   long regionid)
            throws java.lang.IllegalArgumentException

Construct HRegionInfo with explicit parameters

Parameters:

tableDesc - the table descriptor

startKey - first key in region

endKey - end of key range

split - true if this region has split and we have daughter regions regions that may or may not hold references to this region.

regionid - Region id to use.

Throws:

java.lang.IllegalArgumentException

HRegionInfo

public HRegionInfo(HRegionInfo other)

Costruct a copy of another HRegionInfo

Parameters:

other -

Method Detail

encodeRegionName

public static java.lang.String encodeRegionName(byte[] regionName)

Parameters:

regionName -

Returns:

the encodedName

prettyPrint

public static java.lang.String prettyPrint(java.lang.String encodedRegionName)

Use logging.

Parameters:

encodedRegionName - The encoded regionname.

Returns:

-ROOT- if passed 70236052 or .META. if passed 1028785192 else returns encodedRegionName

createRegionName

public static byte[] createRegionName(byte[] tableName,
                                      byte[] startKey,
                                      long regionid,
                                      boolean newFormat)

Make a region name of passed parameters.

Parameters:

tableName -

startKey - Can be null

regionid - Region id (Usually timestamp from when region was created).

newFormat - should we create the region name in the new format (such that it contains its encoded name?).

Returns:

Region name made of passed tableName, startKey and id

createRegionName

public static byte[] createRegionName(byte[] tableName,
                                      byte[] startKey,
                                      java.lang.String id,
                                      boolean newFormat)

Make a region name of passed parameters.

Parameters:

tableName -

startKey - Can be null

id - Region id (Usually timestamp from when region was created).

newFormat - should we create the region name in the new format (such that it contains its encoded name?).

Returns:

Region name made of passed tableName, startKey and id

createRegionName

public static byte[] createRegionName(byte[] tableName,
                                      byte[] startKey,
                                      byte[] id,
                                      boolean newFormat)

Make a region name of passed parameters.

Parameters:

tableName -

startKey - Can be null

id - Region id (Usually timestamp from when region was created).

newFormat - should we create the region name in the new format (such that it contains its encoded name?).

Returns:

Region name made of passed tableName, startKey and id

getTableName

public static byte[] getTableName(byte[] regionName)

Gets the table name from the specified region name.

Parameters:

regionName -

Returns:

Table name.

parseRegionName

public static byte[][] parseRegionName(byte[] regionName)
                                throws java.io.IOException

Separate elements of a regionName.

Parameters:

regionName -

Returns:

Array of byte[] containing tableName, startKey and id

Throws:

java.io.IOException

getRegionId

public long getRegionId()

Returns:

the regionId

getRegionName

public byte[] getRegionName()

Returns:

the regionName as an array of bytes.

See Also:

getRegionNameAsString()

getRegionNameAsString

public java.lang.String getRegionNameAsString()

Returns:

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

getEncodedName

public java.lang.String getEncodedName()

Returns:

the encoded region name

getEncodedNameAsBytes

public byte[] getEncodedNameAsBytes()

getStartKey

public byte[] getStartKey()

Returns:

the startKey

getEndKey

public byte[] getEndKey()

Returns:

the endKey

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.

Throws:

java.lang.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.

getTableDesc

public HTableDescriptor getTableDesc()

Returns:

the tableDesc

setTableDesc

public void setTableDesc(HTableDescriptor newDesc)

Parameters:

newDesc - new table descriptor to use

isRootRegion

public boolean isRootRegion()

Returns:

true if this is the root region

isMetaTable

public boolean isMetaTable()

Returns:

true if this is the meta table

isMetaRegion

public boolean isMetaRegion()

Returns:

true if this region is a meta region

isSplit

public boolean isSplit()

Returns:

True if has been split and has daughters.

setSplit

public void setSplit(boolean split)

Parameters:

split - set split status

isOffline

public boolean isOffline()

Returns:

True if this region is offline.

setOffline

public void 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.

isSplitParent

public boolean isSplitParent()

Returns:

True if this is a split parent region.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

getVersion

public byte getVersion()

Specified by:

getVersion in class org.apache.hadoop.io.VersionedWritable

Returns:

the object version number

write

public void write(java.io.DataOutput out)
           throws java.io.IOException

Specified by:

write in interface org.apache.hadoop.io.Writable

Overrides:

write in class org.apache.hadoop.io.VersionedWritable

Throws:

java.io.IOException

readFields

public void readFields(java.io.DataInput in)
                throws java.io.IOException

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Overrides:

readFields in class org.apache.hadoop.io.VersionedWritable

Throws:

java.io.IOException

compareTo

public int compareTo(HRegionInfo o)

Specified by:

compareTo in interface java.lang.Comparable<HRegionInfo>

getComparator

public KeyValue.KVComparator getComparator()

Returns:

Comparator to use comparing KeyValues.