A C D E G I K L M Q R S T U W _

A

actionPerformed(ActionEvent) - Method in class UserInterface.SearchPanel
Initiates the search sequence when the return button is pressed or the search button is clicked, but first it validates the search expression
activeOperators - Static variable in class SearchOperations.Query
Holds the operators the query can identify
addKeyword(String) - Method in class TextDatabase.KeywordTreeSet
Adds a keyword to the collection while managing the keyword's frequency and mantains the record of the most popular keyword
Application - Class in UserInterface
 
Application() - Constructor for class UserInterface.Application
 

C

CapitalA - Static variable in class TextDatabase.WordReader
Holds the capital A character
CapitalToSmallDistance - Static variable in class TextDatabase.WordReader
Holds the distance betweeen small and capital characters
CapitalZ - Static variable in class TextDatabase.WordReader
Holds the capital Z character
CarriageReturn - Static variable in class TextDatabase.WordReader
Holds the carriage return character
ChildPanel - Class in UserInterface
Panel with reference to Master Container
ChildPanel() - Constructor for class UserInterface.ChildPanel
 
compare(Object, Object) - Method in class TextDatabase.Keyword
Compares one keyword with another
compareTo(Object) - Method in class TextDatabase.Document
Compares the Document to another document
compareTo(Object) - Method in class TextDatabase.Keyword
Compares the keyword to another object
contains(String) - Method in class TextDatabase.KeywordTreeSet
Returns true if a keywordname exists in the tree set

D

Document - Class in TextDatabase
The Document is a tree set of keywords
Document(DocumentTreeSet, String) - Constructor for class TextDatabase.Document
Initializes the Document from a file
documentDirectory - Static variable in class TextDatabase.DocumentTreeSet
Holds the directory of the documents
DocumentTreeSet - Class in TextDatabase
A DocumentTreeSet is a TreeSet of Documents
DocumentTreeSet() - Constructor for class TextDatabase.DocumentTreeSet
Initializes the Document Tree Set by reading all the documents held in the document directory
DocumentViewerDialog - Class in UserInterface
Observes the document analysis
DocumentViewerDialog(Document) - Constructor for class UserInterface.DocumentViewerDialog
Initializes the Document Viewer Dialog from a document

E

EndOfFile - Static variable in class TextDatabase.WordReader
Holds the End Of File character
equals(Object) - Method in class TextDatabase.Document
Checks if the Document is equal to another Document
equals(Object) - Method in class TextDatabase.Keyword
Checks the equality of the keyword with an object
evaluate(boolean[]) - Method in class SearchOperations.Query
Evaluates the query by using the boolean weights provided by the document 1.

G

getAlternateDocumentRank(Query, Document) - Method in class TextDatabase.DocumentTreeSet
Gets the document rank for the specified query.
getDocument(String) - Method in class TextDatabase.DocumentTreeSet
Returns the document with the corresponding document name
getDocumentRank(Query, Document) - Method in class TextDatabase.DocumentTreeSet
 
getDocumentRankings(Query, DocumentTreeSet) - Static method in class SearchOperations.SearchEngine
Gets a vector with document rankings derived from the document term weights and the query term weights.
getDocumentTreeSet() - Method in class UserInterface.MainFrame
Gets the active document tree set
getExpression() - Method in class SearchOperations.Query
Gets the raw expression
getFileName() - Method in class TextDatabase.Document
Gets the Document filename
getFrequency() - Method in class TextDatabase.Keyword
Gets the keyword frequency
getFullDocumentRank(Query, Document) - Method in class TextDatabase.DocumentTreeSet
 
getGlobalKeywordTreeSet() - Method in class TextDatabase.DocumentTreeSet
 
