org.apache.hadoop.hbase.filter
Class PrefixFilter
java.lang.Object
org.apache.hadoop.hbase.filter.Filter
org.apache.hadoop.hbase.filter.FilterBase
org.apache.hadoop.hbase.filter.PrefixFilter
@InterfaceAudience.Public
@InterfaceStability.Stable
public class PrefixFilter
- extends FilterBase
Pass results that have same row prefix.
prefix
protected byte[] prefix
passedPrefix
protected boolean passedPrefix
PrefixFilter
public PrefixFilter(byte[] prefix)
getPrefix
public byte[] getPrefix()
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 PrefixFilter parseFrom(byte[] pbBytes)
throws DeserializationException
- Parameters:
pbBytes
- A pb serialized PrefixFilter
instance
- Returns:
- An instance of
PrefixFilter
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 © 2013 The Apache Software Foundation. All Rights Reserved.