@InterfaceAudience.Public @InterfaceStability.Stable public class WhileMatchFilter extends FilterBase
filterAllRemaining()
as soon
as the wrapped filters Filter.filterRowKey(byte[], int, int)
,
Filter.filterKeyValue(org.apache.hadoop.hbase.Cell)
,
Filter.filterRow()
or
Filter.filterAllRemaining()
methods
returns true.Filter.ReturnCode
Constructor and Description |
---|
WhileMatchFilter(Filter filter) |
Modifier and Type | Method and Description |
---|---|
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.
|
boolean |
filterRow()
Filters that never filter by rows based on previously gathered state from
Filter.filterKeyValue(Cell) can inherit this implementation that
never filters a row. |
boolean |
filterRowKey(byte[] buffer,
int offset,
int length)
Filters that do not filter by row key can inherit this implementation that
never filters anything.
|
Filter |
getFilter() |
boolean |
hasFilterRow()
Fitlers that never filter by modifying the returned List of Cells can
inherit this implementation that does nothing.
|
boolean |
isFamilyEssential(byte[] name)
By default, we require all scan's column families to be present.
|
static WhileMatchFilter |
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
|
createFilterFromArguments, filterRowCells, getNextCellHint, getNextKeyHint, transform
isReversed, setReversed
public WhileMatchFilter(Filter filter)
public Filter getFilter()
public void reset() throws java.io.IOException
FilterBase
reset
in class FilterBase
java.io.IOException
- in case an I/O or an filter specific failure needs to be signaled.public boolean filterAllRemaining() throws java.io.IOException
FilterBase
filterAllRemaining
in class FilterBase
java.io.IOException
- in case an I/O or an filter specific failure needs to be signaled.public boolean filterRowKey(byte[] buffer, int offset, int length) throws java.io.IOException
FilterBase
filterRowKey
in class FilterBase
buffer
- buffer containing row keyoffset
- offset into buffer where row key startslength
- length of the row keyjava.io.IOException
- in case an I/O or an filter specific failure needs to be signaled.public Filter.ReturnCode filterKeyValue(Cell v) 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
v
- the Cell in questionjava.io.IOException
- in case an I/O or an filter specific failure needs to be signaled.Filter.ReturnCode
public Cell transformCell(Cell v) throws java.io.IOException
FilterBase
transformCell
in class FilterBase
v
- the KeyValue in questionjava.io.IOException
- in case an I/O or an filter specific failure needs to be signaled.The 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 boolean filterRow() throws java.io.IOException
FilterBase
Filter.filterKeyValue(Cell)
can inherit this implementation that
never filters a row.filterRow
in class FilterBase
java.io.IOException
- in case an I/O or an filter specific failure needs to be signaled.public boolean hasFilterRow()
FilterBase
hasFilterRow
in class FilterBase
public byte[] toByteArray() throws java.io.IOException
FilterBase
toByteArray
in class FilterBase
java.io.IOException
- in case an I/O or an filter specific failure needs to be signaled.public static WhileMatchFilter parseFrom(byte[] pbBytes) throws DeserializationException
pbBytes
- A pb serialized WhileMatchFilter
instanceWhileMatchFilter
made from bytes
DeserializationException
toByteArray()
public boolean isFamilyEssential(byte[] name) throws java.io.IOException
FilterBase
isFamilyEssential
in class FilterBase
java.io.IOException
- in case an I/O or an filter specific failure needs to be signaled.public java.lang.String toString()
FilterBase
toString
in class FilterBase