You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hive.apache.org by se...@apache.org on 2015/10/08 21:49:34 UTC

[2/2] hive git commit: HIVE-12066 : Add javadoc for methods added to public APIs (Sergey Shelukhin)

HIVE-12066 : Add javadoc for methods added to public APIs (Sergey Shelukhin)


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

Branch: refs/heads/llap
Commit: cf76e6b5d89dfa2d44b96c852a10ccd0252a4fe8
Parents: ca99b0c
Author: Sergey Shelukhin <se...@apache.org>
Authored: Thu Oct 8 12:52:04 2015 -0700
Committer: Sergey Shelukhin <se...@apache.org>
Committed: Thu Oct 8 12:52:04 2015 -0700

----------------------------------------------------------------------
 .../apache/hadoop/hive/ql/io/orc/Reader.java    | 27 ++++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/hive/blob/cf76e6b5/ql/src/java/org/apache/hadoop/hive/ql/io/orc/Reader.java
----------------------------------------------------------------------
diff --git a/ql/src/java/org/apache/hadoop/hive/ql/io/orc/Reader.java b/ql/src/java/org/apache/hadoop/hive/ql/io/orc/Reader.java
index 251e1f8..cf81782 100644
--- a/ql/src/java/org/apache/hadoop/hive/ql/io/orc/Reader.java
+++ b/ql/src/java/org/apache/hadoop/hive/ql/io/orc/Reader.java
@@ -22,7 +22,6 @@ import java.io.IOException;
 import java.nio.ByteBuffer;
 import java.util.List;
 
-import org.apache.hadoop.hive.ql.io.orc.OrcProto.Footer;
 import org.apache.hadoop.hive.ql.io.sarg.SearchArgument;
 import org.apache.hadoop.hive.serde2.objectinspector.ObjectInspector;
 
@@ -351,20 +350,44 @@ public interface Reader {
                     boolean[] include, SearchArgument sarg,
                     String[] neededColumns) throws IOException;
 
+  /**
+   * @return Metadata reader used to read file metadata.
+   */
   MetadataReader metadata() throws IOException;
 
+  /**
+   * @return List of integers representing version of the file, in order from major to minor.
+   */
   List<Integer> getVersionList();
 
+  /**
+   * @return Gets the size of metadata, in bytes.
+   */
   int getMetadataSize();
 
+  /**
+   * @return Stripe statistics, in original protobuf form.
+   */
   List<OrcProto.StripeStatistics> getOrcProtoStripeStatistics();
 
+  /**
+   * @return Stripe statistics.
+   */
   List<StripeStatistics> getStripeStatistics();
 
+  /**
+   * @return File statistics, in original protobuf form.
+   */
   List<OrcProto.ColumnStatistics> getOrcProtoFileStatistics();
 
+  /**
+   * @param useZeroCopy Whether zero-copy read should be used.
+   * @return The default data reader that ORC is using to read bytes from disk.
+   */
   DataReader createDefaultDataReader(boolean useZeroCopy);
 
-  /** Gets serialized file metadata read from disk for the purposes of caching, etc. */
+  /**
+   * @return Serialized file metadata read from disk for the purposes of caching, etc.
+   */
   ByteBuffer getSerializedFileFooter();
 }