org.apache.tephra.hbase.coprocessor

Class TransactionFilters

java.lang.Object

org.apache.tephra.hbase.coprocessor.TransactionFilters

public class TransactionFilters
extends Object

Factory class for providing Filter instances.

Constructor Summary

Constructors

Constructor and Description
TransactionFilters()

Method Summary

Modifier and Type	Method and Description
static org.apache.hadoop.hbase.filter.Filter	getVisibilityFilter(Transaction tx, Map<byte[],Long> ttlByFamily, boolean allowEmptyValues, org.apache.hadoop.hbase.regionserver.ScanType scanType) Creates a new Filter for returning data only from visible transactions.
static org.apache.hadoop.hbase.filter.Filter	getVisibilityFilter(Transaction tx, Map<byte[],Long> ttlByFamily, boolean allowEmptyValues, org.apache.hadoop.hbase.regionserver.ScanType scanType, org.apache.hadoop.hbase.filter.Filter cellFilter) Creates a new Filter for returning data only from visible transactions.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionFilters

public TransactionFilters()

Method Detail

getVisibilityFilter

public static org.apache.hadoop.hbase.filter.Filter getVisibilityFilter(Transaction tx,
                                                                        Map<byte[],Long> ttlByFamily,
                                                                        boolean allowEmptyValues,
                                                                        org.apache.hadoop.hbase.regionserver.ScanType scanType)

Creates a new Filter for returning data only from visible transactions.

Parameters:

tx - the current transaction to apply. Only data visible to this transaction will be returned.

ttlByFamily - map of time-to-live (TTL) (in milliseconds) by column family name

allowEmptyValues - if true cells with empty byte[] values will be returned, if false these will be interpreted as "delete" markers and the column will be filtered out

scanType - the type of scan operation being performed

getVisibilityFilter

public static org.apache.hadoop.hbase.filter.Filter getVisibilityFilter(Transaction tx,
                                                                        Map<byte[],Long> ttlByFamily,
                                                                        boolean allowEmptyValues,
                                                                        org.apache.hadoop.hbase.regionserver.ScanType scanType,
                                                                        @Nullable
                                                                        org.apache.hadoop.hbase.filter.Filter cellFilter)

Creates a new Filter for returning data only from visible transactions.

Parameters:

tx - the current transaction to apply. Only data visible to this transaction will be returned.

ttlByFamily - map of time-to-live (TTL) (in milliseconds) by column family name

allowEmptyValues - if true cells with empty byte[] values will be returned, if false these will be interpreted as "delete" markers and the column will be filtered out

scanType - the type of scan operation being performed

cellFilter - if non-null, this filter will be applied to all cells visible to the current transaction, by calling Filter.filterKeyValue(org.apache.hadoop.hbase.Cell). If null, then Filter.ReturnCode#INCLUDE_AND_NEXT_COL will be returned instead.