[jira] [Commented] (HBASE-6142) Javadoc in some Filters ambiguous

["Joep Rottinghuis (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/HBASE-6142?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13287862#comment-13287862 ] 

Joep Rottinghuis commented on HBASE-6142:
-----------------------------------------

Ah, I will look up my (signed) copy of said book, write test and take a shot at the javadoc.
Cannot promise any angel qualities though...
                
> Javadoc in some Filters ambiguous
> ---------------------------------
>
>                 Key: HBASE-6142
>                 URL: https://issues.apache.org/jira/browse/HBASE-6142
>             Project: HBase
>          Issue Type: Bug
>          Components: documentation
>    Affects Versions: 0.92.2, 0.96.0, 0.94.1
>            Reporter: Joep Rottinghuis
>            Priority: Minor
>              Labels: noob
>
> 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.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira