Top Description Fields Methods
org.apache.derby.iapi.sql

public Interface LanguageFactory

Known Direct Implementers
org.apache.derby.impl.sql.GenericLanguageFactory
Imports
org.apache.derby.shared.common.error.StandardException, org.apache.derby.iapi.services.loader.ClassInspector
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.

Field Summary

Modifier and TypeField and Description
public static final String
MODULE

Used to locate this factory by the Monitor basic service.

Method Summary

Modifier and TypeMethod and Description
public ResultDescription

Returns:

ResultDescription the rd
getResultDescription(ResultDescription
the input rd
inputResultDescription, int[]
non null array of ints
theCols)

Get a new result description from the input result description.

public ResultDescription

Returns:

ResultDescription the rd
getResultDescription(ResultColumnDescriptor[]
an array of col descriptors
cols, String
the statement type
type)

Get a new result description

public ParameterValueSet

Returns:

A new ParameterValueSet with the given number of parms
newParameterValueSet(ClassInspector
A class inspector
ci, int
The number of parameters in the ParameterValueSet
numParms, boolean
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()
hasReturnParam)

Get a ParameterValueSet

Field Detail

MODULEback to summary
public static final String MODULE

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

Method Detail

getResultDescriptionback to summary
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:ResultDescription

the input rd

theCols:int[]

non null array of ints

Returns:ResultDescription

ResultDescription the rd

getResultDescriptionback to summary
public ResultDescription getResultDescription(ResultColumnDescriptor[] cols, String type)

Get a new result description

Parameters
cols:ResultColumnDescriptor[]

an array of col descriptors

type:String

the statement type

Returns:ResultDescription

ResultDescription the rd

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

Get a ParameterValueSet

Parameters
ci:ClassInspector

A class inspector

numParms:int

The number of parameters in the ParameterValueSet

hasReturnParam:boolean

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:ParameterValueSet

A new ParameterValueSet with the given number of parms