Package org.apache.hadoop.hbase.filter
Class ColumnPrefixFilter
java.lang.Object
org.apache.hadoop.hbase.filter.Filter
org.apache.hadoop.hbase.filter.FilterBase
org.apache.hadoop.hbase.filter.ColumnPrefixFilter
This filter is used for selecting only those keys with columns that matches a particular prefix.
For example, if prefix is 'an', it will pass keys with columns like 'and', 'anti' but not keys
with columns like 'ball', 'act'.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.Filter
Filter.ReturnCode
-
Field Summary
-
Constructor Summary
-
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.private static int
compareQualifierPart
(Cell cell, int length, byte[] prefix) static Filter
createFilterFromArguments
(ArrayList<byte[]> filterArguments) boolean
filterCell
(Cell cell) A way to filter based on the column family, column qualifier and/or the column value.filterColumn
(Cell cell) Deprecated.boolean
filterRowKey
(Cell cell) Filters a row based on the row key.getNextCellHint
(Cell cell) Filters that are not sure which key must be next seeked to, can inherit this implementation that, by default, returns a null Cell.byte[]
int
hashCode()
static ColumnPrefixFilter
parseFrom
(byte[] pbBytes) Parses a serialized representation of theColumnPrefixFilter
byte[]
Returns The filter serialized using pbtoString()
Return filter's info for debugging and logging purpose.Methods inherited from class org.apache.hadoop.hbase.filter.FilterBase
filterAllRemaining, filterRow, filterRowCells, filterRowKey, hasFilterRow, isFamilyEssential, reset, transformCell
Methods inherited from class org.apache.hadoop.hbase.filter.Filter
isReversed, setReversed
-
Field Details
-
prefix
-
-
Constructor Details
-
ColumnPrefixFilter
-
-
Method Details
-
getPrefix
-
filterRowKey
Description copied from class:Filter
Filters a row based on the row key. If this returns true, the entire row will be excluded. If false, each KeyValue in the row will be passed toFilter.filterCell(Cell)
below. IfFilter.filterAllRemaining()
returns true, thenFilter.filterRowKey(Cell)
should also return true. Concrete implementers can signal a failure condition in their code by throwing anIOException
.- Overrides:
filterRowKey
in classFilterBase
- Parameters:
cell
- The first cell coming in the new row- Returns:
- true, remove entire row, false, include the row (maybe).
- Throws:
IOException
- in case an I/O or an filter specific failure needs to be signaled.
-
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:
cell
- the Cell in question- Returns:
- code as described below
- See Also:
-
filterColumn
-
compareQualifierPart
-
createFilterFromArguments
-
toByteArray
Returns The filter serialized using pb- Overrides:
toByteArray
in classFilterBase
- Returns:
- The filter serialized using pb
-
parseFrom
Parses a serialized representation of theColumnPrefixFilter
- Parameters:
pbBytes
- A pb serializedColumnPrefixFilter
instance- Returns:
- An instance of
ColumnPrefixFilter
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 classFilterBase
- 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.
-
getNextCellHint
Description copied from class:FilterBase
Filters that are not sure which key must be next seeked to, can inherit this implementation that, by default, returns a null Cell. If the filter returns the match code SEEK_NEXT_USING_HINT, then it should also tell which is the next key it must seek to. After receiving the match code SEEK_NEXT_USING_HINT, the QueryMatcher would call this function to find out which key it must next seek to. Concrete implementers can signal a failure condition in their code by throwing anIOException
.- Overrides:
getNextCellHint
in classFilterBase
- Returns:
- KeyValue which must be next seeked. return null if the filter is not sure which key to seek to next.
-
toString
Description copied from class:FilterBase
Return filter's info for debugging and logging purpose.- Overrides:
toString
in classFilterBase
-
equals
-
hashCode
-