org.springframework.data.hadoop.hbase

Class HbaseTemplate

java.lang.Object

org.springframework.data.hadoop.hbase.HbaseAccessor

org.springframework.data.hadoop.hbase.HbaseTemplate

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, HbaseOperations

public class HbaseTemplate
extends HbaseAccessor
implements HbaseOperations

Central class for accessing the HBase API. Simplifies the use of HBase and helps to avoid common errors. It executes core HBase workflow, leaving application code to invoke actions and extract results.

Author:

Costin Leau, Shaun Elliott

Constructor Summary

Constructors

Constructor and Description
HbaseTemplate()
HbaseTemplate(org.apache.hadoop.conf.Configuration configuration)

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.dao.DataAccessException	convertHbaseAccessException(java.lang.Exception ex)
void	delete(java.lang.String tableName, java.lang.String rowName, java.lang.String familyName) Deletes a single qualifier in the given table and family.
void	delete(java.lang.String tableName, java.lang.String rowName, java.lang.String familyName, java.lang.String qualifier) Deletes a single cell in the given table.
<T> T	execute(java.lang.String tableName, TableCallback<T> action) Executes the given action against the specified table handling resource management.
<T> T	find(java.lang.String tableName, org.apache.hadoop.hbase.client.Scan scan, ResultsExtractor<T> action) Scans the target table using the given Scan object.
<T> java.util.List<T>	find(java.lang.String tableName, org.apache.hadoop.hbase.client.Scan scan, RowMapper<T> action) Scans the target table using the given Scan object.
<T> T	find(java.lang.String tableName, java.lang.String family, ResultsExtractor<T> action) Scans the target table, using the given family.
<T> java.util.List<T>	find(java.lang.String tableName, java.lang.String family, RowMapper<T> action) Scans the target table, using the given column family.
<T> T	find(java.lang.String tableName, java.lang.String family, java.lang.String qualifier, ResultsExtractor<T> action) Scans the target table, using the given column family and qualifier.
<T> java.util.List<T>	find(java.lang.String tableName, java.lang.String family, java.lang.String qualifier, RowMapper<T> action) Scans the target table, using the given column family.
<T> T	get(java.lang.String tableName, java.lang.String rowName, RowMapper<T> mapper) Gets an individual row from the given table.
<T> T	get(java.lang.String tableName, java.lang.String rowName, java.lang.String familyName, RowMapper<T> mapper) Gets an individual row from the given table.
<T> T	get(java.lang.String tableName, java.lang.String rowName, java.lang.String familyName, java.lang.String qualifier, RowMapper<T> mapper) Gets an individual row from the given table.
void	put(java.lang.String tableName, java.lang.String rowName, java.lang.String familyName, java.lang.String qualifier, byte[] value) Puts a single value in to the given table.
void	setAutoFlush(boolean autoFlush) Sets the auto flush.

Methods inherited from class org.springframework.data.hadoop.hbase.HbaseAccessor

afterPropertiesSet, getCharset, getConfiguration, getTableFactory, setConfiguration, setEncoding, setTableFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HbaseTemplate

public HbaseTemplate()

HbaseTemplate

public HbaseTemplate(org.apache.hadoop.conf.Configuration configuration)

Method Detail

execute

public <T> T execute(java.lang.String tableName,
            TableCallback<T> action)

Description copied from interface: HbaseOperations

Executes the given action against the specified table handling resource management.

Application exceptions thrown by the action object get propagated to the caller (can only be unchecked). Allows for returning a result object (typically a domain object or collection of domain objects).

Specified by:

execute in interface HbaseOperations

Type Parameters:

T - action type

Parameters:

tableName - the target table

action - callback object that specifies the action

Returns:

the result object of the callback action, or null

convertHbaseAccessException

public org.springframework.dao.DataAccessException convertHbaseAccessException(java.lang.Exception ex)

find

public <T> T find(java.lang.String tableName,
         java.lang.String family,
         ResultsExtractor<T> action)

Description copied from interface: HbaseOperations

Scans the target table, using the given family. The content is processed by the given action typically returning a domain object or collection of domain objects.

Specified by:

find in interface HbaseOperations

Type Parameters:

T - action type

Parameters:

tableName - target table

family - column family

action - action handling the scanner results

Returns:

the result object of the callback action, or null

find

public <T> T find(java.lang.String tableName,
         java.lang.String family,
         java.lang.String qualifier,
         ResultsExtractor<T> action)

Description copied from interface: HbaseOperations

Scans the target table, using the given column family and qualifier. The content is processed by the given action typically returning a domain object or collection of domain objects.

Specified by:

find in interface HbaseOperations

Type Parameters:

T - action type

Parameters:

tableName - target table

family - column family

qualifier - column qualifier

