gora-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lewi...@apache.org
Subject [13/17] gora git commit: adding java docs to AVRO data beans
Date Fri, 05 Aug 2016 10:41:36 GMT
adding java docs to AVRO data beans


Project: http://git-wip-us.apache.org/repos/asf/gora/repo
Commit: http://git-wip-us.apache.org/repos/asf/gora/commit/44bf7101
Tree: http://git-wip-us.apache.org/repos/asf/gora/tree/44bf7101
Diff: http://git-wip-us.apache.org/repos/asf/gora/diff/44bf7101

Branch: refs/heads/master
Commit: 44bf7101e44dd6690cf7165bd314511092ca86cd
Parents: 351eb63
Author: Kevin Ratnasekera <djkevincr@yahoo.com>
Authored: Fri Aug 5 14:22:43 2016 +0530
Committer: Kevin Ratnasekera <djkevincr@yahoo.com>
Committed: Fri Aug 5 14:22:43 2016 +0530

----------------------------------------------------------------------
 .../org/apache/gora/compiler/GoraCompiler.java  |  5 ++++
 .../apache/gora/compiler/templates/record.vm    | 31 ++++++++++++--------
 .../gora/examples/generated/Employee.java       | 26 +++++++++++-----
 .../examples/generated/ImmutableFields.java     | 26 +++++++++++-----
 .../gora/examples/generated/Metadata.java       | 26 +++++++++++-----
 .../gora/examples/generated/TokenDatum.java     | 26 +++++++++++-----
 .../org/apache/gora/examples/generated/V2.java  | 26 +++++++++++-----
 .../apache/gora/examples/generated/WebPage.java | 26 +++++++++++-----
 .../gora/persistency/impl/PersistentBase.java   | 28 ++++++++++++++++++
 .../apache/gora/goraci/generated/CINode.java    | 26 +++++++++++-----
 .../apache/gora/goraci/generated/Flushed.java   | 26 +++++++++++-----
 .../tutorial/log/generated/MetricDatum.java     | 26 +++++++++++-----
 .../gora/tutorial/log/generated/Pageview.java   | 26 +++++++++++-----
 13 files changed, 231 insertions(+), 93 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/gora/blob/44bf7101/gora-compiler/src/main/java/org/apache/gora/compiler/GoraCompiler.java
----------------------------------------------------------------------
diff --git a/gora-compiler/src/main/java/org/apache/gora/compiler/GoraCompiler.java b/gora-compiler/src/main/java/org/apache/gora/compiler/GoraCompiler.java
index 6716e3c..6e8707c 100644
--- a/gora-compiler/src/main/java/org/apache/gora/compiler/GoraCompiler.java
+++ b/gora-compiler/src/main/java/org/apache/gora/compiler/GoraCompiler.java
@@ -274,6 +274,11 @@ public class GoraCompiler extends SpecificCompiler {
     return newSchema;
   }
 
+  /**
+   * Utility method by velocity templates to generate serialVersionUID on AVRO beans.
+   *
+   * @param schema Data bean AVRO schema.
+   */
   public static long fingerprint64(Schema schema) {
     return SchemaNormalization.parsingFingerprint64(schema);
   }

http://git-wip-us.apache.org/repos/asf/gora/blob/44bf7101/gora-compiler/src/main/velocity/org/apache/gora/compiler/templates/record.vm
----------------------------------------------------------------------
diff --git a/gora-compiler/src/main/velocity/org/apache/gora/compiler/templates/record.vm
b/gora-compiler/src/main/velocity/org/apache/gora/compiler/templates/record.vm
index aa1844d..30d5e3d 100644
--- a/gora-compiler/src/main/velocity/org/apache/gora/compiler/templates/record.vm
+++ b/gora-compiler/src/main/velocity/org/apache/gora/compiler/templates/record.vm
@@ -354,31 +354,36 @@ public class ${this.mangle($schema.getName())}#if ($schema.isError())
extends or
   
   }
 
-  private static final org.apache.avro.io.DatumWriter
-          DATUM_WRITER$ = new org.apache.avro.specific.SpecificDatumWriter(SCHEMA$);
-  private static final org.apache.avro.io.DatumReader
-          DATUM_READER$ = new org.apache.avro.specific.SpecificDatumReader(SCHEMA$);
-
+  /**
+   * Writes AVRO data bean to output stream in the form of AVRO Binary encoding format. This
will transform
+   * AVRO data bean from its Java object form to it s serializable form.
+   *
+   * @param out java.io.ObjectOutput output stream to write data bean in serializable form
+   */
   @Override
   public void writeExternal(java.io.ObjectOutput out)
           throws java.io.IOException {
     out.write(super.getDirtyBytes().array());
-    DATUM_WRITER$.write
-            (this, org.apache.avro.io.EncoderFactory.get()
-                    .directBinaryEncoder((java.io.OutputStream) out,
-                            null));
+    DATUM_WRITER$.write(this, org.apache.avro.io.EncoderFactory.get()
+            .directBinaryEncoder((java.io.OutputStream) out,
+                    null));
   }
 
+  /**
+   * Reads AVRO data bean from input stream in it s AVRO Binary encoding format to Java object
format.
+   * This will transform AVRO data bean from it s serializable form to deserialized Java
object form.
+   *
+   * @param in java.io.ObjectOutput input stream to read data bean in serializable form
+   */
   @Override
   public void readExternal(java.io.ObjectInput in)
           throws java.io.IOException {
     byte[] __g__dirty = new byte[getFieldsCount()];
     in.read(__g__dirty);
     super.setDirtyBytes(java.nio.ByteBuffer.wrap(__g__dirty));
-    DATUM_READER$.read
-            (this, org.apache.avro.io.DecoderFactory.get()
-                    .directBinaryDecoder((java.io.InputStream) in,
-                            null));
+    DATUM_READER$.read(this, org.apache.avro.io.DecoderFactory.get()
+            .directBinaryDecoder((java.io.InputStream) in,
+                    null));
   }
   
 }

http://git-wip-us.apache.org/repos/asf/gora/blob/44bf7101/gora-core/src/examples/java/org/apache/gora/examples/generated/Employee.java
----------------------------------------------------------------------
diff --git a/gora-core/src/examples/java/org/apache/gora/examples/generated/Employee.java
b/gora-core/src/examples/java/org/apache/gora/examples/generated/Employee.java
index 253f7b2..cf3fe97 100644
--- a/gora-core/src/examples/java/org/apache/gora/examples/generated/Employee.java
+++ b/gora-core/src/examples/java/org/apache/gora/examples/generated/Employee.java
@@ -673,26 +673,36 @@ public class Employee extends org.apache.gora.persistency.impl.PersistentBase
im
   private static final org.apache.avro.io.DatumReader
           DATUM_READER$ = new org.apache.avro.specific.SpecificDatumReader(SCHEMA$);
 
+  /**
+   * Writes AVRO data bean to output stream in the form of AVRO Binary encoding format. This
will transform
+   * AVRO data bean from its Java object form to it s serializable form.
+   *
+   * @param out java.io.ObjectOutput output stream to write data bean in serializable form
+   */
   @Override
   public void writeExternal(java.io.ObjectOutput out)
           throws java.io.IOException {
     out.write(super.getDirtyBytes().array());
-    DATUM_WRITER$.write
-            (this, org.apache.avro.io.EncoderFactory.get()
-                    .directBinaryEncoder((java.io.OutputStream) out,
-                            null));
+    DATUM_WRITER$.write(this, org.apache.avro.io.EncoderFactory.get()
+            .directBinaryEncoder((java.io.OutputStream) out,
+                    null));
   }
 
+  /**
+   * Reads AVRO data bean from input stream in it s AVRO Binary encoding format to Java object
format.
+   * This will transform AVRO data bean from it s serializable form to deserialized Java
object form.
+   *
+   * @param in java.io.ObjectOutput input stream to read data bean in serializable form
+   */
   @Override
   public void readExternal(java.io.ObjectInput in)
           throws java.io.IOException {
     byte[] __g__dirty = new byte[getFieldsCount()];
     in.read(__g__dirty);
     super.setDirtyBytes(java.nio.ByteBuffer.wrap(__g__dirty));
-    DATUM_READER$.read
-            (this, org.apache.avro.io.DecoderFactory.get()
-                    .directBinaryDecoder((java.io.InputStream) in,
-                            null));
+    DATUM_READER$.read(this, org.apache.avro.io.DecoderFactory.get()
+            .directBinaryDecoder((java.io.InputStream) in,
+                    null));
   }
   
 }

http://git-wip-us.apache.org/repos/asf/gora/blob/44bf7101/gora-core/src/examples/java/org/apache/gora/examples/generated/ImmutableFields.java
----------------------------------------------------------------------
diff --git a/gora-core/src/examples/java/org/apache/gora/examples/generated/ImmutableFields.java
b/gora-core/src/examples/java/org/apache/gora/examples/generated/ImmutableFields.java
index edb91d0..f885a58 100644
--- a/gora-core/src/examples/java/org/apache/gora/examples/generated/ImmutableFields.java
+++ b/gora-core/src/examples/java/org/apache/gora/examples/generated/ImmutableFields.java
@@ -344,26 +344,36 @@ public class ImmutableFields extends org.apache.gora.persistency.impl.Persistent
   private static final org.apache.avro.io.DatumReader
           DATUM_READER$ = new org.apache.avro.specific.SpecificDatumReader(SCHEMA$);
 
+  /**
+   * Writes AVRO data bean to output stream in the form of AVRO Binary encoding format. This
will transform
+   * AVRO data bean from its Java object form to it s serializable form.
+   *
+   * @param out java.io.ObjectOutput output stream to write data bean in serializable form
+   */
   @Override
   public void writeExternal(java.io.ObjectOutput out)
           throws java.io.IOException {
     out.write(super.getDirtyBytes().array());
-    DATUM_WRITER$.write
-            (this, org.apache.avro.io.EncoderFactory.get()
-                    .directBinaryEncoder((java.io.OutputStream) out,
-                            null));
+    DATUM_WRITER$.write(this, org.apache.avro.io.EncoderFactory.get()
+            .directBinaryEncoder((java.io.OutputStream) out,
+                    null));
   }
 
+  /**
+   * Reads AVRO data bean from input stream in it s AVRO Binary encoding format to Java object
format.
+   * This will transform AVRO data bean from it s serializable form to deserialized Java
object form.
+   *
+   * @param in java.io.ObjectOutput input stream to read data bean in serializable form
+   */
   @Override
   public void readExternal(java.io.ObjectInput in)
           throws java.io.IOException {
     byte[] __g__dirty = new byte[getFieldsCount()];
     in.read(__g__dirty);
     super.setDirtyBytes(java.nio.ByteBuffer.wrap(__g__dirty));
-    DATUM_READER$.read
-            (this, org.apache.avro.io.DecoderFactory.get()
-                    .directBinaryDecoder((java.io.InputStream) in,
-                            null));
+    DATUM_READER$.read(this, org.apache.avro.io.DecoderFactory.get()
+            .directBinaryDecoder((java.io.InputStream) in,
+                    null));
   }
 
 }

http://git-wip-us.apache.org/repos/asf/gora/blob/44bf7101/gora-core/src/examples/java/org/apache/gora/examples/generated/Metadata.java
----------------------------------------------------------------------
diff --git a/gora-core/src/examples/java/org/apache/gora/examples/generated/Metadata.java
b/gora-core/src/examples/java/org/apache/gora/examples/generated/Metadata.java
index 66d1f2c..a603c45 100644
--- a/gora-core/src/examples/java/org/apache/gora/examples/generated/Metadata.java
+++ b/gora-core/src/examples/java/org/apache/gora/examples/generated/Metadata.java
@@ -332,26 +332,36 @@ public class Metadata extends org.apache.gora.persistency.impl.PersistentBase
im
   private static final org.apache.avro.io.DatumReader
           DATUM_READER$ = new org.apache.avro.specific.SpecificDatumReader(SCHEMA$);
 
+  /**
+   * Writes AVRO data bean to output stream in the form of AVRO Binary encoding format. This
will transform
+   * AVRO data bean from its Java object form to it s serializable form.
+   *
+   * @param out java.io.ObjectOutput output stream to write data bean in serializable form
+   */
   @Override
   public void writeExternal(java.io.ObjectOutput out)
           throws java.io.IOException {
     out.write(super.getDirtyBytes().array());
-    DATUM_WRITER$.write
-            (this, org.apache.avro.io.EncoderFactory.get()
-                    .directBinaryEncoder((java.io.OutputStream) out,
-                            null));
+    DATUM_WRITER$.write(this, org.apache.avro.io.EncoderFactory.get()
+            .directBinaryEncoder((java.io.OutputStream) out,
+                    null));
   }
 
