net.sf.farrago.query
Class FarragoExecutableExplainStmt

java.lang.Object
  extended by org.eigenbase.util.CompoundClosableAllocation
      extended by net.sf.farrago.util.FarragoCompoundAllocation
          extended by net.sf.farrago.query.FarragoExecutableStmtImpl
              extended by net.sf.farrago.query.FarragoExecutableExplainStmt
All Implemented Interfaces:
FarragoSessionExecutableStmt, FarragoAllocation, FarragoAllocationOwner, ClosableAllocation, ClosableAllocationOwner

 class FarragoExecutableExplainStmt
extends FarragoExecutableStmtImpl

FarragoExecutableExplainStmt implements FarragoSessionExecutableStmt for an EXPLAIN PLAN statement.

NOTE: be sure to read superclass warnings before modifying this class.

Version:
$Id: //open/dev/farrago/src/net/sf/farrago/query/FarragoExecutableExplainStmt.java#15 $
Author:
John V. Sichi

Field Summary
private  String explanation
           
 
Fields inherited from class net.sf.farrago.query.FarragoExecutableStmtImpl
tracer
 
Fields inherited from class org.eigenbase.util.CompoundClosableAllocation
allocations
 
Constructor Summary
FarragoExecutableExplainStmt(RelDataType dynamicParamRowType, String explanation)
           
 
Method Summary
 ResultSet execute(FarragoSessionRuntimeContext runtimeContext)
          Executes this statement.
 long getMemoryUsage()
           
 RelDataType getRowType()
           
 
Methods inherited from class net.sf.farrago.query.FarragoExecutableStmtImpl
getDynamicParamRowType, getIterCalcTypeMap, getReferencedObjectIds, getReferencedObjectModTime, getResultSetTypeMap, getTableAccessMap, getTableModOp, isDml
 
Methods inherited from class org.eigenbase.util.CompoundClosableAllocation
addAllocation, closeAllocation, forgetAllocation, hasAllocations
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eigenbase.util.ClosableAllocationOwner
addAllocation
 
Methods inherited from interface org.eigenbase.util.ClosableAllocation
closeAllocation
 
Methods inherited from interface org.eigenbase.util.ClosableAllocation
closeAllocation
 

Field Detail

explanation

private final String explanation
Constructor Detail

FarragoExecutableExplainStmt

FarragoExecutableExplainStmt(RelDataType dynamicParamRowType,
                             String explanation)
Method Detail

getRowType

public RelDataType getRowType()
Returns:
type descriptor for rows produced by this stmt

execute

public ResultSet execute(FarragoSessionRuntimeContext runtimeContext)
Description copied from interface: FarragoSessionExecutableStmt
Executes this statement.

Parameters:
runtimeContext - context in which to execute
Returns:
ResultSet produced by statement

getMemoryUsage

public long getMemoryUsage()
Returns:
approximate total number of bytes used by this statement's in-memory representation