|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.hadoop.hbase.filter.ColumnValueFilter
public class ColumnValueFilter
This filter is a no-op in HBase 0.20. Don't use it. This filter is used to filter based on the value of a given column. It takes an operator (equal, greater, not equal, etc) and either a byte [] value or a byte [] comparator. If we have a byte [] value then we just do a lexicographic compare. If this is not sufficient (eg you want to deserialize a long and then compare it to a fixed long value), then you can pass in your own comparator instead.
Nested Class Summary | |
---|---|
static class |
ColumnValueFilter.CompareOp
Deprecated. Comparison operators. |
Constructor Summary | |
---|---|
ColumnValueFilter(byte[] columnName,
ColumnValueFilter.CompareOp compareOp,
byte[] value)
Deprecated. Constructor. |
|
ColumnValueFilter(byte[] columnName,
ColumnValueFilter.CompareOp compareOp,
byte[] value,
boolean filterIfColumnMissing)
Deprecated. Constructor. |
|
ColumnValueFilter(byte[] columnName,
ColumnValueFilter.CompareOp compareOp,
WritableByteArrayComparable comparator)
Deprecated. Constructor. |
|
ColumnValueFilter(byte[] columnName,
ColumnValueFilter.CompareOp compareOp,
WritableByteArrayComparable comparator,
boolean filterIfColumnMissing)
Deprecated. Constructor. |
Method Summary | |
---|---|
boolean |
filterAllRemaining()
Deprecated. Determines if the filter has decided that all remaining results should be filtered (skipped). |
boolean |
filterColumn(byte[] rowKey,
byte[] colKey,
byte[] data)
Deprecated. Filters on row key, column name, and column value. |
boolean |
filterColumn(byte[] rowKey,
int roffset,
int rlength,
byte[] cn,
int coffset,
int clength,
byte[] columnValue,
int voffset,
int vlength)
Deprecated. Filters on row key, column name, and column value. |
boolean |
filterRow(List<KeyValue> results)
Deprecated. Filter on the fully assembled row. |
boolean |
filterRow(SortedMap<byte[],Cell> columns)
Deprecated. Filter on the fully assembled row. |
boolean |
filterRowKey(byte[] rowKey)
Deprecated. Filters on just a row key. |
boolean |
filterRowKey(byte[] rowKey,
int offset,
int length)
Deprecated. Filters on just a row key. |
boolean |
processAlways()
Deprecated. Returns whether or not the filter should always be processed in any filtering call. |
void |
readFields(DataInput in)
Deprecated. |
void |
reset()
Deprecated. Resets the state of the filter. |
void |
rowProcessed(boolean filtered,
byte[] key)
Deprecated. Called to let filter know the final decision (to pass or filter) on a given row. |
void |
rowProcessed(boolean filtered,
byte[] key,
int offset,
int length)
Deprecated. Called to let filter know the final decision (to pass or filter) on a given row. |
void |
validate(byte[][] columns)
Deprecated. Validates that this filter applies only to a subset of the given columns. |
void |
write(DataOutput out)
Deprecated. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ColumnValueFilter(byte[] columnName, ColumnValueFilter.CompareOp compareOp, byte[] value)
columnName
- name of columncompareOp
- operatorvalue
- value to compare column values againstpublic ColumnValueFilter(byte[] columnName, ColumnValueFilter.CompareOp compareOp, byte[] value, boolean filterIfColumnMissing)
columnName
- name of columncompareOp
- operatorvalue
- value to compare column values againstfilterIfColumnMissing
- if true then we will filter rows that don't have the column.public ColumnValueFilter(byte[] columnName, ColumnValueFilter.CompareOp compareOp, WritableByteArrayComparable comparator)
columnName
- name of columncompareOp
- operatorcomparator
- Comparator to use.public ColumnValueFilter(byte[] columnName, ColumnValueFilter.CompareOp compareOp, WritableByteArrayComparable comparator, boolean filterIfColumnMissing)
columnName
- name of columncompareOp
- operatorcomparator
- Comparator to use.filterIfColumnMissing
- if true then we will filter rows that don't have the column.Method Detail |
---|
public boolean filterRowKey(byte[] rowKey)
RowFilterInterface
filterRowKey
in interface RowFilterInterface
public boolean filterRowKey(byte[] rowKey, int offset, int length)
RowFilterInterface
filterRowKey
in interface RowFilterInterface
public boolean filterColumn(byte[] rowKey, byte[] colKey, byte[] data)
RowFilterInterface
filterColumn
in interface RowFilterInterface
rowKey
- row key to filter on.colKey
- column name to filter ondata
- column value to filter on
public boolean filterColumn(byte[] rowKey, int roffset, int rlength, byte[] cn, int coffset, int clength, byte[] columnValue, int voffset, int vlength)
RowFilterInterface
filterColumn
in interface RowFilterInterface
rowKey
- row key to filter on.cn
- column name to filter oncolumnValue
- column value to filter on
public boolean filterAllRemaining()
RowFilterInterface
filterAllRemaining
in interface RowFilterInterface
public boolean filterRow(SortedMap<byte[],Cell> columns)
RowFilterInterface
filterRow
in interface RowFilterInterface
public boolean filterRow(List<KeyValue> results)
RowFilterInterface
filterRow
in interface RowFilterInterface
public boolean processAlways()
RowFilterInterface
processAlways
in interface RowFilterInterface
public void reset()
RowFilterInterface
reset
in interface RowFilterInterface
public void rowProcessed(boolean filtered, byte[] key)
RowFilterInterface
rowProcessed
in interface RowFilterInterface
RowFilterSet
public void rowProcessed(boolean filtered, byte[] key, int offset, int length)
RowFilterInterface
rowProcessed
in interface RowFilterInterface
RowFilterSet
public void validate(byte[][] columns)
RowFilterInterface
validate
in interface RowFilterInterface
public void readFields(DataInput in) throws IOException
readFields
in interface org.apache.hadoop.io.Writable
IOException
public void write(DataOutput out) throws IOException
write
in interface org.apache.hadoop.io.Writable
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |