@InterfaceAudience.Public public class PrefixFilter extends 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 |
|---|---|
(package private) boolean |
areSerializedFieldsEqual(Filter o)
Default implementation so that writers of custom filters aren't forced to implement.
|
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.
|
Filter.ReturnCode |
filterKeyValue(Cell c)
Deprecated.
|
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) |
void |
reset()
Filters that are purely stateless and do nothing in their reset() methods can inherit
this null/empty implementation.
|
byte[] |
toByteArray()
Return length 0 byte array for Filters that don't require special serialization
|
String |
toString()
Return filter's info for debugging and logging purpose.
|
filterRowCells, filterRowKey, getNextCellHint, hasFilterRow, isFamilyEssential, transformCellisReversed, setReversedprotected byte[] prefix
protected boolean passedPrefix
protected boolean filterRow
public PrefixFilter(byte[] prefix)
public byte[] getPrefix()
public boolean filterRowKey(Cell firstRowCell)
FilterFilter.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 FilterBasefirstRowCell - The first cell coming in the new row@Deprecated public Filter.ReturnCode filterKeyValue(Cell c)
FilterReturnCode.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 Filterc - the Cell in questionFilter.ReturnCodepublic Filter.ReturnCode filterCell(Cell c)
FilterReturnCode.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 Filterc - the Cell in questionFilter.ReturnCodepublic boolean filterRow()
FilterBaseFilter.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 FilterBasepublic void reset()
FilterBaseIOException.reset in class FilterBasepublic boolean filterAllRemaining()
FilterBaseIOException.filterAllRemaining in class FilterBasepublic static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)
public byte[] toByteArray()
FilterBasetoByteArray in class FilterBasepublic static PrefixFilter parseFrom(byte[] pbBytes) throws DeserializationException
pbBytes - A pb serialized PrefixFilter instancePrefixFilter made from bytesDeserializationExceptiontoByteArray()boolean areSerializedFieldsEqual(Filter o)
FilterBaseareSerializedFieldsEqual in class FilterBaseo - the other filter to compare withpublic String toString()
FilterBasetoString in class FilterBaseCopyright © 2007–2019 The Apache Software Foundation. All rights reserved.