Apache
/
hbase
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

HADOOP-1402 Fix javadoc warnings in hbase contrib. (Michael Stack) 

git-svn-id: https://svn.apache.org/repos/asf/lucene/hadoop/trunk/src/contrib/hbase@540271 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Jim Kellerman 2007-05-21 20:35:19 +00:00
parent 7402e1b4fe
commit ba1ef8c0c3
5 changed files with 32 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES.txt
View File

@ -4,3 +4,4 @@ HBase Change Log
Trunk (unreleased changes)
1. HADOOP-1384. HBase omnibus patch. (jimk, Vuk Ercegovac, and Michael Stack)
2. HADOOP-1402. Fix javadoc warnings in hbase contrib. (Michael Stack)

2
src/java/org/apache/hadoop/hbase/HLog.java
View File

@ -357,7 +357,7 @@ public class HLog implements HConstants {
* and complete of a cache-flush. Otherwise the log-seq-id for
* the flush will not appear in the correct logfile.
* @return sequence ID to pass {@link #completeCacheFlush(Text, Text, long)}
* @see {@link #completeCacheFlush(Text, Text, long)}
* @see #completeCacheFlush(Text, Text, long)
*/
public synchronized long startCacheFlush() {
while (insideCacheFlush) {

3
src/java/org/apache/hadoop/hbase/HRegionInterface.java
View File

@ -64,7 +64,6 @@ public interface HRegionInterface extends VersionedProtocol {
/**
* Opens a remote scanner.
*
* @param clientId - client identifier (so we can associate a scanner with a client)
* @param regionName - name of region to scan
* @param columns - columns to scan
* @param startRow - starting row to scan
@ -79,8 +78,6 @@ public interface HRegionInterface extends VersionedProtocol {
*
* @param scannerId - clientId passed to openScanner
* @param key - the next HStoreKey
* @param columns - an array of column names
* @param values - an array of byte[] values (corresponds 1-1 with columns)
* @return - true if a value was retrieved
* @throws IOException
*/

12
src/java/org/apache/hadoop/hbase/HStoreKey.java
View File

@ -93,8 +93,8 @@ public class HStoreKey implements WritableComparable {
/**
* @param other Key to compare against. Compares row and column.
* @return True if same row and column.
* @see {@link #matchesWithoutColumn(HStoreKey)}
* @see {@link #matchesRowFamily(HStoreKey)}
* @see #matchesWithoutColumn(HStoreKey)
* @see #matchesRowFamily(HStoreKey)
*/
public boolean matchesRowCol(HStoreKey other) {
return this.row.compareTo(other.row) == 0
@ -105,8 +105,8 @@ public class HStoreKey implements WritableComparable {
* @param other Key to copmare against. Compares row and timestamp.
*
* @return True if same row and timestamp is greater than <code>other</code>
* @see {@link #matchesRowCol(HStoreKey)}
* @see {@link #matchesRowFamily(HStoreKey)}
* @see #matchesRowCol(HStoreKey)
* @see #matchesRowFamily(HStoreKey)
*/
public boolean matchesWithoutColumn(HStoreKey other) {
return this.row.compareTo(other.row) == 0
@ -117,8 +117,8 @@ public class HStoreKey implements WritableComparable {
* @param other Key to compare against. Compares row and column family
*
* @return true if same row and column family
* @see {@link #matchesRowCol(HStoreKey)}
* @see {@link #matchesWithoutColumn(HStoreKey)}
* @see #matchesRowCol(HStoreKey)
* @see #matchesWithoutColumn(HStoreKey)
*/
public boolean matchesRowFamily(HStoreKey other) {
boolean status = false;

29
src/java/org/apache/hadoop/hbase/package.html
View File

@ -2,21 +2,38 @@
<html>
<head />
<body bgcolor="white">
Provides HBase, the <a href="http://lucene.apache.org/hadoop">Hadoop</a> simple database.
Provides HBase, the <a href="http://lucene.apache.org/hadoop">Hadoop</a>
simple database.
<h2>Requirements</h2>
<ul>
<li><a href="http://lucene.apache.org/hadoop">Hadoop</a> It has its own set of <a href="http://lucene.apache.org/hadoop/api/overview-summary.html">requirements</a> (Scroll down the page).</li>
<li>Java 1.5.x, preferably from <a href="http://lucene.apache.org/hadoop/api/index.html">Sun</a> Set JAVA_HOME to the root of your Java installation</li>
<li><a href="http://lucene.apache.org/hadoop">Hadoop</a>: Hadoop has its own set of
<a href="http://lucene.apache.org/hadoop/api/overview-summary.html">requirements</a>
(Scroll down the page).</li>
<li>Java 1.5.x, preferably from <a href="http://lucene.apache.org/hadoop/api/index.html">Sun</a>
Set <code>JAVA_HOME</code> to the root of your Java installation</li>
</ul>
<h2>Getting Started</h2>
<p>First, you need a working instance of Hadoop. Download releases at <a href="http://www.apache.org/dyn/closer.cgi/lucene/hadoop/">Hadoop downloads</a>.
Unpack the release and connect to its top-level directory. Edit the file conf/hadoop-env.sh to define at least JAVA_HOME. Try the following command:
<p>First, you need a working instance of Hadoop. Download a recent release from
<a href="http://www.apache.org/dyn/closer.cgi/lucene/hadoop/">Hadoop downloads</a>.
Unpack the release and connect to its top-level directory. Edit the file
<code>conf/hadoop-env.sh</code> to define at least <code>JAVA_HOME</code>. Also,
add site-particular customizations to the file <code>conf/hadoop-site.xml</code>.
Try the following command:
<pre>bin/hadoop
</pre>
This will display the documentation for the Hadoop command script.
</p>
<p>TODO</p>
<p>Next, start hbase servers. Currently each server -- the master server and the
'slave' regionservers -- must be started manually (FIX).
<pre>src/contrib/hbase/bin/hbase master start
src/contrib/hbase/bin/hbase regionserver start
</pre>
</p>
<p>As for hadoop, local customizations can be added to
<code>src/contrib/hbase/conf/hbase-site.xml</code>.
</p>
<h2>Related Documentation</h2>