Package org.apache.hadoop.hbase.filter
Class ColumnRangeFilter
java.lang.Object
org.apache.hadoop.hbase.filter.Filter
org.apache.hadoop.hbase.filter.FilterBase
org.apache.hadoop.hbase.filter.ColumnRangeFilter
This filter is used for selecting only those keys with columns that are between minColumn to
maxColumn. For example, if minColumn is 'an', and maxColumn is 'be', it will pass keys with
columns like 'ana', 'bad', but not keys with columns like 'bed', 'eye' If minColumn is null,
there is no lower bound. If maxColumn is null, there is no upper bound. minColumnInclusive and
maxColumnInclusive specify if the ranges are inclusive or not.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.Filter
Filter.ReturnCode
-
Field Summary
Modifier and TypeFieldDescriptionprotected byte[]
protected boolean
protected byte[]
protected boolean
-
Constructor Summary
ConstructorDescriptionColumnRangeFilter
(byte[] minColumn, boolean minColumnInclusive, byte[] maxColumn, boolean maxColumnInclusive) Create a filter to select those keys with columns that are between minColumn and maxColumn. -
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.boolean
filterRowKey
(Cell cell) Filters a row based on the row key.byte[]
Returns the max column range for the filterboolean
Returns true if max column is inclusive, false otherwisebyte[]
Returns the min column range for the filterboolean
Returns true if min column is inclusive, false otherwisegetNextCellHint
(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.int
hashCode()
boolean
Returns if max column range is inclusive.boolean
Returns if min column range is inclusive.static ColumnRangeFilter
parseFrom
(byte[] pbBytes) Parse a serialized representation ofColumnRangeFilter
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
-
minColumn
-
minColumnInclusive
-
maxColumn
-
maxColumnInclusive
-
-
Constructor Details
-
ColumnRangeFilter
public ColumnRangeFilter(byte[] minColumn, boolean minColumnInclusive, byte[] maxColumn, boolean maxColumnInclusive) Create a filter to select those keys with columns that are between minColumn and maxColumn.- Parameters:
minColumn
- minimum value for the column range. If if it's null, there is no lower bound.minColumnInclusive
- if true, include minColumn in the range.maxColumn
- maximum value for the column range. If it's null,maxColumnInclusive
- if true, include maxColumn in the range. there is no upper bound.
-
-
Method Details
-
isMinColumnInclusive
Returns if min column range is inclusive. -
isMaxColumnInclusive
Returns if max column range is inclusive. -
getMinColumn
Returns the min column range for the filter -
getMinColumnInclusive
Returns true if min column is inclusive, false otherwise -
getMaxColumn
Returns the max column range for the filter -
getMaxColumnInclusive
Returns true if max column is inclusive, false otherwise -
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:
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 ofColumnRangeFilter
- Parameters:
pbBytes
- A pb serializedColumnRangeFilter
instance- Returns:
- An instance of
ColumnRangeFilter
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
-