+  /**
+   * Reads AVRO data bean from input stream in it s AVRO Binary encoding format to Java object
format.
+   * This will transform AVRO data bean from it s serializable form to deserialized Java
object form.
+   *
+   * @param in java.io.ObjectOutput input stream to read data bean in serializable form
+   */
   @Override
   public void readExternal(java.io.ObjectInput in)
           throws java.io.IOException {
     byte[] __g__dirty = new byte[getFieldsCount()];
     in.read(__g__dirty);
     super.setDirtyBytes(java.nio.ByteBuffer.wrap(__g__dirty));
-    DATUM_READER$.read
-            (this, org.apache.avro.io.DecoderFactory.get()
-                    .directBinaryDecoder((java.io.InputStream) in,
-                            null));
+    DATUM_READER$.read(this, org.apache.avro.io.DecoderFactory.get()
+            .directBinaryDecoder((java.io.InputStream) in,
+                    null));
   }
 
 }

http://git-wip-us.apache.org/repos/asf/gora/blob/44bf7101/gora-core/src/examples/java/org/apache/gora/examples/generated/TokenDatum.java
----------------------------------------------------------------------
diff --git a/gora-core/src/examples/java/org/apache/gora/examples/generated/TokenDatum.java
b/gora-core/src/examples/java/org/apache/gora/examples/generated/TokenDatum.java
index 391c912..7b09d13 100644
--- a/gora-core/src/examples/java/org/apache/gora/examples/generated/TokenDatum.java
+++ b/gora-core/src/examples/java/org/apache/gora/examples/generated/TokenDatum.java
@@ -260,26 +260,36 @@ public class TokenDatum extends org.apache.gora.persistency.impl.PersistentBase
   private static final org.apache.avro.io.DatumReader
           DATUM_READER$ = new org.apache.avro.specific.SpecificDatumReader(SCHEMA$);
 
+  /**
+   * Writes AVRO data bean to output stream in the form of AVRO Binary encoding format. This
will transform
+   * AVRO data bean from its Java object form to it s serializable form.
+   *
+   * @param out java.io.ObjectOutput output stream to write data bean in serializable form
+   */
   @Override
   public void writeExternal(java.io.ObjectOutput out)
           throws java.io.IOException {
     out.write(super.getDirtyBytes().array());
-    DATUM_WRITER$.write
-            (this, org.apache.avro.io.EncoderFactory.get()
-                    .directBinaryEncoder((java.io.OutputStream) out,
-                            null));
+    DATUM_WRITER$.write(this, org.apache.avro.io.EncoderFactory.get()
+            .directBinaryEncoder((java.io.OutputStream) out,
+                    null));
   }
 
+  /**
+   * Reads AVRO data bean from input stream in it s AVRO Binary encoding format to Java object
format.
+   * This will transform AVRO data bean from it s serializable form to deserialized Java
object form.
+   *
+   * @param in java.io.ObjectOutput input stream to read data bean in serializable form
+   */
   @Override
   public void readExternal(java.io.ObjectInput in)
           throws java.io.IOException {
     byte[] __g__dirty = new byte[getFieldsCount()];
     in.read(__g__dirty);
     super.setDirtyBytes(java.nio.ByteBuffer.wrap(__g__dirty));
-    DATUM_READER$.read
-            (this, org.apache.avro.io.DecoderFactory.get()
-                    .directBinaryDecoder((java.io.InputStream) in,
-                            null));
+    DATUM_READER$.read(this, org.apache.avro.io.DecoderFactory.get()
+            .directBinaryDecoder((java.io.InputStream) in,
+                    null));
   }
   
 }

http://git-wip-us.apache.org/repos/asf/gora/blob/44bf7101/gora-core/src/examples/java/org/apache/gora/examples/generated/V2.java
----------------------------------------------------------------------
diff --git a/gora-core/src/examples/java/org/apache/gora/examples/generated/V2.java b/gora-core/src/examples/java/org/apache/gora/examples/generated/V2.java
index 2092e1b..64f85f5 100644
--- a/gora-core/src/examples/java/org/apache/gora/examples/generated/V2.java
+++ b/gora-core/src/examples/java/org/apache/gora/examples/generated/V2.java
@@ -260,26 +260,36 @@ public class V2 extends org.apache.gora.persistency.impl.PersistentBase
implemen
   private static final org.apache.avro.io.DatumReader
           DATUM_READER$ = new org.apache.avro.specific.SpecificDatumReader(SCHEMA$);
 
+  /**
+   * Writes AVRO data bean to output stream in the form of AVRO Binary encoding format. This
will transform
+   * AVRO data bean from its Java object form to it s serializable form.
+   *
+   * @param out java.io.ObjectOutput output stream to write data bean in serializable form
+   */
   @Override
   public void writeExternal(java.io.ObjectOutput out)
           throws java.io.IOException {
     out.write(super.getDirtyBytes().array());
-    DATUM_WRITER$.write
-            (this, org.apache.avro.io.EncoderFactory.get()
-                    .directBinaryEncoder((java.io.OutputStream) out,
-                            null));
+    DATUM_WRITER$.write(this, org.apache.avro.io.EncoderFactory.get()
+            .directBinaryEncoder((java.io.OutputStream) out,
+                    null));
   }
 
+  /**
+   * Reads AVRO data bean from input stream in it s AVRO Binary encoding format to Java object
format.
+   * This will transform AVRO data bean from it s serializable form to deserialized Java
object form.
+   *
+   * @param in java.io.ObjectOutput input stream to read data bean in serializable form
+   */
   @Override
   public void readExternal(java.io.ObjectInput in)
           throws java.io.IOException {
     byte[] __g__dirty = new byte[getFieldsCount()];
     in.read(__g__dirty);
     super.setDirtyBytes(java.nio.ByteBuffer.wrap(__g__dirty));
-    DATUM_READER$.read
-            (this, org.apache.avro.io.DecoderFactory.get()
-                    .directBinaryDecoder((java.io.InputStream) in,
-                            null));
+    DATUM_READER$.read(this, org.apache.avro.io.DecoderFactory.get()
+            .directBinaryDecoder((java.io.InputStream) in,
+                    null));
   }
 
 }

http://git-wip-us.apache.org/repos/asf/gora/blob/44bf7101/gora-core/src/examples/java/org/apache/gora/examples/generated/WebPage.java
----------------------------------------------------------------------
diff --git a/gora-core/src/examples/java/org/apache/gora/examples/generated/WebPage.java b/gora-core/src/examples/java/org/apache/gora/examples/generated/WebPage.java
index 0a7b7ea..a624a3d 100644
--- a/gora-core/src/examples/java/org/apache/gora/examples/generated/WebPage.java
+++ b/gora-core/src/examples/java/org/apache/gora/examples/generated/WebPage.java
@@ -831,26 +831,36 @@ public class WebPage extends org.apache.gora.persistency.impl.PersistentBase
imp
   private static final org.apache.avro.io.DatumReader
           DATUM_READER$ = new org.apache.avro.specific.SpecificDatumReader(SCHEMA$);
 
+  /**
+   * Writes AVRO data bean to output stream in the form of AVRO Binary encoding format. This
will transform
+   * AVRO data bean from its Java object form to it s serializable form.
+   *
+   * @param out java.io.ObjectOutput output stream to write data bean in serializable form
+   */
   @Override
   public void writeExternal(java.io.ObjectOutput out)
           throws java.io.IOException {
     out.write(super.getDirtyBytes().array());
-    DATUM_WRITER$.write
-            (this, org.apache.avro.io.EncoderFactory.get()
-                    .directBinaryEncoder((java.io.OutputStream) out,
-                            null));
+    DATUM_WRITER$.write(this, org.apache.avro.io.EncoderFactory.get()
+            .directBinaryEncoder((java.io.OutputStream) out,
+                    null));
   }
 
+  /**
+   * Reads AVRO data bean from input stream in it s AVRO Binary encoding format to Java object
format.
+   * This will transform AVRO data bean from it s serializable form to deserialized Java
object form.
+   *
+   * @param in java.io.ObjectOutput input stream to read data bean in serializable form
+   */
   @Override
   public void readExternal(java.io.ObjectInput in)
           throws java.io.IOException {
     byte[] __g__dirty = new byte[getFieldsCount()];
     in.read(__g__dirty);
     super.setDirtyBytes(java.nio.ByteBuffer.wrap(__g__dirty));
-    DATUM_READER$.read
-            (this, org.apache.avro.io.DecoderFactory.get()
-                    .directBinaryDecoder((java.io.InputStream) in,
-                            null));
+    DATUM_READER$.read(this, org.apache.avro.io.DecoderFactory.get()
+            .directBinaryDecoder((java.io.InputStream) in,
+                    null));
   }
 
 }

