Package org.apache.hadoop.hbase.filter
Class FilterList
java.lang.Object
org.apache.hadoop.hbase.filter.Filter
org.apache.hadoop.hbase.filter.FilterBase
org.apache.hadoop.hbase.filter.FilterList
Implementation of
Defaults to
Filter
that represents an ordered List of Filters which will be
evaluated with a specified boolean operator FilterList.Operator.MUST_PASS_ALL
(AND
) or
FilterList.Operator.MUST_PASS_ONE
(OR
). Since you can use Filter Lists as children of
Filter Lists, you can create a hierarchy of filters to be evaluated. FilterList.Operator.MUST_PASS_ALL
evaluates lazily: evaluation stops as soon as one filter does not
include the Cell. FilterList.Operator.MUST_PASS_ONE
evaluates non-lazily: all filters are always evaluated. Defaults to
FilterList.Operator.MUST_PASS_ALL
.-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.Filter
Filter.ReturnCode
-
Field Summary
-
Constructor Summary
ConstructorDescriptionFilterList
(List<Filter> filters) Constructor that takes a set ofFilter
s.FilterList
(Filter... filters) Constructor that takes a var arg number ofFilter
s.FilterList
(FilterList.Operator operator) Constructor that takes an operator.FilterList
(FilterList.Operator operator, List<Filter> filters) Constructor that takes a set ofFilter
s and an operator.FilterList
(FilterList.Operator operator, Filter... filters) Constructor that takes a var arg number ofFilter
s and an operator. -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
Add a filter.(package private) boolean
areSerializedFieldsEqual
(Filter other) Returns true if and only if the fields of the filter that are serialized are equal to the corresponding fields in other.boolean
boolean
Filters that never filter all remaining can inherit this implementation that never stops the filter early.filterCell
(Cell c) A way to filter based on the column family, column qualifier and/or the column value.Deprecated.boolean
Filters that never filter by rows based on previously gathered state fromFilter.filterCell(Cell)
can inherit this implementation that never filters a row.void
filterRowCells
(List<Cell> cells) Filters that never filter by modifying the returned List of Cells can inherit this implementation that does nothing.boolean
filterRowKey
(byte[] rowKey, int offset, int length) Filters that do not filter by row key can inherit this implementation that never filters anything.boolean
filterRowKey
(Cell firstRowCell) Filters a row based on the row key.Get the filters.getNextCellHint
(Cell currentCell) Filters that are not sure which key must be next seeked to, can inherit this implementation that, by default, returns a null Cell.Get the operator.boolean
Filters that never filter by modifying the returned List of Cells can inherit this implementation that does nothing.int
hashCode()
boolean
isFamilyEssential
(byte[] name) By default, we require all scan's column families to be present.boolean
static FilterList
parseFrom
(byte[] pbBytes) Parse a seralized representation ofFilterList
void
reset()
Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation.void
setReversed
(boolean reversed) alter the reversed scan flagint
size()
byte[]
Returns The filter serialized using pbtoString()
Return filter's info for debugging and logging purpose.By default no transformation takes place By default no transformation takes place Give the filter a chance to transform the passed KeyValue.Methods inherited from class org.apache.hadoop.hbase.filter.FilterBase
createFilterFromArguments
-
Field Details
-
operator
-
filterListBase
-
-
Constructor Details
-
FilterList
Constructor that takes a set ofFilter
s and an operator.- Parameters:
operator
- Operator to process filter set with.filters
- Set of row filters.
-
FilterList
Constructor that takes a set ofFilter
s. The default operator MUST_PASS_ALL is assumed. All filters are cloned to internal list.- Parameters:
filters
- list of filters
-
FilterList
Constructor that takes a var arg number ofFilter
s. The default operator MUST_PASS_ALL is assumed. -
FilterList
Constructor that takes an operator.- Parameters:
operator
- Operator to process filter set with.
-
FilterList
Constructor that takes a var arg number ofFilter
s and an operator.- Parameters:
operator
- Operator to process filter set with.filters
- Filters to use
-
-
Method Details
-
getOperator
Get the operator. -
getFilters
Get the filters. -
size
-
addFilter
-
addFilter
Add a filter.- Parameters:
filter
- another filter
-
reset
Description copied from class:FilterBase
Filters that are purely stateless and do nothing in their reset() methods can inherit this null/empty implementation. Reset the state of the filter between rows. Concrete implementers can signal a failure condition in their code by throwing anIOException
.- Overrides:
reset
in classFilterBase
- Throws:
IOException
- in case an I/O or an filter specific failure needs to be signaled.
-
filterRowKey
Description copied from class:FilterBase
Filters that do not filter by row key can inherit this implementation that never filters anything. (ie: returns false). Filters a row based on the row key. If this returns true, the entire row will be excluded. If false, each KeyValue in the row will be passed toFilter.filterCell(Cell)
below. Concrete implementers can signal a failure condition in their code by throwing anIOException
.- Overrides:
filterRowKey
in classFilterBase
- Parameters:
rowKey
- 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).
- Throws:
IOException
- in case an I/O or an filter specific failure needs to be signaled.
-
filterRowKey
Description copied from class:Filter
Filters a row based on the row key. If this returns true, the entire row will be excluded. If false, each KeyValue in the row will be passed toFilter.filterCell(Cell)
below. IfFilter.filterAllRemaining()
returns true, thenFilter.filterRowKey(Cell)
should also return true. Concrete implementers can signal a failure condition in their code by throwing anIOException
.- Overrides:
filterRowKey
in classFilterBase
- Parameters:
firstRowCell
- The first cell coming in the new row- Returns:
- true, remove entire row, false, include the row (maybe).
- Throws:
IOException
- in case an I/O or an filter specific failure needs to be signaled.
-
filterAllRemaining
Description copied from class:FilterBase
Filters that never filter all remaining can inherit this implementation that never stops the filter early. If this returns true, the scan will terminate. Concrete implementers can signal a failure condition in their code by throwing anIOException
.- Overrides:
filterAllRemaining
in classFilterBase
- Returns:
- true to end scan, false to continue.
- Throws:
IOException
- in case an I/O or an filter specific failure needs to be signaled.
-
transformCell
Description copied from class:FilterBase
By default no transformation takes place Give the filter a chance to transform the passed KeyValue. If the Cell is changed a new Cell object must be returned.- Overrides:
transformCell
in classFilterBase
- Parameters:
c
- the KeyValue in question- Returns:
- the changed KeyValue
- Throws:
IOException
- in case an I/O or an filter specific failure needs to be signaled.- See Also:
-
filterKeyValue
Deprecated.Description copied from class:Filter
A way to filter based on the column family, column qualifier and/or the column value. Return code is described below. This allows filters to filter only certain number of columns, then terminate without matching ever column. If filterRowKey returns true, filterKeyValue needs to be consistent with it. filterKeyValue can assume that filterRowKey has already been called for the row. If your filter returnsReturnCode.NEXT_ROW
, it should returnReturnCode.NEXT_ROW
untilFilter.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 anIOException
.- Overrides:
filterKeyValue
in classFilter
- Parameters:
c
- the Cell in question- Returns:
- code as described below, Filter.ReturnCode.INCLUDE by default
- Throws:
IOException
- in case an I/O or an filter specific failure needs to be signaled.- See Also:
-
filterCell
Description copied from class:Filter
A way to filter based on the column family, column qualifier and/or the column value. Return code is described below. This allows filters to filter only certain number of columns, then terminate without matching ever column. If filterRowKey returns true, filterCell needs to be consistent with it. filterCell can assume that filterRowKey has already been called for the row. If your filter returnsReturnCode.NEXT_ROW
, it should returnReturnCode.NEXT_ROW
untilFilter.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 anIOException
.- Overrides:
filterCell
in classFilter
- Parameters:
c
- the Cell in question- Returns:
- code as described below
- Throws:
IOException
- in case an I/O or an filter specific failure needs to be signaled.- See Also:
-
filterRowCells
Filters that never filter by modifying the returned List of Cells can inherit this implementation that does nothing. Filters that never filter by modifying the returned List of Cells can inherit this implementation that does nothing. Chance to alter the list of Cells to be submitted. Modifications to the list will carry on Concrete implementers can signal a failure condition in their code by throwing anIOException
.- Overrides:
filterRowCells
in classFilterBase
- Parameters:
cells
- the list of Cells to be filtered- Throws:
IOException
- in case an I/O or an filter specific failure needs to be signaled.
-
hasFilterRow
Description copied from class:FilterBase
Filters that never filter by modifying the returned List of Cells can inherit this implementation that does nothing. Primarily used to check for conflicts with scans(such as scans that do not read a full row at a time).- Overrides:
hasFilterRow
in classFilterBase
- Returns:
- True if this filter actively uses filterRowCells(List) or filterRow().
-
filterRow
Description copied from class:FilterBase
Filters that never filter by rows based on previously gathered state fromFilter.filterCell(Cell)
can inherit this implementation that never filters a row. Last chance to veto row based on previousFilter.filterCell(Cell)
calls. The filter needs to retain state then return a particular value for this call if they wish to exclude a row if a certain column is missing (for example). Concrete implementers can signal a failure condition in their code by throwing anIOException
.- Overrides:
filterRow
in classFilterBase
- Returns:
- true to exclude row, false to include row.
- Throws:
IOException
- in case an I/O or an filter specific failure needs to be signaled.
-
toByteArray
Returns The filter serialized using pb- Overrides:
toByteArray
in classFilterBase
- Returns:
- The filter serialized using pb
- Throws:
IOException
- in case an I/O or an filter specific failure needs to be signaled.
-
parseFrom
Parse a seralized representation ofFilterList
- Parameters:
pbBytes
- A pb serializedFilterList
instance- Returns:
- An instance of
FilterList
made frombytes
- Throws:
DeserializationException
- if an error occurred- See Also:
-
areSerializedFieldsEqual
Returns true if and only if the fields of the filter that are serialized are equal to the corresponding fields in other. Used for testing.- Overrides:
areSerializedFieldsEqual
in classFilterBase
- Returns:
- true if and only if the fields of the filter that are serialized are equal to the corresponding fields in other. Used for testing.
-
getNextCellHint
Description copied from class:FilterBase
Filters that are not sure which key must be next seeked to, can inherit this implementation that, by default, returns a null Cell. If the filter returns the match code SEEK_NEXT_USING_HINT, then it should also tell which is the next key it must seek to. After receiving the match code SEEK_NEXT_USING_HINT, the QueryMatcher would call this function to find out which key it must next seek to. Concrete implementers can signal a failure condition in their code by throwing anIOException
.- Overrides:
getNextCellHint
in classFilterBase
- Returns:
- KeyValue which must be next seeked. return null if the filter is not sure which key to seek to next.
- Throws:
IOException
- in case an I/O or an filter specific failure needs to be signaled.
-
isFamilyEssential
Description copied from class:FilterBase
By default, we require all scan's column families to be present. Our subclasses may be more precise. Check that given column family is essential for filter to check row. Most filters always return true here. But some could have more sophisticated logic which could significantly reduce scanning process by not even touching columns until we are 100% sure that it's data is needed in result. Concrete implementers can signal a failure condition in their code by throwing anIOException
.- Overrides:
isFamilyEssential
in classFilterBase
- Throws:
IOException
- in case an I/O or an filter specific failure needs to be signaled.
-
setReversed
Description copied from class:Filter
alter the reversed scan flag- Overrides:
setReversed
in classFilter
- Parameters:
reversed
- flag
-
isReversed
- Overrides:
isReversed
in classFilter
-
toString
Description copied from class:FilterBase
Return filter's info for debugging and logging purpose.- Overrides:
toString
in classFilterBase
-
equals
-
hashCode
-