org.mule.extension.db.api.param

Class ParameterizedStatementDefinition<T extends ParameterizedStatementDefinition>

java.lang.Object

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

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

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

Type Parameters:

T - the generic type of the implementing type

Direct Known Subclasses:

QueryDefinition, StoredProcedureCall

public abstract class ParameterizedStatementDefinition<T extends ParameterizedStatementDefinition>
extends StatementDefinition<T>

Base class for StatementDefinition implementations which have a Map of input parameters.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	inputParameters A Map which keys are the name of an input parameter to be set on the JDBC prepared statement.

Fields inherited from class org.mule.extension.db.api.param.StatementDefinition

sql

Constructor Summary

Constructors

Constructor and Description
ParameterizedStatementDefinition()

Method Summary

Modifier and Type	Method and Description
void	addInputParameter(String paramName, Object value) Adds a new input parameter
protected T	copy() Returns a shallow copy of this instance.
protected Optional<Object>	findParameter(Map<String,Object> parameters, String name)
Optional<Object>	getInputParameter(String name) Optionally returns a parameter of the given name
Map<String,Object>	getInputParameters()
Map<String,Object>	getParameterValues() Returns a Map which keys are the names of the input parameters and the values are its values
T	resolveFromTemplate() Returns an instance of the same class which state has been derived from the state of the StatementDefinition.getTemplate() and the state of this instance.

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

getParameterType, getParameterTypes, getSql, getTemplate, setSql

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

inputParameters

@Parameter
 @Optional(defaultValue="#[{}]")
 @Example(value="#[{\'name\': \"Max\", \'nickname\': \"The Mule\", \'company\': \"MuleSoft\"}]")
 @Content
 @Placement(order=2)
 @TypeResolver(value=DbInputMetadataResolver.class)
protected Map<String,Object> inputParameters

A Map which keys are the name of an input parameter to be set on the JDBC prepared statement. Each parameter should be referenced in the sql text using a semicolon prefix (E.g: where id = :myParamName)).

The map's values will contain the actual assignation for each parameter.

Constructor Detail

ParameterizedStatementDefinition

public ParameterizedStatementDefinition()

Method Detail

getParameterValues

public Map<String,Object> getParameterValues()

Returns a Map which keys are the names of the input parameters and the values are its values

getInputParameter

public Optional<Object> getInputParameter(String name)

Optionally returns a parameter of the given name

Parameters:

name - the name of the searched parameter

Returns:

an Optional ParameterType

findParameter

protected Optional<Object> findParameter(Map<String,Object> parameters,
                                         String name)

getInputParameters

public Map<String,Object> getInputParameters()

Returns:

an immutable Map with the input parameters

addInputParameter

public void addInputParameter(String paramName,
                              Object value)

Adds a new input parameter

Parameters:

paramName - the parameter name

value - the parameter value

copy

protected T copy()

Description copied from class: StatementDefinition

Returns a shallow copy of this instance.

Overrides:

copy in class StatementDefinition<T extends ParameterizedStatementDefinition>

Returns:

resolveFromTemplate

public T resolveFromTemplate()

Description copied from class: StatementDefinition

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

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

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

Overrides:

resolveFromTemplate in class StatementDefinition<T extends ParameterizedStatementDefinition>