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

Class FilterSupportStatus

java.lang.Object

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

@InternalApi(value="For internal usage only")
public class FilterSupportStatus
extends Object

FilterSupportStatus is a result type indicating whether a filter has a supported adaptation to bigtable reader expressions.

The isSupported method indicates whether the Filter is supported and if isSupport() is false a reason may be provided by the adapter.

For internal use only - public for technical reasons.

Field Summary

Fields

Modifier and Type	Field and Description
static FilterSupportStatus	NOT_SUPPORTED_WRONG_TYPE Used to indicate an internal error where an adapter for a single Filter type is passed an instance of an incompatible Filter type.
static FilterSupportStatus	SUPPORTED A static instance for all supported Filter adaptations.

Method Summary

Modifier and Type	Method and Description
boolean	isSupported() True if the adaptation is supported, false otherwise.
static FilterSupportStatus	newCompositeNotSupported(List<FilterSupportStatus> unsupportedSubfilters) Static constructor for a not supported status caused by sub-filters not being supported.
static FilterSupportStatus	newNotSupported(String reason) Generic static constructor for not supported adaptations with the stated reason.
static FilterSupportStatus	newUnknownFilterType(org.apache.hadoop.hbase.filter.Filter unknownFilterType) Static helper to construct not support adaptations due to no adapter being available for the given Filter type.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SUPPORTED

public static final FilterSupportStatus SUPPORTED

A static instance for all supported Filter adaptations.

NOT_SUPPORTED_WRONG_TYPE

public static final FilterSupportStatus NOT_SUPPORTED_WRONG_TYPE

Used to indicate an internal error where an adapter for a single Filter type is passed an instance of an incompatible Filter type.

Method Detail

newUnknownFilterType

public static FilterSupportStatus newUnknownFilterType(org.apache.hadoop.hbase.filter.Filter unknownFilterType)

Static helper to construct not support adaptations due to no adapter being available for the given Filter type.

Parameters:

unknownFilterType - The unknown filter instance.

Returns:

A new FilterSupportStatus.

newNotSupported

public static FilterSupportStatus newNotSupported(String reason)

Generic static constructor for not supported adaptations with the stated reason.

Parameters:

reason - a String object.

Returns:

a FilterSupportStatus object.

newCompositeNotSupported

public static FilterSupportStatus newCompositeNotSupported(List<FilterSupportStatus> unsupportedSubfilters)

Static constructor for a not supported status caused by sub-filters not being supported.

Parameters:

unsupportedSubfilters - a List object.

Returns:

a FilterSupportStatus object.

isSupported

public boolean isSupported()

True if the adaptation is supported, false otherwise.

Returns:

a boolean.

toString

public String toString()

Overrides:

toString in class Object