http://git-wip-us.apache.org/repos/asf/gora/blob/44bf7101/gora-core/src/main/java/org/apache/gora/persistency/impl/PersistentBase.java
----------------------------------------------------------------------
diff --git a/gora-core/src/main/java/org/apache/gora/persistency/impl/PersistentBase.java
b/gora-core/src/main/java/org/apache/gora/persistency/impl/PersistentBase.java
index 58128c0..fea153f 100644
--- a/gora-core/src/main/java/org/apache/gora/persistency/impl/PersistentBase.java
+++ b/gora-core/src/main/java/org/apache/gora/persistency/impl/PersistentBase.java
@@ -17,6 +17,8 @@
 */
 package org.apache.gora.persistency.impl;
 
+import java.io.ObjectInput;
+import java.io.ObjectOutput;
 import java.nio.ByteBuffer;
 import java.util.Collection;
 import java.util.List;
@@ -181,10 +183,36 @@ public abstract class PersistentBase extends SpecificRecordBase implements
     setDirty(getSchema().getField(field).pos());
   }
 
+  /**
+   * Exposing dirty bytes over public method. Purpose is to preserve dirty bytes content
+   * while transporting AVRO data beans over TCP wire in serialized form.
+   * Since {@link org.apache.gora.persistency.impl.PersistentBase} implements {@link java.io.Externalizable},
+   * this method can be used to retrieve the dirty bytes as {@link java.nio.ByteBuffer} and
and get the content
+   * as bytes[] and write byte stream to the TCP wire.
+   * See {@link java.io.Externalizable#writeExternal(ObjectOutput)} abstract method implementation
+   * on velocity template record.vm.
+   * <p>
+   * Note {@link java.nio.ByteBuffer} is not itself not in serializable form.
+   */
   public ByteBuffer getDirtyBytes() {
     return __g__dirty;
   }
 
+
+  /**
+   * Setter method for assign dirty bytes when deserializing AVRO bean from dirty bytes
+   * preserved in serialized bytes form.
+   * Since {@link org.apache.gora.persistency.impl.PersistentBase} implements {@link java.io.Externalizable}
+   * and when actual deserialization happens for {@link org.apache.gora.persistency.impl.PersistentBase}
+   * new instance, acquire byte stream from TCP wire, extracting specific byte[] from byte
stream
+   * and create {@link java.nio.ByteBuffer} instance and set using this public method.
+   * See {@link java.io.Externalizable#readExternal(ObjectInput)} abstract method implementation
+   * on velocity template record.vm.
+   * <p>
+   * Note {@link java.io.Externalizable} extending means it is mandatory to have default
public constructor.
+   *
+   * @param __g__dirty dirty bytes
+   */
   public void setDirtyBytes(ByteBuffer __g__dirty) {
     this.__g__dirty = __g__dirty;
   }

http://git-wip-us.apache.org/repos/asf/gora/blob/44bf7101/gora-goraci/src/main/java/org/apache/gora/goraci/generated/CINode.java
----------------------------------------------------------------------
diff --git a/gora-goraci/src/main/java/org/apache/gora/goraci/generated/CINode.java b/gora-goraci/src/main/java/org/apache/gora/goraci/generated/CINode.java
index 0545c34..3dddfd0 100644
--- a/gora-goraci/src/main/java/org/apache/gora/goraci/generated/CINode.java
+++ b/gora-goraci/src/main/java/org/apache/gora/goraci/generated/CINode.java
@@ -408,26 +408,36 @@ public class CINode extends org.apache.gora.persistency.impl.PersistentBase
impl
   private static final org.apache.avro.io.DatumReader
           DATUM_READER$ = new org.apache.avro.specific.SpecificDatumReader(SCHEMA$);
 
+  /**
+   * Writes AVRO data bean to output stream in the form of AVRO Binary encoding format. This
will transform
+   * AVRO data bean from its Java object form to it s serializable form.
+   *
+   * @param out java.io.ObjectOutput output stream to write data bean in serializable form
+   */
   @Override
   public void writeExternal(java.io.ObjectOutput out)
           throws java.io.IOException {
     out.write(super.getDirtyBytes().array());
-    DATUM_WRITER$.write
-            (this, org.apache.avro.io.EncoderFactory.get()
-                    .directBinaryEncoder((java.io.OutputStream) out,
-                            null));
+    DATUM_WRITER$.write(this, org.apache.avro.io.EncoderFactory.get()
+            .directBinaryEncoder((java.io.OutputStream) out,
+                    null));
   }
 
