@InterfaceAudience.Public public class ColumnRangeFilter extends org.apache.hadoop.hbase.filter.FilterBase
Filter.ReturnCode
Modifier and Type | Field and Description |
---|---|
protected byte[] |
maxColumn |
protected boolean |
maxColumnInclusive |
protected byte[] |
minColumn |
protected boolean |
minColumnInclusive |
Constructor and Description |
---|
ColumnRangeFilter(byte[] minColumn,
boolean minColumnInclusive,
byte[] maxColumn,
boolean maxColumnInclusive)
Create a filter to select those keys with columns that are between minColumn and maxColumn.
|
Modifier and Type | Method and Description |
---|---|
static Filter |
createFilterFromArguments(ArrayList<byte[]> filterArguments) |
boolean |
equals(Object obj) |
Filter.ReturnCode |
filterCell(Cell c)
A way to filter based on the column family, column qualifier and/or the column value.
|
boolean |
filterRowKey(Cell cell)
Filters a row based on the row key.
|
byte[] |
getMaxColumn()
Returns the max column range for the filter
|
boolean |
getMaxColumnInclusive()
Returns true if max column is inclusive, false otherwise
|
byte[] |
getMinColumn()
Returns the min column range for the filter
|
boolean |
getMinColumnInclusive()
Returns true if min column is inclusive, false otherwise
|
Cell |
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.
|
int |
hashCode() |
boolean |
isMaxColumnInclusive()
Returns if max column range is inclusive.
|
boolean |
isMinColumnInclusive()
Returns if min column range is inclusive.
|
static ColumnRangeFilter |
parseFrom(byte[] pbBytes)
Parse a serialized representation of
ColumnRangeFilter |
byte[] |
toByteArray()
Returns The filter serialized using pb
|
String |
toString()
Return filter's info for debugging and logging purpose.
|
filterAllRemaining, filterRow, filterRowCells, hasFilterRow, isFamilyEssential, reset, transformCell
isReversed, setReversed
protected byte[] minColumn
protected boolean minColumnInclusive
protected byte[] maxColumn
protected boolean maxColumnInclusive
public ColumnRangeFilter(byte[] minColumn, boolean minColumnInclusive, byte[] maxColumn, boolean maxColumnInclusive)
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.public boolean isMinColumnInclusive()
public boolean isMaxColumnInclusive()
public byte[] getMinColumn()
public boolean getMinColumnInclusive()
public byte[] getMaxColumn()
public boolean getMaxColumnInclusive()
public boolean filterRowKey(Cell cell) throws IOException
Filter
Filter.filterCell(Cell)
below. If
Filter.filterAllRemaining()
returns true, then Filter.filterRowKey(Cell)
should also return
true. Concrete implementers can signal a failure condition in their code by throwing an
IOException
.filterRowKey
in class org.apache.hadoop.hbase.filter.FilterBase
cell
- The first cell coming in the new rowIOException
- in case an I/O or an filter specific failure needs to be signaled.public Filter.ReturnCode filterCell(Cell c)
Filter
ReturnCode.NEXT_ROW
, it should return
ReturnCode.NEXT_ROW
until Filter.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 an IOException
.filterCell
in class Filter
c
- the Cell in questionFilter.ReturnCode
public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)
public byte[] toByteArray()
toByteArray
in class org.apache.hadoop.hbase.filter.FilterBase
public static ColumnRangeFilter parseFrom(byte[] pbBytes) throws org.apache.hadoop.hbase.exceptions.DeserializationException
ColumnRangeFilter
pbBytes
- A pb serialized ColumnRangeFilter
instanceColumnRangeFilter
made from bytes
org.apache.hadoop.hbase.exceptions.DeserializationException
- if an error occurredtoByteArray()
public Cell getNextCellHint(Cell cell)
org.apache.hadoop.hbase.filter.FilterBase
IOException
.getNextCellHint
in class org.apache.hadoop.hbase.filter.FilterBase
public String toString()
org.apache.hadoop.hbase.filter.FilterBase
toString
in class org.apache.hadoop.hbase.filter.FilterBase
Copyright © 2007–2020 The Apache Software Foundation. All rights reserved.