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

["Misty Stanley-Jones (JIRA)" <ji...@apache.org>]

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

Misty Stanley-Jones commented on HBASE-6142:
--------------------------------------------

[~jrottinghuis] Are you still interested in helping out with this? I have a feeling it would be good to have an exhaustive chapter about filters in general. I'm still too new to HBase to be able to figure out how all the filters work easily. Did you take any notes about which filters filter out versus filter in?

> 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.94.1, 0.95.2
>            Reporter: Joep Rottinghuis
>            Assignee: Misty Stanley-Jones
>            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 was sent by Atlassian JIRA
(v6.2#6252)