net.sf.basedb.core.query
Class HqlEntityParameterExpression

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

All Implemented Interfaces:

Expression, QueryElement

public class HqlEntityParameterExpression
extends Object
implements Expression

Entity parameter expression. Accepts BasicItem or BasicData objects as parameter values.

Version:

2.17

Author:

Nicklas

See Also:

Hql.entityParameter(String, net.sf.basedb.core.Item), HqlQuery.setEntityParameter(String, net.sf.basedb.core.BasicItem)

Last modified

$Date: 2011-02-04 09:25:16 +0100 (Fri, 04 Feb 2011) $

Field Summary

private Item	itemType
private String	name

Constructor Summary

HqlEntityParameterExpression(String name, Item itemType)

Method Summary

boolean	equals(Object other) This expression is equal to another HqlEntityParameterExpression if their names are equal.
Collection<? extends QueryElement>	getChildren() Get the children of this query element or null if it has no children.
Item	getItemType() Get the type of entites that are accepted by the parameter.
String	getName() Get the name of the parameter.
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

itemType

private final Item itemType

Constructor Detail

HqlEntityParameterExpression

public HqlEntityParameterExpression(String name,
                                    Item itemType)

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 HqlEntityParameterExpression if their names 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.

getItemType

public Item getItemType()

Get the type of entites that are accepted by the parameter.