[HBASE-6142] Javadoc in some Filters ambiguous

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Won't Fix
• Affects Version/s: 0.92.2, 0.94.1, 0.95.2
• Component/s: documentation
• Labels: beginner
• Tags: beginner
• Assignee: Unassigned
• Reporter: Joep Rottinghuis
• Created: 31/May/12 19:16
• Updated: 13/Jun/22 16:37
• Resolved: 22/Dec/14 02:21

Description

The javadoc on some of the filter is somewhat confusing.
The main Filter interface has methods that behave like a sieve; when filterRowKey returns true, that means that the row is filtered out (not included).

Many of the Filter implementations work the other way around. When the condition is met the value passes (ie, the row is returned).

Most Filters make it clear when a values passes (passing through the filter meaning the values are returned from the scan).
Some are less clear in light of how the Filter interface works: WhileMatchFilter and SingleColumnValueFilter are examples.