com.sun.jdo.spi.persistence.support.ejb.ejbqlc
Class ParameterSupport

java.lang.Object
  com.sun.jdo.spi.persistence.support.ejb.ejbqlc.ParameterSupport

public class ParameterSupport
extends java.lang.Object

Helper class to handle EJBQL query parameters.

Author:

Michael Bouschen, Shing Wai Chan

Field Summary

protected static java.util.ResourceBundle

msgs I18N support.

Constructor Summary

ParameterSupport(java.lang.reflect.Method method)
Constructor.

Method Summary

int	getParameterCount() Returns the number of parameters.
java.lang.String	getParameterEjbName(int paramNumber) Get EJB name corresponding to the EJBQL parameter number.
java.lang.String	getParameterEjbName(java.lang.String ejbqlParamDecl) Get EJB name corresponding to the EJBQL parameter by input parameter declaration string.
java.lang.String[]	getParameterEjbNames() Get all EJB names corresponding to the EJBQL parameters.
java.lang.String	getParameterName(int paramNumber) Returns the name of the corresponding JDO parameter by parameter number.
java.lang.String	getParameterName(java.lang.String ejbqlParamDecl) Returns the name of the corresponding JDO parameter.
java.lang.Class	getParameterType(int paramNumber) Returns the type of the EJBQL parameter by number.
java.lang.Class	getParameterType(java.lang.String ejbqlParamDecl) Returns type of the EJBQL parameter by input parameter declaration string.
void	setParameterEjbName(java.lang.String ejbqlParamDecl, java.lang.String ejbName) Set EJB name corresponding to the EJBQL parameter by input parameter declaration string.

Methods inherited from class java.lang.Object

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

Field Detail

msgs

protected static final java.util.ResourceBundle msgs

I18N support.

Constructor Detail

ParameterSupport

public ParameterSupport(java.lang.reflect.Method method)

Constructor.

Parameters:

method - the Method instance of the finder/selector method.

Method Detail

getParameterType

public java.lang.Class getParameterType(java.lang.String ejbqlParamDecl)

Returns type of the EJBQL parameter by input parameter declaration string. The specified string denotes a parameter application in EJBQL. It has the form "?" where is the parameter number starting with 1.

Returns:

class instance representing the parameter type.

getParameterType

public java.lang.Class getParameterType(int paramNumber)

Returns the type of the EJBQL parameter by number. Note, the numbering of EJBQL parameters starts with 1, so the method expects 1 as the number of the first parameter.

Returns:

class instance representing the parameter type.

getParameterEjbName

public java.lang.String getParameterEjbName(java.lang.String ejbqlParamDecl)

Get EJB name corresponding to the EJBQL parameter by input parameter declaration string.

Parameters:

ejbqlParamDecl - denotes a parameter application in EJBQL. It has the form "?" where is the parameter number starting with 1.

Returns:

class instance representing the parameter type.

getParameterEjbName

public java.lang.String getParameterEjbName(int paramNumber)

Get EJB name corresponding to the EJBQL parameter number.

Parameters:

paramNumber - numbering of parameters starting with 1

Returns:

class instance representing the parameter type.

setParameterEjbName

public void setParameterEjbName(java.lang.String ejbqlParamDecl,
                                java.lang.String ejbName)

Set EJB name corresponding to the EJBQL parameter by input parameter declaration string.

Parameters:

ejbqlParamDecl - denotes a parameter application in EJBQL. It has the form "?" where is the parameter number starting with 1.

ejbName -

getParameterEjbNames

public java.lang.String[] getParameterEjbNames()

Get all EJB names corresponding to the EJBQL parameters.

Returns:

class instance representing the parameter type.

getParameterName

public java.lang.String getParameterName(java.lang.String ejbqlParamDecl)

Returns the name of the corresponding JDO parameter. The specified string denotes a parameter application in EJBQL. It has the form "?" where is the parameter number starting with 1.

Returns:

name of JDOQL parameter

getParameterName

public java.lang.String getParameterName(int paramNumber)

Returns the name of the corresponding JDO parameter by parameter number.

Returns:

name of JDOQL parameter

getParameterCount

public int getParameterCount()

Returns the number of parameters.

Returns:

parameter count.