net.sf.basedb.core.query
Class ParameterExpression

java.lang.Object
  net.sf.basedb.core.query.ParameterExpression

All Implemented Interfaces:

Expression, QueryElement

public class ParameterExpression
extends Object
implements Expression

Parameter expression. Used to be able to set a value in the query from the query object.

Version:

2.0

Author:

Nicklas

See Also:

Expressions.parameter(String, Object, Type), Query.setParameter(String, Object, Type)

Last modified

$Date: 2010-09-27 14:53:33 +0200 (Mon, 27 Sep 2010) $

Field Summary

private Object	defaultValue
private String	name
private Type	valueType

Constructor Summary

ParameterExpression(String name, Object defaultValue, Type valueType)

Method Summary

boolean	equals(Object other) This expression is equal to another ParameterExpression if their names expressions are equal.
Collection<? extends QueryElement>	getChildren() Get the children of this query element or null if it has no children.
Object	getDefaultValue() Get the default value of the parameter.
String	getName() Get the name of the parameter.
Type	getValueType() Get the type of value.
int	hashCode()
String	toQl(Query query, DbControl dc) Create a query language string of the query element.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

name

private final String name

defaultValue

private final Object defaultValue

valueType

private final Type valueType

Constructor Detail

ParameterExpression

public ParameterExpression(String name,
                           Object defaultValue,
                           Type valueType)

Method Detail

toQl

public String toQl(Query query,
                   DbControl dc)
            throws BaseException

Description copied from interface: QueryElement

Create a query language string of the query element. Use the Query.getQueryType() method to find out which query language is wanted in case the element requires different syntax for different languages.

Specified by:

toQl in interface QueryElement

Parameters:

query - The query that is about to be executed

dc - The DbControl object used to execute the query

Throws:

BaseException - If there is any other error

getChildren

public Collection<? extends QueryElement> getChildren()

Description copied from interface: QueryElement

Get the children of this query element or null if it has no children. For example the AddExpression has two children, the expression beeing added.

Specified by:

getChildren in interface QueryElement

Returns:

Always null

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

This expression is equal to another ParameterExpression if their names expressions are equal.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getName

public String getName()

Get the name of the parameter.

Since:

2.16

getDefaultValue

public Object getDefaultValue()

Get the default value of the parameter.

Since:

2.16

getValueType

public Type getValueType()

Get the type of value.

Since:

2.16