org.springframework.data.hadoop.hbase

Interface HbaseOperations

All Known Implementing Classes:

HbaseTemplate

public interface HbaseOperations

Interface that specifies a basic set of Hbase operations, implemented by HbaseTemplate. Not often used, but a useful option to enhance testability, as it can easily be mocked or stubbed.

Author:

Costin Leau, Shaun Elliott

Method Summary

Methods

Modifier and Type	Method and Description
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[] data) Puts a single value in to the given table.

Method Detail

execute

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

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).

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

find

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

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.

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

<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. The content is processed by the given action typically returning a domain object or collection of domain objects.

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

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

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

<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. The content is processed row by row by the given action, returning a list of domain objects.

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

<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. The content is processed row by row by the given action, returning a list of domain objects.

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

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

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

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

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

Type Parameters:

T - mapper type

Parameters:

tableName - target table

rowName - row name

mapper - row mapper

Returns:

object mapping the target row

get

<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. The content is mapped by the given action.

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

<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. The content is mapped by the given action.

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

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

Puts a single value in to the given table.

Parameters:

tableName - target table

rowName - row name

familyName - family

qualifier - column qualifier

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

delete

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

Deletes a single qualifier in the given table and family.

Parameters:

tableName - target table

rowName - row name

familyName - family

delete

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.

Parameters:

tableName - target table

rowName - row name

familyName - family

qualifier - column qualifier