action - action handling the scanner results

Returns:

the result object of the callback action, or null

find

public <T> T find(java.lang.String tableName,
         org.apache.hadoop.hbase.client.Scan scan,
         ResultsExtractor<T> action)

Description copied from interface: HbaseOperations

Scans the target table using the given Scan object. Suitable for maximum control over the scanning process. The content is processed by the given action typically returning a domain object or collection of domain objects.

Specified by:

find in interface HbaseOperations

Type Parameters:

T - action type

Parameters:

tableName - target table

scan - table scanner

action - action handling the scanner results

Returns:

the result object of the callback action, or null

find

public <T> java.util.List<T> find(java.lang.String tableName,
                         java.lang.String family,
                         RowMapper<T> action)

Description copied from interface: HbaseOperations

Scans the target table, using the given column family. The content is processed row by row by the given action, returning a list of domain objects.

Specified by:

find in interface HbaseOperations

Type Parameters:

T - action type

Parameters:

tableName - target table

family - column family

action - row mapper handling the scanner results

Returns:

a list of objects mapping the scanned rows

find

public <T> java.util.List<T> find(java.lang.String tableName,
                         java.lang.String family,
                         java.lang.String qualifier,
                         RowMapper<T> action)

Description copied from interface: HbaseOperations

Scans the target table, using the given column family. The content is processed row by row by the given action, returning a list of domain objects.

Specified by:

find in interface HbaseOperations

Type Parameters:

T - action type

Parameters:

tableName - target table

family - column family

qualifier - column qualifier

action - row mapper handling the scanner results

Returns:

a list of objects mapping the scanned rows

find

public <T> java.util.List<T> find(java.lang.String tableName,
                         org.apache.hadoop.hbase.client.Scan scan,
                         RowMapper<T> action)

Description copied from interface: HbaseOperations

Scans the target table using the given Scan object. Suitable for maximum control over the scanning process. The content is processed row by row by the given action, returning a list of domain objects.

Specified by:

find in interface HbaseOperations

Type Parameters:

T - action type

Parameters:

tableName - target table

scan - table scanner

action - row mapper handling the scanner results

Returns:

a list of objects mapping the scanned rows

get

public <T> T get(java.lang.String tableName,
        java.lang.String rowName,
        RowMapper<T> mapper)

Description copied from interface: HbaseOperations

Gets an individual row from the given table. The content is mapped by the given action.

Specified by:

get in interface HbaseOperations

Type Parameters:

T - mapper type

Parameters:

tableName - target table

rowName - row name

mapper - row mapper

Returns:

object mapping the target row

get

public <T> T get(java.lang.String tableName,
        java.lang.String rowName,
        java.lang.String familyName,
        RowMapper<T> mapper)

Description copied from interface: HbaseOperations

Gets an individual row from the given table. The content is mapped by the given action.

Specified by:

get in interface HbaseOperations

Type Parameters:

T - mapper type

Parameters:

tableName - target table

rowName - row name

familyName - column family

mapper - row mapper

Returns:

object mapping the target row

get

public <T> T get(java.lang.String tableName,
        java.lang.String rowName,
        java.lang.String familyName,
        java.lang.String qualifier,
        RowMapper<T> mapper)

Description copied from interface: HbaseOperations

Gets an individual row from the given table. The content is mapped by the given action.

Specified by:

get in interface HbaseOperations

Type Parameters:

T - mapper type

Parameters:

tableName - target table

rowName - row name

familyName - family

qualifier - column qualifier

mapper - row mapper

Returns:

object mapping the target row

put

public void put(java.lang.String tableName,
       java.lang.String rowName,
       java.lang.String familyName,
       java.lang.String qualifier,
       byte[] value)

Description copied from interface: HbaseOperations

Puts a single value in to the given table.

Specified by:

put in interface HbaseOperations

Parameters:

tableName - target table

rowName - row name

familyName - family

qualifier - column qualifier

value - the byte array of the data value to be put

delete

public void delete(java.lang.String tableName,
          java.lang.String rowName,
          java.lang.String familyName)

Description copied from interface: HbaseOperations

Deletes a single qualifier in the given table and family.

Specified by:

delete in interface HbaseOperations

Parameters:

tableName - target table

rowName - row name

familyName - family

delete

public void delete(java.lang.String tableName,
          java.lang.String rowName,
          java.lang.String familyName,
          java.lang.String qualifier)

Description copied from interface: HbaseOperations

Deletes a single cell in the given table.

Specified by:

delete in interface HbaseOperations

Parameters:

tableName - target table

rowName - row name

familyName - family

qualifier - column qualifier

setAutoFlush

public void setAutoFlush(boolean autoFlush)

Sets the auto flush.

Parameters:

autoFlush - The autoFlush to set.