|
||||||||||
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.Plugin
org.objectweb.fractal.fraclet.FractalPlugin
public abstract class FractalPlugin
Abstract Fractal plugin supporting Jelly and Velocity as template engines.
Field Summary | |
---|---|
protected static String |
ATTR_CTRL
|
protected static String |
ATTR_NAME
|
protected static String |
ATTRIBUTE_NAME
|
protected static String |
COMP_PREFIX
|
protected static String |
COMPONENT
|
protected static String |
CONTROL
|
protected static String |
FC_CONTROL
Fractal control interface package exluded by the generation engine. |
protected static String |
LIFECYCLE
|
protected static String |
LOGGER_NAME
|
protected static String |
PROVIDES
|
protected static String |
REQUIRES
|
Fields inherited from class org.objectweb.fractal.fraclet.Plugin |
---|
OBJECT, shouldGenerate |
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)
|
|
FractalPlugin(VelocityTemplateEngine velocity,
QDoxCapableMetadataProvider qdox,
WriterMapper writer)
|
Method Summary | |
---|---|
String |
attributeController(JavaClass cls)
Returns the name of the attribute controller. |
String |
attributeControllerFullname(JavaClass cls)
Provides the fullname of the attribute-controller associated to the component. |
String |
attributeControllerName(JavaClass cls)
Provides the fullname of the attribute-controller associated to the component. |
String |
attributeName(JavaField f)
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 f)
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 f)
Computes the binding signature (the field signature if no tag specified). |
String |
componentFullname(JavaClass cls)
Provides the fully qualified name of the component depending on the filename. |
String |
componentName(JavaClass cls)
Provides the short name of the component depending on the filename. |
String |
componentPackage(JavaClass cls)
Provides the label of the component's package. |
protected JavaClass[] |
extend(JavaClass cls)
Provides a list of business classes at the first level. |
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 |
hasLifecycles(JavaClass cls,
boolean all)
Checks if the component defines some lifecycle handler. |
boolean |
hasLogger(JavaClass cls,
boolean all)
Checks if the class defines a logger. |
boolean |
hasPackage(JavaClass cls)
Checks if the class defines a package. |
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 |
isData(JavaClass cls)
Checks if the class defines fractal interface(s). |
boolean |
isInterface(JavaClass cls)
Checks if the class defines fractal interface(s). |
boolean |
isPrimitive(JavaClass cls)
Checks if the class is a primitive component. |
JavaMethod[] |
lifecycles(JavaClass cls,
boolean all)
Provides the list of lifecycle handlers. |
String |
loggerName(JavaField f)
Provides the name of the logger associated to the field. |
JavaField[] |
loggers(JavaClass cls,
boolean all)
Provides the reference to the last logger declared. |
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.objectweb.fractal.fraclet.Plugin |
---|
debug, failure, fields, getDestinationFilename, getDestinationPackage, methods, setDestination, shouldGenerate, toInt |
Methods inherited from class org.generama.defaults.QDoxPlugin |
---|
getMetadata, getMetadataProvider, setRestrictedpath |
Methods inherited from class org.generama.Plugin |
---|
assertTrue, getContextObjects, getDestdirFile, 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 COMP_PREFIX
protected static final String COMPONENT
protected static final String PROVIDES
protected static final String REQUIRES
protected static final String ATTRIBUTE_NAME
protected static final String CONTROL
protected static final String LOGGER_NAME
protected static final String LIFECYCLE
Constructor Detail |
---|
public FractalPlugin(JellyTemplateEngine jelly, QDoxCapableMetadataProvider qdox, WriterMapper writer)
public FractalPlugin(VelocityTemplateEngine velocity, QDoxCapableMetadataProvider qdox, WriterMapper writer)
Method Detail |
---|
public String componentName(JavaClass cls)
cls
- the java class source file parsed.
public String componentPackage(JavaClass cls)
cls
- the class associated to the component.
public boolean hasPackage(JavaClass cls)
cls
- the class to check.
public String packagePrefix(JavaClass cls)
cls
- the class used.
public String componentFullname(JavaClass cls)
cls
- the java class source file parsed.
public boolean hasGlue(JavaClass cls)
cls
- the class to check.
public boolean isInterface(JavaClass cls)
cls
- the class to check.
public boolean isData(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.
public JavaField[] bindings(JavaClass cls, boolean all)
cls
- the java class source file parsed.all
- performs the search recursively.
public boolean hasBindings(JavaClass cls, boolean all)
cls
- the java class source file parsed.all
- performs the search recursively.
public String bindingName(JavaField f)
f
- the java field source file parsed.
public String bindingSignature(JavaField f)
f
- the java field source file parsed.
public JavaField[] attributes(JavaClass cls, boolean all)
cls
- the java class source file parsed.all
- performs the search recursively.
public boolean hasAttributes(JavaClass cls, boolean all)
cls
- the java class source file parsed.all
- performs the search recursively.
public String attributeControllerName(JavaClass cls)
cls
- the component.
public String attributeControllerFullname(JavaClass cls)
cls
- the component.
public String superAttributeController(JavaClass cls)
cls
- the class considered.
public String attributeController(JavaClass cls)
cls
- the class considered.
public String attributeName(JavaField f)
f
- the java field source file parsed.
public JavaField[] reflects(JavaClass cls, boolean all)
cls
- the java class source file parsed.all
- performs the search recursively.
public boolean hasReflects(JavaClass cls, boolean all)
cls
- the java class source file parsed.all
- performs the search recursively.
public JavaField[] loggers(JavaClass cls, boolean all)
cls
- the reference to the logger.all
- performs the search recursively.
public boolean hasLogger(JavaClass cls, boolean all)
cls
- the class to check.all
- performs the search recursively.
public String loggerName(JavaField f)
f
- the field referencing the logger.
public JavaMethod[] lifecycles(JavaClass cls, boolean all)
cls
- the java class source file parsed.all
- performs the search recursively.
public boolean hasLifecycles(JavaClass cls, boolean all)
cls
- the java class source file parsed.all
- performs the search recursively.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |