Phonetix > Library

You are here:

Home > Products > Phonetix > Library

com.tangentum.phonetix.lucene (Phonetix)

Overview

Package

Class

Tree

Index

Help

Phonetix
v0.2

PREV PACKAGE NEXT PACKAGE

FRAMES NO FRAMES

Package com.tangentum.phonetix.lucene

Provides adapter-classes for the Lucene search-engine.

See:
Description

Class Summary

HitEnumeration An HitEnumeration adapts the results of a Lucene search to the standard Java collections.

PhoneticAnalyzer Filters StandardTokenizer with StandardFilter, LowerCaseFilter, StopFilter, and PhoneticFilter.

PhoneticFilter A PhoneticFilter is a TokenFilter according to the Lucene search-engine, which uses a PhoneticEncoder.

Package com.tangentum.phonetix.lucene Description

Provides adapter-classes for the Lucene search-engine.

Package Specification

This package provides implementations of adapters of some popular phonetic algorithms to the Lucene search-engine. The adapters are mainly special Analyzers as defined by Lucene's API.

Using the adapters is as easy as using the standard Analyzers of Lucene. Simply replace them with PhoneticAnalyzers while writing and searching the indices. But be careful to use exactly the same phonetic algorithm for indexing and searching, because an index written by one algorithm can't be used with a query using an other algorithm.

This package is available, if the library of the Lucene search-engine was contained in the classpath while building phonetix-X.Y.jar. The library included in the standard distribution already contains the adapters, therefore Phonetix is usable together with Lucene "out of the box".