Main Page | Packages | Class Hierarchy | Class List | File List | Class Members | Related Pages | Search for 

org.objectweb.jonas_ejb.genic.VcMethod Class Reference

List of all members.

Public Member Functions

String getName ()
String getCapName ()
String getFormalParameters ()
String getActualParameters ()
String getExceptionList ()
boolean canThrowCreate ()
String getSecuritySignature ()
int getTxAttribute ()
String getReturnType ()
boolean isFinderAll ()
boolean isFinderByPk ()
boolean isFinderSimple ()
boolean isFinderEnum ()
boolean isFinderCol ()
boolean isEjbSelectSimple ()
boolean isEjbSelectSet ()
boolean isEjbSelectCol ()
boolean isEjbqlReturnRemoteBean ()
boolean isEjbqlReturnLocalBean ()
boolean isCreate ()
boolean isEjbCreate ()
boolean isEjbPostCreate ()
boolean isRemoveThis ()
boolean isRemovePk ()
boolean isRemoveHandle ()
boolean isEjbRemove ()
boolean isEjbLoad ()
boolean isEjbStore ()
boolean isEjbSetEntityContext ()
boolean isEjbActivate ()
String getSqlStmt ()
Class[] getParameterTypes ()
int getParametersNumber ()
Vector getParamWhereList ()
Vector getParamList ()
int getMethodIndex ()
org.objectweb.medor.api.Field getResFieldOfEjbql ()
String getTupleGetter ()
boolean isTupleGetterPrimitive ()
String getTupleGetterObjectClass ()
String getArrayObjectParameters ()
String toString ()

Package Functions

 VcMethod (Method method, MethodDesc methodDesc, BeanDesc dd)
String[] splitPath (String path)

Static Package Attributes

final byte METHOD_CREATE = 0
final byte METHOD_EJB_CREATE = 1
final byte METHOD_EJB_POST_CREATE = 2
final byte METHOD_REMOVE_THIS = 10
final byte METHOD_REMOVE_PK = 11
final byte METHOD_REMOVE_HANDLE = 12
final byte METHOD_EJB_REMOVE = 13
final byte METHOD_FINDER_BY_PK = 20
final byte METHOD_FINDER_ALL = 21
final byte METHOD_FINDER_SIMPLE = 22
final byte METHOD_FINDER_ENUM = 23
final byte METHOD_FINDER_COL = 24
final byte METHOD_EJB_SELECT_SIMPLE = 30
final byte METHOD_EJB_SELECT_COL = 31
final byte METHOD_EJB_SELECT_SET = 32
final byte METHOD_EJB_LOAD = 40
final byte METHOD_EJB_STORE = 41
final byte METHOD_EJB_SET_ENTITY_CONTEXT = 42
final byte METHOD_EJB_ACTIVATE = 43

Detailed Description

This class is the "Velocity context" for a interface method or a bean method used in the Velocity Templates.
Author:
Helene Joanin (Bull) : Initial developer

Santiago Gala (sgala@hisitech.com) - 00/09/14 - Parameters can be followed by a number in the WHERE clause

Joe Gittings has proposed to code method signature for security in order to avoid same signature for inherited methods.

Definition at line 58 of file VcMethod.java.

Constructor & Destructor Documentation

org.objectweb.jonas_ejb.genic.VcMethod.VcMethod (  Method  method,
MethodDesc  methodDesc,
BeanDesc  dd
)  [package]
 

VcMethod constructor

Parameters:
method java.lang.reflect.Method method description
methodDesc method description
dd bean description of the associated bean

Definition at line 259 of file VcMethod.java.

References org.objectweb.jonas_ejb.deployment.api.EntityCmpDesc.getCmpFieldDescIterator(), org.objectweb.jonas_ejb.deployment.api.BeanDesc.getEjbName(), org.objectweb.jonas_ejb.deployment.api.MethodDesc.getIndex(), org.objectweb.jonas_ejb.deployment.api.FieldJdbcDesc.getJdbcFieldName(), org.objectweb.jonas_ejb.deployment.api.EntityJdbcCmp1Desc.getJdbcTableName(), org.objectweb.jonas_ejb.deployment.api.MethodDesc.getRoleName(), org.objectweb.jonas_ejb.deployment.api.MethodDesc.getTxAttribute(), org.objectweb.jonas_ejb.deployment.api.MethodDesc.isExcluded(), and org.objectweb.jonas_ejb.deployment.api.FieldDesc.isPrimaryKey().

