org.apache.pig.backend.hadoop.executionengine.physicalLayer.relationalOperators

Class PORank

java.lang.Object

org.apache.pig.impl.plan.Operator<PhyPlanVisitor>

org.apache.pig.backend.hadoop.executionengine.physicalLayer.PhysicalOperator

org.apache.pig.backend.hadoop.executionengine.physicalLayer.relationalOperators.PORank

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Operator>, Illustrable

Direct Known Subclasses:

PORankTez

public class PORank
extends PhysicalOperator

This operator is part of the RANK operator implementation. Reads the output tuple from POCounter and the cumulative sum previously calculated. Here is read the task identifier in order to get the corresponding cumulative sum, and the local counter at the tuple. These values are summed and prepended to the tuple.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.pig.backend.hadoop.executionengine.physicalLayer.PhysicalOperator

PhysicalOperator.OriginalLocation

Field Summary

Fields inherited from class org.apache.pig.backend.hadoop.executionengine.physicalLayer.PhysicalOperator

alias, illustrator, input, inputAttached, inputs, lineageTracer, mBagFactory, mTupleFactory, outputs, parentPlan, pigLogger, reporter, requestedParallelism, res, RESULT_EMPTY, RESULT_EOP, resultType

Fields inherited from class org.apache.pig.impl.plan.Operator

mKey

Constructor Summary

Constructors

Constructor and Description
PORank(OperatorKey k)
PORank(OperatorKey k, int rp)
PORank(OperatorKey k, int rp, List<PhysicalOperator> inp)
PORank(OperatorKey operatorKey, int requestedParallelism, List inp, List<PhysicalPlan> rankPlans, List<Boolean> ascendingCol)
PORank(OperatorKey k, List<PhysicalOperator> inp)
PORank(PORank copy)

Method Summary

Methods

Modifier and Type	Method and Description
Result	addRank(Result input) Reads the output tuple from POCounter and the cumulative sum previously calculated.
PORank	clone() Make a copy of this operator.
List<Boolean>	getAscendingCols()
Result	getNextTuple()
String	getOperationID()
protected Long	getRankCounterOffset(Integer taskId)
List<PhysicalPlan>	getRankPlans()
Tuple	illustratorMarkup(Object in, Object out, int eqClassIndex) input tuple mark up to be illustrate-able
String	name()
void	setAscendingCols(List<Boolean> mAscCols)
void	setOperationID(String operationID) Operation ID: identifier shared within the corresponding POCounter
void	setRankPlans(List<PhysicalPlan> rankPlans)
boolean	supportsMultipleInputs() Indicates whether this operator supports multiple inputs.
boolean	supportsMultipleOutputs() Indicates whether this operator supports multiple outputs.
void	visit(PhyPlanVisitor v) Visit this node with the provided visitor.

Methods inherited from class org.apache.pig.backend.hadoop.executionengine.physicalLayer.PhysicalOperator

addOriginalLocation, addOriginalLocation, attachInput, cloneHelper, clonePlans, copyAliasFrom, detachInput, getAlias, getAliasString, getIllustrator, getInputs, getLogger, getNext, getNextBigDecimal, getNextBigInteger, getNextBoolean, getNextDataBag, getNextDataByteArray, getNextDateTime, getNextDouble, getNextFloat, getNextInteger, getNextLong, getNextMap, getNextString, getOriginalLocations, getPigLogger, getReporter, getRequestedParallelism, getResultType, isAccumStarted, isAccumulative, isBlocking, isInputAttached, processInput, reset, setAccumEnd, setAccumStart, setAccumulative, setIllustrator, setInputs, setParentPlan, setPigLogger, setReporter, setRequestedParallelism, setResultType, staticDataCleanup

Methods inherited from class org.apache.pig.impl.plan.Operator

compareTo, equals, getOperatorKey, getProjectionMap, hashCode, regenerateProjectionMap, rewire, toString, unsetProjectionMap

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PORank

public PORank(OperatorKey k)

PORank

public PORank(OperatorKey k,
      int rp)

PORank

public PORank(OperatorKey k,
      List<PhysicalOperator> inp)

PORank

public PORank(OperatorKey k,
      int rp,
      List<PhysicalOperator> inp)

PORank

public PORank(PORank copy)

PORank

public PORank(OperatorKey operatorKey,
      int requestedParallelism,
      List inp,
      List<PhysicalPlan> rankPlans,
      List<Boolean> ascendingCol)

Method Detail

illustratorMarkup

public Tuple illustratorMarkup(Object in,
                      Object out,
                      int eqClassIndex)

Description copied from interface: Illustrable

input tuple mark up to be illustrate-able

Parameters:

in - input tuple

out - output tuple before wrapped in ExampleTuple

eqClassIndex - index into equivalence classes in illustrator

Returns:

tuple

visit

public void visit(PhyPlanVisitor v)
           throws VisitorException

Description copied from class: Operator

Visit this node with the provided visitor. This should only be called by the visitor class itself, never directly.

Specified by:

visit in class PhysicalOperator

Parameters:

v - Visitor to visit with.

Throws:

VisitorException - if the visitor has a problem.

getNextTuple

public Result getNextTuple()
                    throws ExecException

Overrides:

getNextTuple in class PhysicalOperator

Throws:

ExecException

addRank

public Result addRank(Result input)
               throws ExecException

Reads the output tuple from POCounter and the cumulative sum previously calculated. Here is read the task identifier in order to get the corresponding cumulative sum, and the local counter at the tuple. These values are summed and prepended to the tuple.

Parameters:

input - processed by POCounter

Returns:

input as Result. The input.result tuple owns the prepend rank value

Throws:

ExecException

getRankCounterOffset

protected Long getRankCounterOffset(Integer taskId)

supportsMultipleInputs

public boolean supportsMultipleInputs()

Description copied from class: Operator

Indicates whether this operator supports multiple inputs.

Specified by:

supportsMultipleInputs in class Operator<PhyPlanVisitor>

Returns:

true if it does, otherwise false.

supportsMultipleOutputs

public boolean supportsMultipleOutputs()

Description copied from class: Operator

Indicates whether this operator supports multiple outputs.

Specified by:

supportsMultipleOutputs in class Operator<PhyPlanVisitor>

Returns:

true if it does, otherwise false.

name

public String name()

Specified by:

name in class Operator<PhyPlanVisitor>

setRankPlans

public void setRankPlans(List<PhysicalPlan> rankPlans)

getRankPlans

public List<PhysicalPlan> getRankPlans()

setAscendingCols

public void setAscendingCols(List<Boolean> mAscCols)

getAscendingCols

public List<Boolean> getAscendingCols()

setOperationID

public void setOperationID(String operationID)

Operation ID: identifier shared within the corresponding POCounter

Parameters:

operationID -

getOperationID

public String getOperationID()

clone

public PORank clone()
             throws CloneNotSupportedException

Description copied from class: PhysicalOperator

Make a copy of this operator. This function is blank, however, we should leave a place holder so that the subclasses can clone to make deep copy as this one creates a shallow copy of non-primitive types (objects, arrays and lists)

Overrides:

clone in class PhysicalOperator

Throws:

CloneNotSupportedException

See Also:

Do not use the clone method directly. Operators are cloned when logical plans are cloned using {@link LogicalPlanCloner}