@InterfaceAudience.Public @InterfaceStability.Evolving public class MultiRowRangeFilter extends FilterBase
Modifier and Type | Class and Description |
---|---|
static class |
MultiRowRangeFilter.RowRange |
Filter.ReturnCode
Constructor and Description |
---|
MultiRowRangeFilter(java.util.List<MultiRowRangeFilter.RowRange> list) |
Modifier and Type | Method and Description |
---|---|
boolean |
filterAllRemaining()
Filters that never filter all remaining can inherit this implementation that
never stops the filter early.
|
Filter.ReturnCode |
filterKeyValue(Cell ignored)
A way to filter based on the column family, column qualifier and/or the column value.
|
boolean |
filterRowKey(byte[] buffer,
int offset,
int length)
Filters that do not filter by row key can inherit this implementation that
never filters anything.
|
Cell |
getNextCellHint(Cell currentKV)
Filters that are not sure which key must be next seeked to, can inherit
this implementation that, by default, returns a null Cell.
|
java.util.List<MultiRowRangeFilter.RowRange> |
getRowRanges() |
static MultiRowRangeFilter |
parseFrom(byte[] pbBytes) |
static java.util.List<MultiRowRangeFilter.RowRange> |
sortAndMerge(java.util.List<MultiRowRangeFilter.RowRange> ranges)
sort the ranges and if the ranges with overlap, then merge them.
|
byte[] |
toByteArray()
Return length 0 byte array for Filters that don't require special serialization
|
createFilterFromArguments, filterRow, filterRowCells, getNextKeyHint, hasFilterRow, isFamilyEssential, reset, toString, transform, transformCell
isReversed, setReversed
public MultiRowRangeFilter(java.util.List<MultiRowRangeFilter.RowRange> list) throws java.io.IOException
list
- A list of RowRange
java.io.IOException
- throw an exception if the range list is not in an natural order or any
RowRange
is invalidpublic boolean filterAllRemaining()
FilterBase
filterAllRemaining
in class FilterBase
public java.util.List<MultiRowRangeFilter.RowRange> getRowRanges()
public boolean filterRowKey(byte[] buffer, int offset, int length)
FilterBase
filterRowKey
in class FilterBase
buffer
- buffer containing row keyoffset
- offset into buffer where row key startslength
- length of the row keypublic Filter.ReturnCode filterKeyValue(Cell ignored)
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
.filterKeyValue
in class Filter
ignored
- the Cell in questionFilter.ReturnCode
public Cell getNextCellHint(Cell currentKV)
FilterBase
getNextCellHint
in class FilterBase
public byte[] toByteArray()
FilterBase
toByteArray
in class FilterBase
public static MultiRowRangeFilter parseFrom(byte[] pbBytes) throws DeserializationException
pbBytes
- A pb serialized instanceDeserializationException
public static java.util.List<MultiRowRangeFilter.RowRange> sortAndMerge(java.util.List<MultiRowRangeFilter.RowRange> ranges)
ranges
- the list of ranges to sort and merge.