org.mule.db.commons.api.param

Class ParameterizedStatementDefinition<T extends ParameterizedStatementDefinition>

java.lang.Object

org.mule.db.commons.api.param.QuerySettings

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

org.mule.db.commons.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:

1.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.db.commons.api.param.StatementDefinition

sql

Constructor Summary

Constructors

Constructor and Description
ParameterizedStatementDefinition()
ParameterizedStatementDefinition(String sql, List<ParameterType> parameterTypes, Map<String,Object> inputParameters, int queryTimeout, TimeUnit queryTimeoutUnit, Integer fetchSize, Integer maxRows) Creates a new instance of ParameterizedStatementDefinition with the given arguments.

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<org.mule.runtime.api.util.Reference<Object>>	findParameter(Map<String,Object> parameters, String name)
Optional<org.mule.runtime.api.util.Reference<Object>>	getInputParameter(String name) Optionally returns a parameter of the given name
Map<String,Object>	getInputParameters()

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

getParameterType, getParameterTypes, getSql, setSql

Methods inherited from class org.mule.db.commons.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
 @Content
 @Optional
 @NullSafe
 @TypeResolver(value=DbInputMetadataResolver.class)
 @Placement(order=2)
 @DisplayName(value="Input Parameters")
 @Example(value="#[{\'name\': \"Max\", \'nickname\': \"The Mule\", \'company\': \"MuleSoft\"}]")
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()

ParameterizedStatementDefinition

public ParameterizedStatementDefinition(String sql,
                                        List<ParameterType> parameterTypes,
                                        Map<String,Object> inputParameters,
                                        int queryTimeout,
                                        TimeUnit queryTimeoutUnit,
                                        Integer fetchSize,
                                        Integer maxRows)

Creates a new instance of ParameterizedStatementDefinition with the given arguments.

Parameters:

sql - The text of the SQL query to be executed

parameterTypes - Allows to optionally specify the type of one or more of the parameters in the query. If provided, you're not even required to reference all of the parameters, but you cannot reference a parameter not present in the input values

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.

queryTimeout - Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. No timeout is used by default.

queryTimeoutUnit - A TimeUnit which qualifies the QuerySettings.queryTimeout

fetchSize - Indicates how many rows to fetch from the database when rows are read from a resultSet.

maxRows - * Sets the limit for the maximum number of rows that any ResultSet object generated by this message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.

Method Detail

getInputParameter

public Optional<org.mule.runtime.api.util.Reference<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<org.mule.runtime.api.util.Reference<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: