org.wicketstuff.datatable_autocomplete.trie.Trie Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wicketstuff-datatable-autocomplete-common Show documentation

This module provides the Patricia Trie implementation. It is seperated from the main datatable-autocomplete module to allow reuse in non wicket environments.

There is a newer version: 1.5.13

Show newest version

package org.wicketstuff.datatable_autocomplete.trie;

import java.util.List;

import org.apache.wicket.IClusterable;

/**
 * 
 * @author mocleiri
 * 
 *         With the introduction of the TernarySearchTrie this interface was extracted to provide a
 *         common base between them.
 */
public interface Trie extends IClusterable
{

	/**
	 * @param value
	 */
	public abstract void index(C value);

	/**
	 * Get the list of strings that are reachable from the prefix given.
	 * 
	 * i.e. the ordered traversal of the subtree for the prefix given.
	 * 
	 * @param prefix
	 * @return reachable list of strings.
	 */
	public abstract List getWordList(String prefix);

	public abstract List getWordList(String prefix, ITrieFilter filter);

	public abstract List getWordList(String prefix, ITrieFilter filter, int limit);

	public abstract List getWordList(String prefix, int limit);

	/**
	 * Invoked before the indexing process is started.
	 */
	public abstract void preIndexing();

	/**
	 * Invoked after the index process has completed.
	 */
	public abstract void postIndexing();


}