RefEntryBackEnd

Name

RefEntryBackEnd -- back end class holding RefEntry information

Synopsis

 class RefEntryBackEnd {
RefEntryBackEnd(HashSet cw);
boolean add(RefEntry page);
HashSet getEntry(String id);
HashSet getValues(HashSet keys);
}

Description

RefEntryBackEnd holds the information required to be able to search the servlet RefEntry documents. Its add method adds a RefEntry to the backend index. Its getValues method returns a set of RefEntry documents for the search keys.

Parameters

The RefEntryBackEnd constructor takes a set of common words cw to ignore when indexing RefEntry documents.

Methods

RefEntryBackEnd class "friendly" (package private) methods make it possible for the servlet to handle RefEntry objects.

add

Add a RefEntry to the back end.

getEntry

Retrieve a RefEntry through the back end, given the RefEntry identifier.

getValues

Retrieve a set of RefEntry documents through the back end, given a set of keys on which the documents are indexed.