Welcome to JSuggest

Current Release: June 1st 2008, JSuggest-Alpha-1.0

Project web site: http://sourceforge.net/projects/jsuggest/

The goal of the project is to provide a complete open source suggest framework for java.

Features Single and Multi-Field suggestions In-Client and Client/Server architecture Implements GWT, JSON, Hessian client/server Implements Java and GWT Multi Suggest Text Box Easy configuration Supports Bean- and Delimited File-Dictionaries Preprocessing allows for phonetic or word stemmer suggestions High performance, tested with data set of  apprx 1.5 Mio records Live GWT Demo USA ZIP Explorer

Quick Start Download the project from sourceforge Unzip the file Check that your default java version is 1.5 or higher by calling java -version. If this is not the case you may have to change the path to java in the bat files. Execute \bat\demo\fatclient\ZipClient.bat (If you are on another platform than windows go to the jsuggest home directory and call java -Xmx512m -showversion -jar jsuggest.jar org.rzo.jsuggest.demo.fatclient.ZIPUsa

Developers

The Core classes are:

• Dictionary: A Dictionary loads data into an index. Currently 2 types of Dictionary are implemented:
• FileDictionary: Allows loading of data from a Delimited Text File
• BeanDictionary: Stores data from java beans.
• DictionarySet: A Map of Dictionaries. A DictionarySet can be easily initialized from a configuration file. 
• MultiSuggestTextField: A Form containing 1 or more suggest boxes. The suggestions are updated in all Fields simultanously. The user may thus get a suggest for cities and states starting with "new".

For more details take a look at the javadoc and the included demos.

Configuration

The file /conf/dictionaries.properties.ini is a sample configuration file. The comments within this file will help you to adapt it .

Restrictions

• Currently only single word keys are supported. Thus, in the Zip demo, entry of state abbreviations is not supported. This will require as key 2 strings: state name and the state abbrev.
• Currently only single word encoders are supported. Thus, in the Zip Demo, entry of "Dakota" will not show "North Dakota" as suggestion. This will require word stemmers which return multiple words. In the example this would be "North" and "Dakota"
• Currently the index data storage only supports strings. It may be more useful to generally support "Comparable" for keys and Object[] for data.

Questions and Comments are welcome. Please post the on the sourceforge forums or tracker