+  /**
+   * Reads AVRO data bean from input stream in it s AVRO Binary encoding format to Java object
format.
+   * This will transform AVRO data bean from it s serializable form to deserialized Java
object form.
+   *
+   * @param in java.io.ObjectOutput input stream to read data bean in serializable form
+   */
   @Override
   public void readExternal(java.io.ObjectInput in)
           throws java.io.IOException {
     byte[] __g__dirty = new byte[getFieldsCount()];
     in.read(__g__dirty);
     super.setDirtyBytes(java.nio.ByteBuffer.wrap(__g__dirty));
-    DATUM_READER$.read
-            (this, org.apache.avro.io.DecoderFactory.get()
-                    .directBinaryDecoder((java.io.InputStream) in,
-                            null));
+    DATUM_READER$.read(this, org.apache.avro.io.DecoderFactory.get()
+            .directBinaryDecoder((java.io.InputStream) in,
+                    null));
   }
   
 }

http://git-wip-us.apache.org/repos/asf/gora/blob/44bf7101/gora-goraci/src/main/java/org/apache/gora/goraci/generated/Flushed.java
----------------------------------------------------------------------
diff --git a/gora-goraci/src/main/java/org/apache/gora/goraci/generated/Flushed.java b/gora-goraci/src/main/java/org/apache/gora/goraci/generated/Flushed.java
index 6f27717..53bfaec 100644
--- a/gora-goraci/src/main/java/org/apache/gora/goraci/generated/Flushed.java
+++ b/gora-goraci/src/main/java/org/apache/gora/goraci/generated/Flushed.java
@@ -247,26 +247,36 @@ public class Flushed extends org.apache.gora.persistency.impl.PersistentBase
imp
   private static final org.apache.avro.io.DatumReader
           DATUM_READER$ = new org.apache.avro.specific.SpecificDatumReader(SCHEMA$);
 
+  /**
+   * Writes AVRO data bean to output stream in the form of AVRO Binary encoding format. This
will transform
+   * AVRO data bean from its Java object form to it s serializable form.
+   *
+   * @param out java.io.ObjectOutput output stream to write data bean in serializable form
+   */
   @Override
   public void writeExternal(java.io.ObjectOutput out)
           throws java.io.IOException {
     out.write(super.getDirtyBytes().array());
-    DATUM_WRITER$.write
-            (this, org.apache.avro.io.EncoderFactory.get()
-                    .directBinaryEncoder((java.io.OutputStream) out,
-                            null));
+    DATUM_WRITER$.write(this, org.apache.avro.io.EncoderFactory.get()
+            .directBinaryEncoder((java.io.OutputStream) out,
+                    null));
   }
 
+  /**
+   * Reads AVRO data bean from input stream in it s AVRO Binary encoding format to Java object
format.
+   * This will transform AVRO data bean from it s serializable form to deserialized Java
object form.
+   *
+   * @param in java.io.ObjectOutput input stream to read data bean in serializable form
+   */
   @Override
   public void readExternal(java.io.ObjectInput in)
           throws java.io.IOException {
     byte[] __g__dirty = new byte[getFieldsCount()];
     in.read(__g__dirty);
     super.setDirtyBytes(java.nio.ByteBuffer.wrap(__g__dirty));
-    DATUM_READER$.read
-            (this, org.apache.avro.io.DecoderFactory.get()
-                    .directBinaryDecoder((java.io.InputStream) in,
-                            null));
+    DATUM_READER$.read(this, org.apache.avro.io.DecoderFactory.get()
+            .directBinaryDecoder((java.io.InputStream) in,
+                    null));
   }
   
 }

http://git-wip-us.apache.org/repos/asf/gora/blob/44bf7101/gora-tutorial/src/main/java/org/apache/gora/tutorial/log/generated/MetricDatum.java
----------------------------------------------------------------------
diff --git a/gora-tutorial/src/main/java/org/apache/gora/tutorial/log/generated/MetricDatum.java
b/gora-tutorial/src/main/java/org/apache/gora/tutorial/log/generated/MetricDatum.java
index df9662d..4b541bc 100644
--- a/gora-tutorial/src/main/java/org/apache/gora/tutorial/log/generated/MetricDatum.java
+++ b/gora-tutorial/src/main/java/org/apache/gora/tutorial/log/generated/MetricDatum.java
@@ -407,26 +407,36 @@ public class MetricDatum extends org.apache.gora.persistency.impl.PersistentBase
   private static final org.apache.avro.io.DatumReader
           DATUM_READER$ = new org.apache.avro.specific.SpecificDatumReader(SCHEMA$);
 
