|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.generama.Plugin
org.generama.defaults.QDoxPlugin
org.objectweb.fractal.fraclet.FractalPlugin
Abstract Fractal plugin supporting Jelly and Velocity as template engines.
Field Summary | |
protected static String |
AC_NAME
|
protected static String |
ATTR_CTRL
|
protected static String |
ATTR_NAME
|
protected static String |
BC_NAME
|
protected static String |
FC_CONTROL
Fractal control interface package exluded by the generation engine. |
protected static String |
ITF_NAME
|
protected static String |
LOG_NAME
|
protected static String |
OBJECT
|
protected static String |
RC_NAME
|
Fields inherited from class org.generama.defaults.QDoxPlugin |
metadataProvider |
Fields inherited from class org.generama.Plugin |
DONTEDIT, writerMapper |
Constructor Summary | |
FractalPlugin(JellyTemplateEngine jelly,
QDoxCapableMetadataProvider qdox,
WriterMapper writer)
Constructor used to generate XML files. |
|
FractalPlugin(VelocityTemplateEngine velocity,
QDoxCapableMetadataProvider qdox,
WriterMapper writer)
Constructor used to generate Java or Property files. |
Method Summary | |
String |
attributeController(JavaClass cls)
Returns the name of the attribute controller. |
String |
attributeName(JavaField fld)
Computes the name of the attribute (field name if no tag specified). |
JavaField[] |
attributes(JavaClass cls,
boolean all)
Provides the list of component attribute fields. |
String |
bindingName(JavaField fld)
Computes the binding name (the field name if no tag specified). |
JavaField[] |
bindings(JavaClass cls,
boolean all)
Provides the list of bindings defined by the class. |
String |
bindingSignature(JavaField fld)
Computes the binding signature (the field signature if no tag specified). |
protected JavaClass[] |
extend(JavaClass cls)
Provides a list of business classes at the first level. |
protected JavaField[] |
fields(JavaClass cls,
String doclet,
boolean all)
Provides a list of filtered fields. |
String |
fullname(JavaClass cls)
Provides the fully qualified name of the component depending on the filename. |
boolean |
hasAttributes(JavaClass cls,
boolean all)
Checks if the component defines some attribute. |
boolean |
hasBindings(JavaClass cls,
boolean all)
Checks if the class defines some binding. |
boolean |
hasGlue(JavaClass cls)
Checks if a component glue need to be generated. |
boolean |
hasLogger(JavaClass cls,
boolean all)
Checks if the class defines a logger. |
boolean |
hasReflects(JavaClass cls,
boolean all)
Checks if the component defines some control fields. |
boolean |
isAttributeController(JavaClass cls)
Checks if the interface is an attribute controller. |
boolean |
isComponent(JavaClass cls)
Checks if the class is considered as a component. |
boolean |
isController(JavaClass cls)
Checks if the class is a controller (attribute, binding, lifecycle, etc.). |
boolean |
isInterface(JavaClass cls)
Checks if the class defines fractal interface(s). |
boolean |
isPrimitive(JavaClass cls)
Checks if the class is a primitive component. |
JavaField |
logger(JavaClass cls,
boolean all)
Provides the reference to the last logger declared. |
String |
loggerName(JavaField fld)
Provides the name of the logger associated to the field. |
String |
name(JavaClass cls)
Provides the short name of the component depending on the filename. |
String |
packagePrefix(JavaClass cls)
Provides the prefix of the package (empty if no package). |
JavaField[] |
reflects(JavaClass cls,
boolean all)
Provides the list of component control fields. |
String |
superAttributeController(JavaClass cls)
Return the name of super attribute controller. |
Methods inherited from class org.generama.defaults.QDoxPlugin |
getMetadata, getMetadataProvider, setRestrictedpath, shouldGenerate |
Methods inherited from class org.generama.Plugin |
assertTrue, getContextObjects, getDestdirFile, getDestinationFilename, getDestinationPackage, getEncoding, getOutputValidator, getPackageName, getWriterMapper, isEmpty, isMultioutput, isValidate, populateContextMap, preGenerate, setDestdir, setEncoding, setFileregex, setFilereplace, setMultioutput, setOutputValidator, setPackageregex, setPackagereplace, setValidate, start, stop |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static final String FC_CONTROL
protected static final String ATTR_NAME
protected static final String ATTR_CTRL
protected static final String OBJECT
protected static final String ITF_NAME
protected static final String BC_NAME
protected static final String AC_NAME
protected static final String RC_NAME
protected static final String LOG_NAME
Constructor Detail |
public FractalPlugin(JellyTemplateEngine jelly, QDoxCapableMetadataProvider qdox, WriterMapper writer)
jelly
- Jelly template engine used to generate artifacts.qdox
- QDox source code metadata provider.writer
- the output writer.public FractalPlugin(VelocityTemplateEngine velocity, QDoxCapableMetadataProvider qdox, WriterMapper writer)
velocity
- Velocity template engine used to generate artifacts.qdox
- QDox source code metadata provider.writer
- the output writer.Method Detail |
public String name(JavaClass cls)
cls
- the java class source file parsed.
public String fullname(JavaClass cls)
cls
- the java class source file parsed.
public String packagePrefix(JavaClass cls)
cls
- the class used.
public boolean hasGlue(JavaClass cls)
cls
- the class to check.
public boolean isInterface(JavaClass cls)
cls
- the class to check.
public boolean isComponent(JavaClass cls)
cls
- the class to check.
public boolean isPrimitive(JavaClass cls)
cls
- the class to check.
public boolean isController(JavaClass cls)
cls
- the class to check.
public boolean isAttributeController(JavaClass cls)
cls
- the java class source file parsed.
protected JavaClass[] extend(JavaClass cls)
cls
- the class considered.
protected JavaField[] fields(JavaClass cls, String doclet, boolean all)
cls
- the java class source file parsed.doclet
- the name of the doclet to retrieve.
public JavaField[] bindings(JavaClass cls, boolean all)
cls
- the java class source file parsed.
public boolean hasBindings(JavaClass cls, boolean all)
cls
- the java class source file parsed.
public String bindingName(JavaField fld)
fld
- the java field source file parsed.
public String bindingSignature(JavaField fld)
fld
- the java field source file parsed.
public JavaField[] attributes(JavaClass cls, boolean all)
cls
- the java class source file parsed.
public boolean hasAttributes(JavaClass cls, boolean all)
cls
- the java class source file parsed.
public String superAttributeController(JavaClass cls)
cls
- the class considered.
public String attributeController(JavaClass cls)
cls
- the class considered.
public String attributeName(JavaField fld)
fld
- the java field source file parsed.
public JavaField[] reflects(JavaClass cls, boolean all)
cls
- the java class source file parsed.
public boolean hasReflects(JavaClass cls, boolean all)
cls
- the java class source file parsed.
public JavaField logger(JavaClass cls, boolean all)
cls
- the reference to the logger.
public boolean hasLogger(JavaClass cls, boolean all)
cls
- the class to check.
public String loggerName(JavaField fld)
fld
- the field referencing the logger.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |