net.sf.mmapps.modules.mmbasedoclet
Class MMBaseDoclet

java.lang.Object
  com.sun.javadoc.Doclet
      net.sf.mmapps.modules.mmbasedoclet.MMBaseDoclet

public class MMBaseDoclet

extends com.sun.javadoc.Doclet

MMBaseDoclet is a javadoc doclet to create MMBase object models based on javadoc comments in files in a package. The doclet introduces new tags.

Application tags that give information about the MMBase application

NodeManager tagsthat define node managers

Relation type tags that give information about possible relation between nodemanagers

Relation manager tags that give information about possible relation between nodemanagers

mmbase-application-name	defines the name of the application	required
mmbase-application-depends	denotes an application depends of an other application	not required (muliple allowed)
mmbase-application-extends	denotes that application extends an other application(the application wil first be loaded) then the javadoc application will added to the applicatio it extends. it is possible to extend from multiple other applications	not required(multiple allowed)
mmbase-required-nodemanager	denotes the an application requires a certain node manager but the node manager is node deliverd in the application
mmbase-nodemanager-name	defines the name of a node manager this should always be the first tag to use when you are trying to define a nodemanager	required and unique
mmbase-nodemanager-extends	defines what configuration the nodemanager extends values van be object and insrel	default = "object"
mmbase-nodemanager-classfile	defines what java class file the node manager should use. if you haven't writen a special MMObjectBuilder is is best not to define this tag, the class file will be taken from the node manager configuration this object extends	not required
mmbase-nodemanager-version	integer value giving information about the version of the nodemanager	default ="1"
mmbase-nodemanager-maintainer	autho/organisation maintaining the node manager	default ="mmbase.org"
mmbase-nodemanager-searchage	default value in days for wich nodes from this nodemanager should not been show in the editor	default ="360"
mmbase-nodemanager-field	defines a field for the node manager. this value main contain 3 strings. the name of the field the type of the field (MMBase types like STRING/INTEGER) default = STRING the size of the field (default is 127 if applicable)	not required
mmbase-relationtype-name	defines the name/role of a relation (related,authorrel)	required but not unique
mmbase-relationtype-nodemanager	defines what nodemanager MMBase should use to store it's relation data. for example by using the posrel node manager one aditional field "pos" is available. The field contains the name of the nodemanager. the nodemanager should extend the insrel node manager	(default = "insrel")
mmbase-relationmanager-directionality	defines the directionalily of the relation. possible values are "bidirectional" and "unidirectional".	(default = "bidirectional"
mmbase-relationmanager-type	defines the name/role of a relation (related,authorrel)	required but not unique
mmbase-relationmanager-source	defines the source of the relation, this is the name of the nodemanager	required
mmbase-relationmanager-destination	defines the destination of the relation, this is the name of the nodemanager	required

Version:

$Id: MMBaseDoclet.java,v 1.3 2004/05/18 14:51:28 keesj Exp $

Author:

Kees Jongenburger

Constructor Summary

MMBaseDoclet()

Method Summary

static net.sf.mmapps.modules.config.FieldConfiguration	createFieldConfiguration(java.lang.String data, net.sf.mmapps.modules.config.Configuration config)
static net.sf.mmapps.modules.config.NodeManagerConfiguration	createNodeManagerConfiguration(com.sun.javadoc.Tag[] tags, int startIndex, int endIndex, net.sf.mmapps.modules.config.Configuration config)
static net.sf.mmapps.modules.config.RelationManagerConfiguration	createRelationManagerConfiguration(com.sun.javadoc.Tag[] tags, int startIndex, int endIndex, net.sf.mmapps.modules.config.Configuration config)
static net.sf.mmapps.modules.config.RelationType	createRelationType(com.sun.javadoc.Tag[] tags, int startIndex, int endIndex)
static int	optionLength(java.lang.String option)
static boolean	start(com.sun.javadoc.RootDoc root)
static boolean	validOptions(java.lang.String[][] options, com.sun.javadoc.DocErrorReporter reporter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MMBaseDoclet

public MMBaseDoclet()

Method Detail

start

public static boolean start(com.sun.javadoc.RootDoc root)

optionLength

public static int optionLength(java.lang.String option)

validOptions

public static boolean validOptions(java.lang.String[][] options,
                                   com.sun.javadoc.DocErrorReporter reporter)

createNodeManagerConfiguration

public static net.sf.mmapps.modules.config.NodeManagerConfiguration createNodeManagerConfiguration(com.sun.javadoc.Tag[] tags,
                                                                                                   int startIndex,
                                                                                                   int endIndex,
                                                                                                   net.sf.mmapps.modules.config.Configuration config)

createRelationManagerConfiguration

public static net.sf.mmapps.modules.config.RelationManagerConfiguration createRelationManagerConfiguration(com.sun.javadoc.Tag[] tags,
                                                                                                           int startIndex,
                                                                                                           int endIndex,
                                                                                                           net.sf.mmapps.modules.config.Configuration config)

createRelationType

public static net.sf.mmapps.modules.config.RelationType createRelationType(com.sun.javadoc.Tag[] tags,
                                                                           int startIndex,
                                                                           int endIndex)

createFieldConfiguration

public static net.sf.mmapps.modules.config.FieldConfiguration createFieldConfiguration(java.lang.String data,
                                                                                       net.sf.mmapps.modules.config.Configuration config)