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

Class POUserFunc

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.expressionOperators.ExpressionOperator

org.apache.pig.backend.hadoop.executionengine.physicalLayer.expressionOperators.POUserFunc

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Operator>, Illustrable

public class POUserFunc
extends ExpressionOperator

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

Modifier and Type	Field and Description
static byte	FINAL
static byte	INITIAL
static byte	INTERMEDIATE

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
POUserFunc(OperatorKey k, int rp, java.util.List<PhysicalOperator> inp)
POUserFunc(OperatorKey k, int rp, java.util.List<PhysicalOperator> inp, FuncSpec funcSpec)
POUserFunc(OperatorKey k, int rp, java.util.List<PhysicalOperator> inp, FuncSpec funcSpec, EvalFunc func)

Method Summary

Modifier and Type	Method and Description
POUserFunc	clone() Make a deep copy of this operator.
boolean	combinable()
void	finish()
java.util.List<java.lang.String>	getCacheFiles()
java.util.List<ExpressionOperator>	getChildExpressions() Get child expression of this expression
org.apache.hadoop.security.Credentials	getCredentials()
java.lang.String	getFinal()
EvalFunc	getFunc()
FuncSpec	getFuncSpec()
java.lang.String	getInitial()
java.lang.String	getIntermed()
Result	getNextBigDecimal()
Result	getNextBigInteger()
Result	getNextBoolean()
Result	getNextDataBag()
Result	getNextDataByteArray()
Result	getNextDateTime()
Result	getNextDouble()
Result	getNextFloat()
Result	getNextInteger()
Result	getNextLong()
Result	getNextMap()
Result	getNextString()
Result	getNextTuple()
java.lang.reflect.Type	getOriginalReturnType()
PhysicalOperator	getReferencedOperator()
java.lang.reflect.Type	getReturnType()
java.util.List<java.lang.String>	getShipFiles()
java.lang.String	getSignature()
Tuple	illustratorMarkup(java.lang.Object in, java.lang.Object out, int eqClassIndex) input tuple mark up to be illustrate-able
java.lang.Boolean	isAsynchronous()
java.lang.String	name()
boolean	needEndOfAllInputProcessing()
Schema	outputSchema(Schema input)
Result	processInput() A generic method for parsing input that either returns the attached input if it exists or fetches it from its predecessor.
void	setAccumStart()
void	setAlgebraicFunction(byte Function)
void	setCacheFiles(java.util.List<java.lang.String> cf)
void	setCredentials(org.apache.hadoop.security.Credentials creds)
void	setFuncInputSchema()
void	setFuncInputSchema(java.lang.String signature) Sets EvalFunc's inputschema based on the signature
void	setFuncSpec(FuncSpec funcSpec)
void	setReferencedOperator(PhysicalOperator referencedOperator)
void	setResultType(byte resultType)
void	setShipFiles(java.util.List<java.lang.String> sf)
void	setSignature(java.lang.String signature)
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.expressionOperators.ExpressionOperator

accumChild, containUDF, setIllustrator, toString

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, getOriginalLocations, getParentPlan, getPigLogger, getReporter, getRequestedParallelism, getResultType, isAccumStarted, isAccumulative, isBlocking, isEndOfAllInput, isInputAttached, reset, setAccumEnd, setAccumulative, setInputs, setParentPlan, setPigLogger, setReporter, setRequestedParallelism, staticDataCleanup

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

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

Methods inherited from class java.lang.Object

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

Field Detail

INITIAL

public static final byte INITIAL

See Also:

Constant Field Values

INTERMEDIATE

public static final byte INTERMEDIATE

See Also:

Constant Field Values

FINAL

public static final byte FINAL

See Also:

Constant Field Values

Constructor Detail

POUserFunc

public POUserFunc(OperatorKey k,
                  int rp,
                  java.util.List<PhysicalOperator> inp)

POUserFunc

public POUserFunc(OperatorKey k,
                  int rp,
                  java.util.List<PhysicalOperator> inp,
                  FuncSpec funcSpec)

POUserFunc

public POUserFunc(OperatorKey k,
                  int rp,
                  java.util.List<PhysicalOperator> inp,
                  FuncSpec funcSpec,
                  EvalFunc func)

Method Detail

getReferencedOperator

public PhysicalOperator getReferencedOperator()

setReferencedOperator

public void setReferencedOperator(PhysicalOperator referencedOperator)

setFuncInputSchema

public void setFuncInputSchema()

processInput

public Result processInput()
                    throws ExecException

Description copied from class: PhysicalOperator

A generic method for parsing input that either returns the attached input if it exists or fetches it from its predecessor. If special processing is required, this method should be overridden.

Overrides:

processInput in class PhysicalOperator

Returns:

The Result object that results from processing the input

Throws:

ExecException

getNextTuple

public Result getNextTuple()
                    throws ExecException

Overrides:

getNextTuple in class PhysicalOperator

Throws:

ExecException

getNextDataBag

public Result getNextDataBag()
                      throws ExecException

Overrides:

getNextDataBag in class ExpressionOperator

Throws:

ExecException

getNextInteger

public Result getNextInteger()
                      throws ExecException

Overrides:

getNextInteger in class PhysicalOperator

Throws:

ExecException

getNextBoolean

public Result getNextBoolean()
                      throws ExecException

Overrides:

getNextBoolean in class PhysicalOperator

Throws:

ExecException

getNextDataByteArray

public Result getNextDataByteArray()
                            throws ExecException

Overrides:

getNextDataByteArray in class PhysicalOperator

Throws:

ExecException

getNextDouble

public Result getNextDouble()
                     throws ExecException

Overrides:

getNextDouble in class PhysicalOperator

Throws:

ExecException

getNextBigInteger

public Result getNextBigInteger()
                         throws ExecException

Overrides:

getNextBigInteger in class PhysicalOperator

Throws:

ExecException

getNextBigDecimal

public Result getNextBigDecimal()
                         throws ExecException

Overrides:

getNextBigDecimal in class PhysicalOperator

Throws:

ExecException

getNextFloat

public Result getNextFloat()
                    throws ExecException

Overrides:

getNextFloat in class PhysicalOperator

Throws:

ExecException

getNextLong

public Result getNextLong()
                   throws ExecException

Overrides:

getNextLong in class PhysicalOperator

Throws:

ExecException

getNextDateTime

public Result getNextDateTime()
                       throws ExecException

Overrides:

getNextDateTime in class PhysicalOperator

Throws:

ExecException

getNextMap

public Result getNextMap()
                  throws ExecException

Overrides:

getNextMap in class PhysicalOperator

Throws:

ExecException

getNextString

public Result getNextString()
                     throws ExecException

Overrides:

getNextString in class PhysicalOperator

Throws:

ExecException

setAlgebraicFunction

public void setAlgebraicFunction(byte Function)
                          throws ExecException

Throws:

ExecException

getInitial

public java.lang.String getInitial()
                            throws ExecException

Throws:

ExecException

getIntermed

public java.lang.String getIntermed()
                             throws ExecException

Throws:

ExecException

getFinal

public java.lang.String getFinal()
                          throws ExecException

Throws:

ExecException

getOriginalReturnType

public java.lang.reflect.Type getOriginalReturnType()
                                             throws ExecException

Throws:

ExecException

getReturnType

public java.lang.reflect.Type getReturnType()

finish

public void finish()

outputSchema

public Schema outputSchema(Schema input)

isAsynchronous

public java.lang.Boolean isAsynchronous()

name

public java.lang.String name()

Specified by:

name in class Operator<PhyPlanVisitor>

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.

Overrides:

supportsMultipleOutputs in class ExpressionOperator

Returns:

true if it does, otherwise false.

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 ExpressionOperator

Parameters:

v - Visitor to visit with.

Throws:

VisitorException - if the visitor has a problem.

getFuncSpec

public FuncSpec getFuncSpec()

setFuncSpec

public void setFuncSpec(FuncSpec funcSpec)

getCacheFiles

public java.util.List<java.lang.String> getCacheFiles()

setCacheFiles

public void setCacheFiles(java.util.List<java.lang.String> cf)

getShipFiles

public java.util.List<java.lang.String> getShipFiles()

setShipFiles

public void setShipFiles(java.util.List<java.lang.String> sf)

combinable

public boolean combinable()

clone

public POUserFunc clone()
                 throws java.lang.CloneNotSupportedException

Description copied from class: ExpressionOperator

Make a deep copy of this operator. This is declared here to make it possible to call clone on ExpressionOperators.

Overrides:

clone in class ExpressionOperator

Throws:

java.lang.CloneNotSupportedException

See Also:

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

getChildExpressions

public java.util.List<ExpressionOperator> getChildExpressions()

Get child expression of this expression

Specified by:

getChildExpressions in class ExpressionOperator

setAccumStart

public void setAccumStart()

Overrides:

setAccumStart in class PhysicalOperator

setResultType

public void setResultType(byte resultType)

Overrides:

setResultType in class PhysicalOperator

illustratorMarkup

public Tuple illustratorMarkup(java.lang.Object in,
                               java.lang.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

getFunc

public EvalFunc getFunc()

getSignature

public java.lang.String getSignature()

setSignature

public void setSignature(java.lang.String signature)

setFuncInputSchema

public void setFuncInputSchema(java.lang.String signature)

Sets EvalFunc's inputschema based on the signature

Parameters:

signature -

needEndOfAllInputProcessing

public boolean needEndOfAllInputProcessing()

getCredentials

public org.apache.hadoop.security.Credentials getCredentials()

setCredentials

public void setCredentials(org.apache.hadoop.security.Credentials creds)