@InterfaceAudience.Public @InterfaceStability.Stable public class ColumnCountGetFilter extends FilterBase
filterAllRemaining()
returns true. This
makes this filter unsuitable as a Scan filter.Filter.ReturnCode
Constructor and Description |
---|
ColumnCountGetFilter(int n) |
Modifier and Type | Method and Description |
---|---|
static Filter |
createFilterFromArguments(java.util.ArrayList<byte[]> filterArguments) |
boolean |
filterAllRemaining()
Filters that never filter all remaining can inherit this implementation that
never stops the filter early.
|
Filter.ReturnCode |
filterKeyValue(Cell v)
A way to filter based on the column family, column qualifier and/or the column value.
|
int |
getLimit() |
static ColumnCountGetFilter |
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
|
java.lang.String |
toString()
Return filter's info for debugging and logging purpose.
|
Cell |
transformCell(Cell v)
By default no transformation takes place
|
filterRow, filterRowCells, filterRowKey, getNextCellHint, getNextKeyHint, hasFilterRow, isFamilyEssential, transform
isReversed, setReversed
public int getLimit()
public boolean filterAllRemaining()
FilterBase
filterAllRemaining
in class FilterBase
public Filter.ReturnCode filterKeyValue(Cell v)
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
v
- the Cell in questionFilter.ReturnCode
public Cell transformCell(Cell v)
FilterBase
transformCell
in class FilterBase
v
- 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 void reset()
FilterBase
reset
in class FilterBase
public static Filter createFilterFromArguments(java.util.ArrayList<byte[]> filterArguments)
public byte[] toByteArray()
FilterBase
toByteArray
in class FilterBase
public static ColumnCountGetFilter parseFrom(byte[] pbBytes) throws DeserializationException
pbBytes
- A pb serialized ColumnCountGetFilter
instanceColumnCountGetFilter
made from bytes
DeserializationException
toByteArray()
public java.lang.String toString()
FilterBase
toString
in class FilterBase