org.sape.carbon.services.sql
Interface StatementFactoryConfiguration

All Superinterfaces:

ComponentConfiguration, Configuration

public interface StatementFactoryConfiguration

extends ComponentConfiguration

This configuration maintains the setup of a

Since:

carbon 1.0

Version:

$Revision: 1.7 $($Author: dvoet $ / $Date: 2003/05/05 21:21:36 $)

Author:

Vivekanand Kirubanandan, June 2002, Greg Hinkle, December 2002

Field Summary

Fields inherited from interface org.sape.carbon.core.component.ComponentConfiguration

ComponentTemplateName

Method Summary

ConnectionFactory	getConnectionFactory() Getter for the connection factory to be used when creating queries.
Integer	getFetchSize() Getter for the configured fetch size.
Integer	getMaxFieldSize() Getter for the maximum field size.
Integer	getMaxRows() Getter for the configured maximum number of rows to return.
Integer	getQueryTimeOut() Getter for the configured query timeout.
ResultSetConcurrencyEnum	getResultSetConcurrency() Getter for the configured default result set concurrency.
ResultSetTypeEnum	getResultSetType() Getter for the result set type.
StatementConfiguration[]	getStatement() Retrieves an array of all the sql query configurations.
void	setConnectionFactory(ConnectionFactory connectionFactory) Setter for the connection factory
void	setFetchSize(Integer fetchSize) Setter for the fetch size on results sets.
void	setMaxFieldSize(Integer maxFieldSize) Setter for the size of fields to be returned.
void	setMaxRows(Integer maxRows) Setter for the max rows to return.
void	setQueryTimeOut(Integer queryTimeOut) Setter for the timeout in milleseconds of this query
void	setResultSetConcurrency(ResultSetConcurrencyEnum resultSetConcurrency) Setter for the concurrency of the result set.
void	setResultSetType(ResultSetTypeEnum resultSetType) Setter for the default type of result set.
void	setStatement(StatementConfiguration[] statement) Sets an array of all the sql query configurations.

Methods inherited from interface org.sape.carbon.core.component.ComponentConfiguration

getComponentDescription, getComponentTemplateName, getFunctionalImplementationClass, getFunctionalInterface, setComponentDescription, setComponentTemplateName, setFunctionalImplementationClass, setFunctionalInterface

Methods inherited from interface org.sape.carbon.core.config.Configuration

clone, getConfigurationInterface, getConfigurationName, getDataStructure, getRootElement, isConfigurationWritable, setConfigurationName, setConfigurationReadOnly

Method Detail

getStatement

public StatementConfiguration[] getStatement()

Retrieves an array of all the sql query configurations.

Returns:

array of all sql query configurations

setStatement

public void setStatement(StatementConfiguration[] statement)

Sets an array of all the sql query configurations.

Parameters:

statement - array of all sql query configurations

getConnectionFactory

public ConnectionFactory getConnectionFactory()

Getter for the connection factory to be used when creating queries.

Returns:

the default connection factory for this component

setConnectionFactory

public void setConnectionFactory(ConnectionFactory connectionFactory)

Setter for the connection factory

Parameters:

connectionFactory - the default connection factory for this component

getResultSetType

public ResultSetTypeEnum getResultSetType()

Getter for the result set type. As of version 4.2, the now returns an ResutlSetTypeEnum enumeration.

Returns:

the default type of result set

Since:

carbon 1.2

setResultSetType

public void setResultSetType(ResultSetTypeEnum resultSetType)

Setter for the default type of result set. As of 4.2, the now takes an ResutlSetTypeEnum enumeration.

Parameters:

resultSetType - the type of result set created by default

Since:

carbon 1.2

See Also:

ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, ResultSet.TYPE_SCROLL_SENSITIVE

getResultSetConcurrency

public ResultSetConcurrencyEnum getResultSetConcurrency()

Getter for the configured default result set concurrency. As of version 4.2, this now returns a ResultSetConcurrencyEnum instead of a String.

Returns:

the default concurrency for this component

Since:

carbon 1.2

setResultSetConcurrency

public void setResultSetConcurrency(ResultSetConcurrencyEnum resultSetConcurrency)

Setter for the concurrency of the result set. As of version 4.2, this now takes a ResultSetConcurrencyEnum enumeration.

Parameters:

resultSetConcurrency - the concurrency type of the result set

Since:

carbon 1.2

See Also:

ResultSet.CONCUR_READ_ONLY, ResultSet.CONCUR_UPDATABLE

getMaxRows

public Integer getMaxRows()

Getter for the configured maximum number of rows to return.

Returns:

the maximum number of rows to return.

setMaxRows

public void setMaxRows(Integer maxRows)

Setter for the max rows to return.

Parameters:

maxRows - The maximum number of rows to return from a query.

getFetchSize

public Integer getFetchSize()

Getter for the configured fetch size.

Returns:

Gets the configured driver hint for rows to return at a time.

setFetchSize

public void setFetchSize(Integer fetchSize)

Setter for the fetch size on results sets.

Parameters:

fetchSize - A driver hint for the count of records to be returned on each database message.

getMaxFieldSize

public Integer getMaxFieldSize()

Getter for the maximum field size.

Returns:

the maximum field size in bytes

setMaxFieldSize

public void setMaxFieldSize(Integer maxFieldSize)

Setter for the size of fields to be returned.

Parameters:

maxFieldSize - The max size, in bytes, that the driver should return for a column.

getQueryTimeOut

public Integer getQueryTimeOut()

Getter for the configured query timeout.

Returns:

the configured query timeout in milleseconds

setQueryTimeOut

public void setQueryTimeOut(Integer queryTimeOut)

Setter for the timeout in milleseconds of this query

Parameters:

queryTimeOut - the number of milleseconds before the driver should timeout a database query. (Drivers have defaults)