org.apache.hadoop.hbase.filter
Class InclusiveStopFilter
java.lang.Object
org.apache.hadoop.hbase.filter.Filter
org.apache.hadoop.hbase.filter.FilterBase
org.apache.hadoop.hbase.filter.InclusiveStopFilter
@InterfaceAudience.Public
@InterfaceStability.Stable
public class InclusiveStopFilter
- extends FilterBase
A Filter that stops after the given row. There is no "RowStopFilter" because
the Scan spec allows you to specify a stop row.
Use this filter to include the stop row, eg: [A,Z].
Fields inherited from class org.apache.hadoop.hbase.filter.Filter |
reversed |
InclusiveStopFilter
public InclusiveStopFilter(byte[] stopRowKey)
getStopRowKey
public byte[] getStopRowKey()
filterKeyValue
public Filter.ReturnCode filterKeyValue(Cell v)
- Description copied from class:
FilterBase
- Filters that dont filter by key value can inherit this implementation that
includes all Cells.
- Overrides:
filterKeyValue
in class FilterBase
- Parameters:
v
- the Cell in question
- Returns:
- code as described below
- See Also:
Filter.ReturnCode
filterRowKey
public boolean filterRowKey(byte[] buffer,
int offset,
int length)
- Description copied from class:
FilterBase
- Filters that do not filter by row key can inherit this implementation that
never filters anything. (ie: returns false).
- Overrides:
filterRowKey
in class FilterBase
- Parameters:
buffer
- buffer containing row keyoffset
- offset into buffer where row key startslength
- length of the row key
- Returns:
- true, remove entire row, false, include the row (maybe).
filterAllRemaining
public boolean filterAllRemaining()
- Description copied from class:
FilterBase
- Filters that never filter all remaining can inherit this implementation that
never stops the filter early.
- Overrides:
filterAllRemaining
in class FilterBase
- Returns:
- true to end scan, false to continue.
createFilterFromArguments
public static Filter createFilterFromArguments(ArrayList<byte[]> filterArguments)
toByteArray
public byte[] toByteArray()
- Description copied from class:
FilterBase
- Return length 0 byte array for Filters that don't require special serialization
- Overrides:
toByteArray
in class FilterBase
- Returns:
- The filter serialized using pb
parseFrom
public static InclusiveStopFilter parseFrom(byte[] pbBytes)
throws DeserializationException
- Parameters:
pbBytes
- A pb serialized InclusiveStopFilter
instance
- Returns:
- An instance of
InclusiveStopFilter
made from bytes
- Throws:
DeserializationException
- See Also:
toByteArray()
toString
public String toString()
- Description copied from class:
FilterBase
- Return filter's info for debugging and logging purpose.
- Overrides:
toString
in class FilterBase
Copyright © 2007–2015 The Apache Software Foundation. All rights reserved.