com.hammurapi.render
Class ReportGenerator

java.lang.Object
  com.hammurapi.render.ReportGenerator

All Implemented Interfaces:

RenderingConstants

public class ReportGenerator
extends java.lang.Object
implements RenderingConstants

Documentation/report generator.

Author:

Pavel Vlasov

Field Summary

Fields inherited from interface com.hammurapi.render.RenderingConstants

CONTENTS, CONTENTS_HTTP, GIF, IMAGES, OUTLINE, OUTLINE_HTTP, RENDER_HELPER, RENDER_START, TO_RENDER

Constructor Summary

ReportGenerator()

Method Summary

void	generate(java.lang.Object root, java.io.File outputDir, java.lang.String title, boolean http) This method creates index.html and outline.html in the target directory, extracts resources, and then uses rendering framework to generate documentation for the root object.
void	generate(java.lang.Object root, java.io.File outputFile, java.lang.String title, java.lang.String profile, boolean http) This method generates documentation for the root object.
Context	getContext()
java.util.Map<java.lang.String,java.lang.Object>	getEnvironment()
java.util.Locale	getLocale()
void	setContext(Context context)
void	setEnvironment(java.util.Map<java.lang.String,java.lang.Object> environment)
void	setLocale(java.util.Locale locale)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportGenerator

public ReportGenerator()

Method Detail

getEnvironment

public java.util.Map<java.lang.String,java.lang.Object> getEnvironment()

setEnvironment

public void setEnvironment(java.util.Map<java.lang.String,java.lang.Object> environment)

getContext

public Context getContext()

setContext

public void setContext(Context context)

getLocale

public java.util.Locale getLocale()

setLocale

public void setLocale(java.util.Locale locale)

generate

public void generate(java.lang.Object root,
                     java.io.File outputFile,
                     java.lang.String title,
                     java.lang.String profile,
                     boolean http)
              throws RenderingException

This method generates documentation for the root object.

Parameters:

root - Root object to document.

outputFile - Output file.

Throws:

java.lang.Exception

RenderingException

generate

public void generate(java.lang.Object root,
                     java.io.File outputDir,
                     java.lang.String title,
                     boolean http)
              throws RenderingException

This method creates index.html and outline.html in the target directory, extracts resources, and then uses rendering framework to generate documentation for the root object.

Parameters:

root - Root object to document.

outputDir - Output directory.

http - If this flag is true, outline trees use AJAX.

Throws:

java.lang.Exception

RenderingException