Top Fields Constructors Methods
org.apache.derby.impl.sql.compile

pack-priv Class AccessPathImpl

extends Object
implements AccessPath
Class Inheritance
All Implemented Interfaces
org.apache.derby.iapi.sql.compile.AccessPath
Imports
org.apache.derby.shared.common.error.StandardException, org.apache.derby.shared.common.reference.SQLState, org.apache.derby.shared.common.sanity.SanityManager, org.apache.derby.iapi.sql.compile.AccessPath, .CostEstimate, .JoinStrategy, .Optimizer, org.apache.derby.iapi.sql.dictionary.ConglomerateDescriptor, .ConstraintDescriptor, .DataDictionary, .TableDescriptor

Field Summary

Modifier and TypeField and Description
private String
accessPathName

pack-priv ConglomerateDescriptor
cd

private CostEstimate
costEstimate

pack-priv boolean
coveringIndexScan

pack-priv JoinStrategy
joinStrategy

pack-priv int
lockMode

pack-priv boolean
nonMatchingIndexScan

pack-priv Optimizer
optimizer

Constructor Summary

AccessConstructor and Description
pack-priv
AccessPathImpl(Optimizer optimizer)

Method Summary

Modifier and TypeMethod and Description
public void
copy(AccessPath copyFrom)

Implements org.apache.derby.iapi.sql.compile.AccessPath.copy.

Copy all information from the given AccessPath to this one.

public ConglomerateDescriptor
getConglomerateDescriptor()

Implements org.apache.derby.iapi.sql.compile.AccessPath.getConglomerateDescriptor.

Get whatever was last set as the conglomerate descriptor.

public CostEstimate
getCostEstimate()

Implements org.apache.derby.iapi.sql.compile.AccessPath.getCostEstimate.

Get the cost estimate for this AccessPath.

public boolean
getCoveringIndexScan()

Implements org.apache.derby.iapi.sql.compile.AccessPath.getCoveringIndexScan.

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

public JoinStrategy
getJoinStrategy()

Implements org.apache.derby.iapi.sql.compile.AccessPath.getJoinStrategy.

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

public int
getLockMode()

Implements org.apache.derby.iapi.sql.compile.AccessPath.getLockMode.

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

public boolean
getNonMatchingIndexScan()

Implements org.apache.derby.iapi.sql.compile.AccessPath.getNonMatchingIndexScan.

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

public Optimizer
getOptimizer()

Implements org.apache.derby.iapi.sql.compile.AccessPath.getOptimizer.

Get the optimizer associated with this access path.

public void
initializeAccessPathName(DataDictionary
Datadictionary.
dd, TableDescriptor
TableDescriptor of the base table.
td)

Implements org.apache.derby.iapi.sql.compile.AccessPath.initializeAccessPathName.

Sets the "name" of the access path.

public void
setConglomerateDescriptor(ConglomerateDescriptor
A ConglomerateDescriptor
cd)

Implements org.apache.derby.iapi.sql.compile.AccessPath.setConglomerateDescriptor.

Set the conglomerate descriptor for this access path.

public void
setCostEstimate(CostEstimate costEstimate)

Implements org.apache.derby.iapi.sql.compile.AccessPath.setCostEstimate.

Set the given cost estimate in this AccessPath.

public void
setCoveringIndexScan(boolean coveringIndexScan)

Implements org.apache.derby.iapi.sql.compile.AccessPath.setCoveringIndexScan.

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

public void
setJoinStrategy(JoinStrategy
The best join strategy
joinStrategy)

Implements org.apache.derby.iapi.sql.compile.AccessPath.setJoinStrategy.

Remember the given join strategy

public void
setLockMode(int lockMode)

Implements org.apache.derby.iapi.sql.compile.AccessPath.setLockMode.

Set the lock mode

public void
setNonMatchingIndexScan(boolean nonMatchingIndexScan)

Implements org.apache.derby.iapi.sql.compile.AccessPath.setNonMatchingIndexScan.

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

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

accessPathNameback to summary
private String accessPathName
cdback to summary
pack-priv ConglomerateDescriptor cd
costEstimateback to summary
private CostEstimate costEstimate
coveringIndexScanback to summary
pack-priv boolean coveringIndexScan
joinStrategyback to summary
pack-priv JoinStrategy joinStrategy
lockModeback to summary
pack-priv int lockMode
nonMatchingIndexScanback to summary
pack-priv boolean nonMatchingIndexScan
optimizerback to summary
pack-priv Optimizer optimizer

Constructor Detail

AccessPathImplback to summary
pack-priv AccessPathImpl(Optimizer optimizer)

Method Detail

copyback to summary
public void copy(AccessPath copyFrom)

Implements org.apache.derby.iapi.sql.compile.AccessPath.copy.

Doc from org.apache.derby.iapi.sql.compile.AccessPath.copy.

Copy all information from the given AccessPath to this one.

See Also
AccessPath#copy
getConglomerateDescriptorback to summary
public ConglomerateDescriptor getConglomerateDescriptor()

Implements org.apache.derby.iapi.sql.compile.AccessPath.getConglomerateDescriptor.

