|
DODS 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.enhydra.dods.generator.DODSGenerator
This class is used for generating DODS code and DODS documentation.
Field Summary | |
protected java.lang.String |
action
Action that will be performed. |
protected static int |
ACTION_PARAMETER
|
protected static java.util.HashSet |
actions
|
protected java.lang.String |
database
Database vendor. |
static java.lang.String |
DATABASE_NOT_SET
|
protected static int |
DATABASE_PARAMETER
|
protected java.lang.String |
doml
Doml that will be used. |
protected java.lang.String |
force
Indicator for force (overwrite) option. |
protected static int |
FORCE_PARAMETER
|
protected static boolean |
help
|
protected static java.lang.String |
HELP_MESSAGE
|
protected static int |
HELP_PARAMETER
|
protected boolean |
html
Indicator for html option. |
protected static int |
HTML_PARAMETER
|
protected static java.lang.String |
INVALID_ACTION_PARAMETER_MESSAGE
|
protected static java.lang.String |
INVALID_DOML_FILE
|
protected static java.lang.String |
INVALID_NUMBER_OF_PARAMETER_MESSAGE
|
protected static java.lang.String |
INVALID_PARAMETER_MESSAGE
|
protected static java.lang.String |
INVALID_TEMPLATE_SET_PARAMETER_MESSAGE
|
protected boolean |
invoke
Indicator whether dods generator should be involved during project ant rebuild. |
protected boolean |
kelp
Indicator for using kelp. |
protected static java.lang.String |
NONEXISTING_DOML_FILE
|
protected java.lang.String |
outputDir
Output directory that will be used. |
protected static java.util.HashMap |
parameters
|
protected boolean |
pdf
Indicator for pdf option. |
protected static int |
PDF_PARAMETER
|
protected boolean |
ptl
Indicator for ptl option. |
protected static int |
PTL_PARAMETER
|
protected static int |
TEMPLATE_SET_PARAMETER
|
protected java.lang.String |
templateSet
Template set that will be used. |
protected static java.util.HashSet |
templateSets
|
protected DODSWizard |
wizard
Wizard that will be used. |
protected boolean |
xmi
Indicator for xmi option. |
protected static int |
XMI_PARAMETER
|
Constructor Summary | |
DODSGenerator()
Default constructor. |
Method Summary | |
int |
generateAll()
Generation of DODS code means generation of ant-build, sql, java files, html, pdf, xmi and ptl. |
java.lang.Process |
generateAll(boolean ownErrorReader)
Generation of DODS code means generation of ant-build, sql, java files, html, pdf, xmi and ptl. |
static int |
generateAll(java.lang.String outputDir,
java.lang.String domlFile,
java.lang.String genAction,
java.lang.String templateSet,
java.lang.String forceBuild,
java.lang.String database,
boolean genHtml,
boolean genPdf,
boolean genXmi,
boolean genPtl)
Generation of DODS code means generation of ant-build, sql, java files, html, pdf, xmi and ptl. |
static java.lang.Process |
generateAll(java.lang.String outputDir,
java.lang.String domlFile,
java.lang.String genAction,
java.lang.String templateSet,
java.lang.String forceBuild,
java.lang.String database,
boolean genHtml,
boolean genPdf,
boolean genXmi,
boolean genPtl,
boolean ownErrorReader)
Generation of DODS code means generation of ant-build, sql, java files, html, pdf, xmi and ptl. |
java.lang.Process |
generateCode(boolean ownErrorReader)
Generation of DODS code means generation of ant-build, sql and java files. |
static java.lang.Process |
generateCode(java.lang.String outputDir,
java.lang.String domlFile,
java.lang.String action,
java.lang.String templateSet,
java.lang.String forceBuild,
java.lang.String database,
boolean ownErrorReader)
Generation of DODS code means generation of ant-build, sql and java files. |
java.lang.Process |
generateHTML(boolean ownErrorReader)
Generates DODS html documentation from .doml file. |
static java.lang.Process |
generateHTML(java.lang.String outputDir,
java.lang.String domlFile,
java.lang.String htmlFile,
java.lang.String forceBuild,
boolean ownErrorReader)
Generates DODS html documentation from .doml file. |
java.lang.Process |
generatePDF(boolean ownErrorReader)
Generates DODS pdf documentation from .doml file. |
static java.lang.Process |
generatePDF(java.lang.String outputDir,
java.lang.String domlFile,
java.lang.String pdfFile,
java.lang.String forceBuild,
boolean ownErrorReader)
Generates DODS pdf documentation from .doml file. |
java.lang.Process |
generatePTL(boolean ownErrorReader)
Generates DODS ptl documentation from .doml file. |
static java.lang.Process |
generatePTL(java.lang.String outputDir,
java.lang.String domlFile,
java.lang.String ptlFile,
java.lang.String forceBuild,
boolean ownErrorReader)
Generates DODS ptl (Rational Rose) documentation from .doml file. |
java.lang.Process |
generateXMI(boolean ownErrorReader)
Generates DODS xmi documentation from .doml file. |
static java.lang.Process |
generateXMI(java.lang.String outputDir,
java.lang.String domlFile,
java.lang.String xmiFile,
java.lang.String forceBuild,
boolean ownErrorReader)
Generates DODS xmi documentation from .doml file. |
java.lang.String |
getAction()
Method gets action that is performed. |
java.lang.String |
getDatabase()
Method gets database vendor for generating sql. |
java.lang.String |
getDoml()
Method gets doml file that is used. |
java.lang.String |
getForce()
Method gets indicator for force (overwrite) option. |
boolean |
getHtml()
Method gets indicator for html option. |
boolean |
getInvoke()
Method gets invoke indicator. |
boolean |
getKelp()
Method gets indicator for kelp option. |
java.lang.String |
getOutputDir()
Method gets output directory that is used. |
boolean |
getPdf()
Method gets indicator for pdf option. |
boolean |
getPtl()
Method gets indicator for ptl option. |
java.lang.String |
getTemplateSet()
Method gets template set that is used. |
DODSWizard |
getWizard()
Method returns used wizard. |
boolean |
getXmi()
Method gets indicator for xmi option. |
static void |
help()
Generates Command line help. |
static void |
main(java.lang.String[] args)
Generates DODS. |
java.lang.String |
parse(java.lang.String[] args)
Parses input parameters. |
void |
postGenerate()
This method is called by wizard after generate action. |
void |
preCancel()
This method is called after wizard closing. |
void |
preClose()
This method is called before wizard closing. |
void |
preGenerate()
This method is called by wizard before generate action. |
void |
runWizard()
Method runs wizard's GUI . |
void |
setAction(java.lang.String action)
Method sets action that will be performed. |
void |
setDatabase(java.lang.String database)
Method sets database vendor for generating sql. |
void |
setDoml(java.lang.String doml)
Method sets doml file that will be used. |
void |
setForce(java.lang.String force)
Method sets indicator for force (overwrite) option. |
void |
setHtml(boolean html)
Method sets indicator for html option. |
void |
setInvoke(boolean invoke)
Method sets invoke indicator. |
void |
setKelp(boolean kelp)
Method sets indicator for kelp option. |
void |
setOutputDir(java.lang.String outputDir)
Method sets output directory that will be used. |
void |
setPdf(boolean pdf)
Method sets indicator for pdf option. |
void |
setPtl(boolean ptl)
Method sets indicator for ptl option. |
void |
setTemplateSet(java.lang.String templateSet)
Method sets template set that will be used. |
void |
setWizard(DODSWizard wizard)
Method sets wizard that will be used. |
void |
setXmi(boolean xmi)
Method sets indicator for xmi option. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static final int HELP_PARAMETER
protected static final int ACTION_PARAMETER
protected static final int TEMPLATE_SET_PARAMETER
protected static final int FORCE_PARAMETER
protected static final int DATABASE_PARAMETER
protected static final int HTML_PARAMETER
protected static final int PDF_PARAMETER
protected static final int XMI_PARAMETER
protected static final int PTL_PARAMETER
protected static final java.lang.String HELP_MESSAGE
protected static final java.lang.String INVALID_NUMBER_OF_PARAMETER_MESSAGE
protected static final java.lang.String INVALID_PARAMETER_MESSAGE
protected static final java.lang.String INVALID_ACTION_PARAMETER_MESSAGE
protected static final java.lang.String INVALID_TEMPLATE_SET_PARAMETER_MESSAGE
protected static final java.lang.String INVALID_DOML_FILE
protected static final java.lang.String NONEXISTING_DOML_FILE
public static final java.lang.String DATABASE_NOT_SET
protected DODSWizard wizard
protected java.lang.String doml
protected java.lang.String outputDir
protected java.lang.String action
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
protected boolean invoke
protected boolean kelp
protected static boolean help
protected static java.util.HashMap parameters
protected static java.util.HashSet actions
protected static java.util.HashSet templateSets
Constructor Detail |
public DODSGenerator()
Method Detail |
public DODSWizard getWizard()
public void setWizard(DODSWizard wizard)
wizard
- wizard that will be used.public java.lang.String getDoml()
public void setDoml(java.lang.String doml)
doml
- doml file that will be used.public java.lang.String getOutputDir()
public void setOutputDir(java.lang.String outputDir)
outputDir
- output directory that will be used.public java.lang.String getAction()
public void setAction(java.lang.String action)
public java.lang.String getTemplateSet()
public void setTemplateSet(java.lang.String templateSet)
templateSet
- template set that will be used.public java.lang.String getForce()
public void setForce(java.lang.String force)
force
- indicator for force (overwrite) option.public java.lang.String getDatabase()
public void setDatabase(java.lang.String database)
database
- database vendor for generating sql.public boolean getHtml()
public void setHtml(boolean html)
html
- indicator for html option.public boolean getPdf()
public void setPdf(boolean pdf)
pdf
- indicator for pdf option.public boolean getXmi()
public void setXmi(boolean xmi)
xmi
- indicator for xmi option.public boolean getPtl()
public void setPtl(boolean ptl)
ptl
- indicator for ptl option.public boolean getInvoke()
public void setInvoke(boolean invoke)
invoke
- invoke indicator.public boolean getKelp()
public void setKelp(boolean kelp)
kelp
- indicator for kelp option.public void runWizard()
public void preGenerate()
public void postGenerate()
public void preClose()
public void preCancel()
public static java.lang.Process generateCode(java.lang.String outputDir, java.lang.String domlFile, java.lang.String action, java.lang.String templateSet, java.lang.String forceBuild, java.lang.String database, boolean ownErrorReader) throws DODSGenerateException
Procces
which will generate code.
outputDir
- full path to output directory that will be used.domlFile
- full path to .doml file for generating code.action
- type of generation.templateSet
- template set which will be used for generating java code.forceBuild
- "true" if code will be always generated, otherwise only
changes will be regenerated.database
- database vendor for generating sql files.ownErrorReader
- true
if user needs to make its own ErrorReader,
otherwise (false
) method will make ErrorReader
.
DODSGenerateException
- if any error occurs.
Example:
String s; Process p = DODSGenerator.generateCode(outputDir,doml,action,template,force,false); BufferedReader buffer = new BufferedReader(new InputStreamReader(p.getInputStream())); while((s = buffer.readLine()) != null) { System.out.println(s); }
public java.lang.Process generateCode(boolean ownErrorReader) throws DODSGenerateException
Procces
which will generate code.
ownErrorReader
- true
if user needs to make its own ErrorReader,
otherwise (false
) method will make ErrorReader
.
DODSGenerateException
- if any error occurs.
Example:
String s; Process p = DODSGenerator.generateCode(false); BufferedReader buffer = new BufferedReader(new InputStreamReader(p.getInputStream())); while((s = buffer.readLine()) != null) { System.out.println(s); }
public static java.lang.Process generateHTML(java.lang.String outputDir, java.lang.String domlFile, java.lang.String htmlFile, java.lang.String forceBuild, boolean ownErrorReader) throws DODSGenerateException
Procces
which will generate documentation.
outputDir
- full path to output directory that will be used.domlFile
- full path to .doml file for generating code.htmlFile
- output html file.forceBuild
- "true" if code will be always generated, otherwise only changes
will be regenerated.ownErrorReader
- true
if user needs to make its own ErrorReader,
otherwise (false
) method will make ErrorReader
.
DODSGenerateException
- if any error occurs.org.enhydra.dods.generator.DODSGenerator#generateCode(String, String, String, String, String, boolean)
public java.lang.Process generateHTML(boolean ownErrorReader) throws DODSGenerateException
Procces
which will generate documentation.
ownErrorReader
- true
if user needs to make its own ErrorReader,
otherwise (false
) method will make ErrorReader
.
DODSGenerateException
- if any error occurs.org.enhydra.dods.generator.DODSGenerator#generateCode(String, String, String, String, String, boolean)
public static java.lang.Process generatePDF(java.lang.String outputDir, java.lang.String domlFile, java.lang.String pdfFile, java.lang.String forceBuild, boolean ownErrorReader) throws DODSGenerateException
Procces
which will generate documentation.
outputDir
- full path to output directory that will be used.domlFile
- full path to .doml file for generating code.pdfFile
- output pdf file.forceBuild
- "true" if code will be always generated, otherwise only changes
will be regenerated.ownErrorReader
- true
if user needs to make its own ErrorReader,
otherwise (false
) method will make ErrorReader
.
DODSGenerateException
- if any error occurs.org.enhydra.dods.generator.DODSGenerator#generateCode(String, String, String, String, String, boolean)
public java.lang.Process generatePDF(boolean ownErrorReader) throws DODSGenerateException
Procces
which will generate documentation.
ownErrorReader
- true
if user needs to make its own ErrorReader,
otherwise (false
) method will make ErrorReader
.
DODSGenerateException
- if any error occurs.org.enhydra.dods.generator.DODSGenerator#generateCode(String, String, String, String, String, boolean)
public static java.lang.Process generateXMI(java.lang.String outputDir, java.lang.String domlFile, java.lang.String xmiFile, java.lang.String forceBuild, boolean ownErrorReader) throws DODSGenerateException
Procces
which will generate documentation.
outputDir
- full path to output directory that will be used.domlFile
- full path to .doml file for generating code.xmiFile
- output xmi file.forceBuild
- "true" if code will be always generated, otherwise only changes
will be regenerated.ownErrorReader
- true
if user needs to make its own ErrorReader,
otherwise (false
) method will make ErrorReader
.
DODSGenerateException
- if any error occurs.org.enhydra.dods.generator.DODSGenerator#generateCode(String, String, String, String, String, boolean)
public java.lang.Process generateXMI(boolean ownErrorReader) throws DODSGenerateException
Procces
which will generate documentation.
ownErrorReader
- true
if user needs to make its own ErrorReader,
otherwise (false
) method will make ErrorReader
.
DODSGenerateException
- if any error occurs.org.enhydra.dods.generator.DODSGenerator#generateCode(String, String, String, String, String, boolean)
public static java.lang.Process generatePTL(java.lang.String outputDir, java.lang.String domlFile, java.lang.String ptlFile, java.lang.String forceBuild, boolean ownErrorReader) throws DODSGenerateException
Procces
which will generate documentation.
outputDir
- full path to output directory that will be used.domlFile
- full path to .doml file for generating code.ptlFile
- output ptl file.forceBuild
- "true" if code will be always generated, otherwise only changes
will be regenerated.ownErrorReader
- true
if user needs to make its own ErrorReader,
otherwise (false
) method will make ErrorReader
.
DODSGenerateException
- if any error occurs.org.enhydra.dods.generator.DODSGenerator#generateCode(String, String, String, String, String, boolean)
public java.lang.Process generatePTL(boolean ownErrorReader) throws DODSGenerateException
Procces
which will generate documentation.
ownErrorReader
- true
if user needs to make its own ErrorReader,
otherwise (false
) method will make ErrorReader
.
DODSGenerateException
- if any error occurs.org.enhydra.dods.generator.DODSGenerator#generateCode(String, String, String, String, String, boolean)
public static int generateAll(java.lang.String outputDir, java.lang.String domlFile, java.lang.String genAction, java.lang.String templateSet, java.lang.String forceBuild, java.lang.String database, boolean genHtml, boolean genPdf, boolean genXmi, boolean genPtl) throws DODSGenerateException
Procces
which will generate code.
outputDir
- full path to output directory that will be used.domlFile
- full path to .doml file for generating code.genAction
- type of generation.templateSet
- template set which will be used for generating java code.forceBuild
- "true" if code will be always generated, otherwise only
changes will be regenerated.database
- database vendor for generating sql files.genHtml
- if true
generates DODS html documentation from .doml file.genPdf
- if true
generates DODS pdf documentation from .doml file.genXmi
- if true
generates DODS xmi documentation from .doml file.genPtl
- if true
generates DODS ptl documentation from .doml file.
DODSGenerateException
- if any error occurs.public int generateAll() throws DODSGenerateException
Procces
which will generate code.
DODSGenerateException
- if any error occurs.public static java.lang.Process generateAll(java.lang.String outputDir, java.lang.String domlFile, java.lang.String genAction, java.lang.String templateSet, java.lang.String forceBuild, java.lang.String database, boolean genHtml, boolean genPdf, boolean genXmi, boolean genPtl, boolean ownErrorReader) throws DODSGenerateException
Procces
which will generate code.
This method call (dods.bat/dods) with all parameters.
outputDir
- full path to output directory that will be used.domlFile
- full path to .doml file for generating code.genAction
- type of generation.templateSet
- template set which will be used for generating java code.forceBuild
- "true" if code will be always generated, otherwise only
changes will be regenerated.database
- database vendor for generating sql files.ownErrorReader
- true
if user needs to make its own ErrorReader,
otherwise (false
) method will make ErrorReader
.genHtml
- if true
generates DODS html documentation from .doml file.genPdf
- if true
generates DODS pdf documentation from .doml file.genXmi
- if true
generates DODS xmi documentation from .doml file.genPtl
- if true
generates DODS ptl documentation from .doml file.
DODSGenerateException
- if any error occurs.public java.lang.Process generateAll(boolean ownErrorReader) throws DODSGenerateException
Procces
which will generate code.
This method call (dods.bat/dods) with all parameters.
ownErrorReader
- true
if user needs to make its own ErrorReader,
otherwise (false
) method will make ErrorReader
.
DODSGenerateException
- if any error occurs.public static void help()
public java.lang.String parse(java.lang.String[] args)
args
- array of input command line parameters.
public static void main(java.lang.String[] args)
Command line: dods [-?/help] [-a action] [-t templateset] [-b/-database] [-f/force] [-h/html] [-p/pdf] [-x/xmi] [-r/ptl] domlfile outputdir where: outputdir full path to output directory that will be used. domlfile full path to .doml file for generating code. options: [-? -help] shows help. [-a action] ant task parameter for code generation: dods:build_all - to create all sql files and java classes (default). 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. [-t templateset] template set for generating java and sql code: standard - generate standard java code (default). multidb - generate java code with multi database support. webdocwf - generate java code with WebDocWF support. multidb_webdocwf - generate java code with multi database and WebDocWF support. (user defined) - any user defined template set. [-b/-database] sets database vendor for generating sql. [-f/-force] with this switch, code will be always generated, without it, only changes will be regenerated. [-h/-html] generates DODS html documentation from .doml file. [-p/-pdf] generates DODS pdf documentation from .doml file. [-x/-xmi] generates DODS xmi documentation from .doml file. [-r/-ptl] generates DODS ptl (Rational Rose) documentation from .doml file.Example: DODSGenerator -a dods:java -t multidb -f -pdf -x discrack.doml /test/discRack
|
DODS 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |