Author: gates
Date: Mon Sep 15 15:10:46 2008
New Revision: 695659
URL: http://svn.apache.org/viewvc?rev=695659&view=rev
Log:
Fixing documentation issues.
Modified:
incubator/pig/branches/types/src/org/apache/pig/backend/hadoop/executionengine/mapReduceLayer/PigOutputFormat.java
incubator/pig/branches/types/src/org/apache/pig/backend/hadoop/executionengine/physicalLayer/package.html
incubator/pig/branches/types/src/org/apache/pig/backend/hadoop/executionengine/physicalLayer/relationalOperators/POPostCombinerPackage.java
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LODistinct.java
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOFilter.java
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOForEach.java
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOLimit.java
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOStream.java
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOUnion.java
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOVisitor.java
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/schema/Schema.java
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/DefaultInputHandler.java
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/DefaultOutputHandler.java
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/ExecutableManager.java
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/FileInputHandler.java
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/FileOutputHandler.java
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/StreamingCommand.java
Modified:
incubator/pig/branches/types/src/org/apache/pig/backend/hadoop/executionengine/mapReduceLayer/PigOutputFormat.java
URL:
http://svn.apache.org/viewvc/incubator/pig/branches/types/src/org/apache/pig/backend/hadoop/executionengine/mapReduceLayer/PigOutputFormat.java?rev=695659&r1=695658&r2=695659&view=diff
==============================================================================
---
incubator/pig/branches/types/src/org/apache/pig/backend/hadoop/executionengine/mapReduceLayer/PigOutputFormat.java
(original)
+++
incubator/pig/branches/types/src/org/apache/pig/backend/hadoop/executionengine/mapReduceLayer/PigOutputFormat.java
Mon Sep 15 15:10:46 2008
@@ -109,8 +109,7 @@
* We only care about the values, so we are going to skip the keys when
* we write.
*
- * @see
org.apache.hadoop.mapred.RecordWriter#write(org.apache.hadoop.io.WritableComparable,
- * org.apache.hadoop.io.Writable)
+ * @see org.apache.hadoop.mapred.RecordWriter#write(K, V)
*/
public void write(WritableComparable key, Tuple value)
throws IOException {
Modified:
incubator/pig/branches/types/src/org/apache/pig/backend/hadoop/executionengine/physicalLayer/package.html
URL:
http://svn.apache.org/viewvc/incubator/pig/branches/types/src/org/apache/pig/backend/hadoop/executionengine/physicalLayer/package.html?rev=695659&r1=695658&r2=695659&view=diff
==============================================================================
---
incubator/pig/branches/types/src/org/apache/pig/backend/hadoop/executionengine/physicalLayer/package.html
(original)
+++
incubator/pig/branches/types/src/org/apache/pig/backend/hadoop/executionengine/physicalLayer/package.html
Mon Sep 15 15:10:46 2008
@@ -11,8 +11,8 @@
provided by the [EMAIL PROTECTED] org.apache.pig.impl.plan} package.
<p>
As with [EMAIL PROTECTED] org.apache.pig.impl.logicalLayer}, physical
operators consist
-of [EMAIL PROTECTED] org.apache.pig.impl.physicalLayer.relationalOperators} and
[EMAIL PROTECTED] org.apache.pig.impl.physicalLayer.expressionOperators}. In
many data
+of [EMAIL PROTECTED]
org.apache.pig.backend.hadoop.executionengine.physicalLayer.relationalOperators}
and
[EMAIL PROTECTED]
org.apache.pig.backend.hadoop.executionengine.physicalLayer.expressionOperators}.
In many data
processing systems relational operators and expression operators are modeled
as different entities because they behave differently. Pig blurs, though does
not entirely remove, this distinction because of its support for nested
Modified:
incubator/pig/branches/types/src/org/apache/pig/backend/hadoop/executionengine/physicalLayer/relationalOperators/POPostCombinerPackage.java
URL:
http://svn.apache.org/viewvc/incubator/pig/branches/types/src/org/apache/pig/backend/hadoop/executionengine/physicalLayer/relationalOperators/POPostCombinerPackage.java?rev=695659&r1=695658&r2=695659&view=diff
==============================================================================
---
incubator/pig/branches/types/src/org/apache/pig/backend/hadoop/executionengine/physicalLayer/relationalOperators/POPostCombinerPackage.java
(original)
+++
incubator/pig/branches/types/src/org/apache/pig/backend/hadoop/executionengine/physicalLayer/relationalOperators/POPostCombinerPackage.java
Mon Sep 15 15:10:46 2008
@@ -61,7 +61,8 @@
* A new POPostCombinePackage will be constructed as a near clone of the
* provided POPackage.
* @param pkg POPackage to clone.
- * @param numFields Number of fields in each input tuple
+ * @param bags for each field, indicates whether it should be a bag (true)
+ * or a simple field (false).
*/
public POPostCombinerPackage(POPackage pkg, boolean[] bags) {
super(new OperatorKey(pkg.getOperatorKey().scope,
Modified:
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LODistinct.java
URL:
http://svn.apache.org/viewvc/incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LODistinct.java?rev=695659&r1=695658&r2=695659&view=diff
==============================================================================
---
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LODistinct.java
(original)
+++
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LODistinct.java
Mon Sep 15 15:10:46 2008
@@ -42,8 +42,6 @@
* Logical plan this operator is a part of.
* @param k
* Operator key to assign to this node.
- * @param input
- * input over which distinct will be applied
*/
public LODistinct(LogicalPlan plan, OperatorKey k) {
Modified:
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOFilter.java
URL:
http://svn.apache.org/viewvc/incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOFilter.java?rev=695659&r1=695658&r2=695659&view=diff
==============================================================================
---
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOFilter.java
(original)
+++
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOFilter.java
Mon Sep 15 15:10:46 2008
@@ -43,8 +43,6 @@
* Operator key to assign to this node.
* @param comparisonPlan
* the filter condition
- * @param input
- * the input that needs filtering
*/
public LOFilter(LogicalPlan plan, OperatorKey k,
Modified:
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOForEach.java
URL:
http://svn.apache.org/viewvc/incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOForEach.java?rev=695659&r1=695658&r2=695659&view=diff
==============================================================================
---
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOForEach.java
(original)
+++
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOForEach.java
Mon Sep 15 15:10:46 2008
@@ -56,8 +56,11 @@
* Logical plan this operator is a part of.
* @param k
* Operator key to assign to this node.
- * @param foreachPlan
- * the list of operators that are applied for each input
+ * @param foreachPlans
+ * the list of plans that are applied for each input
+ * @param flattenList
+ * boolean list that tells which elements of the foreach
+ * projection should be flattened.
*/
public LOForEach(LogicalPlan plan, OperatorKey k,
Modified:
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOLimit.java
URL:
http://svn.apache.org/viewvc/incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOLimit.java?rev=695659&r1=695658&r2=695659&view=diff
==============================================================================
---
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOLimit.java
(original)
+++
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOLimit.java
Mon Sep 15 15:10:46 2008
@@ -18,8 +18,6 @@
* Operator key to assign to this node.
* @param limit
* Number of limited outputs
- * @param input
- * the input that needs to limit
*/
public LOLimit(LogicalPlan plan, OperatorKey k, long limit) {
Modified:
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOStream.java
URL:
http://svn.apache.org/viewvc/incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOStream.java?rev=695659&r1=695658&r2=695659&view=diff
==============================================================================
---
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOStream.java
(original)
+++
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOStream.java
Mon Sep 15 15:10:46 2008
@@ -36,8 +36,9 @@
*
* @param plan the logical plan this operator is a part of
* @param k the operator key for this operator
- * @param pigContext the pigContext object
- * @param argv parsed arguments of the <code>command</code>
+ * @param input operator that is input to this command
+ * @param exeManager ExecutableManager used by this streaming command.
+ * @param cmd StreamingCommand for this stream to run.
*/
public LOStream(LogicalPlan plan, OperatorKey k, LogicalOperator input,
ExecutableManager exeManager, StreamingCommand cmd) {
super(plan, k);
Modified:
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOUnion.java
URL:
http://svn.apache.org/viewvc/incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOUnion.java?rev=695659&r1=695658&r2=695659&view=diff
==============================================================================
---
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOUnion.java
(original)
+++
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOUnion.java
Mon Sep 15 15:10:46 2008
@@ -39,8 +39,6 @@
* Logical plan this operator is a part of.
* @param k
* Operator key to assign to this node.
- * @param inputs
- * List of operators that are input to the union
*/
public LOUnion(LogicalPlan plan, OperatorKey k) {
super(plan, k);
Modified:
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOVisitor.java
URL:
http://svn.apache.org/viewvc/incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOVisitor.java?rev=695659&r1=695658&r2=695659&view=diff
==============================================================================
---
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOVisitor.java
(original)
+++
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/LOVisitor.java
Mon Sep 15 15:10:46 2008
@@ -138,8 +138,8 @@
/**
*
- * @param g
- * the logical generate operator that has to be visited
+ * @param forEach
+ * the logical foreach operator that has to be visited
* @throws VisitorException
*/
protected void visit(LOForEach forEach) throws VisitorException {
@@ -207,8 +207,8 @@
/**
*
- * @param forEach
- * the logical foreach operator that has to be visited
+ * @param g
+ * the logical generate operator that has to be visited
* @throws VisitorException
*/
protected void visit(LOGenerate g) throws VisitorException {
Modified:
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/schema/Schema.java
URL:
http://svn.apache.org/viewvc/incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/schema/Schema.java?rev=695659&r1=695658&r2=695659&view=diff
==============================================================================
---
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/schema/Schema.java
(original)
+++
incubator/pig/branches/types/src/org/apache/pig/impl/logicalLayer/schema/Schema.java
Mon Sep 15 15:10:46 2008
@@ -337,7 +337,7 @@
/***
* Recursively prefix merge two schemas
- * @param other the other field schema to be merged with
+ * @param otherFs the other field schema to be merged with
* @return the prefix merged field schema this can be null if one
schema is null and
* allowIncompatibleTypes is true
*
@@ -350,7 +350,7 @@
/***
* Recursively prefix merge two schemas
- * @param other the other field schema to be merged with
+ * @param otherFs the other field schema to be merged with
* @param otherTakesAliasPrecedence true if aliases from the other
* field schema take precedence
* @return the prefix merged field schema this can be null if one
schema is null and
Modified:
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/DefaultInputHandler.java
URL:
http://svn.apache.org/viewvc/incubator/pig/branches/types/src/org/apache/pig/impl/streaming/DefaultInputHandler.java?rev=695659&r1=695658&r2=695659&view=diff
==============================================================================
---
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/DefaultInputHandler.java
(original)
+++
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/DefaultInputHandler.java
Mon Sep 15 15:10:46 2008
@@ -26,8 +26,8 @@
import org.apache.pig.impl.streaming.StreamingCommand.HandleSpec;
/**
- * [EMAIL PROTECTED] DefaultInputHandler} handles the input for the
Pig-Streaming
- * executable in a [EMAIL PROTECTED] InputType#SYNCHRONOUS} manner by feeding
it input
+ * DefaultInputHandler handles the input for the Pig-Streaming
+ * executable in a synchronous manner by feeding it input
* via its <code>stdin</code>.
*/
public class DefaultInputHandler extends InputHandler {
Modified:
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/DefaultOutputHandler.java
URL:
http://svn.apache.org/viewvc/incubator/pig/branches/types/src/org/apache/pig/impl/streaming/DefaultOutputHandler.java?rev=695659&r1=695658&r2=695659&view=diff
==============================================================================
---
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/DefaultOutputHandler.java
(original)
+++
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/DefaultOutputHandler.java
Mon Sep 15 15:10:46 2008
@@ -26,8 +26,8 @@
import org.apache.pig.impl.streaming.StreamingCommand.HandleSpec;
/**
- * [EMAIL PROTECTED] FileOutputHandler} handles the output from the
Pig-Streaming
- * executable in an [EMAIL PROTECTED] OutputType#SYNCHRONOUS} manner by
reading its output
+ * FileOutputHandler handles the output from the Pig-Streaming
+ * executable in an synchronous manner by reading its output
* via its <code>stdout</code>.
*/
public class DefaultOutputHandler extends OutputHandler {
Modified:
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/ExecutableManager.java
URL:
http://svn.apache.org/viewvc/incubator/pig/branches/types/src/org/apache/pig/impl/streaming/ExecutableManager.java?rev=695659&r1=695658&r2=695659&view=diff
==============================================================================
---
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/ExecutableManager.java
(original)
+++
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/ExecutableManager.java
Mon Sep 15 15:10:46 2008
@@ -99,14 +99,7 @@
/**
* Configure and initialize the [EMAIL PROTECTED] ExecutableManager}.
*
- * @param properties
- * [EMAIL PROTECTED] Properties} for the
<code>ExecutableManager</code>
- * @param command
- * [EMAIL PROTECTED] StreamingCommand} to be run by the
- * <code>ExecutableManager</code>
- * @param endOfPipe
- * [EMAIL PROTECTED] DataCollector} to be used to push results
of the
- * <code>StreamingCommand</code> down
+ * @param stream POStream operator
* @throws IOException
* @throws ExecException
*/
@@ -276,7 +269,7 @@
* Start execution of the external process.
*
* This takes care of setting up the environment of the process and also
- * starts [EMAIL PROTECTED] ProcessErrorThread} to process the
<code>stderr</code> of
+ * starts ProcessErrorThread to process the <code>stderr</code> of
* the managed process.
*
* @throws IOException
Modified:
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/FileInputHandler.java
URL:
http://svn.apache.org/viewvc/incubator/pig/branches/types/src/org/apache/pig/impl/streaming/FileInputHandler.java?rev=695659&r1=695658&r2=695659&view=diff
==============================================================================
---
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/FileInputHandler.java
(original)
+++
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/FileInputHandler.java
Mon Sep 15 15:10:46 2008
@@ -28,8 +28,8 @@
import org.apache.pig.impl.streaming.StreamingCommand.HandleSpec;
/**
- * [EMAIL PROTECTED] FileInputHandler} handles the input for the Pig-Streaming
- * executable in an [EMAIL PROTECTED] InputType#ASYNCHRONOUS} manner by
feeding it input
+ * FileInputHandler handles the input for the Pig-Streaming
+ * executable in an asynchronous manner by feeding it input
* via an external file specified by the user.
*/
public class FileInputHandler extends InputHandler {
Modified:
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/FileOutputHandler.java
URL:
http://svn.apache.org/viewvc/incubator/pig/branches/types/src/org/apache/pig/impl/streaming/FileOutputHandler.java?rev=695659&r1=695658&r2=695659&view=diff
==============================================================================
---
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/FileOutputHandler.java
(original)
+++
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/FileOutputHandler.java
Mon Sep 15 15:10:46 2008
@@ -28,8 +28,8 @@
import org.apache.pig.impl.streaming.StreamingCommand.HandleSpec;
/**
- * [EMAIL PROTECTED] FileOutputHandler} handles the output from the
Pig-Streaming
- * executable in an [EMAIL PROTECTED] OutputType#ASYNCHRONOUS} manner by
reading it from
+ * FileOutputHandler handles the output from the Pig-Streaming
+ * executable in an asynchronous manner by reading it from
* an external file specified by the user.
*/
public class FileOutputHandler extends OutputHandler {
Modified:
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/StreamingCommand.java
URL:
http://svn.apache.org/viewvc/incubator/pig/branches/types/src/org/apache/pig/impl/streaming/StreamingCommand.java?rev=695659&r1=695658&r2=695659&view=diff
==============================================================================
---
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/StreamingCommand.java
(original)
+++
incubator/pig/branches/types/src/org/apache/pig/impl/streaming/StreamingCommand.java
Mon Sep 15 15:10:46 2008
@@ -86,7 +86,7 @@
/**
* Create a new <code>StreamingCommand</code> with the given command.
*
- * @param command streaming command to be executed
+ * @param pigContext PigContext structure
* @param argv parsed arguments of the <code>command</code>
*/
public StreamingCommand(PigContext pigContext, String[] argv) {
@@ -516,4 +516,4 @@
}
}
}
-}
\ No newline at end of file
+}
