AccessPath

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> apache >> derby >> iapi >> sql >> [ compile overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.apache.derby.iapi.sql.compile.AccessPath

SOURCE |

Download org.apache.derby.iapi.sql.compile.AccessPath

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.derby.iapi.sql.compile
Interface AccessPath

public interface AccessPath

AccessPath represents a proposed access path for an Optimizable. An Optimizable may have more than one proposed AccessPath.

Method Summary

void copy(AccessPath copyFrom)
          Copy all information from the given AccessPath to this one.

org.apache.derby.iapi.sql.dictionary.ConglomerateDescriptor getConglomerateDescriptor()
          Get whatever was last set as the conglomerate descriptor.

CostEstimate getCostEstimate()
          Get the cost estimate for this AccessPath.

boolean getCoveringIndexScan()
          Return whether or not the optimizer is considering a covering index scan on this AccessPath.

JoinStrategy getJoinStrategy()
          Get the join strategy, as set by setJoinStrategy().

int getLockMode()
          Get the lock mode, as last set in setLockMode().

boolean getNonMatchingIndexScan()
          Return whether or not the optimizer is considering a non-matching index scan on this AccessPath.

Optimizer getOptimizer()
          Get the optimizer associated with this access path.

void initializeAccessPathName(org.apache.derby.iapi.sql.dictionary.DataDictionary dd, org.apache.derby.iapi.sql.dictionary.TableDescriptor td)
          Sets the "name" of the access path.

void setConglomerateDescriptor(org.apache.derby.iapi.sql.dictionary.ConglomerateDescriptor cd)
          Set the conglomerate descriptor for this access path.

void setCostEstimate(CostEstimate costEstimate)
          Set the given cost estimate in this AccessPath.

void setCoveringIndexScan(boolean coveringIndexScan)
          Set whether or not to consider a covering index scan on the optimizable.

void setJoinStrategy(JoinStrategy joinStrategy)
          Remember the given join strategy

void setLockMode(int lockMode)
          Set the lock mode

void setNonMatchingIndexScan(boolean nonMatchingIndexScan)
          Set whether or not to consider a non-matching index scan on this AccessPath.

Method Detail

setConglomerateDescriptor

public void setConglomerateDescriptor(org.apache.derby.iapi.sql.dictionary.ConglomerateDescriptor cd)

Set the conglomerate descriptor for this access path.

getConglomerateDescriptor

public org.apache.derby.iapi.sql.dictionary.ConglomerateDescriptor getConglomerateDescriptor()

Get whatever was last set as the conglomerate descriptor. Returns null if nothing was set since the last call to startOptimizing()

setCostEstimate

public void setCostEstimate(CostEstimate costEstimate)

Set the given cost estimate in this AccessPath. Generally, this will be the CostEstimate for the plan currently under consideration.

getCostEstimate

public CostEstimate getCostEstimate()

Get the cost estimate for this AccessPath. This is the last one set by setCostEstimate.

setCoveringIndexScan

public void setCoveringIndexScan(boolean coveringIndexScan)

Set whether or not to consider a covering index scan on the optimizable.

getCoveringIndexScan

public boolean getCoveringIndexScan()

Return whether or not the optimizer is considering a covering index scan on this AccessPath.

setNonMatchingIndexScan

public void setNonMatchingIndexScan(boolean nonMatchingIndexScan)

Set whether or not to consider a non-matching index scan on this AccessPath.

getNonMatchingIndexScan

public boolean getNonMatchingIndexScan()

Return whether or not the optimizer is considering a non-matching index scan on this AccessPath. We expect to call this during generation, after access path selection is complete.

setJoinStrategy

public void setJoinStrategy(JoinStrategy joinStrategy)

Remember the given join strategy

getJoinStrategy

public JoinStrategy getJoinStrategy()

Get the join strategy, as set by setJoinStrategy().

setLockMode

public void setLockMode(int lockMode)

Set the lock mode

getLockMode

public int getLockMode()

Get the lock mode, as last set in setLockMode().

copy

public void copy(AccessPath copyFrom)

Copy all information from the given AccessPath to this one.

getOptimizer

public Optimizer getOptimizer()

Get the optimizer associated with this access path.

initializeAccessPathName

public void initializeAccessPathName(org.apache.derby.iapi.sql.dictionary.DataDictionary dd,
                                     org.apache.derby.iapi.sql.dictionary.TableDescriptor td)
                              throws org.apache.derby.iapi.error.StandardException

Sets the "name" of the access path. if the access path represents an index then set the name to the name of the index. if it is an index created for a constraint, use the constraint name. This is called only for base tables.