Class GlossaryDocument

java.lang.Object
  extended byGlossaryDocument

public class GlossaryDocument
extends java.lang.Object

This type represents a document containing an Glossary or 'frequently asked questions' section although the questions and answers are usually written by a programmer. The document may also contain the listing of the contents of a directory or a 'webdirectory'. A webdirectory is all the links from some other web-page reproduces as a list in the current page. The Glossary section is indicated by [Glossary] and [/Glossary] tags

See Also:
LinkFolder, Glossary, GlossaryItem, Question, Answer

Constructor Summary
GlossaryDocument()
           
GlossaryDocument(java.lang.String sText)
           
 
Method Summary
 long getLoadDuration()
          return the number of milliseconds taken to load.
 boolean hasGlossary()
          is there an Glossary
static boolean isGlossaryDocument(java.lang.String sText)
          checks if this looks like an GlossaryDocument but no structure checks will be made now.
 void loadData(java.lang.String sText)
          parse the document and try to find the component objects in their text representation.
static void main(java.lang.String[] args)
          a main method for testing
 java.lang.String print()
           
 java.lang.String printDocBook()
           
 java.lang.String printHtml()
           
 java.lang.String printReport()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GlossaryDocument

public GlossaryDocument()

GlossaryDocument

public GlossaryDocument(java.lang.String sText)
Method Detail

getLoadDuration

public long getLoadDuration()
return the number of milliseconds taken to load.


loadData

public void loadData(java.lang.String sText)
parse the document and try to find the component objects in their text representation.


isGlossaryDocument

public static boolean isGlossaryDocument(java.lang.String sText)
checks if this looks like an GlossaryDocument but no structure checks will be made now.


hasGlossary

public boolean hasGlossary()
is there an Glossary


toString

public java.lang.String toString()

printHtml

public java.lang.String printHtml()

printDocBook

public java.lang.String printDocBook()

printReport

public java.lang.String printReport()

print

public java.lang.String print()

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception
a main method for testing

Throws:
java.lang.Exception