Castor Doclet - Tags
 
 JDO
 

JDO doclet tags :

Tag Mapping element Value JDO XML
Class Tags
@table <map-to table=...> #CDATA - if this tag is not defined, the class won't be mapped X  
@xml <map-to xml=...> #CDATA - if this tag is not defined, the class won't be mapped   X
@key-generator <class key-generator=...>   X  
@access <class access=...> read-only | shared | exclusive | db-locked X  
@depends <class depends=...> #CDATA X  
@cache-type <cache-type type=...> none | count-limited | time-limited | unlimited X  
@cache-capacity <cache-type capacity=...> #CDATA X  
Field Tags
@primary-key <class identity=...> #EMPTY - Supports mutiple primary keys (castor0.9 and +) X  
@field-name <field name=...> #CDATA X  
@field-type <field type=...> #CDATA X  
@lazy <field lazy="true"> #EMPTY X  
@required <field required="true"> #EMPTY X  
@get-method <field get-method=...> #CDATA X  
@set-method <field set-method=...> #CDATA X  
@create-method <field create-method=...> #CDATA X  
@many-table <field many-table=...> #CDATA X  
@many-key <field many-key=...> #CDATA X  
@compound   #EMPTY - Compound field X  
@sql-name <sql name=...> #CDATA X  
@sql-type <sql type=...> #CDATA X  
@sql-dirty <sql dirty=...> check | ignore X  
@xml-name <bind-xml name=...> #CDATA - Default value is set by @field-name   X
@xml-node <bind-xml node=...> element | attribute | text   X
@xml-matches <bind-xml matches=...> #CDATA   X
 DDL
 

DDL doclet tags :

Tag Domain Comment
Class Tags
@table #CDATA Name of the table
Field Tags
@primary-key #EMPTY  
@field-name #CDATA Field name
@compound #EMPTY Compound fields
@sql-name #CDATA Name of the SQL field. Default value is set by @field-name
@sql-type #CDATA Type of the SQL field. If not provided, the doclet will do the type conversion
@sql-size n[,m] Data size. You must specify this for char, varchar, numeric SQL types.
@not-null #EMPTY For non null fields
@sql-index [index-name[,rank]] For indexing a field
@sql-unique-index [index-name[,rank]] For indexing a field