A B C D E F G H I L M N O P R T V W

A

admin1Code - Variable in class com.bericotech.clavin.gazetteer.GeoName

admin2Code - Variable in class com.bericotech.clavin.gazetteer.GeoName

admin3Code - Variable in class com.bericotech.clavin.gazetteer.GeoName

admin4Code - Variable in class com.bericotech.clavin.gazetteer.GeoName

alternateCountryCodes - Variable in class com.bericotech.clavin.gazetteer.GeoName

alternateNames - Variable in class com.bericotech.clavin.gazetteer.GeoName

ApacheExtractor - Class in com.bericotech.clavin.extractor

Extracts location names from unstructured text documents using a named entity recognizer (Apache OpenNLP Name Finder).

ApacheExtractor() - Constructor for class com.bericotech.clavin.extractor.ApacheExtractor

Builds an ApacheExtractor by instantiating the OpenNLP Name Finder and Tokenizer.

asciiName - Variable in class com.bericotech.clavin.gazetteer.GeoName

B

BinarySimilarity - Class in com.bericotech.clavin.index

Turns TF (term frequency) into a binary (yes/no) proposition in calculating Lucene relevance score.

BinarySimilarity() - Constructor for class com.bericotech.clavin.index.BinarySimilarity

Simple default constructor for BinarySimilarity.

buildDoc(String, String, int, Long) - Static method in class com.bericotech.clavin.index.IndexDirectoryBuilder

Builds a Lucene document to be added to the index based on a specified name for the location and the corresponding GeoName object.

C

chunkifyList(List<T>, int) - Static method in class com.bericotech.clavin.util.ListUtils

Splits a list into a set of sublists (preserving order) where the size of each sublist is bound by a given max size, and ensuring that no list has fewer than half the max size number of elements.

com.bericotech.clavin - package com.bericotech.clavin

com.bericotech.clavin.extractor - package com.bericotech.clavin.extractor

com.bericotech.clavin.gazetteer - package com.bericotech.clavin.gazetteer

com.bericotech.clavin.index - package com.bericotech.clavin.index

com.bericotech.clavin.resolver - package com.bericotech.clavin.resolver

com.bericotech.clavin.resolver.lucene - package com.bericotech.clavin.resolver.lucene

com.bericotech.clavin.util - package com.bericotech.clavin.util

confidence - Variable in class com.bericotech.clavin.resolver.ResolvedLocation

CountryCode - Enum in com.bericotech.clavin.gazetteer

ISO-3166 2-letter country codes used by GeoNames.

createComponents(String, Reader) - Method in class com.bericotech.clavin.index.WhitespaceLowerCaseAnalyzer

Provides tokenizer access for the analyzer.

D

DamerauLevenshtein - Class in com.bericotech.clavin.util

Utility functions for calculating edit distance between strings, consistent with the Damerau-Levenshtein metric.

DamerauLevenshtein() - Constructor for class com.bericotech.clavin.util.DamerauLevenshtein

damerauLevenshteinDistance(String, String) - Static method in class com.bericotech.clavin.util.DamerauLevenshtein

Computes the true Damerau–Levenshtein edit distance (with adjacent transpositions) between two given strings.

Based on C# code from Wikipedia.

damerauLevenshteinDistanceCaseInsensitive(String, String) - Static method in class com.bericotech.clavin.util.DamerauLevenshtein

Convenience method for calling damerauLevenshteinDistance(String str1, String str2) when you don't care about case sensitivity.

description - Variable in enum com.bericotech.clavin.gazetteer.FeatureClass

description - Variable in enum com.bericotech.clavin.gazetteer.FeatureCode

digitalElevationModel - Variable in class com.bericotech.clavin.gazetteer.GeoName

E

elevation - Variable in class com.bericotech.clavin.gazetteer.GeoName

equals(Object) - Method in class com.bericotech.clavin.extractor.LocationOccurrence

equals(Object) - Method in class com.bericotech.clavin.resolver.ResolvedLocation

Tests equivalence between ResolvedLocation objects.

extractLocationNames(String) - Method in class com.bericotech.clavin.extractor.ApacheExtractor

Extracts location names from unstructured text using the named entity recognizer (NER) feature provided by the Apache OpenNLP Name Finder.

extractLocationNames(String) - Method in interface com.bericotech.clavin.extractor.LocationExtractor

Extracts a list of location names found in unstructured text.

F

FeatureClass - Enum in com.bericotech.clavin.gazetteer

Feature categories used by GeoNames.

featureClass - Variable in enum com.bericotech.clavin.gazetteer.FeatureCode

featureClass - Variable in class com.bericotech.clavin.gazetteer.GeoName

FeatureCode - Enum in com.bericotech.clavin.gazetteer

Individual feature codes used by GeoNames.

featureCode - Variable in class com.bericotech.clavin.gazetteer.GeoName

FeatureCodeBuilder - Class in com.bericotech.clavin.gazetteer

Generates FeatureClass enum definitions from GeoNames featureCodes_en.txt file.

FeatureCodeBuilder() - Constructor for class com.bericotech.clavin.gazetteer.FeatureCodeBuilder

fileToString(File) - Static method in class com.bericotech.clavin.util.TextUtils

Wrapper for calling Apache Commons IO toString(BufferedReader) on a File, essentially providing a File.toString() method for the contents of a text file.

fuzzy - Variable in class com.bericotech.clavin.resolver.ResolvedLocation

G

generateFeatureCodes() - Static method in class com.bericotech.clavin.gazetteer.FeatureCodeBuilder

Reads-in featureCodes_en.txt file, spits-out FeatureClass enum definitions.

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>, Double, Double, FeatureClass, FeatureCode, CountryCode, List<CountryCode>, String, String, String, String, Long, Integer, Integer, TimeZone, Date) - Constructor for class com.bericotech.clavin.gazetteer.GeoName

Sole constructor for GeoName class.

geoname - Variable in class com.bericotech.clavin.resolver.ResolvedLocation

geonameID - Variable in enum com.bericotech.clavin.gazetteer.CountryCode

geonameID - Variable in class com.bericotech.clavin.gazetteer.GeoName

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, LocationResolver, boolean) - Constructor for class com.bericotech.clavin.GeoParser

GeoParserFactory - Class in com.bericotech.clavin

Simple Factory for the creation of GeoParser instances.

GeoParserFactory() - Constructor for class com.bericotech.clavin.GeoParserFactory

getDefault(String) - Static method in class com.bericotech.clavin.GeoParserFactory

Get the default GeoParser.

getDefault(String, boolean) - Static method in class com.bericotech.clavin.GeoParserFactory

Get the default GeoParser.

getDefault(String, int, int) - Static method in class com.bericotech.clavin.GeoParserFactory

Get the default GeoParser.

getDefault(String, int, int, boolean) - Static method in class com.bericotech.clavin.GeoParserFactory

Get the default GeoParser.

getDefault(String, LocationExtractor, int, int, boolean) - Static method in class com.bericotech.clavin.GeoParserFactory

Get the default GeoParser.

getPrimaryCountryName() - Method in class com.bericotech.clavin.gazetteer.GeoName

H

hashCode() - Method in class com.bericotech.clavin.extractor.LocationOccurrence

I

IndexDirectoryBuilder - Class in com.bericotech.clavin.index

Builds a Lucene index of geographic entries based on the GeoNames gazetteer.

IndexDirectoryBuilder() - Constructor for class com.bericotech.clavin.index.IndexDirectoryBuilder

isEditDistance1(String, String) - Static method in class com.bericotech.clavin.util.DamerauLevenshtein

Fast method for determining whether the Damerau-Levenshtein edit distance between two strings is less than 2.

isTokenChar(int) - Method in class com.bericotech.clavin.index.WhitespaceLowerCaseTokenizer

Collects only characters which do not satisfy Character.isWhitespace(int).

L

latitude - Variable in class com.bericotech.clavin.gazetteer.GeoName

ListUtils - Class in com.bericotech.clavin.util

Utility methods for list processing.

ListUtils() - Constructor for class com.bericotech.clavin.util.ListUtils

location - Variable in class com.bericotech.clavin.resolver.ResolvedLocation

LocationExtractor - Interface in com.bericotech.clavin.extractor

Simple interface for location name extraction capabilities to be provided by third-party named entity recognition tools.

LocationOccurrence - Class in com.bericotech.clavin.extractor

Container class representing a location name found in a document.

LocationOccurrence(String, int) - Constructor for class com.bericotech.clavin.extractor.LocationOccurrence

Sole construction for LocationOccurrence class.

LocationResolver - Interface in com.bericotech.clavin.resolver

Resolves location names into GeoName objects.

logger - Static variable in class com.bericotech.clavin.index.IndexDirectoryBuilder

logger - Static variable in class com.bericotech.clavin.resolver.lucene.LuceneLocationResolver

longitude - Variable in class com.bericotech.clavin.gazetteer.GeoName

LuceneLocationResolver - Class in com.bericotech.clavin.resolver.lucene

Resolves location names into GeoName objects.

