@InterfaceAudience.Public public class PrefixFilter extends org.apache.hadoop.hbase.filter.FilterBase
Filter.ReturnCode
Modifier and Type | Field and Description |
---|---|
protected boolean |
filterRow |
protected boolean |
passedPrefix |
protected byte[] |
prefix |
Constructor and Description |
---|
PrefixFilter(byte[] prefix) |
Modifier and Type | Method and Description |
---|---|
static Filter |
createFilterFromArguments(ArrayList<byte[]> filterArguments) |
boolean |
equals(Object obj) |
boolean |
filterAllRemaining()
Filters that never filter all remaining can inherit this implementation that never stops the
filter early.
|
Filter.ReturnCode |
filterCell(Cell c)
A way to filter based on the column family, column qualifier and/or the column value.
|
boolean |
filterRow()
Filters that never filter by rows based on previously gathered state from
Filter.filterCell(Cell) can inherit this implementation that never filters a row. |
boolean |
filterRowKey(Cell firstRowCell)
Filters a row based on the row key.
|
byte[] |
getPrefix() |
int |
hashCode() |
static PrefixFilter |
parseFrom(byte[] pbBytes)
Parse a serialized representation of
PrefixFilter |
void |
reset()
Filters that are purely stateless and do nothing in their reset() methods can inherit this
null/empty implementation.
|
byte[] |
toByteArray()
Returns The filter serialized using pb
|
String |
toString()
Return filter's info for debugging and logging purpose.
|
filterRowCells, getNextCellHint, hasFilterRow, isFamilyEssential, transformCell
isReversed, setReversed
protected byte[] prefix
protected boolean passedPrefix
protected boolean filterRow
public PrefixFilter(byte[] prefix)
public byte[] getPrefix()
public boolean filterRowKey(Cell firstRowCell)
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
firstRowCell
- The first cell coming in the new rowpublic 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 boolean filterRow()
org.apache.hadoop.hbase.filter.FilterBase
Filter.filterCell(Cell)
can inherit this implementation that never filters a row.
Last chance to veto row based on previous Filter.filterCell(Cell)
calls. The filter needs to
retain state then return a particular value for this call if they wish to exclude a row if a
certain column is missing (for example). Concrete implementers can signal a failure condition
in their code by throwing an IOException
.filterRow
in class org.apache.hadoop.hbase.filter.FilterBase
public void reset()
org.apache.hadoop.hbase.filter.FilterBase
IOException
.reset
in class org.apache.hadoop.hbase.filter.FilterBase
public boolean filterAllRemaining()
org.apache.hadoop.hbase.filter.FilterBase
IOException
.filterAllRemaining
in class org.apache.hadoop.hbase.filter.FilterBase
public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)
public byte[] toByteArray()
toByteArray
in class org.apache.hadoop.hbase.filter.FilterBase
public static PrefixFilter parseFrom(byte[] pbBytes) throws org.apache.hadoop.hbase.exceptions.DeserializationException
PrefixFilter
pbBytes
- A pb serialized PrefixFilter
instancePrefixFilter
made from bytes
org.apache.hadoop.hbase.exceptions.DeserializationException
- if an error occurredtoByteArray()
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.