Package org.apache.hadoop.hbase.filter
Class ValueFilter
java.lang.Object
org.apache.hadoop.hbase.filter.Filter
org.apache.hadoop.hbase.filter.FilterBase
org.apache.hadoop.hbase.filter.CompareFilter
org.apache.hadoop.hbase.filter.ValueFilter
This filter is used to filter based on column value. It takes an operator (equal, greater, not
equal, etc) and a byte [] comparator for the cell value.
This filter can be wrapped with WhileMatchFilter
and SkipFilter
to add more
control.
Multiple filters can be combined using FilterList
.
To test the value of a single qualifier when scanning multiple qualifiers, use
SingleColumnValueFilter
.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.CompareFilter
CompareFilter.CompareOp
Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.Filter
Filter.ReturnCode
-
Field Summary
Fields inherited from class org.apache.hadoop.hbase.filter.CompareFilter
comparator, op
-
Constructor Summary
ConstructorDescriptionValueFilter
(CompareOperator valueCompareOp, ByteArrayComparable valueComparator) Constructor.ValueFilter
(CompareFilter.CompareOp valueCompareOp, ByteArrayComparable valueComparator) Deprecated.Since 2.0.0. -
Method Summary
Modifier and TypeMethodDescription(package private) boolean
Returns true if and only if the fields of the filter that are serialized are equal to the corresponding fields in other.static Filter
createFilterFromArguments
(ArrayList<byte[]> filterArguments) boolean
filterCell
(Cell c) A way to filter based on the column family, column qualifier and/or the column value.Deprecated.int
hashCode()
static ValueFilter
parseFrom
(byte[] pbBytes) Parse a serialized representation ofValueFilter
byte[]
Returns The filter serialized using pbMethods inherited from class org.apache.hadoop.hbase.filter.CompareFilter
compare, compare, compareFamily, compareFamily, compareQualifier, compareQualifier, compareRow, compareRow, compareValue, compareValue, convert, extractArguments, filterRowKey, getComparator, getCompareOperator, getOperator, toString
Methods inherited from class org.apache.hadoop.hbase.filter.FilterBase
filterAllRemaining, filterRow, filterRowCells, filterRowKey, getNextCellHint, hasFilterRow, isFamilyEssential, reset, transformCell
Methods inherited from class org.apache.hadoop.hbase.filter.Filter
isReversed, setReversed
-
Constructor Details
-
ValueFilter
Deprecated.Since 2.0.0. Will be removed in 3.0.0. UseValueFilter(CompareOperator, ByteArrayComparable)
Constructor.- Parameters:
valueCompareOp
- the compare op for value matchingvalueComparator
- the comparator for value matching
-
ValueFilter
Constructor.- Parameters:
valueCompareOp
- the compare op for value matchingvalueComparator
- the comparator for value matching
-
-
Method Details
-
filterKeyValue
Deprecated.Description copied from class:Filter
A way to filter based on the column family, column qualifier and/or the column value. Return code is described below. This allows filters to filter only certain number of columns, then terminate without matching ever column. If filterRowKey returns true, filterKeyValue needs to be consistent with it. filterKeyValue can assume that filterRowKey has already been called for the row. If your filter returnsReturnCode.NEXT_ROW
, it should returnReturnCode.NEXT_ROW
untilFilter.reset()
is called just in case the caller calls for the next row. Concrete implementers can signal a failure condition in their code by throwing anIOException
.- Overrides:
filterKeyValue
in classFilter
- Parameters:
c
- the Cell in question- Returns:
- code as described below, Filter.ReturnCode.INCLUDE by default
- See Also:
-
filterCell
Description copied from class:Filter
A way to filter based on the column family, column qualifier and/or the column value. Return code is described below. This allows filters to filter only certain number of columns, then terminate without matching ever column. If filterRowKey returns true, filterCell needs to be consistent with it. filterCell can assume that filterRowKey has already been called for the row. If your filter returnsReturnCode.NEXT_ROW
, it should returnReturnCode.NEXT_ROW
untilFilter.reset()
is called just in case the caller calls for the next row. Concrete implementers can signal a failure condition in their code by throwing anIOException
.- Overrides:
filterCell
in classFilter
- Parameters:
c
- the Cell in question- Returns:
- code as described below
- See Also:
-
createFilterFromArguments
-
toByteArray
Returns The filter serialized using pb- Overrides:
toByteArray
in classFilterBase
- Returns:
- The filter serialized using pb
-
parseFrom
Parse a serialized representation ofValueFilter
- Parameters:
pbBytes
- A pb serializedValueFilter
instance- Returns:
- An instance of
ValueFilter
made frombytes
- Throws:
DeserializationException
- if an error occurred- See Also:
-
areSerializedFieldsEqual
Returns true if and only if the fields of the filter that are serialized are equal to the corresponding fields in other. Used for testing.- Overrides:
areSerializedFieldsEqual
in classCompareFilter
- Returns:
- true if and only if the fields of the filter that are serialized are equal to the corresponding fields in other. Used for testing.
-
equals
- Overrides:
equals
in classCompareFilter
-
hashCode
- Overrides:
hashCode
in classCompareFilter
-