Doc from org.apache.derby.iapi.sql.compile.AccessPath.getConglomerateDescriptor.

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

See Also
AccessPath#getConglomerateDescriptor
getCostEstimateback to summary
public CostEstimate getCostEstimate()

Implements org.apache.derby.iapi.sql.compile.AccessPath.getCostEstimate.

Doc from org.apache.derby.iapi.sql.compile.AccessPath.getCostEstimate.

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

See Also
AccessPath#getCostEstimate
getCoveringIndexScanback to summary
public boolean getCoveringIndexScan()

Implements org.apache.derby.iapi.sql.compile.AccessPath.getCoveringIndexScan.

Doc from org.apache.derby.iapi.sql.compile.AccessPath.getCoveringIndexScan.

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

Returns:boolean

boolean Whether or not the optimizer chose a covering index scan.

See Also
AccessPath#getCoveringIndexScan
getJoinStrategyback to summary
public JoinStrategy getJoinStrategy()

Implements org.apache.derby.iapi.sql.compile.AccessPath.getJoinStrategy.

Doc from org.apache.derby.iapi.sql.compile.AccessPath.getJoinStrategy.

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

See Also
AccessPath#getJoinStrategy
getLockModeback to summary
public int getLockMode()

Implements org.apache.derby.iapi.sql.compile.AccessPath.getLockMode.

Doc from org.apache.derby.iapi.sql.compile.AccessPath.getLockMode.

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

See Also
AccessPath#getLockMode
getNonMatchingIndexScanback to summary
public boolean getNonMatchingIndexScan()

Implements org.apache.derby.iapi.sql.compile.AccessPath.getNonMatchingIndexScan.

Doc from org.apache.derby.iapi.sql.compile.AccessPath.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.

Returns:boolean

boolean Whether or not the optimizer is considering a non-matching index scan.

See Also
AccessPath#getNonMatchingIndexScan
getOptimizerback to summary
public Optimizer getOptimizer()

Implements org.apache.derby.iapi.sql.compile.AccessPath.getOptimizer.

Doc from org.apache.derby.iapi.sql.compile.AccessPath.getOptimizer.

Get the optimizer associated with this access path.

Returns:Optimizer

The optimizer associated with this access path.

See Also
AccessPath#getOptimizer
initializeAccessPathNameback to summary
public void initializeAccessPathName(DataDictionary dd, TableDescriptor td) throws StandardException

Implements org.apache.derby.iapi.sql.compile.AccessPath.initializeAccessPathName.

Doc from org.apache.derby.iapi.sql.compile.AccessPath.initializeAccessPathName.

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.

Parameters
dd:DataDictionary

Datadictionary.

td:TableDescriptor

TableDescriptor of the base table.

Exceptions
StandardException:
on error.
See Also
AccessPath#initializeAccessPathName
setConglomerateDescriptorback to summary
public void setConglomerateDescriptor(ConglomerateDescriptor cd)

Implements org.apache.derby.iapi.sql.compile.AccessPath.setConglomerateDescriptor.

Doc from org.apache.derby.iapi.sql.compile.AccessPath.setConglomerateDescriptor.

Set the conglomerate descriptor for this access path.

Parameters
cd:ConglomerateDescriptor

A ConglomerateDescriptor

See Also
AccessPath#setConglomerateDescriptor
setCostEstimateback to summary
public void setCostEstimate(CostEstimate costEstimate)

Implements org.apache.derby.iapi.sql.compile.AccessPath.setCostEstimate.

Doc from org.apache.derby.iapi.sql.compile.AccessPath.setCostEstimate.

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

See Also
AccessPath#setCostEstimate
setCoveringIndexScanback to summary
public void setCoveringIndexScan(boolean coveringIndexScan)

Implements org.apache.derby.iapi.sql.compile.AccessPath.setCoveringIndexScan.

Doc from org.apache.derby.iapi.sql.compile.AccessPath.setCoveringIndexScan.

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

See Also
AccessPath#setCoveringIndexScan
setJoinStrategyback to summary
public void setJoinStrategy(JoinStrategy joinStrategy)

Implements org.apache.derby.iapi.sql.compile.AccessPath.setJoinStrategy.

Doc from org.apache.derby.iapi.sql.compile.AccessPath.setJoinStrategy.

Remember the given join strategy

Parameters
joinStrategy:JoinStrategy

The best join strategy

See Also
AccessPath#setJoinStrategy
setLockModeback to summary
public void setLockMode(int lockMode)

Implements org.apache.derby.iapi.sql.compile.AccessPath.setLockMode.

Doc from org.apache.derby.iapi.sql.compile.AccessPath.setLockMode.

Set the lock mode

See Also
AccessPath#setLockMode
setNonMatchingIndexScanback to summary
public void setNonMatchingIndexScan(boolean nonMatchingIndexScan)

Implements org.apache.derby.iapi.sql.compile.AccessPath.setNonMatchingIndexScan.

Doc from org.apache.derby.iapi.sql.compile.AccessPath.setNonMatchingIndexScan.

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

See Also
AccessPath#setNonMatchingIndexScan
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override