- Gazetteer - Interface in com.bericotech.clavin.gazetteer.query
-
A Gazetteer provides lookup methods for retrieving details about known
places found in the indexed Gazetteer data.
- GazetteerQuery - Class in com.bericotech.clavin.gazetteer.query
-
Configuration parameters for querying a Gazetteer.
- GazetteerQuery(LocationOccurrence, int, FuzzyMode, boolean, boolean, Set<Integer>, Set<FeatureCode>) - Constructor for class com.bericotech.clavin.gazetteer.query.GazetteerQuery
-
Create a new GazetteerQuery.
- GeoName - Class in com.bericotech.clavin.gazetteer
-
Data-rich representation of a named location, based on entries in
the GeoNames gazetteer.
- GeoName(int, String, String, List<String>, String, Double, Double, FeatureClass, FeatureCode, CountryCode, List<CountryCode>, String, String, String, String, Long, Integer, Integer, TimeZone, Date, String) - Constructor for class com.bericotech.clavin.gazetteer.GeoName
-
Sole constructor for
GeoName class.
- geonameID - Variable in enum com.bericotech.clavin.gazetteer.CountryCode
-
- GeoParser - Class in com.bericotech.clavin
-
Performs geoparsing of documents; extracts location names from
unstructured text and resolves them against a gazetteer to produce
structured geo data.
- GeoParser(LocationExtractor, Gazetteer, int, int, boolean) - Constructor for class com.bericotech.clavin.GeoParser
-
Default constructor.
- GeoParserFactory - Class in com.bericotech.clavin
-
Simple Factory for the creation of GeoParser instances.
- GeoParserFactory() - Constructor for class com.bericotech.clavin.GeoParserFactory
-
- getAdmin1Code() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the code for the first level administrative division (e.g.
- getAdmin2Code() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the code for the second level administrative division (e.g.
- getAdmin3Code() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the code for the third level administrative division.
- getAdmin4Code() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the code for the fourth level administrative division.
- getAlternateCountryCodes() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the alternate ISO-3166 2-letter country codes.
- getAlternateNames() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the alternate names for the location.
- getAncestryKey() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the ancestry key that can be used to identify this administrative division.
- getAsciiName() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the name of the geographical point in plain ascii characters.
- getBestLocation() - Method in class com.bericotech.clavin.resolver.multipart.SearchResult
-
- getBooleanIndexValue(boolean) - Static method in enum com.bericotech.clavin.index.IndexField
-
Gets the integer value representing the provided boolean value in
the Lucene index.
- getCity() - Method in class com.bericotech.clavin.resolver.multipart.MultipartLocationName
-
Get the text of the city name.
- getCity() - Method in class com.bericotech.clavin.resolver.multipart.ResolvedMultipartLocation
-
Get the text of the city name.
- getClosestLocations(GazetteerQuery) - Method in interface com.bericotech.clavin.gazetteer.query.Gazetteer
-
Execute a query against the gazetteer using the provided configuration,
returning the top matches as
ResolvedLocations.
- getClosestLocations(GazetteerQuery) - Method in class com.bericotech.clavin.gazetteer.query.LuceneGazetteer
-
Execute a query against the Lucene gazetteer index using the provided configuration,
returning the top matches as
ResolvedLocations.
- getCode(GeoName) - Method in enum com.bericotech.clavin.resolver.multipart.SearchLevel
-
- getConfidence() - Method in class com.bericotech.clavin.resolver.ResolvedLocation
-
Get the confidence score for resolution.
- getCountry() - Method in class com.bericotech.clavin.resolver.multipart.MultipartLocationName
-
Get the text of the country name.
- getCountry() - Method in class com.bericotech.clavin.resolver.multipart.ResolvedMultipartLocation
-
Get the text of the country name.
- getDefault(String) - Static method in class com.bericotech.clavin.GeoParserFactory
-
Get the default GeoParser, with maxHitDepth and maxContentWindow
both set to 1, and fuzzy matching turned off.
- getDefault(String, boolean) - Static method in class com.bericotech.clavin.GeoParserFactory
-
Get a GeoParser with fuzzy matching explicitly turned on or off.
- getDefault(String, int, int) - Static method in class com.bericotech.clavin.GeoParserFactory
-
Get a GeoParser with defined values for maxHitDepth and
maxContentWindow.
- getDefault(String, int, int, boolean) - Static method in class com.bericotech.clavin.GeoParserFactory
-
Get a GeoParser with defined values for maxHitDepth and
maxContentWindow, and fuzzy matching explicitly turned on or off.
- getDefault(String, LocationExtractor, int, int, boolean) - Static method in class com.bericotech.clavin.GeoParserFactory
-
Get a GeoParser with defined values for maxHitDepth and
maxContentWindow, fuzzy matching explicitly turned on or off,
and a specific LocationExtractor to use.
- getDepth() - Method in class com.bericotech.clavin.resolver.multipart.MatchedLocation.Match
-
- getDescription() - Method in enum com.bericotech.clavin.gazetteer.FeatureCode
-
- getDigitalElevationModel() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the digital elevation model, srtm3 or gtopo30, average
elevation of 3''x3'' (ca 90mx90m) or 30''x30'' (ca 900mx900m)
area in meters, integer.
- getElevation() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the elevation in meters.
- getFeatureClass() - Method in enum com.bericotech.clavin.gazetteer.FeatureCode
-
- getFeatureClass() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the major feature category.
- getFeatureCode() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the feature code.
- getFeatureCodes() - Method in class com.bericotech.clavin.gazetteer.query.GazetteerQuery
-
Get the set of FeatureCodes that should be used to restrict the search.
- getFuzzyMode() - Method in class com.bericotech.clavin.gazetteer.query.GazetteerQuery
-
Indicates how fuzzy matching should be used.
- getGazetteer() - Method in class com.bericotech.clavin.resolver.ClavinLocationResolver
-
Get the Gazetteer used by this resolver.
- getGazetteerRecord() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the gazetteer record for this GeoName.
- getGazetteerRecordWithAncestry() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the gazetteer records for this GeoName and its ancestors, separated
by newline characters.
- getGeoName(int) - Method in interface com.bericotech.clavin.gazetteer.query.Gazetteer
-
Retrieves the GeoName with the provided ID.
- getGeoName(int) - Method in class com.bericotech.clavin.gazetteer.query.LuceneGazetteer
-
Retrieves the GeoName with the provided ID.
- getGeoname() - Method in class com.bericotech.clavin.resolver.ResolvedLocation
-
Get the geographic entity resolved from the location name.
- getGeonameID() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the ID of the record in geonames database.
- getLatitude() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the latitude in decimal degrees.
- getLevel() - Method in class com.bericotech.clavin.resolver.multipart.MatchedLocation.Match
-
- getLocation() - Method in class com.bericotech.clavin.resolver.multipart.MatchedLocation.Match
-
- getLocation() - Method in class com.bericotech.clavin.resolver.ResolvedLocation
-
Get the original location name extracted from the text.
- getLongitude() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the longitude in decimal degrees.
- getMatch(SearchLevel) - Method in class com.bericotech.clavin.resolver.multipart.MatchedLocation
-
- getMatchCount() - Method in class com.bericotech.clavin.resolver.multipart.MatchedLocation
-
- getMatchedName() - Method in class com.bericotech.clavin.resolver.ResolvedLocation
-
Get the name from the gazetteer record that the inputName was
matched against.
- getMatches() - Method in class com.bericotech.clavin.resolver.multipart.MatchedLocation
-
- getMaximumScore() - Method in class com.bericotech.clavin.resolver.multipart.DefaultScorer
-
- getMaximumScore() - Method in interface com.bericotech.clavin.resolver.multipart.Scorer
-
Get the maximum score returned by this scorer.
- getMaxResults() - Method in class com.bericotech.clavin.gazetteer.query.GazetteerQuery
-
Get the maximum number of results that should be returned by this query.
- getMinimumScore() - Method in class com.bericotech.clavin.resolver.multipart.DefaultScorer
-
- getMinimumScore() - Method in interface com.bericotech.clavin.resolver.multipart.Scorer
-
Get the minimum score returned by this scorer.
- getModificationDate() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the last modification date in the GeoNames database.
- getMostSpecificMatch() - Method in class com.bericotech.clavin.resolver.multipart.MatchedLocation
-
- getName() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the name of the geographical point (UTF-8).
- getOccurrence() - Method in class com.bericotech.clavin.gazetteer.query.GazetteerQuery
-
Get the LocationOccurrence to search on.
- getParent() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the parent of this GeoName.
- getParentAncestryKey() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the ancestry key that can be used to identify the direct administrative
parent of this GeoName.
- getParentIds() - Method in class com.bericotech.clavin.gazetteer.query.GazetteerQuery
-
Get the set of parents that should be used to restrict the search.
- getPopulation() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the total number of inhabitants.
- getPosition() - Method in class com.bericotech.clavin.extractor.LocationOccurrence
-
Get the position in the text where the location name starts.
- getPreferredName() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Gets the preferred name of this GeoName, if configured,
otherwise returns the name.
- getPrimaryCountryCode() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the primary ISO-3166 2-letter country code.
- getPrimaryCountryName() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
- getState() - Method in class com.bericotech.clavin.resolver.multipart.MultipartLocationName
-
Get the text of the state/province/etc.
- getState() - Method in class com.bericotech.clavin.resolver.multipart.ResolvedMultipartLocation
-
Get the text of the state/province/etc.
- getText() - Method in class com.bericotech.clavin.extractor.LocationOccurrence
-
Get the text of the location name.
- getTimezone() - Method in class com.bericotech.clavin.gazetteer.GeoName
-
Get the time zone for the geographical point.
- getType() - Method in enum com.bericotech.clavin.gazetteer.FeatureCode
-
- getValue(Document) - Method in enum com.bericotech.clavin.index.IndexField
-
Get the value of this field as set in the given document or null
if the field is not set or cannot be retrieved.
- valueOf(String) - Static method in enum com.bericotech.clavin.gazetteer.CountryCode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.bericotech.clavin.gazetteer.FeatureClass
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.bericotech.clavin.gazetteer.FeatureCode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.bericotech.clavin.gazetteer.query.FuzzyMode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.bericotech.clavin.index.IndexField
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.bericotech.clavin.resolver.multipart.SearchLevel
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.bericotech.clavin.gazetteer.CountryCode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.bericotech.clavin.gazetteer.FeatureClass
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.bericotech.clavin.gazetteer.FeatureCode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.bericotech.clavin.gazetteer.query.FuzzyMode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.bericotech.clavin.index.IndexField
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.bericotech.clavin.resolver.multipart.SearchLevel
-
Returns an array containing the constants of this enum type, in
the order they are declared.