@InterfaceAudience.Public @InterfaceStability.Stable public class ColumnPrefixFilter extends org.apache.hadoop.hbase.filter.FilterBase
Filter.ReturnCode
Modifier and Type | Field and Description |
---|---|
protected byte[] |
prefix |
Constructor and Description |
---|
ColumnPrefixFilter(byte[] prefix) |
Modifier and Type | Method and Description |
---|---|
static Filter |
createFilterFromArguments(ArrayList<byte[]> filterArguments) |
Filter.ReturnCode |
filterColumn(Cell cell) |
Filter.ReturnCode |
filterKeyValue(Cell cell)
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.
|
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.
|
byte[] |
getPrefix() |
static ColumnPrefixFilter |
parseFrom(byte[] pbBytes) |
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.
|
filterAllRemaining, filterRow, filterRowCells, filterRowKey, hasFilterRow, isFamilyEssential, reset, transformCell
isReversed, setReversed
protected byte[] prefix
public ColumnPrefixFilter(byte[] prefix)
public byte[] getPrefix()
public boolean filterRowKey(Cell cell) throws IOException
Filter
Filter.filterKeyValue(Cell)
below.
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 filterKeyValue(Cell cell)
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
cell
- the Cell in questionFilter.ReturnCode
public Filter.ReturnCode filterColumn(Cell cell)
public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)
public byte[] toByteArray()
org.apache.hadoop.hbase.filter.FilterBase
toByteArray
in class org.apache.hadoop.hbase.filter.FilterBase
public static ColumnPrefixFilter parseFrom(byte[] pbBytes) throws org.apache.hadoop.hbase.exceptions.DeserializationException
pbBytes
- A pb serialized ColumnPrefixFilter
instanceColumnPrefixFilter
made from bytes
org.apache.hadoop.hbase.exceptions.DeserializationException
toByteArray()
public Cell getNextCellHint(Cell cell)
org.apache.hadoop.hbase.filter.FilterBase
IOException
.getNextCellHint
in class org.apache.hadoop.hbase.filter.FilterBase
Copyright © 2007–2015 The Apache Software Foundation. All rights reserved.