|
DODS 7.3 API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.enhydra.ant.taskdefs.Dods
public class Dods
<taskdef name="dods" classname="org.enhydra.ant.taskdefs.Dods"/>Parameters
domlfile - The doml input file describing data object mapping. Required = Yes. outputDir - Target for generated classes, expressed as a directory path. Required = Yes. force - Forces DODS always to regenerate source files. Possible values: ("true", "false"(default)). Required = No. action - Name of Ant task from generate.xml. If only documentation need to be generated then set action="dods:generatorOff" and set indicators for generating documentation (pdf,xmi,ptl,html). Required = No. templateDir - Name of folder for template set for generating java code, expressed as a directory path. Required = No. templateSet - Template set for generating java code. Required = No. confDir - Path to custom configuration folder = No. database - Sets database vendor for generating sql. Required = No. html - Indicates DODS to generate html documentation from .doml file Possible values: ("true", "false"(default)). Required = No. pdf - Indicates DODS to generate pdf documentation from .doml file Possible values: ("true", "false"(default)). Required = No. xmi - Indicates DODS to generate xmi documentation from .doml file Possible values: ("true", "false"(default)). Required = No. ptl - Indicates DODS to generate ptl (Rational Rose) documentation from .doml file. Possible values: ("true", "false"(default)). Required = No. without parameters - to create all sql files and java classes and to compile it. action parameters: dods:build_all - to create all sql files and java classes. dods:sql - to create only sql files. dods:java -to create only java files and to compile them. dods:javaNoCompile -To create only java files and not to compile them. dods:noCompile -To create SQL files and java files and not to compile them. dods:build_all_split - to create all sql files and java classes and to compile it. SQL files will be divided into separate files using SQLSplitter dods:sqlsplit - to create only sql files and separate in different files using SQLSplitter. dods:noCompileSplit - To create SQL files and separate sql commands using SQLSplitter and java files and not to compile them. templateset parameters: standard - generate standard java code.- any user defined template set.
<dods domlfile="${basedir}/discRack.doml" outputDir="${basedir}/src" templateset="standard"/>
Field Summary | |
---|---|
protected java.lang.String |
action
|
protected java.lang.String |
confDir
|
protected java.lang.String |
database
|
protected java.lang.String |
domlfile
|
protected java.lang.String |
force
|
protected boolean |
html
|
protected java.lang.String |
outputDir
|
protected boolean |
pdf
|
protected boolean |
ptl
|
protected java.lang.String |
templateDir
|
protected java.lang.String |
templateSet
|
protected boolean |
xmi
|
Fields inherited from class org.apache.tools.ant.Task |
---|
target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
---|
description, location, project |
Constructor Summary | |
---|---|
Dods()
|
Method Summary | |
---|---|
void |
execute()
Simply invokes DODS Generator, and then compiles the generated files. |
void |
setAction(java.lang.String action)
Sets action parameter. |
void |
setConfDir(java.lang.String string)
Indicates DODS to search for configuration files in confDir. |
void |
setDatabase(java.lang.String database)
Set the database vendor for creating sql |
void |
setDomlfile(java.lang.String domlfile)
Sets the doml file. |
void |
setForce(java.lang.String force)
Forces DODS always to regenerate source files. |
void |
setHtml(java.lang.String html)
Indicates DODS to generate html documentation from .doml file. |
void |
setOutputDir(java.lang.String outdir)
The destination directory in which the generated sources are written to. |
void |
setPdf(java.lang.String pdf)
Indicates DODS to generate pdf documentation from .doml file. |
void |
setPtl(java.lang.String ptl)
Indicates DODS to generate ptl (Rational Rose) documentation from .doml file. |
void |
setTemplateDir(java.lang.String tempDir)
Sets the templateDir. |
void |
setTemplateSet(java.lang.String template)
Sets template set parameter. |
void |
setXmi(java.lang.String xmi)
Indicates DODS to generate xmi documentation from .doml file. |
Methods inherited from class org.apache.tools.ant.Task |
---|
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
---|
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.lang.String domlfile
protected java.lang.String outputDir
protected java.lang.String action
protected java.lang.String templateDir
protected java.lang.String confDir
protected java.lang.String templateSet
protected java.lang.String force
protected java.lang.String database
protected boolean html
protected boolean pdf
protected boolean xmi
protected boolean ptl
Constructor Detail |
---|
public Dods()
Method Detail |
---|
public void execute() throws org.apache.tools.ant.BuildException
execute
in class org.apache.tools.ant.Task
org.apache.tools.ant.BuildException
public void setDomlfile(java.lang.String domlfile)
domlfile
- the doml input file describing data object mapping.public void setTemplateDir(java.lang.String tempDir)
tempDir
- Path to folder with templates.public void setOutputDir(java.lang.String outdir)
outdir
- target for generated classes, expressed as a directory path.public void setAction(java.lang.String action)
action
- value of action parameter.public void setTemplateSet(java.lang.String template)
template
- value of template set.public void setDatabase(java.lang.String database)
database
- database vendor for creating sqlpublic void setForce(java.lang.String force)
force
- "true" if source files shoult be regenerated, otherwise "false".public void setHtml(java.lang.String html)
html
- "true" if html documentation shoult be generated, otherwise "false".public void setPdf(java.lang.String pdf)
pdf
- "true" if pdf documentation shoult be generated, otherwise "false".public void setXmi(java.lang.String xmi)
xmi
- "true" if xmi documentation shoult be generated, otherwise "false".public void setPtl(java.lang.String ptl)
ptl
- "true" if ptl documentation shoult be generated, otherwise "false".public void setConfDir(java.lang.String string)
string
- configuration dir
|
DODS 7.3 API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |