org.apache.maven.jxr
Class DirectoryIndexer

java.lang.Object
  extended by org.apache.maven.jxr.DirectoryIndexer

public class DirectoryIndexer
extends java.lang.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:

Version:
$Id: DirectoryIndexer.java 524455 2007-03-31 17:15:38Z dennisl $
Author:
Fabrice Bellingard , Brian Leonard

Constructor Summary
DirectoryIndexer(PackageManager packageManager, java.lang.String root)
          Constructor for the DirectoryIndexer object
 
Method Summary
 java.lang.String getBottom()
          see setBottom(String)
 java.lang.String getDocTitle()
          see setDocTitle(String)
 java.lang.String getOutputEncoding()
          see setOutputEncoding(String)
 java.lang.String getTemplateDir()
          see setTemplateDir(String)
 java.lang.String getWindowTitle()
          see setWindowTitle(String)
 void process(Log log)
          Does the actual indexing.
 void setBottom(java.lang.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(java.lang.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(java.lang.String outputEncoding)
          OutputEncoding is the encoding of output files.
 void setTemplateDir(java.lang.String templateDir)
          TemplateDir is the location of the jelly template files used to generate the navigation pages.
 void setWindowTitle(java.lang.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,
                        java.lang.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(java.lang.String outputEncoding)
OutputEncoding is the encoding of output files.

Parameters:
outputEncoding - output Encoding

getOutputEncoding

public java.lang.String getOutputEncoding()
see setOutputEncoding(String)


setTemplateDir

public void setTemplateDir(java.lang.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 java.lang.String getTemplateDir()
see setTemplateDir(String)


setWindowTitle

public void setWindowTitle(java.lang.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 java.lang.String getWindowTitle()
see setWindowTitle(String)

See Also:
setWindowTitle

setDocTitle

public void setDocTitle(java.lang.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 java.lang.String getDocTitle()
see setDocTitle(String)

See Also:
setDocTitle

setBottom

public void setBottom(java.lang.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 java.lang.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