org.apache.maven.jxr

Class DirectoryIndexer

java.lang.Object

org.apache.maven.jxr.DirectoryIndexer

public class DirectoryIndexer
extends Object

This class creates the navigational pages for jxr's cross-referenced source files. The navigation is inspired by javadoc, so it should have a familiar feel. Creates the following files:

• index.html main index containing the frameset
• overview-frame.html list of the project's packages (top left)
• allclasses-frame.html list of all classes in the project (bottom left)
• overview-summary.html top-level listing of the project's packages (main frame)
• Package specific:
  • package-summary.html listing of all classes in this package (main frame)
  • package-frame.html listing of all classes in this package (bottom left)

Version:

$Id$

Author:

Fabrice Bellingard , Brian Leonard

Constructor Summary

Constructors

Constructor and Description
DirectoryIndexer(PackageManager packageManager, String root) Constructor for the DirectoryIndexer object

Method Summary

Modifier and Type	Method and Description
String	getBottom() see setBottom(String)
String	getDocTitle() see setDocTitle(String)
String	getOutputEncoding() see setOutputEncoding(String)
String	getTemplateDir() see setTemplateDir(String)
String	getWindowTitle() see setWindowTitle(String)
void	process(Log log) Does the actual indexing.
void	setBottom(String bottom) Bottom is a footer for the navigation pages, usually a copyright see the javadoc documentation for the property of the same name
void	setDocTitle(String docTitle) DocTitle is used as a page heading for the summary files see the javadoc documentation for the property of the same name
void	setOutputEncoding(String outputEncoding) OutputEncoding is the encoding of output files.
void	setTemplateDir(String templateDir) TemplateDir is the location of the jelly template files used to generate the navigation pages.
void	setWindowTitle(String windowTitle) WindowTitle is used in the output's <title> tags see the javadoc documentation for the property of the same name

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryIndexer

public DirectoryIndexer(PackageManager packageManager,
                        String root)

Constructor for the DirectoryIndexer object

Parameters:

packageManager - PackageManager for this project

root - Path of the root output directory

Method Detail

setOutputEncoding

public void setOutputEncoding(String outputEncoding)

OutputEncoding is the encoding of output files.

Parameters:

outputEncoding - output Encoding

getOutputEncoding

public String getOutputEncoding()

see setOutputEncoding(String)

setTemplateDir

public void setTemplateDir(String templateDir)

TemplateDir is the location of the jelly template files used to generate the navigation pages.

Parameters:

templateDir - location of the template directory

getTemplateDir

public String getTemplateDir()

see setTemplateDir(String)

setWindowTitle

public void setWindowTitle(String windowTitle)

WindowTitle is used in the output's <title> tags see the javadoc documentation for the property of the same name

Parameters:

windowTitle - the <title> attribute

getWindowTitle

public String getWindowTitle()

see setWindowTitle(String)

See Also:

setWindowTitle

setDocTitle

public void setDocTitle(String docTitle)

DocTitle is used as a page heading for the summary files see the javadoc documentation for the property of the same name

Parameters:

docTitle - major page heading

getDocTitle

public String getDocTitle()

see setDocTitle(String)

See Also:

setDocTitle

setBottom

public void setBottom(String bottom)

Bottom is a footer for the navigation pages, usually a copyright see the javadoc documentation for the property of the same name

Parameters:

bottom - page footer

getBottom

public String getBottom()

see setBottom(String)

See Also:

setBottom

process

public void process(Log log)
             throws JxrException

Does the actual indexing.

Throws:

JxrException - If something went wrong