org.jooq
Interface Param<T>

All Superinterfaces:
Adapter, AliasProvider<Field<T>>, Attachable, Comparable<NamedQueryPart>, Field<T>, NamedQueryPart, NamedTypeProviderQueryPart<T>, QueryPart, Serializable

public interface Param<T>
extends Field<T>

A named parameter and/or bind value.

Author:
Lukas Eder
See Also:
Factory.param(String, Object)

Method Summary
 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 NamedTypeProviderQueryPart.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, betweenSymmetric, betweenSymmetric, bitLength, cast, cast, cast, ceil, charLength, coalesce, coalesce, concat, concat, contains, contains, cos, cosh, cot, coth, count, countDistinct, countOver, decode, decode, decode, decode, deg, desc, div, div, endsWith, endsWith, eq, eq, eq, equal, equal, equal, equalAll, equalAll, equalAll, equalAny, equalAny, equalAny, equalIgnoreCase, equalIgnoreCase, equals, equalSome, exp, extract, firstValue, floor, ge, ge, ge, getType, greaterOrEqual, greaterOrEqual, greaterOrEqual, greaterOrEqualAll, greaterOrEqualAll, greaterOrEqualAll, greaterOrEqualAny, greaterOrEqualAny, greaterOrEqualAny, greaterOrEqualSome, greaterThan, greaterThan, greaterThan, greaterThanAll, greaterThanAll, greaterThanAll, greaterThanAny, greaterThanAny, greaterThanAny, greaterThanSome, greatest, greatest, gt, gt, gt, in, in, in, in, isDistinctFrom, isDistinctFrom, isFalse, isNotDistinctFrom, isNotDistinctFrom, isNotNull, isNull, isNullLiteral, isTrue, lag, lag, lag, lag, lastValue, le, le, le, lead, lead, lead, lead, least, least, length, lessOrEqual, lessOrEqual, lessOrEqual, lessOrEqualAll, lessOrEqualAll, lessOrEqualAll, lessOrEqualAny, lessOrEqualAny, lessOrEqualAny, lessOrEqualSome, lessThan, lessThan, lessThan, lessThanAll, lessThanAll, lessThanAll, lessThanAny, lessThanAny, lessThanAny, lessThanSome, like, like, like, like, likeIgnoreCase, likeIgnoreCase, likeIgnoreCase, likeIgnoreCase, likeRegex, likeRegex, ln, log, lower, lpad, lpad, lpad, lpad, lt, lt, lt, ltrim, max, maxOver, median, min, minOver, mod, mod, mul, mul, ne, ne, ne, neg, notBetween, notBetween, notBetweenSymmetric, notBetweenSymmetric, notEqual, notEqual, notEqual, notEqualAll, notEqualAll, notEqualAll, notEqualAny, notEqualAny, notEqualAny, notEqualIgnoreCase, notEqualIgnoreCase, notEqualSome, notIn, notIn, notIn, notIn, notLike, notLike, notLike, notLike, notLikeIgnoreCase, notLikeIgnoreCase, notLikeIgnoreCase, notLikeIgnoreCase, notLikeRegex, notLikeRegex, nullif, nullif, nvl, nvl, nvl2, nvl2, octetLength, position, position, power, rad, repeat, repeat, replace, replace, replace, replace, round, round, rpad, rpad, rpad, rpad, rtrim, sign, sin, sinh, sort, sortAsc, sortAsc, sortDesc, sortDesc, sqrt, startsWith, startsWith, stddevPop, stddevPopOver, stddevSamp, stddevSampOver, sub, sub, substring, substring, substring, substring, sum, sumOver, tan, tanh, trim, upper, varPop, varPopOver, varSamp, varSampOver
 
Methods inherited from interface org.jooq.NamedTypeProviderQueryPart
getDataType, getDataType
 
Methods inherited from interface org.jooq.QueryPart
attach
 
Methods inherited from interface org.jooq.Adapter
internalAPI
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getName

String getName()
The name of the field.

The name is any of these:


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

Specified by:
getName in interface Field<T>
Specified by:
getName in interface NamedQueryPart

getParamName

String getParamName()
The parameter name. This name is useful for two things:


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 NamedTypeProviderQueryPart.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



Copyright © 2012. All Rights Reserved.