xdoclet.modules.ejb.entity
public class PkTagsHandler extends EjbTagsHandler
Version: $Revision: 1.18 $
UNKNOWN: 13. juni 2002 namespace = "EjbPk"
Method Summary | |
---|---|
static boolean | classHasPrimkeyField(XClass clazz)
Returns true if the specified class has a primkey-field defined on the ejb.bean tag (opposed to having a separate
PK class).
|
String | extendsFrom()
Returns the name of the class pk class extends.
|
protected String | getDependentClassFor(XClass clazz, String type)
Gets the DependentClassFor attribute of the PkTagsHandler object
|
protected static String | getEntityPkClassPattern()
Returns the pattern which is used to calculate the Primary Key class' name from the EJB name. |
static String | getPkClassFor(XClass clazz)
Get the primary key class specified for a given class. |
static String | getPkClassForEjbJarXmlFor(XClass clazz)
Gets the PkClassForEjbJarXmlFor attribute of the PkTagsHandler class
|
static String | getPrimkeyFieldFor(XClass clazz)
Get the primary key field specified for a given class. |
static String | getPrimkeyGetterFor(XClass clazz)
Returns the getter method of the primary key field specified for a given class.
|
static String | getPrimkeySetterFor(XClass clazz)
Returns the setter method of the primary key field specified for a given class.
|
void | ifDoesntHavePrimkeyField(String template, Properties attributes)
Process the tag body if the current class doesn't have a defined primkey-field.
|
void | ifHasPrimkeyField(String template, Properties attributes)
Process the tag body if the current class has a defined primkey-field.
|
void | ifHasPrimkeySetter(String template, Properties attributes)
Process the tag body if the current class has defined a setter for the primkey-field.
|
void | ifIsNotPrimkeyField(String template, Properties attributes)
Process the tag body if the current method is not a getter or setter for the primkey-field.
|
void | ifIsPkField(String template)
Evaluates the body if the current method is a primary key field.
|
void | ifIsPrimkeyField(String template, Properties attributes)
Process the tag body if the current method is a getter or setter for the primkey-field.
|
static boolean | isMethodPrimkeyField(XClass clazz, XMethod method)
Test if a given method is the getter or setter for the primary key field specified for the class.
|
String | pkClass()
Returns the name of generated PK class for the current class.
|
String | pkClassForEjbJarXml()
Returns the name of PK class for the current class.
|
String | pkfieldList()
Returns a string containing comma-separated list of primary key fields with their types.
|
String | pkfieldListFrom(Properties attributes)
Returns a string containing comma-separated list of primary key fields getting from an object specified as
parameter.
|
String | primkeyField(Properties attributes)
Returns the primkey-field defined for the current class.
|
String | primkeyGetter(Properties attributes)
Returns the getter name for the primkey-field.
|
String | primkeySetter(Properties attributes)
Returns the setter name for the primkey-field.
|
Parameters: clazz The class to look into.
Returns: true if the class has a defined primkey-field
Throws: XDocletException
See Also: getPrimkeyFieldFor
Returns: superclass name
Throws: XDocletException
UNKNOWN: type = "content"
Parameters: clazz Describe what the parameter does type Describe what the parameter does
Returns: The DependentClassFor value
Throws: XDocletException
Returns: pattern
primkey-field
parameter on the ejb.bean
tag, this will be the return type of that
field's getter method. Otherwise, it will be determined by the various parameters of the ejb.pk
tag
and the subtask's settings for default pattern, packageSubstitution, etc.
Parameters: clazz The class to look into
Returns: Fully qualified name of the primary key's type
Throws: XDocletException
Parameters: clazz The class to look into
Returns: The PkClassForEjbJarXmlFor value
Throws: XDocletException
primkey-field
parameter
on the ejb.bean
tag, although this may be inherited from a superclass.
Parameters: clazz The class to look into
Returns: The value of the ejb.bean primkey-field parameter
Throws: XDocletException
Parameters: clazz The class to look into
Returns: The name of the ejb.bean primkey-field parameter's getter method, or null if there isn't one
Throws: XDocletException
See Also: getPrimkeyFieldFor
Parameters: clazz The class to look into
Returns: The name of the ejb.bean primkey-field parameter's setter method, or null if there isn't one
Throws: XDocletException
See Also: getPrimkeyFieldFor
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException
UNKNOWN: type = "block"
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException
UNKNOWN: type = "block"
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException
See Also: getPrimkeySetterFor
UNKNOWN: type = "block"
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException
UNKNOWN: type = "block"
Parameters: template The body of the block tag
Throws: XDocletException
UNKNOWN: type = "block"
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException
UNKNOWN: type = "block"
Parameters: clazz The class to look into method The method to check for primkey-field
Returns: true if the method is a getter or setter for the primkey-field
Throws: XDocletException
See Also: getPrimkeyFieldFor
Returns: The name of generated PK class.
Throws: XDocletException
UNKNOWN: type = "content"
Returns: The name of generated PK class.
Throws: XDocletException
UNKNOWN: type = "content"
Returns: A string containing comma-separated list of primary key fields with their types.
Throws: XDocletException
See Also: PersistentTagsHandler
UNKNOWN: type = "content"
Parameters: attributes The attributes of the template tag
Returns: A string containing comma-separated list of primary key fields without their types.
Throws: XDocletException
See Also: PersistentTagsHandler
UNKNOWN: type = "content" name = "name" optional = "false" description = "The name of the variable to get the fields * from."
Parameters: attributes The attributes of the template tag
Returns: The value of the ejb.bean primkey-field parameter
Throws: XDocletException
See Also: getPrimkeyFieldFor
UNKNOWN: type = "content"
Parameters: attributes The attributes of the template tag
Returns: The primkey-field getter
Throws: XDocletException
See Also: getPrimkeyGetterFor
UNKNOWN: type = "content"
Parameters: attributes The attributes of the template tag
Returns: The primkey-field setter
Throws: XDocletException
See Also: getPrimkeySetterFor
UNKNOWN: type = "content"