You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-commits@hadoop.apache.org by cu...@apache.org on 2006/02/07 19:59:28 UTC
svn commit: r375662 - in /lucene/hadoop/trunk/src/java: ./
org/apache/hadoop/conf/ org/apache/hadoop/dfs/ org/apache/hadoop/fs/
org/apache/hadoop/mapred/ org/apache/hadoop/mapred/demo/
org/apache/hadoop/util/
Author: cutting
Date: Tue Feb 7 10:59:06 2006
New Revision: 375662
URL: http://svn.apache.org/viewcvs?rev=375662&view=rev
Log:
Improved javadoc, starting overview and package documentation. Also moved DF from dfs to fs package.
Added:
lucene/hadoop/trunk/src/java/org/apache/hadoop/conf/package.html
lucene/hadoop/trunk/src/java/org/apache/hadoop/dfs/package.html
lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/DF.java
- copied, changed from r375351, lucene/hadoop/trunk/src/java/org/apache/hadoop/dfs/DF.java
lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/package.html
lucene/hadoop/trunk/src/java/org/apache/hadoop/mapred/demo/package.html
lucene/hadoop/trunk/src/java/org/apache/hadoop/util/package.html
lucene/hadoop/trunk/src/java/overview.html
Removed:
lucene/hadoop/trunk/src/java/org/apache/hadoop/dfs/DF.java
Modified:
lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/FileSystem.java
lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/LocalFileSystem.java
lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/Seekable.java
lucene/hadoop/trunk/src/java/org/apache/hadoop/mapred/TaskUmbilicalProtocol.java
lucene/hadoop/trunk/src/java/org/apache/hadoop/mapred/package.html
Added: lucene/hadoop/trunk/src/java/org/apache/hadoop/conf/package.html
URL: http://svn.apache.org/viewcvs/lucene/hadoop/trunk/src/java/org/apache/hadoop/conf/package.html?rev=375662&view=auto
==============================================================================
--- lucene/hadoop/trunk/src/java/org/apache/hadoop/conf/package.html (added)
+++ lucene/hadoop/trunk/src/java/org/apache/hadoop/conf/package.html Tue Feb 7 10:59:06 2006
@@ -0,0 +1,5 @@
+<html>
+<body>
+Configuration of system parameters.
+</body>
+</html>
Added: lucene/hadoop/trunk/src/java/org/apache/hadoop/dfs/package.html
URL: http://svn.apache.org/viewcvs/lucene/hadoop/trunk/src/java/org/apache/hadoop/dfs/package.html?rev=375662&view=auto
==============================================================================
--- lucene/hadoop/trunk/src/java/org/apache/hadoop/dfs/package.html (added)
+++ lucene/hadoop/trunk/src/java/org/apache/hadoop/dfs/package.html Tue Feb 7 10:59:06 2006
@@ -0,0 +1,9 @@
+<html>
+<body>
+
+<p>A distributed implementation of {@link
+org.apache.hadoop.fs.FileSystem}. This is loosely modelled after
+Google's <a href="http://labs.google.com/papers/gfs.html">GFS</a>.</p>
+
+</body>
+</html>
Copied: lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/DF.java (from r375351, lucene/hadoop/trunk/src/java/org/apache/hadoop/dfs/DF.java)
URL: http://svn.apache.org/viewcvs/lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/DF.java?p2=lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/DF.java&p1=lucene/hadoop/trunk/src/java/org/apache/hadoop/dfs/DF.java&r1=375351&r2=375662&rev=375662&view=diff
==============================================================================
--- lucene/hadoop/trunk/src/java/org/apache/hadoop/dfs/DF.java (original)
+++ lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/DF.java Tue Feb 7 10:59:06 2006
@@ -13,7 +13,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-package org.apache.hadoop.dfs;
+package org.apache.hadoop.fs;
import java.io.IOException;
import java.io.InputStreamReader;
Modified: lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/FileSystem.java
URL: http://svn.apache.org/viewcvs/lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/FileSystem.java?rev=375662&r1=375661&r2=375662&view=diff
==============================================================================
--- lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/FileSystem.java (original)
+++ lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/FileSystem.java Tue Feb 7 10:59:06 2006
@@ -88,7 +88,7 @@
protected Configuration conf;
/** Returns a name for this filesystem, suitable to pass to {@link
- * FileSystem#getNamed(String).*/
+ * FileSystem#getNamed(String,Configuration)}.*/
public abstract String getName();
/** Returns a named filesystem. Names are either the string "local" or a
@@ -142,8 +142,6 @@
/**
* Opens an FSDataInputStream at the indicated File.
* @param f the file name to open
- * @param overwrite if a file with this name already exists, then if true,
- * the file will be overwritten, and if false an error will be thrown.
* @param bufferSize the size of the buffer to be used.
*/
public FSDataInputStream open(File f, int bufferSize) throws IOException {
@@ -152,10 +150,7 @@
/**
* Opens an FSDataInputStream at the indicated File.
- * @param f the file name to open
- * @param overwrite if a file with this name already exists, then if true,
- * the file will be overwritten, and if false an error will be thrown.
- * @param bufferSize the size of the buffer to be used.
+ * @param f the file to open
*/
public FSDataInputStream open(File f) throws IOException {
return new FSDataInputStream(this, f, conf);
Modified: lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/LocalFileSystem.java
URL: http://svn.apache.org/viewcvs/lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/LocalFileSystem.java?rev=375662&r1=375661&r2=375662&view=diff
==============================================================================
--- lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/LocalFileSystem.java (original)
+++ lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/LocalFileSystem.java Tue Feb 7 10:59:06 2006
@@ -20,9 +20,7 @@
import java.util.*;
import java.nio.channels.*;
-import org.apache.hadoop.dfs.DFSFile;
-import org.apache.hadoop.dfs.DF;
-import org.apache.hadoop.dfs.DFSFileInfo;
+import org.apache.hadoop.fs.DF;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.io.UTF8;
@@ -211,25 +209,7 @@
/**
*/
public File[] listFilesRaw(File f) throws IOException {
- File[] files = f.listFiles();
- if (files == null) return null;
- // 20041022, xing, Watch out here:
- // currently DFSFile.java does not support those methods
- // public boolean canRead()
- // public boolean canWrite()
- // public boolean createNewFile()
- // public boolean delete()
- // public void deleteOnExit()
- // public boolean isHidden()
- // so you can not rely on returned list for these operations.
- DFSFile[] nfiles = new DFSFile[files.length];
- for (int i = 0; i < files.length; i++) {
- long len = files[i].length();
- UTF8 name = new UTF8(files[i].toString());
- DFSFileInfo info = new DFSFileInfo(name, len, len, files[i].isDirectory());
- nfiles[i] = new DFSFile(info);
- }
- return nfiles;
+ return f.listFiles();
}
/**
Modified: lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/Seekable.java
URL: http://svn.apache.org/viewcvs/lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/Seekable.java?rev=375662&r1=375661&r2=375662&view=diff
==============================================================================
--- lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/Seekable.java (original)
+++ lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/Seekable.java Tue Feb 7 10:59:06 2006
@@ -17,7 +17,7 @@
import java.io.*;
-/* Stream which permits seeking. */
+/** Stream that permits seeking. */
public interface Seekable {
/**
* Seek to the given offset from the start of the file.
Added: lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/package.html
URL: http://svn.apache.org/viewcvs/lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/package.html?rev=375662&view=auto
==============================================================================
--- lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/package.html (added)
+++ lucene/hadoop/trunk/src/java/org/apache/hadoop/fs/package.html Tue Feb 7 10:59:06 2006
@@ -0,0 +1,5 @@
+<html>
+<body>
+An abstract file system API.
+</body>
+</html>
Modified: lucene/hadoop/trunk/src/java/org/apache/hadoop/mapred/TaskUmbilicalProtocol.java
URL: http://svn.apache.org/viewcvs/lucene/hadoop/trunk/src/java/org/apache/hadoop/mapred/TaskUmbilicalProtocol.java?rev=375662&r1=375661&r2=375662&view=diff
==============================================================================
--- lucene/hadoop/trunk/src/java/org/apache/hadoop/mapred/TaskUmbilicalProtocol.java (original)
+++ lucene/hadoop/trunk/src/java/org/apache/hadoop/mapred/TaskUmbilicalProtocol.java Tue Feb 7 10:59:06 2006
@@ -37,7 +37,8 @@
/** Report error messages back to parent. Calls should be sparing, since all
* such messages are held in the job tracker.
- * @param trace, the stack trace text
+ * @param taskid the id of the task involved
+ * @param trace the text to report
*/
void reportDiagnosticInfo(String taskid, String trace) throws IOException;
Added: lucene/hadoop/trunk/src/java/org/apache/hadoop/mapred/demo/package.html
URL: http://svn.apache.org/viewcvs/lucene/hadoop/trunk/src/java/org/apache/hadoop/mapred/demo/package.html?rev=375662&view=auto
==============================================================================
--- lucene/hadoop/trunk/src/java/org/apache/hadoop/mapred/demo/package.html (added)
+++ lucene/hadoop/trunk/src/java/org/apache/hadoop/mapred/demo/package.html Tue Feb 7 10:59:06 2006
@@ -0,0 +1,5 @@
+<html>
+<body>
+MapReduce examples.
+</body>
+</html>
Modified: lucene/hadoop/trunk/src/java/org/apache/hadoop/mapred/package.html
URL: http://svn.apache.org/viewcvs/lucene/hadoop/trunk/src/java/org/apache/hadoop/mapred/package.html?rev=375662&r1=375661&r2=375662&view=diff
==============================================================================
--- lucene/hadoop/trunk/src/java/org/apache/hadoop/mapred/package.html (original)
+++ lucene/hadoop/trunk/src/java/org/apache/hadoop/mapred/package.html Tue Feb 7 10:59:06 2006
@@ -4,10 +4,10 @@
<p>A system for scalable, fault-tolerant, distributed computation over
large data collections.</p>
-<p>Applications implement {@link org.apache.nutch.mapReduce.Mapper} and
-{@link org.apache.nutch.mapReduce.Reducer} interfaces. These are submitted
-as a {@link org.apache.nutch.mapred.JobConf} and are applied to data
-stored in a {@link org.apache.nutch.fs.NutchFileSystem}.</p>
+<p>Applications implement {@link org.apache.hadoop.mapred.Mapper} and
+{@link org.apache.hadoop.mapred.Reducer} interfaces. These are submitted
+as a {@link org.apache.hadoop.mapred.JobConf} and are applied to data
+stored in a {@link org.apache.hadoop.fs.FileSystem}.</p>
<p>See <a href="http://labs.google.com/papers/mapreduce.html">Google's
original Map/Reduce paper</a> for background information.</p>
Added: lucene/hadoop/trunk/src/java/org/apache/hadoop/util/package.html
URL: http://svn.apache.org/viewcvs/lucene/hadoop/trunk/src/java/org/apache/hadoop/util/package.html?rev=375662&view=auto
==============================================================================
--- lucene/hadoop/trunk/src/java/org/apache/hadoop/util/package.html (added)
+++ lucene/hadoop/trunk/src/java/org/apache/hadoop/util/package.html Tue Feb 7 10:59:06 2006
@@ -0,0 +1,5 @@
+<html>
+<body>
+Common utilities.
+</body>
+</html>
Added: lucene/hadoop/trunk/src/java/overview.html
URL: http://svn.apache.org/viewcvs/lucene/hadoop/trunk/src/java/overview.html?rev=375662&view=auto
==============================================================================
--- lucene/hadoop/trunk/src/java/overview.html (added)
+++ lucene/hadoop/trunk/src/java/overview.html Tue Feb 7 10:59:06 2006
@@ -0,0 +1,16 @@
+<html>
+<head>
+ <title>Hadoop</title>
+</head>
+<body>
+
+Hadoop is a distributed computing platform. It primarily consists of
+a distributed filesystem (in <a
+href="org/apache/hadoop/dfs/package-summary.html">org.apache.hadoop.dfs</a>)
+and an implementation of a MapReduce distributed data processor (in <a
+href="org/apache/hadoop/mapred/package-summary.html">org.apache.hadoop.mapred</a>)
+
+<p>
+</body>
+</html>
+