Package org.openstreetmap.josm.io
Class NameFinder
- java.lang.Object
-
- org.openstreetmap.josm.io.NameFinder
-
public final class NameFinder extends Object
Search for names and related items.- Since:
- 11002
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
NameFinder.NameFinderResultParser
A very primitive parser for the name finder's output.static class
NameFinder.SearchResult
Data storage for search results.
-
Field Summary
Fields Modifier and Type Field Description static String
NOMINATIM_URL
Nominatim default URL.static StringProperty
NOMINATIM_URL_PROP
Nominatim URL property.
-
Constructor Summary
Constructors Modifier Constructor Description private
NameFinder()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static URL
buildNominatimURL(String searchExpression)
Builds the Nominatim URL for performing the given searchstatic URL
buildNominatimURL(String searchExpression, Collection<NameFinder.SearchResult> excludeResults)
Builds the Nominatim URL for performing the given search and excluding the results (of a previous search)static List<NameFinder.SearchResult>
parseSearchResults(Reader reader)
Parse search results as returned by Nominatim.static List<NameFinder.SearchResult>
query(URL url)
Performs a custom search.static List<NameFinder.SearchResult>
queryNominatim(String searchExpression)
Performs a Nominatim search.
-
-
-
Field Detail
-
NOMINATIM_URL
public static final String NOMINATIM_URL
Nominatim default URL.- See Also:
- Constant Field Values
-
NOMINATIM_URL_PROP
public static final StringProperty NOMINATIM_URL_PROP
Nominatim URL property.- Since:
- 12557
-
-
Constructor Detail
-
NameFinder
private NameFinder()
-
-
Method Detail
-
buildNominatimURL
public static URL buildNominatimURL(String searchExpression)
Builds the Nominatim URL for performing the given search- Parameters:
searchExpression
- the Nominatim query- Returns:
- the Nominatim URL
-
buildNominatimURL
public static URL buildNominatimURL(String searchExpression, Collection<NameFinder.SearchResult> excludeResults)
Builds the Nominatim URL for performing the given search and excluding the results (of a previous search)- Parameters:
searchExpression
- the Nominatim queryexcludeResults
- the results to exclude- Returns:
- the Nominatim URL
- See Also:
- Result limitation in Nominatim Documentation
-
queryNominatim
public static List<NameFinder.SearchResult> queryNominatim(String searchExpression) throws IOException
Performs a Nominatim search.- Parameters:
searchExpression
- Nominatim search expression- Returns:
- search results
- Throws:
IOException
- if any IO error occurs.
-
query
public static List<NameFinder.SearchResult> query(URL url) throws IOException
Performs a custom search.- Parameters:
url
- search URL to any Nominatim instance- Returns:
- search results
- Throws:
IOException
- if any IO error occurs.
-
parseSearchResults
public static List<NameFinder.SearchResult> parseSearchResults(Reader reader) throws IOException, ParserConfigurationException, SAXException
Parse search results as returned by Nominatim.- Parameters:
reader
- reader- Returns:
- search results
- Throws:
ParserConfigurationException
- if a parser cannot be created which satisfies the requested configuration.SAXException
- for SAX errors.IOException
- if any IO error occurs.
-
-