LuceneLocationResolver(File, int, int) - Constructor for class com.bericotech.clavin.resolver.lucene.LuceneLocationResolver

Builds a LuceneLocationResolver by loading a pre-built Lucene index from disk and setting configuration parameters for resolving location names to GeoName objects.

M

main(String[]) - Static method in class com.bericotech.clavin.index.IndexDirectoryBuilder

Turns a GeoNames gazetteer file into a Lucene index, and adds some supplementary gazetteer records at the end.

main(String[]) - Static method in class com.bericotech.clavin.WorkflowDemo

Run this after installing & configuring CLAVIN to get a sense of how to use it.

matchedName - Variable in class com.bericotech.clavin.resolver.ResolvedLocation

modificationDate - Variable in class com.bericotech.clavin.gazetteer.GeoName

N

name - Variable in class com.bericotech.clavin.extractor.LocationOccurrence

name - Variable in enum com.bericotech.clavin.gazetteer.CountryCode

name - Variable in class com.bericotech.clavin.gazetteer.GeoName

normalize(int) - Method in class com.bericotech.clavin.index.WhitespaceLowerCaseTokenizer

Converts char to lower case Character.toLowerCase(int).

O

OUT_OF_BOUNDS - Static variable in class com.bericotech.clavin.gazetteer.GeoName

P

parse(String) - Method in class com.bericotech.clavin.GeoParser

Takes an unstructured text document (as a String), extracts the location names contained therein, and resolves them into geographic entities representing the best match for those location names.

parseFromGeoNamesRecord(String) - Static method in class com.bericotech.clavin.gazetteer.GeoName

Builds a GeoName object based on a single gazetteer record in the GeoNames geographical database.

population - Variable in class com.bericotech.clavin.gazetteer.GeoName

position - Variable in class com.bericotech.clavin.extractor.LocationOccurrence

primaryCountryCode - Variable in class com.bericotech.clavin.gazetteer.GeoName

R

ResolvedLocation - Class in com.bericotech.clavin.resolver

Object produced by resolving a location name against gazetteer records.

ResolvedLocation(Document, LocationOccurrence, boolean) - Constructor for class com.bericotech.clavin.resolver.ResolvedLocation

Builds a ResolvedLocation from a document retrieved from the Lucene index representing the geographic entity resolved from a location name.

resolveLocations(List<LocationOccurrence>, boolean) - Method in interface com.bericotech.clavin.resolver.LocationResolver

Resolves the supplied list of location names into ResolvedLocations containing GeoName objects.

resolveLocations(List<LocationOccurrence>, boolean) - Method in class com.bericotech.clavin.resolver.lucene.LuceneLocationResolver

Resolves the supplied list of location names into ResolvedLocations containing GeoName objects.

T

TextUtils - Class in com.bericotech.clavin.util

Various utility methods for processing text.

TextUtils() - Constructor for class com.bericotech.clavin.util.TextUtils

tf(float) - Method in class com.bericotech.clavin.index.BinarySimilarity

Ignores multiple appearance of the query term in the index document field, effectively making TF (term frequency) a yes/no proposition (i.e., zero is still zero, but you don't get extra points for a query term being found multiple times in an index document field).

timezone - Variable in class com.bericotech.clavin.gazetteer.GeoName

toString() - Method in class com.bericotech.clavin.gazetteer.GeoName

For pretty-printing.

toString() - Method in class com.bericotech.clavin.resolver.ResolvedLocation

For pretty-printing.

type - Variable in enum com.bericotech.clavin.gazetteer.FeatureClass

type - Variable in enum com.bericotech.clavin.gazetteer.FeatureCode

V

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.

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.

W

WhitespaceLowerCaseAnalyzer - Class in com.bericotech.clavin.index

A Lucene Analyzer that filters WhitespaceTokenizer with LowerCaseFilter.

WhitespaceLowerCaseAnalyzer() - Constructor for class com.bericotech.clavin.index.WhitespaceLowerCaseAnalyzer

Simple default constructor for WhitespaceLowerCaseAnalyzer.

WhitespaceLowerCaseTokenizer - Class in com.bericotech.clavin.index

LowerCaseTokenizer performs the function of WhitespaceTokenizer and LowerCaseFilter together.

WhitespaceLowerCaseTokenizer(Version, Reader) - Constructor for class com.bericotech.clavin.index.WhitespaceLowerCaseTokenizer

Call the "super" constructor.

WorkflowDemo - Class in com.bericotech.clavin

Quick example showing how to use CLAVIN's capabilities.

WorkflowDemo() - Constructor for class com.bericotech.clavin.WorkflowDemo

A B C D E F G H I L M N O P R T V W