hbase-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jean-Daniel Cryans (JIRA)" <j...@apache.org>
Subject [jira] Commented: (HBASE-1688) Improve javadocs in Result and KeyValue
Date Thu, 23 Jul 2009 11:25:14 GMT

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

Jean-Daniel Cryans commented on HBASE-1688:

I would switch those two parts in Result because the first part talks abort the internals
of the class but the client will probably only care for the convenience methods. +1 for the
doc in KV.

+ * A Result is backed by an array of {@link KeyValue} objects, each representing
+ * an HBase cell defined by the row, family, qualifier, timestamp, and value.<p>
+ * 
+ * The underlying {@link KeyValue} objects can be accessed through the methods
+ * {@link #sorted()} and {@link #list()}.  Each KeyValue can then be accessed
+ * through {@link KeyValue#getRow()}, {@link KeyValue#getFamily()}, {@link KeyValue#getQualifier()},

+ * {@link KeyValue#getTimestamp()}, and {@link KeyValue#getValue()}.


+ * Additional convenience methods are available that return various {@link Map}
+ * structures and values directly.<p>
+ * 
+ * To get a complete mapping of all cells in the Result, which can include 
+ * multiple families and multiple versions, use {@link #getMap()}.<p>
+ * 
+ * To get a mapping of each family to its columns (qualifiers and values), 
+ * including only the latest version of each, use {@link #getNoVersionMap()}.
+ * 
+ * To get a mapping of qualifiers to latest values for an individual family use 
+ * {@link #getFamilyMap(byte[])}.<p>
+ * 
+ * To get the latest value for a specific family and qualifier use {@link #getValue(byte[],

> Improve javadocs in Result and KeyValue
> ---------------------------------------
>                 Key: HBASE-1688
>                 URL: https://issues.apache.org/jira/browse/HBASE-1688
>             Project: Hadoop HBase
>          Issue Type: Improvement
>          Components: client
>    Affects Versions: 0.20.0
>            Reporter: Jonathan Gray
>            Assignee: Jonathan Gray
>             Fix For: 0.20.0
>         Attachments: HBASE-1688-v1.patch
> Result has almost no class comment even though it is one of the most user-facing classes,
and is confusing because of exposure to KeyValue as well as all the nasty looking Maps.
> KeyValue is also documented with a purely server-side focus.  Should add some documentation
in the class comment and around those methods that will typically be used client-side.

This message is automatically generated by JIRA.
You can reply to this email to add a comment to the issue online.

View raw message