File Doc Category Size Date Package
MkIndex.java API Doc Example 6530 Wed Sep 05 13:40:08 BST 2001 None

MkIndex

java.lang.Object

public class MkIndex extends Object

MkIndex -- make a static index.html for a Java Source directory REQUIRES JDK1.2 OR LATER FOR SORT!! Started life as an awk script that used "ls" to get the list of files, grep out .class and javadoc output files, |sort. Now it's all in Java (including the ls-ing and the sorting).

author: Ian F. Darwin, ian@darwinsys.com
Version: $Id: MkIndex.java,v 1.30 2001/09/05 16:40:08 ian Exp $

Fields Summary
public static final String
OUTPUTFILE
The output file that we create
public static final String
TITLE
The string for TITLE and H1
PrintWriter
out
The main output stream
public static final String
BGCOLOR
The background color for the page
File
dirFile
The File object, for directory listing.
boolean[]
exists
Array of letters that exist. Should fold case here so don't get f and F as distinct entries! This only works for ASCII characters (8-bit chars).
ArrayList
vec
Vector for temporary storage, and sorting
boolean[]
done
Keep track of each letter for #links
Constructors Summary
Methods Summary
void BEGIN()
Write the HTML headers
println("<HTML>"); println("<HEAD>"); println(" <META HTTP-EQUIV=\"Content-Type\" CONTENT=\"text/html; charset=iso-8859-1\">"); println(" <META NAME=\"GENERATOR\" CONTENT=\"Java MkIndex\">"); println(" <title>" + TITLE + "</title>"); println("</HEAD>"); println("<body bgcolor=\"" + BGCOLOR + "\">"); println("<h1>" + TITLE + "</h1>"); if (new File("about.html").exists()) { FileIO.copyFile("about.html", out, false); } else { println("<P>The following files are online."); println("Some of these files are still experimental!</P>"); println("<P>Most of these files are Java source code."); println("If you load an HTML file from here, the applets will not run!"); println("The HTML files must be saved to disk and the applets compiled,"); println("before you can run them!"); } println("<P>All files are Copyright ©: All rights reserved."); println("See the accompanying <A HREF=\"legal-notice.txt\">Legal Notice</A> for conditions of use."); println("May be used by readers of my Java Cookbook for educational purposes, and for commercial use if certain conditions are met."); println("</P>"); println("<HR>");
void END()
Write the trailers and a signature
System.out.println("Finishing the HTML"); println("</UL>"); flush(); println("<P>This file generated by "); print("<A HREF=\"MkIndex.java\">MkIndex</A>, a Java program, at "); println(Calendar.getInstance().getTime().toString()); println("</P>"); println("</BODY>"); println("</HTML>");
void close()
Close open files
System.out.println("Closing output files..."); if (out != null) out.close();
void flush()
Convenience for out.flush();
out.flush();
public static void main(java.lang.String[] args)
Make an index
MkIndex mi = new MkIndex(); String inDir = args.length > 0 ? args[0] : "."; mi.open(inDir, OUTPUTFILE); // open files mi.BEGIN(); // print HTML header mi.process(); // do bulk of work mi.END(); // print trailer. mi.close(); // close files
void mkDirLink(java.lang.String index, java.lang.String dir)
// XXX Open the index and look for TITLE lines! mkLink(index, dir + " -- Directory");
void mkLink(java.lang.String href, java.lang.String descrip)
print("<LI>"); char c = href.charAt(0); if (!done[c]) { print("<A NAME=\"" + c + "\">"); done[c] = true; } println("<A HREF=\"" + href + "\">" + descrip + "</A>");
void open(java.lang.String dir, java.lang.String outFile)
dirFile = new File(dir); try { out = new PrintWriter(new FileWriter(outFile)); } catch (IOException e) { System.err.println(e); }
void print(java.lang.String s)
Convenience routine for out.print
out.print(s);
void println(java.lang.String s)
Convenience routine for out.println
out.println(s);
void process()
Do the bulk of the work
System.out.println("Start PASS ONE -- from directory to Vector..."); String[] fl = dirFile.list(); for (int i=0; i<fl.length; i++) { String fn = fl[i]; if (fn.startsWith("index")) { // we'll have no self-reference here! System.err.println("Ignoring " + fn); continue; } else if (fn.endsWith(".bak")) { // delete .bak files System.err.println("DELETING " + fn); new File(fn).delete(); continue; } else if (fn.equals("CVS")) { // Ignore CVS subdirectories continue; // don't mention it } else if (fn.charAt(0) == '.") { // UNIX dot-file continue; } else if (fn.endsWith(".class")) { // nag about .class files System.err.println("Ignoring " + fn); continue; } else if (new File(fn).isDirectory()) { vec.add(fn + "/"); } else vec.add(fn); exists[fn.charAt(0)] = true; // only after chances to continue } System.out.println("Writing the Alphabet Navigator..."); for (char c = 'A"; c<='Z"; c++) if (exists[c]) print("<A HREF=\"#" + c + "\">" + c + "</A> "); // ... (and the beginning of the HTML Unordered List...) println("<UL>"); System.out.println("Sorting the Vector..."); Collections.sort(vec, String.CASE_INSENSITIVE_ORDER); System.out.println("Start PASS TWO -- from Vector to " + OUTPUTFILE + "..."); String fn; Iterator it = vec.iterator(); while (it.hasNext()) { fn = (String)it.next(); // Need to make a link into this directory. // IF there is a descr.txt file, use it for the text // of the link, otherwise, use the directory name. // But, if there is an index.html or index.html file, // make the link to that file, else to the directory itself. if (fn.endsWith("/")) { // directory String descr = null; if (new File(fn + "descr.txt").exists()) { descr = com.darwinsys.util.FileIO.readLine(fn + "descr.txt"); }; if (new File(fn + "index.html").exists()) mkDirLink(fn+"index.html", descr!=null?descr:fn); else if (new File(fn + "index.htm").exists()) mkDirLink(fn+"index.htm", descr!=null?descr:fn); else mkLink(fn, descr!=null?descr:fn + " -- Directory"); } else // file mkLink(fn, fn); } System.out.println("*** process - ALL DONE***");