org.apache.tajo.plan

Class LogicalPlan

java.lang.Object

org.apache.tajo.plan.LogicalPlan

@NotThreadSafe
public class LogicalPlan
extends Object

This represents and keeps every information about a query plan for a query.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogicalPlan.BlockEdge
static class	LogicalPlan.BlockType
class	LogicalPlan.QueryBlock

Field Summary

Fields

Modifier and Type	Field and Description
static String	NONAME_BLOCK_PREFIX
static char	NONAMED_COLUMN_PREFIX
static String	ROOT_BLOCK it indicates the root block
static char	VIRTUAL_TABLE_PREFIX the prefix character for virtual tables

Constructor Summary

Constructors

Constructor and Description
LogicalPlan(LogicalPlanner planner)

Method Summary

Methods

Modifier and Type	Method and Description
void	addHistory(String string)
void	connectBlocks(LogicalPlan.QueryBlock srcBlock, LogicalPlan.QueryBlock targetBlock, LogicalPlan.BlockType type)
<T extends LogicalNode> T	createNode(Class<T> theClass) Create a LogicalNode instance for a type.
static <T extends LogicalNode> T	createNodeWithoutPID(Class<T> theClass) Create a LogicalNode instance for a type.
void	disconnectBlocks(LogicalPlan.QueryBlock srcBlock, LogicalPlan.QueryBlock targetBlock)
String	generateUniqueColumnName(EvalNode evalNode) It generates an unique column name from EvalNode.
String	generateUniqueColumnName(Expr expr) It generates an unique column name from Expr.
LogicalPlan.QueryBlock	getBlock(LogicalNode node)
LogicalPlan.QueryBlock	getBlock(String blockName)
LogicalPlan.QueryBlock	getBlockByExpr(Expr expr)
String	getBlockNameByExpr(Expr expr)
List<LogicalPlan.QueryBlock>	getChildBlocks(LogicalPlan.QueryBlock block)
List<String>	getHistory()
String	getLogicalPlanAsString()
LogicalPlan.QueryBlock	getParentBlock(LogicalPlan.QueryBlock block)
SimpleDirectedGraph<String,LogicalPlan.BlockEdge>	getQueryBlockGraph()
Collection<LogicalPlan.QueryBlock>	getQueryBlocks()
String	getQueryGraphAsString()
LogicalPlan.QueryBlock	getRootBlock()
boolean	isExplain()
void	mapExprToBlock(Expr expr, String blockName)
LogicalPlan.QueryBlock	newAndGetBlock(String blockName) Create a new LogicalPlan.QueryBlock and Get
int	newPID()
LogicalPlan.QueryBlock	newQueryBlock()
void	removeBlock(LogicalPlan.QueryBlock block)
void	resetGeneratedId()
Column	resolveColumn(LogicalPlan.QueryBlock block, ColumnReferenceExpr columnRef)
void	setExplain()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

VIRTUAL_TABLE_PREFIX

public static final char VIRTUAL_TABLE_PREFIX

the prefix character for virtual tables

See Also:

Constant Field Values

NONAMED_COLUMN_PREFIX

public static final char NONAMED_COLUMN_PREFIX

See Also:

Constant Field Values

ROOT_BLOCK

public static final String ROOT_BLOCK

it indicates the root block

See Also:

Constant Field Values

NONAME_BLOCK_PREFIX

public static final String NONAME_BLOCK_PREFIX

See Also:

Constant Field Values

Constructor Detail

LogicalPlan

public LogicalPlan(LogicalPlanner planner)

Method Detail

createNode

public <T extends LogicalNode> T createNode(Class<T> theClass)

Create a LogicalNode instance for a type. Each a LogicalNode instance is given an unique plan node id (PID).

Parameters:

theClass - The class to be created

Returns:

a LogicalNode instance identified by an unique plan node id (PID).

createNodeWithoutPID

public static <T extends LogicalNode> T createNodeWithoutPID(Class<T> theClass)

Create a LogicalNode instance for a type. Each a LogicalNode instance is not given an unique plan node id (PID). This method must be only used after all query planning and optimization phases.

Parameters:

theClass - The class to be created

Returns:

a LogicalNode instance

setExplain

public void setExplain()

isExplain

public boolean isExplain()

newAndGetBlock

public LogicalPlan.QueryBlock newAndGetBlock(String blockName)

Create a new LogicalPlan.QueryBlock and Get

Parameters:

blockName - the query block name

Returns:

a created query block

newPID

public int newPID()

newQueryBlock

public LogicalPlan.QueryBlock newQueryBlock()

resetGeneratedId

public void resetGeneratedId()

generateUniqueColumnName

public String generateUniqueColumnName(EvalNode evalNode)

It generates an unique column name from EvalNode. It is usually used for an expression or predicate without a specified name (i.e., alias).

generateUniqueColumnName

public String generateUniqueColumnName(Expr expr)

It generates an unique column name from Expr. It is usually used for an expression or predicate without a specified name (i.e., alias).

getRootBlock

public LogicalPlan.QueryBlock getRootBlock()

getBlock

public LogicalPlan.QueryBlock getBlock(String blockName)

getBlock

public LogicalPlan.QueryBlock getBlock(LogicalNode node)

removeBlock

public void removeBlock(LogicalPlan.QueryBlock block)

disconnectBlocks

public void disconnectBlocks(LogicalPlan.QueryBlock srcBlock,
                    LogicalPlan.QueryBlock targetBlock)

connectBlocks

public void connectBlocks(LogicalPlan.QueryBlock srcBlock,
                 LogicalPlan.QueryBlock targetBlock,
                 LogicalPlan.BlockType type)

getParentBlock

public LogicalPlan.QueryBlock getParentBlock(LogicalPlan.QueryBlock block)

getChildBlocks

public List<LogicalPlan.QueryBlock> getChildBlocks(LogicalPlan.QueryBlock block)

mapExprToBlock

public void mapExprToBlock(Expr expr,
                  String blockName)

getBlockByExpr

public LogicalPlan.QueryBlock getBlockByExpr(Expr expr)

getBlockNameByExpr

public String getBlockNameByExpr(Expr expr)

getQueryBlocks

public Collection<LogicalPlan.QueryBlock> getQueryBlocks()

getQueryBlockGraph

public SimpleDirectedGraph<String,LogicalPlan.BlockEdge> getQueryBlockGraph()

resolveColumn

public Column resolveColumn(LogicalPlan.QueryBlock block,
                   ColumnReferenceExpr columnRef)
                     throws PlanningException

Throws:

PlanningException

getQueryGraphAsString

public String getQueryGraphAsString()

getLogicalPlanAsString

public String getLogicalPlanAsString()

addHistory

public void addHistory(String string)

getHistory

public List<String> getHistory()

toString

public String toString()

Overrides:

toString in class Object