Here is the call graph for this function:

Member Function Documentation

boolean org.objectweb.jonas_ejb.genic.VcMethod.canThrowCreate (   ) 
 

Returns:
Return true if the method throws the javax.ejb.createException exception

Definition at line 679 of file VcMethod.java.

String org.objectweb.jonas_ejb.genic.VcMethod.getActualParameters (   ) 
 

Returns:
Return the string representation of the actual parameters list (ie "p1, p2")

Definition at line 665 of file VcMethod.java.

References org.objectweb.jonas_ejb.deployment.api.EntityJdbcCmp1Desc.toString().

Here is the call graph for this function:

String org.objectweb.jonas_ejb.genic.VcMethod.getArrayObjectParameters (   ) 
 

Gets an empty array if no parameters and return an array of objects of the parameters if any

Returns:
array of objects

Definition at line 1041 of file VcMethod.java.

References org.objectweb.jonas_ejb.deployment.api.EntityJdbcCmp1Desc.toString().

Here is the call graph for this function:

String org.objectweb.jonas_ejb.genic.VcMethod.getCapName (   ) 
 

Returns:
Return the name of the method with the first letter capitalized

Definition at line 651 of file VcMethod.java.

String org.objectweb.jonas_ejb.genic.VcMethod.getExceptionList (   ) 
 

Returns:
Return the string representation of the exception list of the method

Definition at line 672 of file VcMethod.java.

References org.objectweb.jonas_ejb.deployment.api.EntityJdbcCmp1Desc.toString().

Here is the call graph for this function:

String org.objectweb.jonas_ejb.genic.VcMethod.getFormalParameters (   ) 
 

Returns:
Return the string representation of the formal parameters list (ie "int p1, String p2")

Definition at line 658 of file VcMethod.java.

References org.objectweb.jonas_ejb.deployment.api.EntityJdbcCmp1Desc.toString().

Here is the call graph for this function:

int org.objectweb.jonas_ejb.genic.VcMethod.getMethodIndex (   ) 
 

Returns:
Return the index of the method. This is a unique index for each method of a bean.

Definition at line 916 of file VcMethod.java.

String org.objectweb.jonas_ejb.genic.VcMethod.getName (   ) 
 

Returns:
Return the name of the method

Definition at line 644 of file VcMethod.java.

int org.objectweb.jonas_ejb.genic.VcMethod.getParametersNumber (   ) 
 

Returns:
Return the number of the parameters of the method

Definition at line 883 of file VcMethod.java.

Class [] org.objectweb.jonas_ejb.genic.VcMethod.getParameterTypes (   ) 
 

Returns:
Return the Class array of the parameters of the method

Definition at line 876 of file VcMethod.java.

Vector org.objectweb.jonas_ejb.genic.VcMethod.getParamList (   ) 
 

Returns:
Return the VcParam list of the method

Definition at line 904 of file VcMethod.java.

Vector org.objectweb.jonas_ejb.genic.VcMethod.getParamWhereList (   ) 
 

Only for CMP1 finder methods

Returns:
Return the VcParamWhere list of the method

Definition at line 892 of file VcMethod.java.

org.objectweb.medor.api.Field org.objectweb.jonas_ejb.genic.VcMethod.getResFieldOfEjbql (   ) 
 

Only for CMP2 finder/select methods

Returns:
Return the Medor field of tuple result of an Finder/Select method

Definition at line 924 of file VcMethod.java.

String org.objectweb.jonas_ejb.genic.VcMethod.getReturnType (   ) 
 

Returns:
Return the name of the return type of the method

Definition at line 708 of file VcMethod.java.

String org.objectweb.jonas_ejb.genic.VcMethod.getSecuritySignature (   ) 
 

Returns:
Return the string representation of the security signature of the method

Definition at line 686 of file VcMethod.java.

String org.objectweb.jonas_ejb.genic.VcMethod.getSqlStmt (   ) 
 

Only for CMP1 finder methods

Returns:
Return the string representation of the SQL statement associated to the method

Definition at line 864 of file VcMethod.java.

String org.objectweb.jonas_ejb.genic.VcMethod.getTupleGetter (   ) 
 

Only for CMP2 finder/select methods

Returns:
Return the Medor get method name of the tuple result of an ejbSelect method

Definition at line 932 of file VcMethod.java.

String org.objectweb.jonas_ejb.genic.VcMethod.getTupleGetterObjectClass (   ) 
 

Only for CMP2 finder/select methos

Returns:
Return the associated class of the Medor getter method of the tuple result of an ejbSelect method when it's a primtive type

Definition at line 999 of file VcMethod.java.

int org.objectweb.jonas_ejb.genic.VcMethod.getTxAttribute (   ) 
 

Returns:
Return the transactional attribute associated to the method

Definition at line 697 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isCreate (   ) 
 

Returns:
Return true if the method is home.create()

Definition at line 786 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isEjbActivate (   ) 
 

Returns:
Return true if the method is bean.ejbActivate()

Definition at line 856 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isEjbCreate (   ) 
 

Returns:
Return true if the method is bean.ejbCreate()

Definition at line 793 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isEjbLoad (   ) 
 

Returns:
Return true if the method is bean.ejbLoad()

Definition at line 835 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isEjbPostCreate (   ) 
 

Returns:
Return true if the method is bean.ejbPostCreate()

Definition at line 800 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isEjbqlReturnLocalBean (   ) 
 

Returns:
Return true if the method is a finder/select method that return a local bean

Definition at line 779 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isEjbqlReturnRemoteBean (   ) 
 

Returns:
Return true if the method is a finder/select method that return a remote bean

Definition at line 772 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isEjbRemove (   ) 
 

Returns:
Return true if the method is bean.ejbRemove()

Definition at line 828 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isEjbSelectCol (   ) 
 

Returns:
Return true if the method is an ejbSelect method that returns a Collection

Definition at line 765 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isEjbSelectSet (   ) 
 

Returns:
Return true if the method is an ejbSelect method that returns a Set

Definition at line 758 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isEjbSelectSimple (   ) 
 

Returns:
Return true if the method is an ejbSelect method that returns a unique object

Definition at line 751 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isEjbSetEntityContext (   ) 
 

Returns:
Return true if the method is bean.setEntityContext()

Definition at line 849 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isEjbStore (   ) 
 

Returns:
Return true if the method is bean.ejbStore()

Definition at line 842 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isFinderAll (   ) 
 

Returns:
Return false because we are not able to know if a finder method is a FinderAll method !!

Definition at line 715 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isFinderByPk (   ) 
 

Returns:
Return true if the method is the findByPrimaryKey() method

Definition at line 723 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isFinderCol (   ) 
 

Returns:
Return true if the method is a finder method that returns a Collection

Definition at line 744 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isFinderEnum (   ) 
 

Returns:
Return true if the method is a finder method that returns a Enumeration

Definition at line 737 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isFinderSimple (   ) 
 

Returns:
Return true if the method is a finder method that returns a unique object

Definition at line 730 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isRemoveHandle (   ) 
 

Returns:
Return true if the method is home.remove(handle);

Definition at line 821 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isRemovePk (   ) 
 

Returns:
Return true if the method is home.remove(primarykey)

Definition at line 814 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isRemoveThis (   ) 
 

Returns:
Return true if the method is EJBObject.remove() method

Definition at line 807 of file VcMethod.java.

boolean org.objectweb.jonas_ejb.genic.VcMethod.isTupleGetterPrimitive (   ) 
 

Only for CMP2 finder/select methods

Returns:
Return true is the return type of the Medor getter method of the tuple result of an ejbSelect method is a primitive type

Definition at line 978 of file VcMethod.java.

String [] org.objectweb.jonas_ejb.genic.VcMethod.splitPath (  String  path  )  [package]
 

Split a dot separated path into tokens

Parameters:
path input path to split
Returns:
Return the string array of the splited token

Definition at line 1028 of file VcMethod.java.

String org.objectweb.jonas_ejb.genic.VcMethod.toString (   ) 
 

Returns:
Return a string representation of the VcMethod object for debug use

Definition at line 1053 of file VcMethod.java.

Member Data Documentation

final byte org.objectweb.jonas_ejb.genic.VcMethod.METHOD_CREATE = 0 [static, package]
 

home.create method

Definition at line 63 of file VcMethod.java.

final byte org.objectweb.jonas_ejb.genic.VcMethod.METHOD_EJB_ACTIVATE = 43 [static, package]
 

bean.ejbActivate() method

Definition at line 135 of file VcMethod.java.

final byte org.objectweb.jonas_ejb.genic.VcMethod.METHOD_EJB_CREATE = 1 [static, package]
 

bean.ebjCreate method

Definition at line 67 of file VcMethod.java.

final byte org.objectweb.jonas_ejb.genic.VcMethod.METHOD_EJB_LOAD = 40 [static, package]
 

bean.ejbLoad() method

Definition at line 123 of file VcMethod.java.

final byte org.objectweb.jonas_ejb.genic.VcMethod.METHOD_EJB_POST_CREATE = 2 [static, package]
 

bean.ejbPostCreate method

Definition at line 71 of file VcMethod.java.

final byte org.objectweb.jonas_ejb.genic.VcMethod.METHOD_EJB_REMOVE = 13 [static, package]
 

bean.ejbRemove() method

Definition at line 87 of file VcMethod.java.

final byte org.objectweb.jonas_ejb.genic.VcMethod.METHOD_EJB_SELECT_COL = 31 [static, package]
 

bean.ejbSelectXxx() method that returns a Collection

Definition at line 115 of file VcMethod.java.

final byte org.objectweb.jonas_ejb.genic.VcMethod.METHOD_EJB_SELECT_SET = 32 [static, package]
 

bean.ejbSelectXxx() method that returns a Set

Definition at line 119 of file VcMethod.java.

final byte org.objectweb.jonas_ejb.genic.VcMethod.METHOD_EJB_SELECT_SIMPLE = 30 [static, package]
 

bean.ejbSelectXxx() method that returns a simple object

Definition at line 111 of file VcMethod.java.

final byte org.objectweb.jonas_ejb.genic.VcMethod.METHOD_EJB_SET_ENTITY_CONTEXT = 42 [static, package]
 

bean.setEntityContext() method

Definition at line 131 of file VcMethod.java.

final byte org.objectweb.jonas_ejb.genic.VcMethod.METHOD_EJB_STORE = 41 [static, package]
 

bean.ejbStore() method

Definition at line 127 of file VcMethod.java.

final byte org.objectweb.jonas_ejb.genic.VcMethod.METHOD_FINDER_ALL = 21 [static, package]
 

home.findXxx() method

Definition at line 95 of file VcMethod.java.

final byte org.objectweb.jonas_ejb.genic.VcMethod.METHOD_FINDER_BY_PK = 20 [static, package]
 

home.findByPrimaryKey(pk) method

Definition at line 91 of file VcMethod.java.

final byte org.objectweb.jonas_ejb.genic.VcMethod.METHOD_FINDER_COL = 24 [static, package]
 

home.findXxx() method that returns a Collection

Definition at line 107 of file VcMethod.java.

final byte org.objectweb.jonas_ejb.genic.VcMethod.METHOD_FINDER_ENUM = 23 [static, package]
 

home.findXxx() method that returns an Enumeration

Definition at line 103 of file VcMethod.java.

final byte org.objectweb.jonas_ejb.genic.VcMethod.METHOD_FINDER_SIMPLE = 22 [static, package]
 

home.findXxx() method that returns a simple object

Definition at line 99 of file VcMethod.java.

final byte org.objectweb.jonas_ejb.genic.VcMethod.METHOD_REMOVE_HANDLE = 12 [static, package]
 

home.remove(handle) method

Definition at line 83 of file VcMethod.java.

final byte org.objectweb.jonas_ejb.genic.VcMethod.METHOD_REMOVE_PK = 11 [static, package]
 

home.remove(primarykey) method

Definition at line 79 of file VcMethod.java.

final byte org.objectweb.jonas_ejb.genic.VcMethod.METHOD_REMOVE_THIS = 10 [static, package]
 

EJBObject.remove() method

Definition at line 75 of file VcMethod.java.

The documentation for this class was generated from the following file:
Generated on Tue Feb 15 15:11:49 2005 for JOnAS by  doxygen 1.3.9.1