You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hawq.apache.org by od...@apache.org on 2016/05/03 02:33:22 UTC
[06/13] incubator-hawq git commit: HAWQ-683. Support for aggregate
javadoc
HAWQ-683. Support for aggregate javadoc
Project: http://git-wip-us.apache.org/repos/asf/incubator-hawq/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-hawq/commit/f89fa9ca
Tree: http://git-wip-us.apache.org/repos/asf/incubator-hawq/tree/f89fa9ca
Diff: http://git-wip-us.apache.org/repos/asf/incubator-hawq/diff/f89fa9ca
Branch: refs/heads/HAWQ-703
Commit: f89fa9ca3c7b24afd519b14462d7cc40380fcc4c
Parents: e74109b
Author: Shivram Mani <sh...@gmail.com>
Authored: Fri Apr 22 16:12:40 2016 -0700
Committer: Shivram Mani <sh...@gmail.com>
Committed: Fri Apr 22 16:12:40 2016 -0700
----------------------------------------------------------------------
pxf/Makefile | 5 ++++-
pxf/build.gradle | 5 +++++
.../org/apache/hawq/pxf/api/package-info.java | 23 ++++++++++++++++++++
.../hawq/pxf/api/utilities/Utilities.java | 11 +++++-----
.../hawq/pxf/plugins/hbase/package-info.java | 23 ++++++++++++++++++++
.../hawq/pxf/plugins/hdfs/AvroResolver.java | 4 ++--
.../hawq/pxf/plugins/hdfs/package-info.java | 23 ++++++++++++++++++++
.../hawq/pxf/plugins/hive/package-info.java | 23 ++++++++++++++++++++
.../pxf/service/MetadataResponseFormatter.java | 1 +
.../apache/hawq/pxf/service/package-info.java | 23 ++++++++++++++++++++
.../pxf/service/utilities/ProtocolData.java | 2 +-
11 files changed, 134 insertions(+), 9 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-hawq/blob/f89fa9ca/pxf/Makefile
----------------------------------------------------------------------
diff --git a/pxf/Makefile b/pxf/Makefile
index 9f71478..7669772 100644
--- a/pxf/Makefile
+++ b/pxf/Makefile
@@ -39,6 +39,7 @@ help:
@echo " - - VENDOR=<vendor name> - add vendor name to created RPMs"
@echo " - tomcat - builds tomcat rpm from downloaded tarball"
@echo " - - LICENSE and VENDOR parameters can be used as well"
+ @echo " - doc - creates aggregate javadoc under docs"
all:
./gradlew clean release $(BUILD_PARAMS)
@@ -58,7 +59,9 @@ rpm:
clean:
./gradlew clean
+doc:
+ ./gradlew aggregateJavadoc
+
.PHONY: tomcat
tomcat:
./gradlew tomcatRpm $(BUILD_PARAMS)
-
http://git-wip-us.apache.org/repos/asf/incubator-hawq/blob/f89fa9ca/pxf/build.gradle
----------------------------------------------------------------------
diff --git a/pxf/build.gradle b/pxf/build.gradle
index ed7b9f0..3f3d31c 100644
--- a/pxf/build.gradle
+++ b/pxf/build.gradle
@@ -37,6 +37,7 @@ buildscript {
dependencies {
classpath "com.netflix.nebula:gradle-ospackage-plugin:2.2.6"
classpath "de.undercouch:gradle-download-task:2.1.0"
+ classpath 'com.netflix.nebula:gradle-aggregate-javadocs-plugin:2.2.+'
}
}
@@ -465,3 +466,7 @@ task tomcatRpm(type: Rpm) {
}
tomcatRpm.dependsOn tomcatGet
+
+
+buildDir = '.'
+apply plugin: 'nebula-aggregate-javadocs'
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-hawq/blob/f89fa9ca/pxf/pxf-api/src/main/java/org/apache/hawq/pxf/api/package-info.java
----------------------------------------------------------------------
diff --git a/pxf/pxf-api/src/main/java/org/apache/hawq/pxf/api/package-info.java b/pxf/pxf-api/src/main/java/org/apache/hawq/pxf/api/package-info.java
new file mode 100644
index 0000000..a8dbad3
--- /dev/null
+++ b/pxf/pxf-api/src/main/java/org/apache/hawq/pxf/api/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * Provides PXF base classes and interfaces for all the PXF plugins.
+ */
+package org.apache.hawq.pxf.api;
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-hawq/blob/f89fa9ca/pxf/pxf-api/src/main/java/org/apache/hawq/pxf/api/utilities/Utilities.java
----------------------------------------------------------------------
diff --git a/pxf/pxf-api/src/main/java/org/apache/hawq/pxf/api/utilities/Utilities.java b/pxf/pxf-api/src/main/java/org/apache/hawq/pxf/api/utilities/Utilities.java
index 314583c..51326bc 100644
--- a/pxf/pxf-api/src/main/java/org/apache/hawq/pxf/api/utilities/Utilities.java
+++ b/pxf/pxf-api/src/main/java/org/apache/hawq/pxf/api/utilities/Utilities.java
@@ -19,13 +19,13 @@ package org.apache.hawq.pxf.api.utilities;
* under the License.
*/
-import java.lang.reflect.Constructor;
-import java.lang.reflect.InvocationTargetException;
-
import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
+import java.lang.reflect.Constructor;
+import java.lang.reflect.InvocationTargetException;
+
/**
* Utilities class exposes helper method for PXF classes
*/
@@ -53,8 +53,9 @@ public class Utilities {
try {
cls = Class.forName(className);
} catch (ClassNotFoundException e) {
- // in case the class name uses the old "com.pivotal.pxf" package
- // name, recommend using the new package "org.apache.hawq.pxf".
+ /* In case the class name uses the older and unsupported "com.pivotal.pxf"
+ * package name, recommend using the new package "org.apache.hawq.pxf"
+ */
if (className.startsWith("com.pivotal.pxf")) {
throw new Exception(
"Class "
http://git-wip-us.apache.org/repos/asf/incubator-hawq/blob/f89fa9ca/pxf/pxf-hbase/src/main/java/org/apache/hawq/pxf/plugins/hbase/package-info.java
----------------------------------------------------------------------
diff --git a/pxf/pxf-hbase/src/main/java/org/apache/hawq/pxf/plugins/hbase/package-info.java b/pxf/pxf-hbase/src/main/java/org/apache/hawq/pxf/plugins/hbase/package-info.java
new file mode 100644
index 0000000..93412f7
--- /dev/null
+++ b/pxf/pxf-hbase/src/main/java/org/apache/hawq/pxf/plugins/hbase/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * Provides PXF HBase Plugin.
+ */
+package org.apache.hawq.pxf.plugins.hbase;
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-hawq/blob/f89fa9ca/pxf/pxf-hdfs/src/main/java/org/apache/hawq/pxf/plugins/hdfs/AvroResolver.java
----------------------------------------------------------------------
diff --git a/pxf/pxf-hdfs/src/main/java/org/apache/hawq/pxf/plugins/hdfs/AvroResolver.java b/pxf/pxf-hdfs/src/main/java/org/apache/hawq/pxf/plugins/hdfs/AvroResolver.java
index 00ef830..9a6a1c9 100644
--- a/pxf/pxf-hdfs/src/main/java/org/apache/hawq/pxf/plugins/hdfs/AvroResolver.java
+++ b/pxf/pxf-hdfs/src/main/java/org/apache/hawq/pxf/plugins/hdfs/AvroResolver.java
@@ -151,8 +151,8 @@ public class AvroResolver extends Plugin implements ReadResolver {
/**
* The record can arrive from one out of two different sources: a sequence
* file or an AVRO file. If it comes from an AVRO file, then it was already
- * obtained as a {@link GenericRecord} when when it was fetched from the
- * file with the {@link AvroRecorReader} so in this case a cast is enough.
+ * obtained as a {@link GenericRecord} when it was fetched from the
+ * file so in this case a cast is enough.
* On the other hand, if the source is a sequence file, then the input
* parameter obj hides a bytes [] buffer which is in fact one Avro record
* serialized. Here, we build the Avro record from the flat buffer, using
http://git-wip-us.apache.org/repos/asf/incubator-hawq/blob/f89fa9ca/pxf/pxf-hdfs/src/main/java/org/apache/hawq/pxf/plugins/hdfs/package-info.java
----------------------------------------------------------------------
diff --git a/pxf/pxf-hdfs/src/main/java/org/apache/hawq/pxf/plugins/hdfs/package-info.java b/pxf/pxf-hdfs/src/main/java/org/apache/hawq/pxf/plugins/hdfs/package-info.java
new file mode 100644
index 0000000..00d0c46
--- /dev/null
+++ b/pxf/pxf-hdfs/src/main/java/org/apache/hawq/pxf/plugins/hdfs/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * Provides PXF HDFS Plugin.
+ */
+package org.apache.hawq.pxf.plugins.hdfs;
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-hawq/blob/f89fa9ca/pxf/pxf-hive/src/main/java/org/apache/hawq/pxf/plugins/hive/package-info.java
----------------------------------------------------------------------
diff --git a/pxf/pxf-hive/src/main/java/org/apache/hawq/pxf/plugins/hive/package-info.java b/pxf/pxf-hive/src/main/java/org/apache/hawq/pxf/plugins/hive/package-info.java
new file mode 100644
index 0000000..e2540d3
--- /dev/null
+++ b/pxf/pxf-hive/src/main/java/org/apache/hawq/pxf/plugins/hive/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * Provides PXF Hive Plugin.
+ */
+package org.apache.hawq.pxf.plugins.hive;
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-hawq/blob/f89fa9ca/pxf/pxf-service/src/main/java/org/apache/hawq/pxf/service/MetadataResponseFormatter.java
----------------------------------------------------------------------
diff --git a/pxf/pxf-service/src/main/java/org/apache/hawq/pxf/service/MetadataResponseFormatter.java b/pxf/pxf-service/src/main/java/org/apache/hawq/pxf/service/MetadataResponseFormatter.java
index 92d11de..55a6da5 100644
--- a/pxf/pxf-service/src/main/java/org/apache/hawq/pxf/service/MetadataResponseFormatter.java
+++ b/pxf/pxf-service/src/main/java/org/apache/hawq/pxf/service/MetadataResponseFormatter.java
@@ -42,6 +42,7 @@ public class MetadataResponseFormatter {
* Converts list of {@link Metadata} to JSON String format.
*
* @param metadataList list of metadata objects to convert
+ * @param path path string
* @return JSON formatted response
* @throws IOException if converting the data to JSON fails
*/
http://git-wip-us.apache.org/repos/asf/incubator-hawq/blob/f89fa9ca/pxf/pxf-service/src/main/java/org/apache/hawq/pxf/service/package-info.java
----------------------------------------------------------------------
diff --git a/pxf/pxf-service/src/main/java/org/apache/hawq/pxf/service/package-info.java b/pxf/pxf-service/src/main/java/org/apache/hawq/pxf/service/package-info.java
new file mode 100644
index 0000000..7084f86
--- /dev/null
+++ b/pxf/pxf-service/src/main/java/org/apache/hawq/pxf/service/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * Provides PXF Rest API resources.
+ */
+package org.apache.hawq.pxf.service;
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-hawq/blob/f89fa9ca/pxf/pxf-service/src/main/java/org/apache/hawq/pxf/service/utilities/ProtocolData.java
----------------------------------------------------------------------
diff --git a/pxf/pxf-service/src/main/java/org/apache/hawq/pxf/service/utilities/ProtocolData.java b/pxf/pxf-service/src/main/java/org/apache/hawq/pxf/service/utilities/ProtocolData.java
index ec258fa..0337937 100644
--- a/pxf/pxf-service/src/main/java/org/apache/hawq/pxf/service/utilities/ProtocolData.java
+++ b/pxf/pxf-service/src/main/java/org/apache/hawq/pxf/service/utilities/ProtocolData.java
@@ -154,7 +154,7 @@ public class ProtocolData extends InputData {
* Constructs a ProtocolData. Parses X-GP-* configuration variables.
*
* @param paramsMap contains all query-specific parameters from Hawq
- * @param profile contains the profile name
+ * @param profileString contains the profile name
*/
public ProtocolData(Map<String, String> paramsMap, String profileString) {
requestParametersMap = paramsMap;