textractor.abbreviation
Class Abbreviation

java.lang.Object
  textractor.abbreviation.Abbreviation

public final class Abbreviation
extends Object

Finds possible abbreviations when given a long form search term, and returns a result ranked by relevance.

Constructor Summary

Abbreviation(DocumentIndexManager newDocManager)
Constructor for Abbreviation searcher.

Abbreviation(DocumentIndexManager newDocManager, DocumentStoreReader docStoreReader)
Constructore for Abbreviation searcher.

Method Summary

List<ScoredResult>

findAbbreviationsForLongForm(String longForm) Searches for abbreviations of the form: long form (abbreviation) in the index provided by the docmanager.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Abbreviation

public Abbreviation(DocumentIndexManager newDocManager)
             throws IOException

Constructor for Abbreviation searcher. Requires a DocumentIndexManager, from which a new word reader will be created.

Parameters:

newDocManager -

Throws:

IOException

Abbreviation

public Abbreviation(DocumentIndexManager newDocManager,
                    DocumentStoreReader docStoreReader)
             throws IOException

Constructore for Abbreviation searcher. Use this method if a DocumentStoreReader already exists for the DocumentIndexManager, newDocManager. Otherwise, use Abbreviations(DocumentIndexManager).

Parameters:

newDocManager -

docStoreReader -

Throws:

IOException

Method Detail

findAbbreviationsForLongForm

public List<ScoredResult> findAbbreviationsForLongForm(String longForm)
                                                throws IOException

Searches for abbreviations of the form: long form (abbreviation) in the index provided by the docmanager.

Parameters:

longForm - is the String to search for

Returns:

an ArrayList of abbreviation terms and scores, wrapped as a ScoredResult.

Throws:

IOException