Qizx fe-4.4p2 API

com.qizx.api.fulltext
Interface FullTextFactory

All Known Implementing Classes:
DefaultFullTextFactory

public interface FullTextFactory

Pluggable factory of Full-text resources.

Allows redefining the way resources like full-text Tokenizer, Stemmer and Thesaurus are created and accessed.

The default Fulltext Provider provides a language-independent tokenizer, no stemmer, no stop-word list, no thesaurus.

Note: stopword lists are not supported.


Method Summary
 Scorer createScorer()
          Returns a scoring algorithm.
 Stemmer getStemmer(String languageCode)
          Returns an appropriate Stemmer for the language, if any.
 Thesaurus getThesaurus(String uri, String languageCode, String relationship, int levelMin, int levelMax)
          Returns a Thesaurus lookup driver.
 TextTokenizer getTokenizer(String languageCode)
          Returns an instance of TextTokenizer suitable for the specified language.
 

Method Detail

getTokenizer

TextTokenizer getTokenizer(String languageCode)
Returns an instance of TextTokenizer suitable for the specified language.

Parameters:
languageCode - an ISO language code (e.g 'en', 'fr-CH'), or null if no language is specified, in which case a generic tokenizer (DefaultTextTokenizer) is provided.
Returns:
a new instance of a WordTokenizer.

getStemmer

Stemmer getStemmer(String languageCode)
Returns an appropriate Stemmer for the language, if any.

Parameters:
languageCode -
Returns:
an instance of a Stemmer, or null if no applicable stemmer can be found,

getThesaurus

Thesaurus getThesaurus(String uri,
                       String languageCode,
                       String relationship,
                       int levelMin,
                       int levelMax)
Returns a Thesaurus lookup driver. This driver is searched using the URI and the language code. It is then assumed to filter lookup by the specified relationship and levels.

Parameters:
uri - identifier of the Thesaurus. It is the string "default" if the default thesaurus is invoked.
languageCode - a normalized language code like "en" or "fr-CH". A null language code is in principle not meaningful.
relationship - relationship from root word(s) to thesaurus-equivalent words. It can be null if the relationship is unspecified.
levelMin - minimum value of the level of a synonym. A simple synonym has a level equal to 1.
levelMax - maximum value of the level of a synonym. A negative value means no maximum.
Returns:
an instance of a Thesaurus, or null if none can be found,

createScorer

Scorer createScorer()
Returns a scoring algorithm.

Returns:
an implementation of Scorer

© 2010 Axyana Software