Package org.apache.hadoop.hbase.filter
Class FilterWrapper
java.lang.Object
org.apache.hadoop.hbase.filter.Filter
org.apache.hadoop.hbase.filter.FilterWrapper
This is a Filter wrapper class which is used in the server side. Some filter related hooks can be
defined in this wrapper. The only way to create a FilterWrapper instance is passing a client side
Filter instance through
Scan.getFilter()
.-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.hadoop.hbase.filter.Filter
Filter.ReturnCode
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescription(package private) boolean
Concrete implementers can signal a failure condition in their code by throwing anIOException
.boolean
If this returns true, the scan will terminate.filterCell
(Cell c) A way to filter based on the column family, column qualifier and/or the column value.Deprecated.boolean
Last chance to veto row based on previousFilter.filterCell(Cell)
calls.void
filterRowCells
(List<Cell> kvs) Chance to alter the list of Cells to be submitted.filterRowCellsWithRet
(List<Cell> kvs) boolean
filterRowKey
(byte[] buffer, int offset, int length) Filters a row based on the row key.boolean
filterRowKey
(Cell cell) Filters a row based on the row key.getNextCellHint
(Cell currentCell) 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.boolean
Primarily used to check for conflicts with scans(such as scans that do not read a full row at a time).boolean
isFamilyEssential
(byte[] name) Check that given column family is essential for filter to check row.static FilterWrapper
parseFrom
(byte[] pbBytes) void
reset()
Reset the state of the filter between rows.byte[]
Returns The filter serialized using pbGive the filter a chance to transform the passed KeyValue.Methods inherited from class org.apache.hadoop.hbase.filter.Filter
isReversed, setReversed
-
Field Details
-
filter
-
-
Constructor Details
-
FilterWrapper
-
-
Method Details
-
toByteArray
Returns The filter serialized using pb- Specified by:
toByteArray
in classFilter
- Returns:
- The filter serialized using pb
- Throws:
IOException
- in case an I/O or an filter specific failure needs to be signaled.
-
parseFrom
- Parameters:
pbBytes
- A pb serializedFilterWrapper
instance- Returns:
- An instance of
FilterWrapper
made frombytes
- Throws:
DeserializationException
- See Also:
-
reset
Description copied from class:Filter
Reset the state of the filter between rows. Concrete implementers can signal a failure condition in their code by throwing anIOException
.- Specified by:
reset
in classFilter
- Throws:
IOException
- in case an I/O or an filter specific failure needs to be signaled.
-
filterAllRemaining
Description copied from class:Filter
If this returns true, the scan will terminate. Concrete implementers can signal a failure condition in their code by throwing anIOException
.- Specified by:
filterAllRemaining
in classFilter
- Returns:
- true to end scan, false to continue.
- Throws:
IOException
- in case an I/O or an filter specific failure needs to be signaled.
-
filterRow
Description copied from class:Filter
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
.- Specified by:
filterRow
in classFilter
- 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.
-
getNextCellHint
Description copied from class:Filter
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
.- Specified by:
getNextCellHint
in classFilter
- 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.
-
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. Concrete implementers can signal a failure condition in their code by throwing anIOException
.- Specified by:
filterRowKey
in classFilter
- 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).
- 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
.- Specified by:
filterRowKey
in classFilter
- Parameters:
cell
- 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.
-
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:
-
transformCell
Description copied from class:Filter
Give the filter a chance to transform the passed KeyValue. If the Cell is changed a new Cell object must be returned.- Specified by:
transformCell
in classFilter
- Parameters:
v
- 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:
-
hasFilterRow
Description copied from class:Filter
Primarily used to check for conflicts with scans(such as scans that do not read a full row at a time).- Specified by:
hasFilterRow
in classFilter
- Returns:
- True if this filter actively uses filterRowCells(List) or filterRow().
-
filterRowCells
Description copied from class:Filter
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
.- Specified by:
filterRowCells
in classFilter
- Parameters:
kvs
- the list of Cells to be filtered- Throws:
IOException
- in case an I/O or an filter specific failure needs to be signaled.
-
filterRowCellsWithRet
- Throws:
IOException
-
isFamilyEssential
Description copied from class:Filter
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
.- Specified by:
isFamilyEssential
in classFilter
- Throws:
IOException
- in case an I/O or an filter specific failure needs to be signaled.
-
areSerializedFieldsEqual
Description copied from class:Filter
Concrete implementers can signal a failure condition in their code by throwing anIOException
.- Specified by:
areSerializedFieldsEqual
in classFilter
- Parameters:
o
- the other filter to compare with- 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.
-