org.mule.extension.db.api.param

Class StatementDefinition<T extends StatementDefinition>

java.lang.Object

org.mule.extension.db.api.param.QuerySettings

org.mule.extension.db.api.param.StatementDefinition<T>

Type Parameters:

T - the generic type of the implementing type

Direct Known Subclasses:

BulkQueryDefinition, ParameterizedStatementDefinition

public abstract class StatementDefinition<T extends StatementDefinition>
extends QuerySettings

Base class containing common attributes for a statement.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected String	sql The text of the SQL query to be executed

Constructor Summary

Constructors

Constructor and Description
StatementDefinition()

Method Summary

Modifier and Type	Method and Description
protected T	copy() Returns a shallow copy of this instance.
Optional<ParameterType>	getParameterType(String paramName) Returns the type for a given parameter
List<ParameterType>	getParameterTypes()
String	getSql()
abstract T	getTemplate() Returns a globally defined definition this instance points to.
T	resolveFromTemplate() Returns an instance of the same class which state has been derived from the state of the getTemplate() and the state of this instance.
void	setSql(String sql)

Methods inherited from class org.mule.extension.db.api.param.QuerySettings

copyInto, getFetchSize, getMaxRows, getQueryTimeout, getQueryTimeoutUnit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sql

@Parameter
 @Optional
 @Text
 @DisplayName(value="SQL Query Text")
 @Placement(order=1)
 @MetadataKeyId
protected String sql

The text of the SQL query to be executed

Constructor Detail

StatementDefinition

public StatementDefinition()

Method Detail

getTemplate

public abstract T getTemplate()

Returns a globally defined definition this instance points to. Can be null.

Returns:

Another definition of the same type or null

resolveFromTemplate

public T resolveFromTemplate()

Returns an instance of the same class which state has been derived from the state of the getTemplate() and the state of this instance.

If getTemplate() is null then this instance is returned.

This method is recursive in the sense that the template can point to another template itself.

copy

protected T copy()

Returns a shallow copy of this instance.

Returns:

getParameterType

public Optional<ParameterType> getParameterType(String paramName)

Returns the type for a given parameter

Parameters:

paramName - the parameter's name

Returns:

an optional ParameterType

getParameterTypes

public List<ParameterType> getParameterTypes()

getSql

public String getSql()

setSql

public void setSql(String sql)