com.hammurapi.render.emf
Class EcoreDoc

java.lang.Object
  Task
      com.hammurapi.render.emf.EcoreDoc

public class EcoreDoc
extends Task

Generates HTML documentation for ECore models and diagrams.

Author:

Pavel Vlasov

Constructor Summary

EcoreDoc()

Method Summary

void	execute()
java.lang.String	getDiagram() Source diagram - file or URL
java.io.File	getOutputDir() Output directory
java.io.File	getOutputFile()
boolean	isHttp()
static void	main(java.lang.String[] args) Generates documentation from a diagram file.
void	setDiagram(java.lang.String diagram) Source diagram - file or URL
void	setHttp(boolean http) If true, outline and contents trees are rendered to use AJAX.
void	setLocale(java.util.Locale locale) Sets rendering locale.
void	setOutputDir(java.io.File outputDir) Output directory
void	setOutputFile(java.io.File outputFile) If outputfile attribute is set, then the task generates documenation in a single HTML file.

Methods inherited from class java.lang.Object

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

Constructor Detail

EcoreDoc

public EcoreDoc()

Method Detail

execute

public void execute()
             throws BuildException

Throws:

BuildException

setLocale

public void setLocale(java.util.Locale locale)

Sets rendering locale.

Parameters:

locale -

getDiagram

public java.lang.String getDiagram()

Source diagram - file or URL

Returns:

setDiagram

public void setDiagram(java.lang.String diagram)

Source diagram - file or URL

Parameters:

diagram -

getOutputDir

public java.io.File getOutputDir()

Output directory

Returns:

setOutputDir

public void setOutputDir(java.io.File outputDir)

Output directory

Parameters:

outputDir -

getOutputFile

public java.io.File getOutputFile()

setOutputFile

public void setOutputFile(java.io.File outputFile)

If outputfile attribute is set, then the task generates documenation in a single HTML file. Convenient for printing.

Parameters:

outputFile -

isHttp

public boolean isHttp()

setHttp

public void setHttp(boolean http)

If true, outline and contents trees are rendered to use AJAX. It is useful for large models, but works only over HTTP.

Parameters:

http -

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Generates documentation from a diagram file. Command line parameters: <diagram file> <output dir> [http]

Parameters:

args -

Throws:

java.lang.Exception