1 | /* |
2 | Copyright - 2017 2023 - wwwouaiebe - Contact: https://www.ouaie.be/ |
3 | |
4 | This program is free software; |
5 | you can redistribute it and/or modify it under the terms of the |
6 | GNU General Public License as published by the Free Software Foundation; |
7 | either version 3 of the License, or any later version. |
8 | |
9 | This program is distributed in the hope that it will be useful, |
10 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
12 | GNU General Public License for more details. |
13 | |
14 | You should have received a copy of the GNU General Public License |
15 | along with this program; if not, write to the Free Software |
16 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
17 | */ |
18 | /* |
19 | Changes: |
20 | - v4.0.0: |
21 | - created from v3.6.0 |
22 | Doc reviewed 202208 |
23 | */ |
24 | |
25 | import theHTMLSanitizer from '../htmlSanitizer/HTMLSanitizer.js'; |
26 | |
27 | /* ------------------------------------------------------------------------------------------------------------------------- */ |
28 | /** |
29 | A simple container to store an address created by the geocoder |
30 | */ |
31 | /* ------------------------------------------------------------------------------------------------------------------------- */ |
32 | |
33 | class GeoCoderAddress { |
34 | |
35 | /** |
36 | The name found in OSM by the GeoCoder or an empty string |
37 | @type {String} |
38 | */ |
39 | |
40 | #name; |
41 | |
42 | /** |
43 | The house number and the street found in OSM by the GeoCoder or an empty string |
44 | @type {String} |
45 | */ |
46 | |
47 | #street; |
48 | |
49 | /** |
50 | The city and eventually the place found in OSM by the GeoCoder or an empty string |
51 | @type {String} |
52 | */ |
53 | |
54 | #city; |
55 | |
56 | /** |
57 | The constructor |
58 | @param {String} nominatimName The name found in OSM |
59 | @param {String} street The house number and the street found in OSM |
60 | @param {String} city The city and eventually the place found in OSM |
61 | */ |
62 | |
63 | constructor ( nominatimName, street, city ) { |
64 | Object.freeze ( this ); |
65 | this.#name = theHTMLSanitizer.sanitizeToJsString ( nominatimName ); |
66 | this.#street = theHTMLSanitizer.sanitizeToJsString ( street ); |
67 | this.#city = theHTMLSanitizer.sanitizeToJsString ( city ); |
68 | } |
69 | |
70 | /** |
71 | The name found in OSM by the GeoCoder or an empty string |
72 | @type {String} |
73 | */ |
74 | |
75 | get name ( ) { return this.#name; } |
76 | |
77 | /** |
78 | The house number and the street found in OSM by the GeoCoder or an empty string |
79 | @type {String} |
80 | */ |
81 | |
82 | get street ( ) { return this.#street; } |
83 | |
84 | /** |
85 | The city and eventually the place found in OSM by the GeoCoder or an empty string |
86 | @type {String} |
87 | */ |
88 | |
89 | get city ( ) { return this.#city; } |
90 | |
91 | } |
92 | |
93 | export default GeoCoderAddress; |
94 | |
95 | /* --- End of file --------------------------------------------------------------------------------------------------------- */ |
96 |