org.apache.derby.iapi.sql
Interface LanguageFactory

All Known Implementing Classes:

GenericLanguageFactory

public interface LanguageFactory

Factory interface for the Language.Interface protocol. This is used via the Database API by users, and is presented as a System Module (not a service module). That could change, but for now this is valid for any database.

Author:

Jeff Lichtman

Field Summary

static java.lang.String

MODULE Used to locate this factory by the Monitor basic service.

Method Summary

ResultDescription	getResultDescription(ResultColumnDescriptor[] cols, java.lang.String type) Get a new result description
ResultDescription	getResultDescription(ResultDescription inputResultDescription, int[] theCols) Get a new result description from the input result description.
ParameterValueSet	newParameterValueSet(ClassInspector ci, int numParms, boolean hasReturnParam) Get a ParameterValueSet

Field Detail

MODULE

public static final java.lang.String MODULE

Used to locate this factory by the Monitor basic service. There needs to be a language factory per database.

See Also:

Constant Field Values

Method Detail

newParameterValueSet

public ParameterValueSet newParameterValueSet(ClassInspector ci,
                                              int numParms,
                                              boolean hasReturnParam)

Get a ParameterValueSet

Parameters:

numParms - The number of parameters in the ParameterValueSet

hasReturnParam - true if this parameter set has a return parameter. The return parameter is always the 1st parameter in the list. It is due to a callableStatement like this: ? = CALL myMethod()

Returns:

A new ParameterValueSet with the given number of parms

getResultDescription

public ResultDescription getResultDescription(ResultDescription inputResultDescription,
                                              int[] theCols)

Get a new result description from the input result description. Picks only the columns in the column array from the inputResultDescription.

Parameters:

inputResultDescription - the input rd

theCols - non null array of ints

Returns:

ResultDescription the rd

getResultDescription

public ResultDescription getResultDescription(ResultColumnDescriptor[] cols,
                                              java.lang.String type)

Get a new result description

Parameters:

cols - an array of col descriptors

type - the statement type

Returns:

ResultDescription the rd