fr.paris.lutece.nlptools

Interface Finder

All Known Implementing Classes:

AbstractFinder, EmailFinder, PersonNameFinder, PhoneNumberFinder

public interface Finder

Finder Interface for entity finders

Method Summary

Modifier and Type	Method and Description
List<String>	findOccurrences(String strInputText) Find one or several occurrences of an entity
List<String>	getFoundEntities() Returns all found entities after a findOccurences
String	replaceOccurrences(String strInputText) Replace all the occurrences of an entity by a replacement text
String	replaceOccurrences(String strInputText, String strReplacement) Replace all the occurrences of an entity by a replacement text

Method Detail

findOccurrences

List<String> findOccurrences(String strInputText)
                      throws FinderException

Find one or several occurrences of an entity

Parameters:

strInputText - The input text

Returns:

The list of entities found

Throws:

FinderException - If an error occurs

replaceOccurrences

String replaceOccurrences(String strInputText)
                   throws FinderException

Replace all the occurrences of an entity by a replacement text

Parameters:

strInputText - The input text

Returns:

The text with replacements

Throws:

FinderException - If an error occurs

replaceOccurrences

String replaceOccurrences(String strInputText,
                          String strReplacement)
                   throws FinderException

Replace all the occurrences of an entity by a replacement text

Parameters:

strInputText - The input text

strReplacement - The replacement text

Returns:

The text with replacements

Throws:

FinderException - If an error occurs

getFoundEntities

List<String> getFoundEntities()

Returns all found entities after a findOccurences

Returns:

The list