1 /*
2 * Copyright (c) 2002-2019, Mairie de Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34
35 package fr.paris.lutece.nlptools;
36
37 import java.util.List;
38
39 /**
40 * Finder Interface for entity finders
41 */
42 public interface Finder
43 {
44 /**
45 * Find one or several occurrences of an entity
46 *
47 * @param strInputText
48 * The input text
49 * @return The list of entities found
50 * @throws FinderException
51 * If an error occurs
52 */
53 List<String> findOccurrences( String strInputText ) throws FinderException;
54
55 /**
56 * Replace all the occurrences of an entity by a replacement text
57 *
58 * @param strInputText
59 * The input text
60 * @throws FinderException
61 * If an error occurs
62 * @return The text with replacements
63 */
64 String replaceOccurrences( String strInputText ) throws FinderException;
65
66 /**
67 * Replace all the occurrences of an entity by a replacement text
68 *
69 * @param strInputText
70 * The input text
71 * @param strReplacement
72 * The replacement text
73 * @throws FinderException
74 * If an error occurs
75 * @return The text with replacements
76 */
77 String replaceOccurrences( String strInputText, String strReplacement ) throws FinderException;
78
79 /**
80 * Returns all found entities after a findOccurences
81 *
82 * @return The list
83 */
84 List<String> getFoundEntities( );
85 }