HRegionLocator (Apache HBase 1.4.11 API)

java.lang.Object
- org.apache.hadoop.hbase.client.HRegionLocator

All Implemented Interfaces:

Closeable, AutoCloseable, RegionLocator
```
@InterfaceAudience.Private
@InterfaceStability.Stable
public class HRegionLocator
extends Object
implements RegionLocator
```
An implementation of RegionLocator. Used to view region location information for a single HBase table. Lightweight. Get as needed and just close when done. Instances of this class SHOULD NOT be constructed directly. Obtain an instance via Connection. See ConnectionFactory class comment for an example of how.
This class is thread safe

Constructor Summary

Constructors
Constructor and Description

HRegionLocator(TableName tableName, ClusterConnection connection)

Constructors
Constructor and Description
`HRegionLocator(TableName tableName, ClusterConnection connection)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()`
`List<HRegionLocation>`	`getAllRegionLocations()` Retrieves all of the regions associated with this table.
`org.apache.hadoop.conf.Configuration`	`getConfiguration()`
`byte[][]`	`getEndKeys()` Gets the ending row key for every region in the currently open table.
`TableName`	`getName()` Gets the fully qualified table name instance of this table.
`HRegionLocation`	`getRegionLocation(byte[] row)` Finds the region on which the given row is being served.
`HRegionLocation`	`getRegionLocation(byte[] row, boolean reload)` Finds the region on which the given row is being served.
`Pair<byte[][],byte[][]>`	`getStartEndKeys()` Gets the starting and ending row keys for every region in the currently open table.
`byte[][]`	`getStartKeys()` Gets the starting row key for every region in the currently open table.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HRegionLocator
```
public HRegionLocator(TableName tableName,
              ClusterConnection connection)
```
- Method Detail
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException
  - getRegionLocation
```
public HRegionLocation getRegionLocation(byte[] row)
                                  throws IOException
```
    Finds the region on which the given row is being served. Does not reload the cache.
    
    Specified by:
    
    getRegionLocation in interface RegionLocator
    
    Parameters:
    row - Row to find.
    
    Returns:
    Location of the row.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getRegionLocation
```
public HRegionLocation getRegionLocation(byte[] row,
                                boolean reload)
                                  throws IOException
```
    Finds the region on which the given row is being served.
    
    Specified by:
    
    getRegionLocation in interface RegionLocator
    
    Parameters:
    row - Row to find.
    reload - true to reload information or false to use cached information
    
    Returns:
    Location of the row.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getAllRegionLocations
```
public List<HRegionLocation> getAllRegionLocations()
                                            throws IOException
```
    Description copied from interface: RegionLocator
    
    Retrieves all of the regions associated with this table.
    
    Specified by:
    
    getAllRegionLocations in interface RegionLocator
    
    Returns:
    a List of all regions associated with this table.
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getStartKeys
```
public byte[][] getStartKeys()
                      throws IOException
```
    Gets the starting row key for every region in the currently open table.
    This is mainly useful for the MapReduce integration.
    
    Specified by:
    
    getStartKeys in interface RegionLocator
    
    Returns:
    Array of region starting row keys
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getEndKeys
```
public byte[][] getEndKeys()
                    throws IOException
```
    Gets the ending row key for every region in the currently open table.
    This is mainly useful for the MapReduce integration.
    
    Specified by:
    
    getEndKeys in interface RegionLocator
    
    Returns:
    Array of region ending row keys
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getStartEndKeys
```
public Pair<byte[][],byte[][]> getStartEndKeys()
                                        throws IOException
```
    Gets the starting and ending row keys for every region in the currently open table.
    This is mainly useful for the MapReduce integration.
    
    Specified by:
    
    getStartEndKeys in interface RegionLocator
    
    Returns:
    Pair of arrays of region starting and ending row keys
    
    Throws:
    
    IOException - if a remote or network exception occurs
  - getName
```
public TableName getName()
```
    Description copied from interface: RegionLocator
    
    Gets the fully qualified table name instance of this table.
    
    Specified by:
    
    getName in interface RegionLocator
  - getConfiguration
```
public org.apache.hadoop.conf.Configuration getConfiguration()
```

Class HRegionLocator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HRegionLocator

Method Detail

close

getRegionLocation

getRegionLocation

getAllRegionLocations

getStartKeys

getEndKeys

getStartEndKeys

getName

getConfiguration