org.jooq

Interface Param<T>

All Superinterfaces:

Field<T>, GroupField, QueryPart, Serializable

public interface Param<T>
extends Field<T>

A named parameter and/or bind value.

Author:

Lukas Eder

See Also:

DSL.param(String, Object)

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() The name of the field.
String	getParamName() The parameter name.
T	getValue() Get the parameter's underlying value.
boolean	isInline() A flag on the bind value to force it to be inlined in rendered SQL
void	setConverted(Object value) Sets a converted value, using this Param's underlying DataType, obtained from Field.getDataType()
void	setInline(boolean inline) A flag on the bind value to force it to be inlined in rendered SQL
void	setValue(T value) Set the parameter's underlying value.

Methods inherited from interface org.jooq.Field

abs, acos, add, add, as, asc, ascii, asin, atan, atan2, atan2, avg, avgOver, between, between, between, between, betweenSymmetric, betweenSymmetric, betweenSymmetric, betweenSymmetric, bitAnd, bitAnd, bitLength, bitNand, bitNand, bitNor, bitNor, bitNot, bitOr, bitOr, bitXNor, bitXNor, bitXor, bitXor, cast, cast, cast, ceil, charLength, coalesce, coalesce, coerce, coerce, coerce, compare, compare, compare, compare, concat, concat, contains, contains, cos, cosh, cot, coth, count, countDistinct, countOver, decode, decode, decode, decode, deg, desc, div, div, divide, divide, endsWith, endsWith, eq, eq, eq, eq, equal, equal, equal, equal, equalIgnoreCase, equalIgnoreCase, equals, exp, extract, firstValue, floor, ge, ge, ge, ge, getComment, getDataType, getDataType, getType, greaterOrEqual, greaterOrEqual, greaterOrEqual, greaterOrEqual, greaterThan, greaterThan, greaterThan, greaterThan, greatest, greatest, gt, gt, gt, gt, in, in, in, in, isDistinctFrom, isDistinctFrom, isFalse, isNotDistinctFrom, isNotDistinctFrom, isNotNull, isNull, isTrue, lag, lag, lag, lag, lastValue, le, le, le, le, lead, lead, lead, lead, least, least, length, lessOrEqual, lessOrEqual, lessOrEqual, lessOrEqual, lessThan, lessThan, lessThan, lessThan, like, like, like, like, likeIgnoreCase, likeIgnoreCase, likeIgnoreCase, likeIgnoreCase, likeRegex, likeRegex, ln, log, lower, lpad, lpad, lpad, lpad, lt, lt, lt, lt, ltrim, max, maxOver, median, min, minOver, minus, minus, mod, mod, modulo, modulo, mul, mul, multiply, multiply, ne, ne, ne, ne, neg, notBetween, notBetween, notBetween, notBetween, notBetweenSymmetric, notBetweenSymmetric, notBetweenSymmetric, notBetweenSymmetric, notEqual, notEqual, notEqual, notEqual, notEqualIgnoreCase, notEqualIgnoreCase, notIn, notIn, notIn, notIn, notLike, notLike, notLike, notLike, notLikeIgnoreCase, notLikeIgnoreCase, notLikeIgnoreCase, notLikeIgnoreCase, notLikeRegex, notLikeRegex, nullif, nullif, nvl, nvl, nvl2, nvl2, octetLength, plus, plus, position, position, pow, power, rad, repeat, repeat, replace, replace, replace, replace, round, round, rpad, rpad, rpad, rpad, rtrim, shl, shl, shr, shr, sign, sin, sinh, sort, sort, sortAsc, sortAsc, sortDesc, sortDesc, sqrt, startsWith, startsWith, stddevPop, stddevPopOver, stddevSamp, stddevSampOver, sub, sub, substring, substring, substring, substring, subtract, subtract, sum, sumOver, tan, tanh, trim, upper, varPop, varPopOver, varSamp, varSampOver

Methods inherited from interface org.jooq.QueryPart

hashCode, toString

Method Detail

getName

String getName()

The name of the field.

The name is any of these:

• The formal name of the field, if it is a physical table/view field
• The alias of an aliased field
• A generated / unspecified value for any other expression
• The name of a parameter if it is a named Param

The Param's value for getName() coincides with getParamName()

Specified by:

getName in interface Field<T>

getParamName

String getParamName()

The parameter name. This name is useful for two things:

• Named parameters in frameworks that support them, such as Spring's JdbcTemplate
• Accessing the parameter from the Query API, with Query.getParam(String), Query.getParams()

getValue

T getValue()

Get the parameter's underlying value. This returns null if no value has been set yet.

setValue

void setValue(T value)

Set the parameter's underlying value. This is the same as setConverted(Object), but ensures generic type-safety.

See Also:

setConverted(Object)

setConverted

void setConverted(Object value)
                  throws DataTypeException

Sets a converted value, using this Param's underlying DataType, obtained from Field.getDataType()

Throws:

DataTypeException - If value cannot be converted into this parameter's data type.

See Also:

DataType.convert(Object), Convert.convert(Object, Class)

setInline

void setInline(boolean inline)

A flag on the bind value to force it to be inlined in rendered SQL

isInline

boolean isInline()

A flag on the bind value to force it to be inlined in rendered SQL