|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectxdoclet.template.TemplateTagHandler
xdoclet.XDocletTagSupport
xdoclet.modules.ejb.EjbTagsHandler
xdoclet.modules.ejb.entity.EntityTagsHandler
xdoclet.modules.ejb.entity.CmpTagsHandler
xdoclet.modules.ejb.entity.PersistentTagsHandler
public class PersistentTagsHandler
Field Summary |
---|
Fields inherited from class xdoclet.modules.ejb.EjbTagsHandler |
---|
ALL, LOCAL_SUFFIX, SERVICE_ENDPOINT, SERVICE_ENDPOINT_SUFFIX |
Fields inherited from class xdoclet.XDocletTagSupport |
---|
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER |
Constructor Summary | |
---|---|
PersistentTagsHandler()
|
Method Summary | |
---|---|
static java.lang.String |
fieldList(xjavadoc.XClass clazz,
java.lang.String inclTag,
java.lang.String exclTag,
int type,
java.lang.String valueObject,
boolean superclasses)
Returns comma-separated list of fields, excluding fields that have tags of exclTag list, including fields that have tags of inclTag list. |
void |
forAllPersistentFields(java.lang.String template,
java.util.Properties attributes)
Evaluates the body for each persistent field. |
protected void |
forAllPersistentMatchedFields(java.lang.String template,
java.lang.String include_tags,
java.lang.String exclude_tags,
boolean superclasses,
java.lang.String valueObject)
Generate only for all Persisted Fields matching a specific XTag or Persisted fields that do not match a specific Tag |
protected java.lang.String[] |
getPkFieldsInHeader()
Returns an array containing ejb:pk-field tags defined in class level. |
void |
ifHasAtLeastOnePersistentField(java.lang.String template)
Evaluates the body if the class has at least one persistent field. |
void |
ifHasAtLeastOnePkField(java.lang.String template)
Evaluates the body if the class has at least one primary key field. |
static boolean |
isPersistentField(xjavadoc.XMethod method)
Returns true if method is a persistent field, false otherwise. |
static boolean |
isPkField(xjavadoc.XMethod method)
Returns true if method is a primary key field, false otherwise. |
static boolean |
isPkFieldInHeader(xjavadoc.XClass clazz)
Returns true if clazz has ejb:pk-field defined. |
static boolean |
isValueObjectField(xjavadoc.XClass clazz,
xjavadoc.XMethod method,
java.lang.String valueObject)
Gets the ValueObjectField attribute of the PersistentTagsHandler class |
java.lang.String |
persistentfieldList(java.util.Properties attributes)
Returns a string containing comma-separated list of persistent fields with their types. |
java.lang.String |
persistentfieldNameValueList()
Returns a string containing comma-separated list of persistent fields without their types in fieldname="value" format. |
java.lang.String |
persistentfieldNameValueList(java.util.Properties attributes)
Returns a string containing comma-separated list of persistent fields without their types in fieldname="value" format. |
Methods inherited from class xdoclet.modules.ejb.entity.CmpTagsHandler |
---|
dbmsColumn, dbmsTable, entityCmpClass, fieldName, forAllCmpEntityBeans, forAllCmpFields, getEntityCmpClassFor, getEntityCmpClassPattern, getFieldNameFor, ifEntityIsCmp, ifIsPersistent, ifNotUsingCmp2, ifUsingCmp2, isEntityCmp, isUsingCmp2Impl |
Methods inherited from class xdoclet.modules.ejb.entity.EntityTagsHandler |
---|
forAllEjbSelectMethods, forAllEntityBeans, ifEntity, isEjbSelectMethod, isEntity, persistenceType, reentrant |
Methods inherited from class xdoclet.template.TemplateTagHandler |
---|
getXJavaDoc, setXJavaDoc |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PersistentTagsHandler()
Method Detail |
---|
public static boolean isPersistentField(xjavadoc.XMethod method)
method
- Description of Parameter
public static boolean isValueObjectField(xjavadoc.XClass clazz, xjavadoc.XMethod method, java.lang.String valueObject) throws XDocletException
clazz
- Describe what the parameter doesmethod
- Describe what the parameter doesvalueObject
- Describe what the parameter does
XDocletException
public static boolean isPkField(xjavadoc.XMethod method)
method
- Description of Parameter
public static boolean isPkFieldInHeader(xjavadoc.XClass clazz)
clazz
- Description of Parameter
public static java.lang.String fieldList(xjavadoc.XClass clazz, java.lang.String inclTag, java.lang.String exclTag, int type, java.lang.String valueObject, boolean superclasses) throws XDocletException
clazz
- Description of ParameterinclTag
- Fields that have at least of the tags of this comma-separated list are used.exclTag
- Fields that don't have all of the tags of this comma-separated list are used.type
- Type of return (0: comma separated list - 1: field=value comma separated list - 2:
getter comma sperated list, 3: comma separated name list)valueObject
- superclasses
-
XDocletException
public void ifHasAtLeastOnePkField(java.lang.String template) throws XDocletException
template
- The body of the block tag
XDocletException
public void ifHasAtLeastOnePersistentField(java.lang.String template) throws XDocletException
template
- The body of the block tag
XDocletException
public void forAllPersistentFields(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
forAllPersistentMatchedFields(java.lang.String,java.lang.String,java.lang.String,boolean,java.lang.String)
public java.lang.String persistentfieldNameValueList(java.util.Properties attributes) throws XDocletException
attributes
-
XDocletException
fieldList(XClass, String, String, int, String, boolean)
public java.lang.String persistentfieldList(java.util.Properties attributes) throws XDocletException
attributes
-
XDocletException
fieldList(XClass, String, String, int, String, boolean)
public java.lang.String persistentfieldNameValueList() throws XDocletException
XDocletException
fieldList(XClass, String, String, int, String, boolean)
protected java.lang.String[] getPkFieldsInHeader() throws XDocletException
XDocletException
protected void forAllPersistentMatchedFields(java.lang.String template, java.lang.String include_tags, java.lang.String exclude_tags, boolean superclasses, java.lang.String valueObject) throws XDocletException
template
- The body of the block taginclude_tags
- only fields having these tagsexclude_tags
- only fields not having these tagssuperclasses
- traverse superclasses toovalueObject
-
XDocletException
forAllPersistentFields(java.lang.String,java.util.Properties)
|
http://xdoclet.sourceforge.net/ | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |