org.apache.pig.newplan

Class Operator

java.lang.Object

org.apache.pig.newplan.Operator

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

JobStats, LogicalExpression, LogicalRelationalOperator, PatternNode

public abstract class Operator
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	annotations
protected int	hashPrime
protected SourceLocation	location
protected java.lang.String	name
protected OperatorPlan	plan

Constructor Summary

Constructors

Constructor and Description
Operator(java.lang.String n, OperatorPlan p)

Method Summary

Modifier and Type	Method and Description
abstract void	accept(PlanVisitor v) Accept a visitor at this node in the graph.
void	annotate(java.lang.String key, java.lang.Object val) Add an annotation to a node in the plan.
java.lang.Object	getAnnotation(java.lang.String key) Look to see if a node is annotated.
SourceLocation	getLocation()
java.lang.String	getName()
OperatorPlan	getPlan() Get the plan associated with this operator.
abstract boolean	isEqual(Operator operator) This is like a shallow equals comparison.
java.lang.Object	removeAnnotation(java.lang.String key) Remove an annotation
void	setLocation(SourceLocation loc)
void	setPlan(OperatorPlan p)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

location

protected SourceLocation location

name

protected java.lang.String name

plan

protected OperatorPlan plan

annotations

protected transient java.util.Map<java.lang.String,java.lang.Object> annotations

hashPrime

protected final transient int hashPrime

See Also:

Constant Field Values

Constructor Detail

Operator

public Operator(java.lang.String n,
                OperatorPlan p)

Method Detail

accept

public abstract void accept(PlanVisitor v)
                     throws FrontendException

Accept a visitor at this node in the graph.

Parameters:

v - Visitor to accept.

Throws:

FrontendException

getName

public java.lang.String getName()

getLocation

public SourceLocation getLocation()

setLocation

public void setLocation(SourceLocation loc)

getPlan

public OperatorPlan getPlan()

Get the plan associated with this operator.

Returns:

plan

annotate

public void annotate(java.lang.String key,
                     java.lang.Object val)

Add an annotation to a node in the plan.

Parameters:

key - string name of this annotation

val - value, as an Object

getAnnotation

public java.lang.Object getAnnotation(java.lang.String key)

Look to see if a node is annotated.

Parameters:

key - string name of annotation to look for

Returns:

value of the annotation, as an Object, or null if the key is not present in the map.

removeAnnotation

public java.lang.Object removeAnnotation(java.lang.String key)

Remove an annotation

Parameters:

key - the key of the annotation

Returns:

the original value of the annotation

setPlan

public void setPlan(OperatorPlan p)

isEqual

public abstract boolean isEqual(Operator operator)
                         throws FrontendException

This is like a shallow equals comparison. It returns true if two operators have equivalent properties even if they are different objects. Here properties mean equivalent plan and equivalent name.

Parameters:

operator -

Returns:

true if two object have equivalent properties, else false

Throws:

FrontendException