jrun.ejb.ejbql
Class EjbQLQuery

java.lang.Object
  |
  +--jrun.ejb.ejbql.EjbQLQuery

All Implemented Interfaces:

Element

public class EjbQLQuery

extends java.lang.Object

implements Element

Representation of a single EJB QL query. CMP 2.0 Entity ejbs can have ejbql queries.

Author:

Enrique Duvos

Fields inherited from interface jrun.ejb.ejbql.Element

UNSPECIFIED_TRAVERSAL_ORDER

Constructor Summary

EjbQLQuery(EntityMetaData entityMetaData, java.lang.String queryMethodName)

Method Summary

void	accept(Visitor visitor)
void	addInputParam(InputParam param)
boolean	equals(java.lang.Object other)
AbstractSchemaName	getAbstractSchemaName() Get the abstract schema corresponding to the persistent object for which this query is defined.
java.util.ListIterator	getChildren(int traversalType)
EJBJarMetaData	getEJBJarMetaData()
EntityMetaData	getEntityMetaData()
FromClause	getFromClause()
java.util.List	getInputParams()
java.lang.String	getQueryJavaReturnType()
QueryMetaData	getQueryMetaData()
java.lang.Class	getQueryMethodReturnType() The return type from the signature of the finder or select method for which this query is defined.
java.lang.String	getReturnedSelectEjbName()
SelectClause	getSelectClause()
WhereClause	getWhereClause()
boolean	hasDistinctResults()
boolean	hasLocalResultTypeMapping() Only applicable for select methods that return ejbs.
boolean	hasRemoteResultTypeMapping()
boolean	hasWhereClause()
boolean	isFinderQuery()
boolean	isLocalFinderQuery() TRUE if finder query is defined in Local Home Interface
boolean	isRemoteFinderQuery() TRUE if finder query is defined in Remote Home Interface
boolean	isSelectQuery()
boolean	queryMethodReturnsCollection()
boolean	queryMethodReturnsSet()
boolean	queryMethodReturnsSingleValue()
void	setEntityMetaData(EntityMetaData entityMetaData)
void	setQueryJavaReturnType() Java type of the objects selected by EJB QL query itself.
void	setQueryMetaData(QueryMetaData queryMetaData)
void	setSelectClause(SelectClause selectClause)
void	setWhereClause(WhereClause whereClause)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EjbQLQuery

public EjbQLQuery(EntityMetaData entityMetaData,
                  java.lang.String queryMethodName)

Method Detail

getAbstractSchemaName

public AbstractSchemaName getAbstractSchemaName()

Get the abstract schema corresponding to the persistent object for which this query is defined.

hasLocalResultTypeMapping

public boolean hasLocalResultTypeMapping()

Only applicable for select methods that return ejbs. Defaults to true if no return type mapping is specified in the deployment descriptor for this query.

hasRemoteResultTypeMapping

public boolean hasRemoteResultTypeMapping()

setEntityMetaData

public void setEntityMetaData(EntityMetaData entityMetaData)

setQueryMetaData

public void setQueryMetaData(QueryMetaData queryMetaData)

getQueryMetaData

public QueryMetaData getQueryMetaData()

getQueryJavaReturnType

public java.lang.String getQueryJavaReturnType()

setQueryJavaReturnType

public void setQueryJavaReturnType()

Java type of the objects selected by EJB QL query itself. Note that this is different from the return type of the finder or select signature.

getReturnedSelectEjbName

public java.lang.String getReturnedSelectEjbName()

getQueryMethodReturnType

public java.lang.Class getQueryMethodReturnType()

The return type from the signature of the finder or select method for which this query is defined.

queryMethodReturnsSingleValue

public boolean queryMethodReturnsSingleValue()

queryMethodReturnsSet

public boolean queryMethodReturnsSet()

queryMethodReturnsCollection

public boolean queryMethodReturnsCollection()

isFinderQuery

public boolean isFinderQuery()

isRemoteFinderQuery

public boolean isRemoteFinderQuery()

TRUE if finder query is defined in Remote Home Interface

isLocalFinderQuery

public boolean isLocalFinderQuery()

TRUE if finder query is defined in Local Home Interface

isSelectQuery

public boolean isSelectQuery()

hasDistinctResults

public boolean hasDistinctResults()

getEntityMetaData

public EntityMetaData getEntityMetaData()

getEJBJarMetaData

public EJBJarMetaData getEJBJarMetaData()

getFromClause

public FromClause getFromClause()

getWhereClause

public WhereClause getWhereClause()

getInputParams

public java.util.List getInputParams()

addInputParam

public void addInputParam(InputParam param)

setWhereClause

public void setWhereClause(WhereClause whereClause)

getSelectClause

public SelectClause getSelectClause()

setSelectClause

public void setSelectClause(SelectClause selectClause)

hasWhereClause

public boolean hasWhereClause()

accept

public void accept(Visitor visitor)

Specified by:

accept in interface Element

getChildren

public java.util.ListIterator getChildren(int traversalType)

Specified by:

getChildren in interface Element

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object