|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.hadoop.hbase.filter.PageRowFilter
public class PageRowFilter
Implementation of RowFilterInterface that limits results to a specific page size. It terminates scanning once the number of filter-passed results is >= the given page size.
Note that this filter cannot guarantee that the number of results returned to a client are <= page size. This is because the filter is applied separately on different region servers. It does however optimize the scan of individual HRegions by making sure that the page size is never exceeded locally.
Constructor Summary | |
---|---|
PageRowFilter()
Default constructor, filters nothing. |
|
PageRowFilter(long pageSize)
Constructor that takes a maximum page size. |
Method Summary | |
---|---|
void |
acceptedRow(Text key)
Called to let filter know that the specified row has been included in the results (passed all filtering). |
boolean |
filter(Text rowKey)
Filters on just a row key. |
boolean |
filter(Text rowKey,
Text colKey,
byte[] data)
Filters on row key and/or a column key. |
boolean |
filterAllRemaining()
Determines if the filter has decided that all remaining results should be filtered (skipped). |
boolean |
filterNotNull(TreeMap<Text,byte[]> columns)
Filters row if given columns are non-null and have null criteria or if there exists criteria on columns not included in the column set. |
void |
readFields(DataInput in)
Reads the fields of this object from in . |
void |
reset()
Resets the state of the filter. |
void |
validate(Text[] columns)
Validates that this filter applies only to a subset of the given columns. |
void |
write(DataOutput out)
Writes the fields of this object to out . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PageRowFilter()
public PageRowFilter(long pageSize)
pageSize
- Maximum result size.Method Detail |
---|
public void validate(Text[] columns)
validate
in interface RowFilterInterface
public void reset()
reset
in interface RowFilterInterface
public void acceptedRow(Text key)
acceptedRow
in interface RowFilterInterface
RowFilterSet
public boolean filterAllRemaining()
filterAllRemaining
in interface RowFilterInterface
public boolean filter(Text rowKey)
filter
in interface RowFilterInterface
public boolean filter(Text rowKey, Text colKey, byte[] data)
filter
in interface RowFilterInterface
rowKey
- row key to filter on. May be null for no filtering of row key.colKey
- column whose data will be filtereddata
- column value
public boolean filterNotNull(TreeMap<Text,byte[]> columns)
filterNotNull
in interface RowFilterInterface
public void readFields(DataInput in) throws IOException
in
. For efficiency,
implementations should attempt to re-use storage in the existing object
where possible.
readFields
in interface Writable
IOException
public void write(DataOutput out) throws IOException
out
.
write
in interface Writable
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |