com.google.cloud.bigtable.hbase.adapters.filters

Interface TypedFilterAdapter<S extends org.apache.hadoop.hbase.filter.Filter>

All Known Implementing Classes:

BigtableFilterAdapter, ColumnCountGetFilterAdapter, ColumnPaginationFilterAdapter, ColumnPrefixFilterAdapter, ColumnRangeFilterAdapter, FamilyFilterAdapter, FilterListAdapter, FirstKeyOnlyFilterAdapter, FuzzyRowFilterAdapter, KeyOnlyFilterAdapter, MultipleColumnPrefixFilterAdapter, MultiRowRangeFilterAdapter, PageFilterAdapter, PrefixFilterAdapter, QualifierFilterAdapter, RandomRowFilterAdapter, RowFilterAdapter, SingleColumnValueExcludeFilterAdapter, SingleColumnValueFilterAdapter, TimestampRangeFilterAdapter, TimestampsFilterAdapter, TypedFilterAdapterBase, ValueFilterAdapter, WhileMatchFilterAdapter

@InternalApi(value="For internal usage only")
public interface TypedFilterAdapter<S extends org.apache.hadoop.hbase.filter.Filter>

An adapter that can adapt an HBase Filter instance into a Bigtable RowFilter.

For internal use only - public for technical reasons.

Method Summary

Modifier and Type	Method and Description
com.google.cloud.bigtable.data.v2.models.Filters.Filter	adapt(FilterAdapterContext context, S filter) Adapt the given filter.
com.google.common.collect.RangeSet<RowKeyWrapper>	getIndexScanHint(S filter) Get hints how to optimize the scan.
FilterSupportStatus	isFilterSupported(FilterAdapterContext context, S filter) Determine if the given filter can be adapted to a Bigtable RowFilter.

Method Detail

adapt

com.google.cloud.bigtable.data.v2.models.Filters.Filter adapt(FilterAdapterContext context,
                                                              S filter)
                                                       throws IOException

Adapt the given filter. Implementers of this method should assume that isFilterSupported has already been called with a result indicating it is in fact supproted.

Parameters:

context - a FilterAdapterContext object.

filter - a S object.

Returns:

a Filters.Filter object.

Throws:

IOException - if any.

isFilterSupported

FilterSupportStatus isFilterSupported(FilterAdapterContext context,
                                      S filter)

Determine if the given filter can be adapted to a Bigtable RowFilter.

Parameters:

context - a FilterAdapterContext object.

filter - a S object.

Returns:

a FilterSupportStatus object.

getIndexScanHint

com.google.common.collect.RangeSet<RowKeyWrapper> getIndexScanHint(S filter)

Get hints how to optimize the scan. For example if the filter will narrow the scan using the prefix "ab" then we can restrict the scan to ["ab" - "ac"). If the filter doesn't narrow the scan then it should return Range.all()

Parameters:

filter - a S object.

Returns:

a RangeSet object.