Added comments to all class headers. Comments to individual methods will

be added as needed.
This commit is contained in:
amontano 2002-11-03 08:56:11 +00:00
parent b4e4decc2e
commit 37b29c8d33
24 changed files with 157 additions and 18 deletions

View file

@ -21,6 +21,11 @@ package org.thdl.tib.scanner;
import java.awt.*; import java.awt.*;
import java.awt.event.*; import java.awt.event.*;
/** Window that displays copyright stuff.
@author Andrés Montano Pellegrini
@see WindowScannerFilter
*/
class AboutDialog extends Dialog implements ActionListener, WindowListener class AboutDialog extends Dialog implements ActionListener, WindowListener
{ {
public AboutDialog(Frame parent) public AboutDialog(Frame parent)

View file

@ -21,6 +21,14 @@ package org.thdl.tib.scanner;
import java.net.*; import java.net.*;
import java.io.*; import java.io.*;
/** Provides interfase to convert from tibetan text transliterated in
the Acip scheme to THDL's extended wylie scheme.
@author Andrés Montano Pellegrini
@see WindowScannerFilter
@see Manipulate
*/
public class AcipToWylie public class AcipToWylie
{ {
private BufferedReader in; private BufferedReader in;
@ -32,6 +40,14 @@ public class AcipToWylie
this.out = out; this.out = out;
} }
/** Simply constructs object and invokes #run().
@param args If no arguments are sent, it takes the ACIP text
from the standard input and sends the wylie text to the standard
output. If one argument is sent, it interprets it as the
file name for the input. If two arguments are sent, it
interprets the first one as the file name for the input and
the second one as the file name for the output.
*/
public static void main (String[] args) throws Exception public static void main (String[] args) throws Exception
{ {
PrintWriter out; PrintWriter out;

View file

@ -19,13 +19,13 @@ package org.thdl.tib.scanner;
import java.io.*; import java.io.*;
/** Provides recommended implementation of the SyllableListTree /** Provides recommended implementation of the {@link SyllableListTree}
(currently most efficient memory-speed combination) loading (currently most efficient memory-speed combination) loading
into memory only the "trunk" of the tree, and from file into memory only the "trunk" of the tree,
searching the rest of the tree directly in the file. and resorting to the disk when searching the rest of the tree.
<p>The words must be stored in a binary file tree structure format. <p>The words must be stored in a binary file tree structure format.
This can be done using the BinaryFileGenerator.</p> This can be done using the {@link BinaryFileGenerator}.</p>
@author Andr&eacute;s Montano Pellegrini @author Andr&eacute;s Montano Pellegrini
@see TibetanScanner @see TibetanScanner

View file

@ -21,8 +21,9 @@ import java.io.*;
import java.net.*; import java.net.*;
import java.util.*; import java.util.*;
/** Inputs a Tibetan text and displays the words with /** Inputs a Tibetan text and displays the words with their
their definitions through the console over a shell. definitions through the console over a shell. Use when no
graphical interfase is supported or for batch processes.
@author Andr&eacute;s Montano Pellegrini @author Andr&eacute;s Montano Pellegrini
*/ */

View file

@ -16,12 +16,14 @@ Pellegrini. All Rights Reserved.
Contributor(s): ______________________________________. Contributor(s): ______________________________________.
*/ */
package org.thdl.tib.scanner;
/** Stores the multiple definitions (corresponding to /** Stores the multiple definitions (corresponding to
various dictionaries) for a single Tibetan word. various dictionaries) for a single Tibetan word.
@see Word
@author Andr&eacute;s Montano Pellegrini @author Andr&eacute;s Montano Pellegrini
*/ */
package org.thdl.tib.scanner;
public class Definitions public class Definitions
{ {

View file

@ -23,7 +23,7 @@ import java.awt.*;
import javax.swing.table.*; import javax.swing.table.*;
/** Used by the DictionaryTable to display the full definition /** Used by the DictionaryTable to display the full definition
of Tibetan word displaed in a table when its row is clicked. of Tibetan word displayed in a table when its row is clicked.
@author Andr&eacute;s Montano Pellegrini @author Andr&eacute;s Montano Pellegrini
@see DictionaryTable @see DictionaryTable

View file

@ -26,10 +26,12 @@ import org.thdl.tib.input.DuffPane;
/** Graphical interfase to be used by applications and applets /** Graphical interfase to be used by applications and applets
to input a Tibetan text (in Roman or Tibetan script) and to input a Tibetan text (in Roman or Tibetan script) and
displays the words (in Roman or Tibetan script) with their display the words (in Roman or Tibetan script) with their
definitions (in Roman script). Uses the THDL inputting system. definitions (in Roman script). Uses the THDL inputting system.
@author Andr&eacute;s Montano Pellegrini @author Andr&eacute;s Montano Pellegrini
@see WindowScannerFilter
@see AppletScannerFilter
*/ */
public class DuffScannerPanel extends ScannerPanel public class DuffScannerPanel extends ScannerPanel
{ {

View file

@ -21,10 +21,10 @@ import java.io.*;
/** Searches the words directly in a file; not the preferred /** Searches the words directly in a file; not the preferred
implementation. The search is too slow! implementation. The search is too slow!
The preferred implementation is the CachedSyllableListTree. The preferred implementation is the {@link CachedSyllableListTree}.
<p>The words must be stored in a binary file tree structure format. <p>The words must be stored in a binary file tree structure format.
This can be done using the BinaryFileGenerator.</p> This can be done using the {@link BinaryFileGenerator}.</p>
@author Andr&eacute;s Montano Pellegrini @author Andr&eacute;s Montano Pellegrini
@see TibetanScanner @see TibetanScanner

View file

@ -19,6 +19,14 @@ Contributor(s): ______________________________________.
package org.thdl.tib.scanner; package org.thdl.tib.scanner;
import java.io.*; import java.io.*;
/** Used by {@link LinkedList} to provide the implementation of a
simple dynamic link list.
@author Andr&eacute;s Montano Pellegrini
@see LinkedList
@see ListIterator
*/
class Link class Link
{ {
private Object obj; private Object obj;

View file

@ -19,6 +19,12 @@ Contributor(s): ______________________________________.
package org.thdl.tib.scanner; package org.thdl.tib.scanner;
import java.util.*; import java.util.*;
/** Implementation of a simple dynamic link list. Be careful with word order!
@author Andr&eacute;s Montano Pellegrini
@see Link
@see ListIterator
*/
public class LinkedList public class LinkedList
{ {
protected Link cabeza; protected Link cabeza;

View file

@ -19,6 +19,14 @@ Contributor(s): ______________________________________.
package org.thdl.tib.scanner; package org.thdl.tib.scanner;
import java.util.*; import java.util.*;
/** Used by {@link LinkedList} to provide the implementation of a
simple dynamic link list.
@author Andr&eacute;s Montano Pellegrini
@see LinkedList
@see Link
*/
public class ListIterator public class ListIterator
{ {
Link current; Link current;

View file

@ -20,6 +20,13 @@ package org.thdl.tib.scanner;
import java.util.*; import java.util.*;
import java.io.*; import java.io.*;
/** Loads dictionary stored in tree format and searches for words recursively.
How the the dictionary is loaded depends on which implementation of
{@link SyllableListTree} is invoked.
@author Andr&eacute;s Montano Pellegrini
@see SyllableListTree
*/
class LocalTibetanScanner implements TibetanScanner class LocalTibetanScanner implements TibetanScanner
{ {
public static String archivo; public static String archivo;

View file

@ -20,9 +20,7 @@ package org.thdl.tib.scanner;
import java.io.*; import java.io.*;
/** Takes the output of ConsoleScannerFilter /** Miscelaneous methods for the manipulation of Tibetan text.
(in RY format), converts the Wylie to Acip
and displays the result in csv format.
@author Andr&eacute;s Montano Pellegrini @author Andr&eacute;s Montano Pellegrini
*/ */
@ -220,9 +218,13 @@ public class Manipulate
return linea; return linea;
} }
/** /** Not really important.
* Sintaxis: java Manipulate [arch-palabras] < dict-orig > dict-dest
* Sintaxis: java Manipulate [word-file] < source-dic-entries > dest-dic-entries
Takes the output of ConsoleScannerFilter
(in RY format), converts the Wylie to Acip
and displays the result in csv format.
* arch-palabras es usado solo cuando deseamos las palabras cambiadas * arch-palabras es usado solo cuando deseamos las palabras cambiadas
* a otro archivo. * a otro archivo.
*/ */

View file

@ -20,6 +20,20 @@ package org.thdl.tib.scanner;
import java.util.*; import java.util.*;
import java.io.*; import java.io.*;
/** Loads the whole dictionary into memory; not the preferred
implementation. Provides the fastest search, but takes up to
much resources. The preferred implementation is the
{@link CachedSyllableListTree}.
<p>The words must be stored in a binary file tree structure format.
This can be done using the {@link BinaryFileGenerator}.</p>
@author Andr&eacute;s Montano Pellegrini
@see TibetanScanner
@see CachedSyllableListTree
@see BinaryFileGenerator
*/
public class MemorySyllableListTree extends LinkedList implements SyllableListTree public class MemorySyllableListTree extends LinkedList implements SyllableListTree
{ {
protected String sil, def; protected String sil, def;

View file

@ -25,6 +25,14 @@ import javax.servlet.*;
import javax.servlet.http.*; import javax.servlet.http.*;
import org.thdl.tib.text.TibetanHTML; import org.thdl.tib.text.TibetanHTML;
/** Interfase to provide access to an on-line dictionary through a form in html;
Inputs Tibetan text (Roman script only) and displays the
words (Roman or Tibetan script) with their definitions.
Runs on the server and is called upon through an HTTP request directly
by the browser. Requires no additional software installed on the client.
@author Andr&eacute;s Montano Pellegrini
*/
public class OnLineScannerFilter extends HttpServlet { public class OnLineScannerFilter extends HttpServlet {
ResourceBundle rb; ResourceBundle rb;

View file

@ -18,6 +18,14 @@ Contributor(s): ______________________________________.
package org.thdl.tib.scanner; package org.thdl.tib.scanner;
/** Right now, it only used by {@link LocalTibetanScanner} to
separate &quot;paragraphs&quot;; eventually it will be one
of many tokens representing grammatical parts of the sentences that will be
interpreted by the parser.
@author Andr&eacute;s Montano Pellegrini
@see LocalTibetanScanner
*/
class PunctuationMark extends Token class PunctuationMark extends Token
{ {
public PunctuationMark(char ch) public PunctuationMark(char ch)

View file

@ -24,6 +24,13 @@ import java.util.*;
import javax.servlet.*; import javax.servlet.*;
import javax.servlet.http.*; import javax.servlet.http.*;
/** Running on the server, receives the tibetan text from applet/applications running on
the client and sends them the words with their definitions through the Internet.
Requests are made through {@link RemoteTibetanScanner}.
@author Andr&eacute;s Montano Pellegrini
@see RemoteTibetanScanner
*/
public class RemoteScannerFilter extends GenericServlet public class RemoteScannerFilter extends GenericServlet
{ {
private TibetanScanner scanner; private TibetanScanner scanner;

View file

@ -20,6 +20,13 @@ package org.thdl.tib.scanner;
import java.net.*; import java.net.*;
import java.io.*; import java.io.*;
/** Used by applets and applications to access remote on-line dictionaries.
Sends Tibetan text, and receives the words with their definitions. The
{@link RemoteScannerFilter} receives the requests on the server.
@author Andr&eacute;s Montano Pellegrini
@see RemoteScannerFilter
*/
public class RemoteTibetanScanner implements TibetanScanner public class RemoteTibetanScanner implements TibetanScanner
{ {
private String url; private String url;

View file

@ -20,6 +20,16 @@ package org.thdl.tib.scanner;
import java.awt.*; import java.awt.*;
import java.awt.event.*; import java.awt.event.*;
/** A non-Swing graphical interfase to be used by applications
running on platforms that don't support Swing,
to input a Tibetan text (in Roman script only) and
display the words (in Roman script only) with their
definitions (in Roman script).
@author Andr&eacute;s Montano Pellegrini
@see WindowScannerFilter
*/
public class SimpleScannerPanel extends ScannerPanel public class SimpleScannerPanel extends ScannerPanel
{ {
private TextArea txtInput, txtOutput; private TextArea txtInput, txtOutput;

View file

@ -27,6 +27,12 @@ Contributor(s): ______________________________________.
package org.thdl.tib.scanner; package org.thdl.tib.scanner;
/** The generic interface for accesing dictionaries. An instance of
a SyllableListTree represents a node containing a syllable, a definition
(if it is the last syllable of a word) and links to its &quot;children&quot;.
@author Andr&eacute;s Montano Pellegrini
*/
public interface SyllableListTree public interface SyllableListTree
{ {
public String getDef(); public String getDef();

View file

@ -19,6 +19,10 @@ Contributor(s): ______________________________________.
package org.thdl.tib.scanner; package org.thdl.tib.scanner;
import java.util.*; import java.util.*;
/** Defines the core methods required to provide access to a dictionary; local or remote.
@author Andr&eacute;s Montano Pellegrini
*/
public interface TibetanScanner public interface TibetanScanner
{ {
public static final String copyrightUnicode="Copyright " + '\u00A9' + " 2000-2002 by Andr" + '\u00E9' + "s Montano Pellegrini, all rights reserved."; public static final String copyrightUnicode="Copyright " + '\u00A9' + " 2000-2002 by Andr" + '\u00E9' + "s Montano Pellegrini, all rights reserved.";

View file

@ -17,6 +17,12 @@ Contributor(s): ______________________________________.
*/ */
package org.thdl.tib.scanner; package org.thdl.tib.scanner;
/** Represents a basic grammatical unit; seems unnecessary but when the parser
is developed it will make sense.
@author Andr&eacute;s Montano Pellegrini
*/
public class Token public class Token
{ {
protected String token; protected String token;

View file

@ -28,6 +28,14 @@ import java.awt.datatransfer.*;
import javax.swing.text.JTextComponent; import javax.swing.text.JTextComponent;
import org.thdl.tib.input.DuffPane; import org.thdl.tib.input.DuffPane;
/** Provides a graphical interfase to input Tibetan text (Roman or
Tibetan script) and displays the words (Roman or Tibetan script)
with their definitions. Works without Tibetan script in
platforms that don't support Swing. Can access dictionaries stored
locally or remotely.
@author Andr&eacute;s Montano Pellegrini
*/
public class WindowScannerFilter implements WindowListener, FocusListener, ActionListener, ItemListener public class WindowScannerFilter implements WindowListener, FocusListener, ActionListener, ItemListener
{ {
private ScannerPanel sp; private ScannerPanel sp;

View file

@ -22,6 +22,10 @@ package org.thdl.tib.scanner;
import org.thdl.tib.text.TibetanHTML; import org.thdl.tib.text.TibetanHTML;
/** Tibetan word with its corresponding definitions.
@author Andr&eacute;s Montano Pellegrini
*/
public class Word extends Token public class Word extends Token
{ {
/** Used to rebuild the text the user entered. */ /** Used to rebuild the text the user entered. */