org.freehep.tools.doclet
Class SplitIndexWriter

java.lang.Object
  java.io.Writer
      java.io.PrintWriter
          com.sun.tools.doclets.HtmlWriter
              com.sun.tools.doclets.HtmlDocWriter
                  org.freehep.tools.doclet.HtmlStandardWriter
                      org.freehep.tools.doclet.AbstractIndexWriter
                          org.freehep.tools.doclet.SplitIndexWriter

public class SplitIndexWriter

extends AbstractIndexWriter

Generate Separate Index Files for all the member names with Indexing in Unicode Order. This will create "index-files" directory in the current or destination directory and will generate separate file for each unicode index.

Author:

Atul M Dambalkar

See Also:

Character

Source Code:

SplitIndexWriter.java

Field Summary

protected int	next Next unicode character in the built index.
protected int	prev Previous unicode character index in the built index.

Fields inherited from class org.freehep.tools.doclet.AbstractIndexWriter

indexbuilder

Fields inherited from class org.freehep.tools.doclet.HtmlStandardWriter

backpath, configuration, displayLength, DOC_FILES_DIR_NAME, filename, path, relativepath, relativepathNoSlash

Fields inherited from class com.sun.tools.doclets.HtmlWriter

fileseparator, htmlFilename, winTitle

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

SplitIndexWriter(ConfigurationStandard configuration, String path, String filename, String relpath, com.sun.tools.doclets.IndexBuilder indexbuilder, int prev, int next)
Construct the SplitIndexWriter.

Method Summary

static void	generate(ConfigurationStandard configuration, com.sun.tools.doclets.IndexBuilder indexbuilder) Generate separate index files, for each Unicode character, listing all the members starting with the particular unicode character.
protected void	generateIndexFile(Character unicode) Generate the contents of each index file, with Header, Footer, Member Field, Method and Constructor Description.
protected void	navLinkNext() Print the next unicode character index link.
protected void	navLinkPrevious() Print the previous unicode character index link.
protected void	printLinksForIndexes() Print Links for all the Index Files per unicode character.

Methods inherited from class org.freehep.tools.doclet.AbstractIndexWriter

generateContents, navLinkIndex, printClassInfo, printComment, printDescription, printDescription, printDescription, printMemberDesc

Methods inherited from class org.freehep.tools.doclet.HtmlStandardWriter

boldText, boldText, boldText, commentTagsToString, configuration, copyDocFiles, error, error, frame, frameEnd, frameSet, frameSetEnd, generateTagInfo, generateTagInfo, getClassLink, getClassLink, getClassLink, getClassLink, getClassLink, getClassLink, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getPackageLink, getPackageLink, getPackageLink, getPackageLink, getPreQualifiedClassLink, getPreQualifiedClassLink, getQualifiedClassLink, getSourcePath, getText, getText, getText, getText, isCoreClass, isCrossClassIncluded, isGeneratedDoc, italicsClassName, msg, navCellEnd, navCellRevStart, navCellStart, navDetail, navHideLists, navHideLists, navLinkClass, navLinkClassIndex, navLinkClassUse, navLinkContents, navLinkDeprecated, navLinkHelp, navLinkMainTree, navLinkNext, navLinkPackage, navLinkPackage, navLinkPrevious, navLinks, navLinkTree, navShowLists, navShowLists, navSummary, notice, notice, pathString, pathString, pathToClass, printBoldTargetHyperLink, printBottom, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printDocLink, printDocLink, printHtmlHeader, printHtmlHeader, printHtmlHeader, printIndexHeading, printInlineComment, printInlineComment, printInlineDeprecatedComment, printInlineDeprecatedComment, printNoFramesBoldTargetHyperLink, printNoFramesTargetHyperLink, printPackageLink, printPackageLink, printPackageLink, printPreQualifiedBoldClassLink, printPreQualifiedClassLink, printQualifiedClassLink, printSinceTag, printSrcLink, printStyleSheetProperties, printSummaryComment, printSummaryDeprecatedComment, printSummaryDeprecatedComment, printSummaryDetailLinks, printTargetClassLink, printTargetHyperLink, printTargetHyperLink, printTargetHyperLink, printTargetPackageLink, printText, printText, printText, printUserHeaderFooter, removeNonInlineHtmlTags, replace, replaceDocRootDir, replaceInheritDoc, seeTagToString, serialClassInclude, serialDocInclude, serialInclude, summaryRow, summaryRowEnd, tableHeaderEnd, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableIndexDetail, tableIndexSummary, tableInheritedHeaderEnd, tableInheritedHeaderStart, tableUseInfoHeaderStart, tdIndex, warning, warning, warning

