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.ArrayList;
38 import java.util.List;
39
40 /**
41 * Abstract Finder
42 */
43 public abstract class AbstractFinder implements Finder
44 {
45 private static final String DEFAULT_LANGUAGE = "en";
46 private String _strReplacement;
47 private String _strLanguage = DEFAULT_LANGUAGE;
48 private List<String> _listFoundEntities = new ArrayList<>( );
49
50 /**
51 * Constructor
52 */
53 public AbstractFinder( )
54 {
55 _strReplacement = " ";
56 }
57
58 /**
59 * Constructor
60 *
61 * @param strReplacement
62 * Replacement
63 */
64 public AbstractFinder( String strReplacement )
65 {
66 _strReplacement = strReplacement;
67 }
68
69 /**
70 * Constructor
71 *
72 * @param strReplacement
73 * Replacement
74 * @param strLanguage
75 * Language
76 */
77 public AbstractFinder( String strReplacement, String strLanguage )
78 {
79 _strReplacement = strReplacement;
80 _strLanguage = strLanguage;
81 }
82
83 /**
84 * @return the _strLanguage
85 */
86 public String getLanguage( )
87 {
88 return _strLanguage;
89 }
90
91 /**
92 * @param strLanguage
93 * the _strLanguage to set
94 */
95 public void setLanguage( String strLanguage )
96 {
97 _strLanguage = strLanguage;
98 }
99
100 /**
101 * @return the replacement
102 */
103 public String getReplacement( )
104 {
105 return _strReplacement;
106 }
107
108 /**
109 * @param strReplacement
110 * the replacement to set
111 */
112 public void setReplacement( String strReplacement )
113 {
114 _strReplacement = strReplacement;
115 }
116
117 /**
118 * Add a found entity
119 *
120 * @param strEntity
121 * The entity
122 */
123 public void addEntity( String strEntity )
124 {
125 _listFoundEntities.add( strEntity );
126 }
127
128 /**
129 * Get all found entities
130 *
131 * @return The list
132 */
133 @Override
134 public List<String> getFoundEntities( )
135 {
136 return new ArrayList( _listFoundEntities );
137 }
138
139 }