Package org.apache.hadoop.hbase.filter
Class QualifierFilter
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.QualifierFilter
This filter is used to filter based on the column qualifier. It takes an operator (equal,
greater, not equal, etc) and a byte [] comparator for the column qualifier portion of a key.
This filter can be wrapped with WhileMatchFilter
and SkipFilter
to add more
control.
Multiple filters can be combined using FilterList
.
If an already known column qualifier is looked for, use
Get.addColumn(byte[], byte[])
directly rather than a filter.
-
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
ConstructorDescriptionQualifierFilter
(CompareOperator op, ByteArrayComparable qualifierComparator) Constructor.QualifierFilter
(CompareFilter.CompareOp op, ByteArrayComparable qualifierComparator) 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 QualifierFilter
parseFrom
(byte[] pbBytes) Parse a serialized representation ofQualifierFilter
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
-
QualifierFilter
@Deprecated public QualifierFilter(CompareFilter.CompareOp op, ByteArrayComparable qualifierComparator) Deprecated.Since 2.0.0. Will be removed in 3.0.0. UseQualifierFilter(CompareOperator, ByteArrayComparable)
instead.Constructor.- Parameters:
op
- the compare op for column qualifier matchingqualifierComparator
- the comparator for column qualifier matching
-
QualifierFilter
Constructor.- Parameters:
op
- the compare op for column qualifier matchingqualifierComparator
- the comparator for column qualifier 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 ofQualifierFilter
- Parameters:
pbBytes
- A pb serializedQualifierFilter
instance- Returns:
- An instance of
QualifierFilter
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
-