You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@hbase.apache.org by "nkeywal (JIRA)" <ji...@apache.org> on 2011/07/12 13:11:59 UTC

[jira] [Created] (HBASE-4086) documentation/javadoc error in SingleColumnValueFilter constructor

documentation/javadoc error in SingleColumnValueFilter constructor
------------------------------------------------------------------

                 Key: HBASE-4086
                 URL: https://issues.apache.org/jira/browse/HBASE-4086
             Project: HBase
          Issue Type: Bug
          Components: documentation
    Affects Versions: 0.90.3
         Environment: all
            Reporter: nkeywal
            Priority: Trivial


The behaviour when the column is not found is documented differently in the constructor and in the setter. The constructor is actually wrong: by default, when the column is not found, the row is emitted (may be the opposite would be better, but it's another question)

SingleColumnValueFilter
public SingleColumnValueFilter(byte[] family,
                               byte[] qualifier,
                               CompareFilter.CompareOp compareOp,
                               byte[] value)

Constructor for binary compare of the value of a single column. If the column is found and the condition passes, all columns of the row will be emitted. If the column is not found or the condition fails, the row will not be emitted.


setFilterIfMissing
public void setFilterIfMissing(boolean filterIfMissing)
Set whether entire row should be filtered if column is not found.
If true, the entire row will be skipped if the column is not found.
If false, the row will pass if the column is not found. This is default. 



Possible correction for the constructor documentation:
If the column is found and the condition passes, all columns of the row will be emitted. If the condition fails, the row will not be emitted. The behavior when the column is not found is defined by setFilterIfMissing.


--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (HBASE-4086) documentation/javadoc error in SingleColumnValueFilter constructor

Posted by "Doug Meil (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HBASE-4086?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13078785#comment-13078785 ] 

Doug Meil commented on HBASE-4086:
----------------------------------

I wound up just making both overloaded constructors match in terms of Javadoc.  One of them was missing the comment about setFilterIsMissing.

> documentation/javadoc error in SingleColumnValueFilter constructor
> ------------------------------------------------------------------
>
>                 Key: HBASE-4086
>                 URL: https://issues.apache.org/jira/browse/HBASE-4086
>             Project: HBase
>          Issue Type: Bug
>          Components: documentation
>    Affects Versions: 0.90.3
>         Environment: all
>            Reporter: nkeywal
>            Assignee: Doug Meil
>            Priority: Trivial
>         Attachments: SingleColumnValueFilter_HBASE_4086.java.patch
>
>
> The behaviour when the column is not found is documented differently in the constructor and in the setter. The constructor is actually wrong: by default, when the column is not found, the row is emitted (may be the opposite would be better, but it's another question)
> SingleColumnValueFilter
> public SingleColumnValueFilter(byte[] family,
>                                byte[] qualifier,
>                                CompareFilter.CompareOp compareOp,
>                                byte[] value)
> Constructor for binary compare of the value of a single column. If the column is found and the condition passes, all columns of the row will be emitted. If the column is not found or the condition fails, the row will not be emitted.
> setFilterIfMissing
> public void setFilterIfMissing(boolean filterIfMissing)
> Set whether entire row should be filtered if column is not found.
> If true, the entire row will be skipped if the column is not found.
> If false, the row will pass if the column is not found. This is default. 
> Possible correction for the constructor documentation:
> If the column is found and the condition passes, all columns of the row will be emitted. If the condition fails, the row will not be emitted. The behavior when the column is not found is defined by setFilterIfMissing.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Updated] (HBASE-4086) documentation/javadoc error in SingleColumnValueFilter constructor

Posted by "Doug Meil (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HBASE-4086?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Doug Meil updated HBASE-4086:
-----------------------------

    Resolution: Fixed
        Status: Resolved  (was: Patch Available)

> documentation/javadoc error in SingleColumnValueFilter constructor
> ------------------------------------------------------------------
>
>                 Key: HBASE-4086
>                 URL: https://issues.apache.org/jira/browse/HBASE-4086
>             Project: HBase
>          Issue Type: Bug
>          Components: documentation
>    Affects Versions: 0.90.3
>         Environment: all
>            Reporter: nkeywal
>            Assignee: Doug Meil
>            Priority: Trivial
>         Attachments: SingleColumnValueFilter_HBASE_4086.java.patch
>
>
> The behaviour when the column is not found is documented differently in the constructor and in the setter. The constructor is actually wrong: by default, when the column is not found, the row is emitted (may be the opposite would be better, but it's another question)
> SingleColumnValueFilter
> public SingleColumnValueFilter(byte[] family,
>                                byte[] qualifier,
>                                CompareFilter.CompareOp compareOp,
>                                byte[] value)
> Constructor for binary compare of the value of a single column. If the column is found and the condition passes, all columns of the row will be emitted. If the column is not found or the condition fails, the row will not be emitted.
> setFilterIfMissing
> public void setFilterIfMissing(boolean filterIfMissing)
> Set whether entire row should be filtered if column is not found.
> If true, the entire row will be skipped if the column is not found.
> If false, the row will pass if the column is not found. This is default. 
> Possible correction for the constructor documentation:
> If the column is found and the condition passes, all columns of the row will be emitted. If the condition fails, the row will not be emitted. The behavior when the column is not found is defined by setFilterIfMissing.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Assigned] (HBASE-4086) documentation/javadoc error in SingleColumnValueFilter constructor

Posted by "stack (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HBASE-4086?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

stack reassigned HBASE-4086:
----------------------------

    Assignee: Doug Meil

You want to have a go at this one Doug?  If not, assign back to me.  Good on you.

> documentation/javadoc error in SingleColumnValueFilter constructor
> ------------------------------------------------------------------
>
>                 Key: HBASE-4086
>                 URL: https://issues.apache.org/jira/browse/HBASE-4086
>             Project: HBase
>          Issue Type: Bug
>          Components: documentation
>    Affects Versions: 0.90.3
>         Environment: all
>            Reporter: nkeywal
>            Assignee: Doug Meil
>            Priority: Trivial
>
> The behaviour when the column is not found is documented differently in the constructor and in the setter. The constructor is actually wrong: by default, when the column is not found, the row is emitted (may be the opposite would be better, but it's another question)
> SingleColumnValueFilter
> public SingleColumnValueFilter(byte[] family,
>                                byte[] qualifier,
>                                CompareFilter.CompareOp compareOp,
>                                byte[] value)
> Constructor for binary compare of the value of a single column. If the column is found and the condition passes, all columns of the row will be emitted. If the column is not found or the condition fails, the row will not be emitted.
> setFilterIfMissing
> public void setFilterIfMissing(boolean filterIfMissing)
> Set whether entire row should be filtered if column is not found.
> If true, the entire row will be skipped if the column is not found.
> If false, the row will pass if the column is not found. This is default. 
> Possible correction for the constructor documentation:
> If the column is found and the condition passes, all columns of the row will be emitted. If the condition fails, the row will not be emitted. The behavior when the column is not found is defined by setFilterIfMissing.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (HBASE-4086) documentation/javadoc error in SingleColumnValueFilter constructor

Posted by "Hudson (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HBASE-4086?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13078814#comment-13078814 ] 

Hudson commented on HBASE-4086:
-------------------------------

Integrated in HBase-TRUNK #2074 (See [https://builds.apache.org/job/HBase-TRUNK/2074/])
    HBASE-4086 - make constructors match each other in terms of Javadoc

dmeil : 
Files : 
* /hbase/trunk/src/main/java/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.java


> documentation/javadoc error in SingleColumnValueFilter constructor
> ------------------------------------------------------------------
>
>                 Key: HBASE-4086
>                 URL: https://issues.apache.org/jira/browse/HBASE-4086
>             Project: HBase
>          Issue Type: Bug
>          Components: documentation
>    Affects Versions: 0.90.3
>         Environment: all
>            Reporter: nkeywal
>            Assignee: Doug Meil
>            Priority: Trivial
>         Attachments: SingleColumnValueFilter_HBASE_4086.java.patch
>
>
> The behaviour when the column is not found is documented differently in the constructor and in the setter. The constructor is actually wrong: by default, when the column is not found, the row is emitted (may be the opposite would be better, but it's another question)
> SingleColumnValueFilter
> public SingleColumnValueFilter(byte[] family,
>                                byte[] qualifier,
>                                CompareFilter.CompareOp compareOp,
>                                byte[] value)
> Constructor for binary compare of the value of a single column. If the column is found and the condition passes, all columns of the row will be emitted. If the column is not found or the condition fails, the row will not be emitted.
> setFilterIfMissing
> public void setFilterIfMissing(boolean filterIfMissing)
> Set whether entire row should be filtered if column is not found.
> If true, the entire row will be skipped if the column is not found.
> If false, the row will pass if the column is not found. This is default. 
> Possible correction for the constructor documentation:
> If the column is found and the condition passes, all columns of the row will be emitted. If the condition fails, the row will not be emitted. The behavior when the column is not found is defined by setFilterIfMissing.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Updated] (HBASE-4086) documentation/javadoc error in SingleColumnValueFilter constructor

Posted by "Doug Meil (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HBASE-4086?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Doug Meil updated HBASE-4086:
-----------------------------

    Attachment: SingleColumnValueFilter_HBASE_4086.java.patch

> documentation/javadoc error in SingleColumnValueFilter constructor
> ------------------------------------------------------------------
>
>                 Key: HBASE-4086
>                 URL: https://issues.apache.org/jira/browse/HBASE-4086
>             Project: HBase
>          Issue Type: Bug
>          Components: documentation
>    Affects Versions: 0.90.3
>         Environment: all
>            Reporter: nkeywal
>            Assignee: Doug Meil
>            Priority: Trivial
>         Attachments: SingleColumnValueFilter_HBASE_4086.java.patch
>
>
> The behaviour when the column is not found is documented differently in the constructor and in the setter. The constructor is actually wrong: by default, when the column is not found, the row is emitted (may be the opposite would be better, but it's another question)
> SingleColumnValueFilter
> public SingleColumnValueFilter(byte[] family,
>                                byte[] qualifier,
>                                CompareFilter.CompareOp compareOp,
>                                byte[] value)
> Constructor for binary compare of the value of a single column. If the column is found and the condition passes, all columns of the row will be emitted. If the column is not found or the condition fails, the row will not be emitted.
> setFilterIfMissing
> public void setFilterIfMissing(boolean filterIfMissing)
> Set whether entire row should be filtered if column is not found.
> If true, the entire row will be skipped if the column is not found.
> If false, the row will pass if the column is not found. This is default. 
> Possible correction for the constructor documentation:
> If the column is found and the condition passes, all columns of the row will be emitted. If the condition fails, the row will not be emitted. The behavior when the column is not found is defined by setFilterIfMissing.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (HBASE-4086) documentation/javadoc error in SingleColumnValueFilter constructor

Posted by "Doug Meil (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HBASE-4086?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13078786#comment-13078786 ] 

Doug Meil commented on HBASE-4086:
----------------------------------

Integrated to TRUNK

> documentation/javadoc error in SingleColumnValueFilter constructor
> ------------------------------------------------------------------
>
>                 Key: HBASE-4086
>                 URL: https://issues.apache.org/jira/browse/HBASE-4086
>             Project: HBase
>          Issue Type: Bug
>          Components: documentation
>    Affects Versions: 0.90.3
>         Environment: all
>            Reporter: nkeywal
>            Assignee: Doug Meil
>            Priority: Trivial
>         Attachments: SingleColumnValueFilter_HBASE_4086.java.patch
>
>
> The behaviour when the column is not found is documented differently in the constructor and in the setter. The constructor is actually wrong: by default, when the column is not found, the row is emitted (may be the opposite would be better, but it's another question)
> SingleColumnValueFilter
> public SingleColumnValueFilter(byte[] family,
>                                byte[] qualifier,
>                                CompareFilter.CompareOp compareOp,
>                                byte[] value)
> Constructor for binary compare of the value of a single column. If the column is found and the condition passes, all columns of the row will be emitted. If the column is not found or the condition fails, the row will not be emitted.
> setFilterIfMissing
> public void setFilterIfMissing(boolean filterIfMissing)
> Set whether entire row should be filtered if column is not found.
> If true, the entire row will be skipped if the column is not found.
> If false, the row will pass if the column is not found. This is default. 
> Possible correction for the constructor documentation:
> If the column is found and the condition passes, all columns of the row will be emitted. If the condition fails, the row will not be emitted. The behavior when the column is not found is defined by setFilterIfMissing.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (HBASE-4086) documentation/javadoc error in SingleColumnValueFilter constructor

Posted by "Doug Meil (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HBASE-4086?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13063946#comment-13063946 ] 

Doug Meil commented on HBASE-4086:
----------------------------------

I'll take a crack at it.

> documentation/javadoc error in SingleColumnValueFilter constructor
> ------------------------------------------------------------------
>
>                 Key: HBASE-4086
>                 URL: https://issues.apache.org/jira/browse/HBASE-4086
>             Project: HBase
>          Issue Type: Bug
>          Components: documentation
>    Affects Versions: 0.90.3
>         Environment: all
>            Reporter: nkeywal
>            Assignee: Doug Meil
>            Priority: Trivial
>
> The behaviour when the column is not found is documented differently in the constructor and in the setter. The constructor is actually wrong: by default, when the column is not found, the row is emitted (may be the opposite would be better, but it's another question)
> SingleColumnValueFilter
> public SingleColumnValueFilter(byte[] family,
>                                byte[] qualifier,
>                                CompareFilter.CompareOp compareOp,
>                                byte[] value)
> Constructor for binary compare of the value of a single column. If the column is found and the condition passes, all columns of the row will be emitted. If the column is not found or the condition fails, the row will not be emitted.
> setFilterIfMissing
> public void setFilterIfMissing(boolean filterIfMissing)
> Set whether entire row should be filtered if column is not found.
> If true, the entire row will be skipped if the column is not found.
> If false, the row will pass if the column is not found. This is default. 
> Possible correction for the constructor documentation:
> If the column is found and the condition passes, all columns of the row will be emitted. If the condition fails, the row will not be emitted. The behavior when the column is not found is defined by setFilterIfMissing.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Updated] (HBASE-4086) documentation/javadoc error in SingleColumnValueFilter constructor

Posted by "Doug Meil (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HBASE-4086?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Doug Meil updated HBASE-4086:
-----------------------------

    Status: Patch Available  (was: Open)

> documentation/javadoc error in SingleColumnValueFilter constructor
> ------------------------------------------------------------------
>
>                 Key: HBASE-4086
>                 URL: https://issues.apache.org/jira/browse/HBASE-4086
>             Project: HBase
>          Issue Type: Bug
>          Components: documentation
>    Affects Versions: 0.90.3
>         Environment: all
>            Reporter: nkeywal
>            Assignee: Doug Meil
>            Priority: Trivial
>         Attachments: SingleColumnValueFilter_HBASE_4086.java.patch
>
>
> The behaviour when the column is not found is documented differently in the constructor and in the setter. The constructor is actually wrong: by default, when the column is not found, the row is emitted (may be the opposite would be better, but it's another question)
> SingleColumnValueFilter
> public SingleColumnValueFilter(byte[] family,
>                                byte[] qualifier,
>                                CompareFilter.CompareOp compareOp,
>                                byte[] value)
> Constructor for binary compare of the value of a single column. If the column is found and the condition passes, all columns of the row will be emitted. If the column is not found or the condition fails, the row will not be emitted.
> setFilterIfMissing
> public void setFilterIfMissing(boolean filterIfMissing)
> Set whether entire row should be filtered if column is not found.
> If true, the entire row will be skipped if the column is not found.
> If false, the row will pass if the column is not found. This is default. 
> Possible correction for the constructor documentation:
> If the column is found and the condition passes, all columns of the row will be emitted. If the condition fails, the row will not be emitted. The behavior when the column is not found is defined by setFilterIfMissing.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira