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/11/29 01:05:22 UTC
svn commit: r480294 - in /lucene/hadoop/trunk: CHANGES.txt
src/java/org/apache/hadoop/io/GenericWritable.java
Author: cutting
Date: Tue Nov 28 16:05:20 2006
New Revision: 480294
URL: http://svn.apache.org/viewvc?view=rev&rev=480294
Log:
HADOOP-689. Add GenericWritable, to facilitate polymorphism in MapReduce, SequenceFile, etc. Contributed by Feng Jiang.
Added:
lucene/hadoop/trunk/src/java/org/apache/hadoop/io/GenericWritable.java
Modified:
lucene/hadoop/trunk/CHANGES.txt
Modified: lucene/hadoop/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/lucene/hadoop/trunk/CHANGES.txt?view=diff&rev=480294&r1=480293&r2=480294
==============================================================================
--- lucene/hadoop/trunk/CHANGES.txt (original)
+++ lucene/hadoop/trunk/CHANGES.txt Tue Nov 28 16:05:20 2006
@@ -137,6 +137,9 @@
40. HADOOP-698. Fix HDFS client not to retry the same datanode on
read failures. (Milind Bhandarkar via cutting)
+41. HADOOP-689. Add GenericWritable, to facilitate polymorphism in
+ MapReduce, SequenceFile, etc. (Feng Jiang via cutting)
+
Release 0.8.0 - 2006-11-03
Added: lucene/hadoop/trunk/src/java/org/apache/hadoop/io/GenericWritable.java
URL: http://svn.apache.org/viewvc/lucene/hadoop/trunk/src/java/org/apache/hadoop/io/GenericWritable.java?view=auto&rev=480294
==============================================================================
--- lucene/hadoop/trunk/src/java/org/apache/hadoop/io/GenericWritable.java (added)
+++ lucene/hadoop/trunk/src/java/org/apache/hadoop/io/GenericWritable.java Tue Nov 28 16:05:20 2006
@@ -0,0 +1,109 @@
+package org.apache.hadoop.io;
+
+import java.io.DataInput;
+import java.io.DataOutput;
+import java.io.IOException;
+
+/**
+ * A wrapper for Writable instances.
+ * <p>
+ * When two sequence files, which have same Key type but different Value
+ * types, are mapped out to reduce, multiple Value types is not allowed.
+ * In this case, this class can help you wrap instances with different types.
+ * </p>
+ *
+ * <p>
+ * Compared with <code>ObjectWritable</code>, this class is much more effective,
+ * because <code>ObjectWritable</code> will append the class declaration as a String
+ * into the output file in every Key-Value pair.
+ * </p>
+ *
+ * how to use it: <br>
+ * 1. Write your own class, such as GenericObject, which extends GenericWritable.<br>
+ * 2. Implements the abstract method <code>getTypes()</code>, defines
+ * the classes which will be wrapped in GenericObject in application.
+ * Attention: this classes defined in <code>getTypes()</code> method, must
+ * implement <code>Writable</code> interface.
+ * <br><br>
+ *
+ * The code looks like this:
+ * <blockquote><pre>
+ * public class GenericObject extends GenericWritable {
+ *
+ * private static Class[] CLASSES = {
+ * ClassType1.class,
+ * ClassType2.class,
+ * ClassType3.class,
+ * };
+ *
+ * protected Class[] getTypes() {
+ * return CLASSES;
+ * }
+ *
+ * }
+ * </pre></blockquote>
+ *
+ * @author Feng Jiang (Feng.a.Jiang@gmail.com)
+ * @since Nov 8, 2006
+ */
+public abstract class GenericWritable implements Writable {
+
+ private static final byte NOT_SET = -1;
+
+ private byte type = NOT_SET;
+
+ private Writable instance;
+
+ /**
+ * Set the instance that is wrapped.
+ *
+ * @param obj
+ */
+ public void set(Writable obj) {
+ instance = obj;
+ Class[] clazzes = getTypes();
+ for (int i = 0; i < clazzes.length; i++) {
+ Class clazz = clazzes[i];
+ if (clazz.isInstance(instance)) {
+ type = (byte) i;
+ return;
+ }
+ }
+ throw new RuntimeException("The type of instance is: "
+ + instance.getClass() + ", which is NOT registered.");
+ }
+
+ /**
+ * Return the wrapped instance.
+ */
+ public Writable get() {
+ return instance;
+ }
+
+ public void readFields(DataInput in) throws IOException {
+ type = in.readByte();
+ Class clazz = getTypes()[type];
+ try {
+ instance = (Writable) clazz.newInstance();
+ } catch (Exception e) {
+ e.printStackTrace();
+ throw new IOException("Cannot initialize the class: " + clazz);
+ }
+ instance.readFields(in);
+ }
+
+ public void write(DataOutput out) throws IOException {
+ if (type == NOT_SET || instance == null)
+ throw new IOException("The GenericWritable has NOT been set correctly. type="
+ + type + ", instance=" + instance);
+ out.writeByte(type);
+ instance.write(out);
+ }
+
+ /**
+ * Return all classes that may be wrapped. Subclasses should implement this
+ * to return a constant array of classes.
+ */
+ abstract protected Class[] getTypes();
+
+}