getInverseDocumentFrequency(Keyword) - Method in class TextDatabase.DocumentTreeSet
Returns the inverse document frequency Inverse Document Frequency = log2( Number Of Documents divided by the number of times a keyword exists in the Tree Set
getInverseDocumentFrequency(String) - Method in class TextDatabase.DocumentTreeSet
Returns the inverse document frequency Inverse Document Frequency = log2( Number Of Documents divided by the number of times a keyword exists in the Tree Set
getInverseDocumentFrequency(int) - Method in class TextDatabase.DocumentTreeSet
 
getKeyword(String) - Method in class TextDatabase.KeywordTreeSet
Gets the Keyword whose keyword name is KeywordName
getKeywordName() - Method in class TextDatabase.Keyword
Gets the keyword's name
getMasterContainer() - Method in class UserInterface.ChildPanel
Gets the Master Container
getMostPopularKeywordFrequency() - Method in class TextDatabase.KeywordTreeSet
Returns the most popular keyword's frequency
getNormalizedFrequency(String) - Method in class TextDatabase.KeywordTreeSet
Gets the normalized frequency of a keywordName Normalized Frequency = keyword's frequency / most popular keyword's frequency
getNormalizedFrequency(Keyword) - Method in class TextDatabase.KeywordTreeSet
Gets the normalized frequency of a keywordName Normalized Frequency = keyword's frequency / most popular keyword's frequency
getQuery() - Method in class UserInterface.SearchPanel
Gets the query from the search expression
getRelevantDocuments(Query, DocumentTreeSet) - Static method in class SearchOperations.SearchEngine
Gets a vector with the relevant documents that satisfy the query.
getTermWeight(String, double) - Method in class SearchOperations.Query
Gets the weight of term for the specifed query QueryTermWeight = (0.5 + (0.5*term's normalized frequency(query))) * term's inverse document frequency
getTermWeight(Keyword, double) - Method in class TextDatabase.Document
Get's the weight of a term for the specified document
getTermWeight(String, double) - Method in class TextDatabase.Document
Gets the weight of term for the specifeid document.
getText() - Method in class TextDatabase.Document
Returns the document's filename contents

I

isCellEditable(int, int) - Method in class UserInterface.ReadOnlyTable
Prevents a cell from being edited
isRelevant(Query) - Method in class TextDatabase.Document
Checks if a document is relevant to a query by evaluating the keywords and the operands of the query

K

Keyword - Class in TextDatabase
A Keyword has a name and a frequency
Keyword(String) - Constructor for class TextDatabase.Keyword
Initializes a the Keyword and sets it's name
Keyword(String, int) - Constructor for class TextDatabase.Keyword
Initializes the Keyword and sets it's name and frequency
KeywordTreeSet - Class in TextDatabase
The KeywordTreeSet is a TreeSet of keywords
KeywordTreeSet() - Constructor for class TextDatabase.KeywordTreeSet
 

L

LineFeed - Static variable in class TextDatabase.WordReader
Holds the linefeed character

M

main(String[]) - Static method in class UserInterface.MainFrame
Main function that initiates the application
MainFrame - Class in UserInterface
The Main Frame is the Master Container and beholder of the User Interface
MainFrame() - Constructor for class UserInterface.MainFrame
Initializes the Main Frame and places all panels to their proper positions.
Mode - Static variable in class UserInterface.Application
 

Q

Query - Class in SearchOperations
Implementation of the user's query
Query(String) - Constructor for class SearchOperations.Query
Initializes the query from a raw text expression

R

ReadOnlyTable - Class in UserInterface
The ReadOnlyTable is JTable whose contents cannot be edited
ReadOnlyTable(Vector, Vector) - Constructor for class UserInterface.ReadOnlyTable
Initializes the ReadOnlyTable
ReadWord() - Method in class TextDatabase.WordReader
Reads a word by reading character after character, converting it to lower case.
ResultPanel - Class in UserInterface
Result Panel contains two columns with the results for each Search Model
ResultPanel() - Constructor for class UserInterface.ResultPanel
Initializes the Result Panel and the column names for each model

S

SearchEngine - Class in SearchOperations
Facilitates the searching activities of the application
SearchEngine() - Constructor for class SearchOperations.SearchEngine
 
SearchOperations - package SearchOperations
 
SearchPanel - Class in UserInterface
The Search Panel is a ChildPanel that implements the Searching part of the User Interface
SearchPanel() - Constructor for class UserInterface.SearchPanel
Initiates the Search panel and it's action listeners
setDocument(Document) - Method in class UserInterface.DocumentViewerDialog
Sets the document
setExpression(String) - Method in class SearchOperations.Query
Set's the query expression
setFileName(String) - Method in class TextDatabase.Document
Sets the document's filename and keyword tree set
setFrequency(int) - Method in class TextDatabase.Keyword
Sets the keyword's frequency
setGlobalKeywordTreeSet(KeywordTreeSet) - Method in class TextDatabase.DocumentTreeSet
 
setKeywordName(String) - Method in class TextDatabase.Keyword
Sets the keyword's name
setResults() - Method in class UserInterface.MainFrame
Sets the contents of the Result Panel.
setResults(Vector, Vector) - Method in class UserInterface.ResultPanel
Populates the Tables with the results of each model
SmallA - Static variable in class TextDatabase.WordReader
Holds the small A character
SmallZ - Static variable in class TextDatabase.WordReader
Holds the small Z character
StopWordTreeSet - Class in TextDatabase
The StopWordTreeSet is TreeSet of StopWords.
StopWordTreeSet() - Constructor for class TextDatabase.StopWordTreeSet
Initializes the StopWordTreeSet from the file

T

TextDatabase - package TextDatabase
 
toString() - Method in class TextDatabase.Document
Returns the documents filename
toString() - Method in class TextDatabase.Keyword
Gets the keyword's name
toVector() - Method in class TextDatabase.Document
Vectorizes the contents of the tree set

U

UserInterface - package UserInterface
 

W

WordReader - Class in TextDatabase
The WordReader class reads words from a file
WordReader(String) - Constructor for class TextDatabase.WordReader
Initializes the WordReader

_

_masterContainer - Variable in class UserInterface.ChildPanel
Holds a reference to the Master Container
_mostPopularKeyword - Variable in class TextDatabase.KeywordTreeSet
Holds the keyword with the highest frequency

A C D E G I K L M Q R S T U W _