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

All Known Implementing Classes:
FromList

public interface OptimizableList

OptimizableList provides services for optimizing a list of Optimizables (tables) in a query.


Method Summary
 Optimizable getOptimizable(int n)
          Return the nth Optimizable in the list.
 void initAccessPaths(Optimizer optimizer)
          Init the access paths for these optimizables.
 boolean legalJoinOrder(int numTablesInQuery)
          Tell whether the join order is legal.
 boolean optimizeJoinOrder()
          Tell whether the join order should be optimized.
 void reOrder(int[] joinOrder)
          Set the join order for this list of optimizables.
 void setOptimizable(int n, Optimizable optimizable)
          Set the nth Optimizable to the specified Optimizable.
 int size()
          Return the number of Optimizables in the list.
 boolean useStatistics()
          user can specify that s/he doesn't want statistics to be considered when optimizing the query.
 void verifyProperties(DataDictionary dDictionary)
          Verify that the Properties list with optimizer overrides, if specified, is valid
 

Method Detail

size

public int size()
Return the number of Optimizables in the list.

Returns:
integer The number of Optimizables in the list.

getOptimizable

public Optimizable getOptimizable(int n)
Return the nth Optimizable in the list.

Parameters:
n - "index" (0 based) into the list.
Returns:
Optimizable The nth Optimizables in the list.

setOptimizable

public void setOptimizable(int n,
                           Optimizable optimizable)
Set the nth Optimizable to the specified Optimizable.

Parameters:
n - "index" (0 based) into the list.
optimizable - New nth Optimizable.
Returns:
Nothing.

verifyProperties

public void verifyProperties(DataDictionary dDictionary)
                      throws StandardException
Verify that the Properties list with optimizer overrides, if specified, is valid

Parameters:
dDictionary - The DataDictionary to use.
Returns:
Nothing.
Throws:
StandardException - Thrown on error

reOrder

public void reOrder(int[] joinOrder)
Set the join order for this list of optimizables. The join order is represented as an array of integers - each entry in the array stands for the order of the corresponding element in the list. For example, a joinOrder of {2, 0, 1} means that the 3rd Optimizable in the list (element 2, since we are zero-based) is the first one in the join order, followed by the 1st element in the list, and finally by the 2nd element in the list. This method shuffles this OptimizableList to match the join order. Obviously, the size of the array must equal the number of elements in the array, and the values in the array must be between 0 and the number of elements in the array minus 1, and the values in the array must be unique.


useStatistics

public boolean useStatistics()
user can specify that s/he doesn't want statistics to be considered when optimizing the query.


optimizeJoinOrder

public boolean optimizeJoinOrder()
Tell whether the join order should be optimized.


legalJoinOrder

public boolean legalJoinOrder(int numTablesInQuery)
Tell whether the join order is legal.


initAccessPaths

public void initAccessPaths(Optimizer optimizer)
Init the access paths for these optimizables.

Parameters:
optimizer - The optimizer being used.
Returns:
Nothing.


Apache Derby V10.0 Engine Documentation - Copyright © 1997,2004 The Apache Software Foundation or its licensors, as applicable.