+  /**
+   * Writes AVRO data bean to output stream in the form of AVRO Binary encoding format. This
will transform
+   * AVRO data bean from its Java object form to it s serializable form.
+   *
+   * @param out java.io.ObjectOutput output stream to write data bean in serializable form
+   */
   @Override
   public void writeExternal(java.io.ObjectOutput out)
           throws java.io.IOException {
     out.write(super.getDirtyBytes().array());
-    DATUM_WRITER$.write
-            (this, org.apache.avro.io.EncoderFactory.get()
-                    .directBinaryEncoder((java.io.OutputStream) out,
-                            null));
+    DATUM_WRITER$.write(this, org.apache.avro.io.EncoderFactory.get()
+            .directBinaryEncoder((java.io.OutputStream) out,
+                    null));
   }
 
+  /**
+   * Reads AVRO data bean from input stream in it s AVRO Binary encoding format to Java object
format.
+   * This will transform AVRO data bean from it s serializable form to deserialized Java
object form.
+   *
+   * @param in java.io.ObjectOutput input stream to read data bean in serializable form
+   */
   @Override
   public void readExternal(java.io.ObjectInput in)
           throws java.io.IOException {
     byte[] __g__dirty = new byte[getFieldsCount()];
     in.read(__g__dirty);
     super.setDirtyBytes(java.nio.ByteBuffer.wrap(__g__dirty));
-    DATUM_READER$.read
-            (this, org.apache.avro.io.DecoderFactory.get()
-                    .directBinaryDecoder((java.io.InputStream) in,
-                            null));
+    DATUM_READER$.read(this, org.apache.avro.io.DecoderFactory.get()
+            .directBinaryDecoder((java.io.InputStream) in,
+                    null));
   }
   
 }

http://git-wip-us.apache.org/repos/asf/gora/blob/44bf7101/gora-tutorial/src/main/java/org/apache/gora/tutorial/log/generated/Pageview.java
----------------------------------------------------------------------
diff --git a/gora-tutorial/src/main/java/org/apache/gora/tutorial/log/generated/Pageview.java
b/gora-tutorial/src/main/java/org/apache/gora/tutorial/log/generated/Pageview.java
index 861be2b..048b379 100644
--- a/gora-tutorial/src/main/java/org/apache/gora/tutorial/log/generated/Pageview.java
+++ b/gora-tutorial/src/main/java/org/apache/gora/tutorial/log/generated/Pageview.java
@@ -813,26 +813,36 @@ public class Pageview extends org.apache.gora.persistency.impl.PersistentBase
im
   private static final org.apache.avro.io.DatumReader
           DATUM_READER$ = new org.apache.avro.specific.SpecificDatumReader(SCHEMA$);
 
+  /**
+   * Writes AVRO data bean to output stream in the form of AVRO Binary encoding format. This
will transform
+   * AVRO data bean from its Java object form to it s serializable form.
+   *
+   * @param out java.io.ObjectOutput output stream to write data bean in serializable form
+   */
   @Override
   public void writeExternal(java.io.ObjectOutput out)
           throws java.io.IOException {
     out.write(super.getDirtyBytes().array());
-    DATUM_WRITER$.write
-            (this, org.apache.avro.io.EncoderFactory.get()
-                    .directBinaryEncoder((java.io.OutputStream) out,
-                            null));
+    DATUM_WRITER$.write(this, org.apache.avro.io.EncoderFactory.get()
+            .directBinaryEncoder((java.io.OutputStream) out,
+                    null));
   }
 
+  /**
+   * Reads AVRO data bean from input stream in it s AVRO Binary encoding format to Java object
format.
+   * This will transform AVRO data bean from it s serializable form to deserialized Java
object form.
+   *
+   * @param in java.io.ObjectOutput input stream to read data bean in serializable form
+   */
   @Override
   public void readExternal(java.io.ObjectInput in)
           throws java.io.IOException {
     byte[] __g__dirty = new byte[getFieldsCount()];
     in.read(__g__dirty);
     super.setDirtyBytes(java.nio.ByteBuffer.wrap(__g__dirty));
-    DATUM_READER$.read
-            (this, org.apache.avro.io.DecoderFactory.get()
-                    .directBinaryDecoder((java.io.InputStream) in,
-                            null));
+    DATUM_READER$.read(this, org.apache.avro.io.DecoderFactory.get()
+            .directBinaryDecoder((java.io.InputStream) in,
+                    null));
   }
 
 }


Mime
View raw message