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

Methods

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

Method Detail

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

java.lang.String getRSXplainType()

getRSXplainDetails

java.lang.String getRSXplainDetails()

getResultSetDescriptor

java.lang.Object getResultSetDescriptor(java.lang.Object rsID,
                                      java.lang.Object parentID,
                                      java.lang.Object scanID,
                                      java.lang.Object sortID,
                                      java.lang.Object stmtID,
                                      java.lang.Object timingID)

getResultSetTimingsDescriptor

java.lang.Object getResultSetTimingsDescriptor(java.lang.Object rstID)

getSortPropsDescriptor

java.lang.Object getSortPropsDescriptor(java.lang.Object spID)

getScanPropsDescriptor

java.lang.Object getScanPropsDescriptor(java.lang.Object spID)