@InterfaceAudience.Public public class KeyOnlyFilter extends org.apache.hadoop.hbase.filter.FilterBase
This filter can be used to grab all of the keys without having to also grab the values.
Filter.ReturnCode
Constructor and Description |
---|
KeyOnlyFilter() |
KeyOnlyFilter(boolean lenAsVal) |
Modifier and Type | Method and Description |
---|---|
static Filter |
createFilterFromArguments(ArrayList<byte[]> filterArguments) |
boolean |
equals(Object obj) |
Filter.ReturnCode |
filterCell(Cell ignored)
A way to filter based on the column family, column qualifier and/or the column value.
|
Filter.ReturnCode |
filterKeyValue(Cell ignored)
Deprecated.
|
boolean |
filterRowKey(Cell cell)
Filters a row based on the row key.
|
int |
hashCode() |
static KeyOnlyFilter |
parseFrom(byte[] pbBytes) |
byte[] |
toByteArray()
Return length 0 byte array for Filters that don't require special serialization
|
Cell |
transformCell(Cell cell)
By default no transformation takes place
Give the filter a chance to transform the passed KeyValue.
|
filterAllRemaining, filterRow, filterRowCells, filterRowKey, getNextCellHint, hasFilterRow, isFamilyEssential, reset, toString
isReversed, setReversed
public KeyOnlyFilter()
public KeyOnlyFilter(boolean lenAsVal)
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 Cell transformCell(Cell cell)
org.apache.hadoop.hbase.filter.FilterBase
transformCell
in class org.apache.hadoop.hbase.filter.FilterBase
cell
- the KeyValue in questionThe transformed KeyValue is what is eventually returned to the client. Most filters will
return the passed KeyValue unchanged.
,
for an example of a
transformation.
Concrete implementers can signal a failure condition in their code by throwing an
{@link IOException}.
@Deprecated public Filter.ReturnCode filterKeyValue(Cell ignored) throws IOException
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 questionIOException
- in case an I/O or an filter specific failure needs to be signaled.Filter.ReturnCode
public Filter.ReturnCode filterCell(Cell ignored) throws IOException
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
ignored
- the Cell in questionIOException
- in case an I/O or an filter specific failure needs to be signaled.Filter.ReturnCode
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 KeyOnlyFilter parseFrom(byte[] pbBytes) throws org.apache.hadoop.hbase.exceptions.DeserializationException
pbBytes
- A pb serialized KeyOnlyFilter
instanceKeyOnlyFilter
made from bytes
org.apache.hadoop.hbase.exceptions.DeserializationException
toByteArray()
Copyright © 2007–2020 The Apache Software Foundation. All rights reserved.