Package org.apache.derby.iapi.sql.execute.xplain

Interface XPLAINable

All Known Subinterfaces:

ResultSetStatistics

All Known Implementing Classes:

RealAnyResultSetStatistics, RealBasicNoPutResultSetStatistics, RealCurrentOfStatistics, RealDeleteCascadeResultSetStatistics, RealDeleteResultSetStatistics, RealDeleteVTIResultSetStatistics, RealDistinctScalarAggregateStatistics, RealDistinctScanStatistics, RealGroupedAggregateStatistics, RealHashJoinStatistics, RealHashLeftOuterJoinStatistics, RealHashScanStatistics, RealHashTableStatistics, RealIndexRowToBaseRowStatistics, RealInsertResultSetStatistics, RealInsertVTIResultSetStatistics, RealJoinResultSetStatistics, RealLastIndexKeyScanStatistics, RealMaterializedResultSetStatistics, RealNestedLoopJoinStatistics, RealNestedLoopLeftOuterJoinStatistics, RealNoPutResultSetStatistics, RealNormalizeResultSetStatistics, RealNoRowsResultSetStatistics, RealOnceResultSetStatistics, RealProjectRestrictStatistics, RealRowCountStatistics, RealRowResultSetStatistics, RealScalarAggregateStatistics, RealScrollInsensitiveResultSetStatistics, RealSetOpResultSetStatistics, RealSortStatistics, RealTableScanStatistics, RealUnionResultSetStatistics, RealUpdateResultSetStatistics, RealVTIStatistics, RealWindowResultSetStatistics

public interface XPLAINable

This interface has to be implemented by object structures, which want to get explained. The current implementation let the ResultSetStatistics extend this Interface to be explainable.

Method Summary

Modifier and Type	Method	Description
void	accept(XPLAINVisitor visitor)	This method gets called to let a visitor visit this XPLAINable object.
Object	getResultSetDescriptor(Object rsID, Object parentID, Object scanID, Object sortID, Object stmtID, Object timingID)
Object	getResultSetTimingsDescriptor(Object rstID)
String	getRSXplainDetails()
String	getRSXplainType()
Object	getScanPropsDescriptor(Object spID)
Object	getSortPropsDescriptor(Object spID)

Method Details

accept

void accept(XPLAINVisitor visitor)

This method gets called to let a visitor visit this XPLAINable object. The general contract is to implement pre-order, depth-first traversal to produce a predictable traversal behaviour.

getRSXplainType

String getRSXplainType()

getRSXplainDetails

String getRSXplainDetails()

getResultSetDescriptor

Object getResultSetDescriptor(Object rsID,
 Object parentID,
 Object scanID,
 Object sortID,
 Object stmtID,
 Object timingID)

getResultSetTimingsDescriptor

Object getResultSetTimingsDescriptor(Object rstID)

getSortPropsDescriptor

Object getSortPropsDescriptor(Object spID)

getScanPropsDescriptor

Object getScanPropsDescriptor(Object spID)