doc.doclets

Class PtIndexer

java.lang.Object

doc.doclets.PtIndexer

public class PtIndexer
extends java.lang.Object

Create a searchable index.

This class has a method append(String, String) takes a key and value and splits the value into alpha-numeric words that are then saved in a data structure for later searching. Common words are filtered out.

The write(String) method saves the data structure to disk via serialization.

The read(String) method reads the data structure.

The search(String) returns a list of values that match a key

Since:

Ptolemy II 10.0

Version:

$Id: PtIndexer.java 70402 2014-10-23 00:52:20Z cxh $

Author:

Christopher Brooks, Contributor: Edward A. Lee

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.util.Set<java.lang.String>	_common The set of common words that are not indexed.

Constructor Summary

Constructors

Constructor and Description
PtIndexer()

Method Summary

Modifier and Type	Method and Description
void	append(java.lang.String location, java.lang.String words) Append all the words to the dictionary.
static void	main(java.lang.String[] args) A test driver for the indexer.
void	read(java.lang.String fileName) Read the dictionary to a file or URL.
java.util.Collection<java.lang.String>	search(java.lang.String target) Search the dictionary for matches.
java.lang.String	statistics() Return statistics about the dictionary.
void	write(java.lang.String fileName) Write the dictionary to a file or URL.

Methods inherited from class java.lang.Object

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

Field Detail

_common

static java.util.Set<java.lang.String> _common

The set of common words that are not indexed. One way to update this is with: find $PTII/doc/codeDoc -name "*.xml" | xargs cat | tr -cs "[:alpha:]" "\n" | tr "[:upper:]" "[:lower:]" | sort | uniq -c | sort -nr | head -100 | awk '{printf(" \"%s\", // %d\n", $2, $1)}'

Constructor Detail

PtIndexer

public PtIndexer()

Method Detail

append

public void append(java.lang.String location,
                   java.lang.String words)
            throws java.io.IOException

Append all the words to the dictionary.

The value of the words parameter is split into words and a map entry is created where the word is the key and the location is an element in a List.

Parameters:

location - The dot separated classname where the value of the words parameter is found.

words - The words found in the location.

Throws:

java.io.IOException - If thrown by the tokenizer.

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

A test driver for the indexer.

Usage:

  java -classpath $PTII doc.doclets.PtIndexer [-c] [target]
  

If called with no arguments, create the dictionary PtIndexer.ser The standard input is read and assumed to be file names. Each file is read and the dictionary is updated with words and locations. The location is determined by substituting "." for "/" in the file name.

Typically, the PtDoclet creates the dictionary, but this driver can be used for testing. To create the .xml file to be read:

  cd $PTII/doc; make docs
  

To run the tool on the .xml files and create the dictionary again:

  cd codeDoc
  find . -name "*.xml" | java -classpath $PTII doc.doclets.PtIndexer
  

If called with -c then use compression.

If called with one argument that is not -c, then the argument is assumed to be a target and the collection of places where target is found is returned.

Parameters:

args - The arguments, if any

Throws:

java.io.IOException - If thrown while reading the input files or dictionary.

java.lang.ClassNotFoundException - If the file does not contain the dictionary class.

read

public void read(java.lang.String fileName)
          throws java.io.IOException,
                 java.lang.ClassNotFoundException

Read the dictionary to a file or URL.

Parameters:

fileName - the file or URL of the dictionary

Throws:

java.io.IOException - If the dictionary cannot be written.

java.lang.ClassNotFoundException - If the file does not contain the dictionary class.

search

public java.util.Collection<java.lang.String> search(java.lang.String target)

Search the dictionary for matches.

The target is converted to lower case and then the dictionary is searched.

Parameters:

target - The string to match.

Returns:

a collection of matches or null if there are no matches

statistics

public java.lang.String statistics()

Return statistics about the dictionary.

Returns:

Statistics about the dictionary

write

public void write(java.lang.String fileName)
           throws java.io.IOException

Write the dictionary to a file or URL.

Parameters:

fileName - the file or URL of the dictionary

Throws:

java.io.IOException - If the dictionary cannot be written.