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

public Class GenericLanguageFactory

extends Object
implements LanguageFactory, ModuleControl
Class Inheritance
All Implemented Interfaces
org.apache.derby.iapi.services.monitor.ModuleControl, org.apache.derby.iapi.sql.LanguageFactory
Imports
org.apache.derby.iapi.services.property.PropertyFactory, org.apache.derby.iapi.store.access.AccessFactory, .TransactionController, org.apache.derby.iapi.sql.LanguageFactory, .ParameterValueSet, .ResultDescription, .ResultColumnDescriptor, .Row, org.apache.derby.iapi.services.monitor.Monitor, .ModuleControl, org.apache.derby.shared.common.error.StandardException, org.apache.derby.iapi.sql.conn.LanguageConnectionFactory, org.apache.derby.iapi.services.loader.ClassInspector, org.apache.derby.iapi.services.io.FormatIdUtil, java.util.Properties
The LanguageFactory provides system-wide services that are available on the Database API.

Field Summary

Modifier and TypeField and Description
private GenericParameterValueSet
emptySet

Constructor Summary

AccessConstructor and Description
public
GenericLanguageFactory()

Method Summary

Modifier and TypeMethod and Description
public void
boot(boolean
True if the database should be created
create, Properties
The start-up parameters (ignored in this case)
startParams)

Implements org.apache.derby.iapi.services.monitor.ModuleControl.boot.

Start-up method for this instance of the language factory.

private static Object
findServiceModule(final Object serviceModule, final String factoryInterface)

Must be private so that user code can't call this entry point.

public ResultDescription

Returns:

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

Implements org.apache.derby.iapi.sql.LanguageFactory.getResultDescription.

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)

Implements org.apache.derby.iapi.sql.LanguageFactory.getResultDescription.

Get a new result description

public ParameterValueSet
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)

Implements org.apache.derby.iapi.sql.LanguageFactory.newParameterValueSet.

Factory method for getting a ParameterValueSet

public void
stop()

Implements org.apache.derby.iapi.services.monitor.ModuleControl.stop.

Stop this module.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

emptySetback to summary
private GenericParameterValueSet emptySet

Constructor Detail

GenericLanguageFactoryback to summary
public GenericLanguageFactory()

Method Detail

bootback to summary
public void boot(boolean create, Properties startParams) throws StandardException

Implements org.apache.derby.iapi.services.monitor.ModuleControl.boot.

Start-up method for this instance of the language factory. This service is expected to be started and accessed relative to a database.

Parameters
create:boolean

Doc from org.apache.derby.iapi.services.monitor.ModuleControl.boot.

True if the database should be created

startParams:Properties

The start-up parameters (ignored in this case)

Exceptions
StandardException:
Thrown if module cannot be booted.
findServiceModuleback to summary
private static Object findServiceModule(final Object serviceModule, final String factoryInterface) throws StandardException

Must be private so that user code can't call this entry point.

getResultDescriptionback to summary
public ResultDescription getResultDescription(ResultDescription inputResultDescription, int[] theCols)

Implements org.apache.derby.iapi.sql.LanguageFactory.getResultDescription.

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[]

array of ints, non null

Returns:ResultDescription

ResultDescription the rd

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

Implements org.apache.derby.iapi.sql.LanguageFactory.getResultDescription.

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)

Implements org.apache.derby.iapi.sql.LanguageFactory.newParameterValueSet.

Factory method for getting a ParameterValueSet

Parameters
ci:ClassInspector

Doc from org.apache.derby.iapi.sql.LanguageFactory.newParameterValueSet.

A class inspector

numParms:int

Doc from org.apache.derby.iapi.sql.LanguageFactory.newParameterValueSet.

The number of parameters in the ParameterValueSet

hasReturnParam:boolean

Doc from org.apache.derby.iapi.sql.LanguageFactory.newParameterValueSet.

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

Doc from org.apache.derby.iapi.sql.LanguageFactory.newParameterValueSet.

A new ParameterValueSet with the given number of parms

See Also
LanguageFactory#newParameterValueSet
stopback to summary
public void stop()

Implements org.apache.derby.iapi.services.monitor.ModuleControl.stop.

Stop this module. In this case, nothing needs to be done.