@InterfaceAudience.Public @InterfaceStability.Stable public class KeyOnlyFilter extends 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(java.util.ArrayList<byte[]> filterArguments) |
Filter.ReturnCode |
filterKeyValue(Cell ignored)
A way to filter based on the column family, column qualifier and/or the column value.
|
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
|
filterAllRemaining, filterRow, filterRowCells, filterRowKey, getNextCellHint, getNextKeyHint, hasFilterRow, isFamilyEssential, reset, toString, transform
isReversed, setReversed
public KeyOnlyFilter()
public KeyOnlyFilter(boolean lenAsVal)
public Cell transformCell(Cell cell)
FilterBase
transformCell
in class 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}.
public Filter.ReturnCode filterKeyValue(Cell ignored) throws java.io.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 questionjava.io.IOException
- in case an I/O or an filter specific failure needs to be signaled.Filter.ReturnCode
public static Filter createFilterFromArguments(java.util.ArrayList<byte[]> filterArguments)
public byte[] toByteArray()
FilterBase
toByteArray
in class FilterBase
public static KeyOnlyFilter parseFrom(byte[] pbBytes) throws DeserializationException
pbBytes
- A pb serialized KeyOnlyFilter
instanceKeyOnlyFilter
made from bytes
DeserializationException
toByteArray()