Methods inherited from class com.sun.tools.doclets.HtmlDocWriter

getHyperLink, getHyperLink, getHyperLink, getHyperLink, getPkgName, printBodyHtmlEnd, printFooter, printFrameFooter, printFramesetHeader, printFramesetHeader, printHyperLink, printHyperLink, printHyperLink, printHyperLink, printNbsps, printPkgName, spaces, today

Methods inherited from class com.sun.tools.doclets.HtmlWriter

address, addressEnd, aEnd, aName, anchor, anchor, blockquote, blockquoteEnd, body, bodyEnd, bold, bold, boldEnd, br, center, centerEnd, code, codeEnd, codeText, commentEnd, commentStart, dd, ddEnd, dl, dlEnd, dt, em, emEnd, font, fontEnd, fontSizeStyle, fontStyle, genWriter, getBold, getBoldEnd, getCode, getCodeEnd, getFontColor, getFontEnd, getWindowTitleOnload, h1, h1, h1End, h2, h2, h2End, h3, h3, h3End, h4, h4, h4End, h5, h5End, head, headEnd, hr, hr, hr, html, htmlEnd, img, italic, italicEnd, italics, italicsText, li, li, link, menu, menuEnd, noFrames, noFramesEnd, p, pEnd, pre, preEnd, printWinTitleScript, script, scriptEnd, space, sup, supEnd, table, table, table, table, tableEnd, td, tdAlign, tdAlignRowspan, tdAlignVAlign, tdAlignVAlignRowspan, tdBgcolorStyle, tdColspan, tdColspanBgcolorStyle, tdEnd, tdNowrap, tdVAlign, tdVAlignClass, tdWidth, title, title, titleEnd, tr, trAlignVAlign, trBgcolor, trBgcolorStyle, trEnd, ul, ulEnd

Methods inherited from class java.io.PrintWriter

checkError, close, flush, print, print, print, print, print, print, print, print, print, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write

Methods inherited from class java.lang.Object

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

Field Detail

prev

protected int prev

Previous unicode character index in the built index.

next

protected int next

Next unicode character in the built index.

Constructor Detail

SplitIndexWriter

public SplitIndexWriter(ConfigurationStandard configuration,
                        String path,
                        String filename,
                        String relpath,
                        com.sun.tools.doclets.IndexBuilder indexbuilder,
                        int prev,
                        int next)
                 throws IOException

Construct the SplitIndexWriter. Uses path to this file and relative path from this file.

Parameters:

path - Path to the file which is getting generated.

filename - Name of the file which is getting genrated.

relpath - Relative path from this file to the current directory.

indexbuilder - Unicode based Index from IndexBuilder

Method Detail

generate

public static void generate(ConfigurationStandard configuration,
                            com.sun.tools.doclets.IndexBuilder indexbuilder)

Generate separate index files, for each Unicode character, listing all the members starting with the particular unicode character.

Parameters:

indexbuilder - IndexBuilder built by IndexBuilder

Throws:

com.sun.tools.doclets.DocletAbortException

generateIndexFile

protected void generateIndexFile(Character unicode)
                          throws IOException

Generate the contents of each index file, with Header, Footer, Member Field, Method and Constructor Description.

Parameters:

unicode - Unicode character referring to the character for the index.

Throws:

IOException

printLinksForIndexes

protected void printLinksForIndexes()

Print Links for all the Index Files per unicode character.

navLinkPrevious

protected void navLinkPrevious()

Print the previous unicode character index link.

Overrides:

navLinkPrevious in class HtmlStandardWriter

navLinkNext

protected void navLinkNext()

Print the next unicode character index link.

Overrides:

navLinkNext in class HtmlStandardWriter