Index

A B C D E F G H I J K L M N O P R S T U V W X 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

A1_suffixes - Static variable in class org.opensextant.extractors.geo.rules.NameRule
 
A2_suffixes - Static variable in class org.opensextant.extractors.geo.rules.NameRule
 
ABBREVIATION_MAX_LEN - Static variable in class org.opensextant.extractors.geo.PlaceCandidate
 
add(String) - Method in class org.opensextant.extractors.geo.PlaceCount
 
add(Collection<SolrInputDocument>) - Method in class org.opensextant.util.SolrProxy
Add many solr records.
add(SolrInputDocument) - Method in class org.opensextant.util.SolrProxy
Add one solr record.
addAdmin1Evidence(String, double, String, String) - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
addCatalogFilter(String) - Method in class org.opensextant.extractors.xtax.TaxonMatcher
 
addCatalogFilters(String[]) - Method in class org.opensextant.extractors.xtax.TaxonMatcher
 
addCoordinate(Geocoding) - Method in class org.opensextant.extractors.geo.rules.CoordinateAssociationRule
 
addCoordinates(List<TextMatch>) - Method in class org.opensextant.extractors.geo.rules.CoordinateAssociationRule
 
addCountryEvidence(String, double, String, Place) - Method in class org.opensextant.extractors.geo.PlaceCandidate
Add country evidence and increment score immediately.
addEvidence(String, double, Place) - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
addEvidence(PlaceEvidence) - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
addFeatureClassEvidence(String, double, String) - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
addFeatureCodeEvidence(String, double, String) - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
addGeocoordEvidence(String, double, LatLon, Place, double) - Method in class org.opensextant.extractors.geo.PlaceCandidate
Add evidence and increment score immediately.
addPlace(ScoredPlace) - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
addPlace(ScoredPlace, Double) - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
addRelated(PlaceCandidate) - Method in class org.opensextant.extractors.geo.PlaceCandidate
Connect another match to this one, usually something cooccurring or collocated with this match
addRule(String) - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
addRule(String) - Method in class org.opensextant.extractors.geo.ScoredPlace
 
addRule(GeocodeRule) - Method in class org.opensextant.extractors.geo.PlaceGeocoder
Add your own geocode rules to enable you to add evidence, adjust score, outright choose Place instances on PlaceCandidates, etc.
addTaxon(Taxon) - Method in class org.opensextant.extractors.xtax.TaxonMatch
 
ADM1 - Static variable in class org.opensextant.extractors.geo.rules.NameRule
 
ADM2 - Static variable in class org.opensextant.extractors.geo.rules.NameRule
 
ADMIN - Static variable in class org.opensextant.extractors.geo.rules.MajorPlaceRule
 
ADMIN_CONTAINS - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
 
ADMIN_CONTAINS_PLACE_WT - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
 
allCountries - Variable in class org.opensextant.extractors.geo.social.SocialGeo
If you populate allCountries with
APRIORI - Enum constant in enum org.opensextant.extractors.geo.PlaceEvidence.Scope
 
AR_TAG_FIELD - Static variable in class org.opensextant.extractors.geo.GazetteerMatcher
Use Solr param 'field = name_tag_ar for Arabic.
assessAllFilters(String) - Method in class org.opensextant.extractors.geo.TagFilter
Run a term (already lowercased) against all stop filters.
assessConfidence(PlaceCandidate) - Method in class org.opensextant.extractors.geo.rules.LocationChooserRule
Confidence of your final chosen location for a given name is assembled as the sum of some absolute metric plus some additional qualifiers.
assessPhoneticMatch(PlaceCandidate) - Method in class org.opensextant.extractors.geo.rules.NonsenseFilter
Assess the validity of a match candidate with the geographic names associated with it.
assessPhraseDensity(String, int) - Static method in class org.opensextant.extractors.geo.rules.NonsenseFilter
 
assessPhraseDensity(TextMatch) - Static method in class org.opensextant.extractors.geo.rules.NonsenseFilter
 
assessPunctuation(PlaceCandidate) - Static method in class org.opensextant.extractors.geo.rules.NonsenseFilter
optimize punctuation detection and filtration.
assignProvinceName(Place) - Method in class org.opensextant.extractors.geo.rules.ProvinceNameSetter
 
associateMatches(List<PlaceCandidate>, List<PlaceCandidate>) - Static method in class org.opensextant.extractors.geo.PostalGeocoder
Given geotagging from a prior pass of PlaceGeocoder or other stuff, compare and align those tags with POSTAL tags.
attributes - Variable in class org.opensextant.extractors.geo.social.GeoInference
Any additional attributes you would like to add.
AV - Static variable in class org.opensextant.extractors.geo.rules.NonsenseFilter
 
AVERAGE_TEXT_SIZE - Static variable in class org.opensextant.extractors.geo.social.GeoInferencer
Avg text size (in chars) of tweets -- in 2014, I measured this to be about 90 chars.
AVG_WORD_LEN - Static variable in class org.opensextant.extractors.geo.rules.GeocodeRule
 

B

banner() - Method in class org.opensextant.xlayer.server.XlayerApp
Banner at start improves visibility of your product.
basicCountryNames - Variable in class org.opensextant.extractors.geo.social.SocialGeo
A particular hashing of the list of country names.
boundaryLevel1InScope(String, Place) - Method in interface org.opensextant.extractors.geo.BoundaryObserver
Given the name (lower case, strip quotes), the location candidate infers an ADMIN boundary
boundaryLevel1InScope(String, Place) - Method in class org.opensextant.extractors.geo.PlaceGeocoder
Observer pattern that sees any time a possible boundary (state, province, district, etc) is mentioned.
boundaryLevel1InScope(String, Place) - Method in class org.opensextant.extractors.geo.PostalGeocoder
 
boundaryLevel2InScope(String, Place) - Method in interface org.opensextant.extractors.geo.BoundaryObserver
Given the name (lower case, strip quotes), the location candidate infers an ADMIN boundary
boundaryLevel2InScope(String, Place) - Method in class org.opensextant.extractors.geo.PlaceGeocoder
 
boundaryLevel2InScope(String, Place) - Method in class org.opensextant.extractors.geo.PostalGeocoder
 
boundaryObserver - Variable in class org.opensextant.extractors.geo.rules.GeocodeRule
 
BoundaryObserver - Interface in org.opensextant.extractors.geo
Emit a boundary event when you come across a concrete reference to a boundary, e.g., county or state, district or prefecture.

C

CAPITAL - Static variable in class org.opensextant.extractors.geo.rules.MajorPlaceRule
 
catalogs - Variable in class org.opensextant.extractors.xtax.TaxonMatcher
Catalogs is a list of catalogs caller wants to tag for.
choose() - Method in class org.opensextant.extractors.geo.PlaceCandidate
Get the most highly ranked Place, or Null if empty list.
choose(ScoredPlace) - Method in class org.opensextant.extractors.geo.PlaceCandidate
If caller is willing to claim an explicit choice, so be it.
CITY - Static variable in class org.opensextant.extractors.geo.rules.NameRule
 
CJK_TAG_FIELD - Static variable in class org.opensextant.extractors.geo.GazetteerMatcher
Use Solr param 'field' = name_tag_cjk to tag in Asian scripts.
cleanup() - Method in class org.opensextant.extractors.geo.PlaceGeocoder
Please shutdown the application cleanly when done.
cleanup() - Method in class org.opensextant.extractors.geo.PostalGeocoder
Very simple resource reporting and cleanup.
cleanup() - Method in class org.opensextant.extractors.geo.PostalTagger
Very simple resource reporting and cleanup.
cleanup() - Method in class org.opensextant.extractors.xtax.TaxonMatcher
Extractor interface.
close() - Method in class org.opensextant.extraction.SolrMatcherSupport
Close solr resources.
close() - Method in class org.opensextant.extractors.geo.PlaceGeocoder
 
close() - Method in class org.opensextant.extractors.geo.social.KMLDemoWriter
 
close() - Method in class org.opensextant.extractors.geo.social.SocialGeo
Release resources quietly.
close() - Method in class org.opensextant.extractors.geo.social.XponentGeocoder
 
close() - Method in class org.opensextant.extractors.geo.SolrGazetteer
Close or release all resources.
close() - Method in class org.opensextant.util.SolrProxy
 
closest(LatLon, List<Place>) - Static method in class org.opensextant.extractors.geo.SolrGazetteer
Iterate through a list and choose a place closest to the given point
commonTaxonLabels - Static variable in class org.opensextant.extractors.xtax.TaxonMatcher
 
compareTo(Object) - Method in class org.opensextant.extractors.geo.PlaceEvidence
 
compareTo(ScoredPlace) - Method in class org.opensextant.extractors.geo.ScoredPlace
Ordering: higher score comes first in our sortable lists.
complementaryPostal(Place, Place) - Static method in class org.opensextant.extractors.geo.rules.PostalCodeAssociationRule
Determine if you have one of each, ADM1 and POSTAL.
confidence - Variable in class org.opensextant.extractors.geo.social.GeoInference
your confidence in this inference
configure() - Method in class org.opensextant.extractors.geo.PlaceGeocoder
We do whatever is needed to init resources...
configure() - Method in class org.opensextant.extractors.geo.PostalGeocoder
 
configure() - Method in class org.opensextant.extractors.geo.PostalTagger
 
configure() - Method in class org.opensextant.extractors.geo.social.SocialGeo
Configure your implementation.
configure() - Method in class org.opensextant.extractors.geo.social.XponentGeocoder
Makes use of a number of APIs: XCoord to parse out additional coordinates not normalized Gazetteer/GazetteerMatcher to resolve place identities by querying them directly PlaceGeocoder to parse longer phrases of multiple words, tagging places so advanced rules could be applied to them. LangID identifies language of text, although for short texts it does not work reliably. GeonamesUtility and TextUtils provide metadata lookup for countries, timezone, language codes, etc.
configure() - Method in class org.opensextant.extractors.geo.social.XponentTextGeotagger
 
configure() - Method in class org.opensextant.extractors.xtax.TaxonMatcher
 
configure() - Method in class org.opensextant.xlayer.server.xgeo.XlayerRestlet
 
configure() - Method in class org.opensextant.xlayer.server.XlayerApp
 
configure(String) - Method in class org.opensextant.extractors.geo.PlaceGeocoder
Configure an Extractor using a config file named by a path.
configure(String) - Method in class org.opensextant.extractors.geo.PostalGeocoder
 
configure(String) - Method in class org.opensextant.extractors.geo.PostalTagger
 
configure(String) - Method in class org.opensextant.extractors.xtax.TaxonMatcher
Configure an Extractor using a config file named by a path
configure(URL) - Method in class org.opensextant.extractors.geo.PlaceGeocoder
Configure an Extractor using a config file named by a URL
configure(URL) - Method in class org.opensextant.extractors.geo.PostalGeocoder
 
configure(URL) - Method in class org.opensextant.extractors.geo.PostalTagger
 
configure(URL) - Method in class org.opensextant.extractors.xtax.TaxonMatcher
Configure an Extractor using a config file named by a URL
CONN_TIMEOUT_STRING - Static variable in class org.opensextant.xlayer.XlayerClient
 
ContextualOrganizationRule - Class in org.opensextant.extractors.geo.rules
 
ContextualOrganizationRule() - Constructor for class org.opensextant.extractors.geo.rules.ContextualOrganizationRule
 
contributor - Variable in class org.opensextant.extractors.geo.social.GeoInference
Contributor -- what app, class or module generated the inference.
control(Representation) - Method in class org.opensextant.xlayer.server.XlayerControl
/control/OPERATION, for example: /control/ping /control/stop
COORD_PROXIMITY_RULE - Static variable in class org.opensextant.extractors.geo.rules.CoordinateAssociationRule
 
COORDINATE_PROXIMITY_ADM1_THRESHOLD - Static variable in class org.opensextant.extractors.geo.PlaceGeocoder
 
COORDINATE_PROXIMITY_CITY_THRESHOLD - Static variable in class org.opensextant.extractors.geo.PlaceGeocoder
Find nearest city within r=25 KM to infer geography of a given coordinate, e.g., What state is (x,y) in? Found locations are sorted by distance to point.
CoordinateAssociationRule - Class in org.opensextant.extractors.geo.rules
 
CoordinateAssociationRule() - Constructor for class org.opensextant.extractors.geo.rules.CoordinateAssociationRule
 
CoordinateAssociationRule(int) - Constructor for class org.opensextant.extractors.geo.rules.CoordinateAssociationRule
 
coordObserver - Variable in class org.opensextant.extractors.geo.rules.GeocodeRule
 
COREF - Enum constant in enum org.opensextant.extractors.geo.PlaceEvidence.Scope
 
coreName - Variable in class org.opensextant.util.SolrProxy
 
count - Variable in class org.opensextant.extractors.geo.CountryCount
 
count - Variable in class org.opensextant.extractors.geo.PlaceCount
 
count - Variable in class org.opensextant.extractors.geo.rules.FeatureClassMeta
Absolute gazetteer count
countries - Variable in class org.opensextant.extractors.geo.social.SocialGeo
 
country - Variable in class org.opensextant.extractors.geo.CountryCount
 
COUNTRY_CONTAINS - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
 
COUNTRY_CONTAINS_PLACE_WT - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
 
countryCount() - Method in interface org.opensextant.extractors.geo.CountryObserver
 
countryCount() - Method in class org.opensextant.extractors.geo.PlaceGeocoder
 
countryCount() - Method in class org.opensextant.extractors.geo.PostalGeocoder
 
CountryCount - Class in org.opensextant.extractors.geo
Country metrics
CountryCount(String) - Constructor for class org.opensextant.extractors.geo.CountryCount
 
CountryCount(Country) - Constructor for class org.opensextant.extractors.geo.CountryCount
 
countryInScope(String) - Method in interface org.opensextant.extractors.geo.CountryObserver
Use a country code to signal that a country was mentioned.
countryInScope(String) - Method in class org.opensextant.extractors.geo.PlaceGeocoder
Record how often country references are made.
countryInScope(String) - Method in class org.opensextant.extractors.geo.PostalGeocoder
 
countryInScope(Country) - Method in interface org.opensextant.extractors.geo.CountryObserver
Use a country object to signal a country was mentioned or is in scope
countryInScope(Country) - Method in class org.opensextant.extractors.geo.PlaceGeocoder
Record how often country references are made.
countryInScope(Country) - Method in class org.opensextant.extractors.geo.PostalGeocoder
 
countryMentionCount() - Method in interface org.opensextant.extractors.geo.CountryObserver
Calculates totals and ratios for the discovered set of countries.
countryMentionCount() - Method in class org.opensextant.extractors.geo.PlaceGeocoder
Calculate country mention totals and ratios.
countryMentionCount() - Method in class org.opensextant.extractors.geo.PostalGeocoder
 
countryObserved(String) - Method in interface org.opensextant.extractors.geo.CountryObserver
Have you seen this country before?
countryObserved(String) - Method in class org.opensextant.extractors.geo.PlaceGeocoder
 
countryObserved(String) - Method in class org.opensextant.extractors.geo.PostalGeocoder
 
countryObserved(Country) - Method in interface org.opensextant.extractors.geo.CountryObserver
Have you seen this country before?
countryObserved(Country) - Method in class org.opensextant.extractors.geo.PlaceGeocoder
 
countryObserved(Country) - Method in class org.opensextant.extractors.geo.PostalGeocoder
 
countryObserver - Variable in class org.opensextant.extractors.geo.rules.GeocodeRule
 
CountryObserver - Interface in org.opensextant.extractors.geo
 
CountryRule - Class in org.opensextant.extractors.geo.rules
 
CountryRule() - Constructor for class org.opensextant.extractors.geo.rules.CountryRule
 
createDefaultSearchParams(int) - Static method in class org.opensextant.extractors.geo.SolrGazetteer
 
createGeocoding(Geocoding, JsonObject) - Static method in class org.opensextant.output.Transforms
Given an existing JSON object, add geocoding metadata to it.
createGeodeticLookupParams() - Static method in class org.opensextant.extractors.geo.SolrGazetteer
Creates a generic spatial query for up to first 25 rows.
createGeodeticLookupParams(int) - Static method in class org.opensextant.extractors.geo.SolrGazetteer
For larger areas choose a higher number of Rows to return.
createInboundRoot() - Method in class org.opensextant.xlayer.server.xgeo.XlayerRestlet
 
createInboundRoot() - Method in class org.opensextant.xlayer.server.XlayerApp
 
createPlace(SolrDocument) - Static method in class org.opensextant.extractors.geo.GazetteerMatcher
Adapt the SolrProxy method for creating a Place object.
createPlace(SolrDocument) - Static method in class org.opensextant.util.SolrUtil
Creates the bare minimum Gazetteer Place record
createTag(SolrDocument) - Method in class org.opensextant.extraction.SolrMatcherSupport
Caller must implement their domain objects, POJOs...
createTag(SolrDocument) - Method in class org.opensextant.extractors.geo.GazetteerMatcher
 
createTag(SolrDocument) - Method in class org.opensextant.extractors.xtax.TaxonMatcher
Create a Taxon tag, which is filtered based on established catalog filters.
createTaxon(SolrDocument) - Static method in class org.opensextant.extractors.xtax.TaxonMatcher
Parse the taxon reference data from a solr doc and return Taxon obj.

D

DATE_TAGGER - Static variable in class org.opensextant.xlayer.server.TaggerResource
 
debug(String) - Method in class org.opensextant.xlayer.server.TaggerResource
 
debug(String) - Method in class org.opensextant.xlayer.server.XlayerApp
 
DEFAULT_COUNTRY_CONF - Static variable in class org.opensextant.extractors.geo.social.XponentGeocoder
 
DEFAULT_FIELDS - Static variable in class org.opensextant.extractors.geo.SolrGazetteer
 
DEFAULT_LOWER_CONFIDENCE - Static variable in class org.opensextant.output.Transforms
Cutoff confidence for geocoding results:
DEFAULT_MIN_LENGTH - Static variable in class org.opensextant.extractors.xtax.TaxonMatcher
Caller can adjust this default constant if shorter tags are desired.
DEFAULT_SCORE - Static variable in class org.opensextant.extractors.geo.PlaceCandidate
 
DEFAULT_TAG_FIELD - Static variable in class org.opensextant.extractors.geo.GazetteerMatcher
Most languages
DEFAULT_TAG_LIMIT - Static variable in class org.opensextant.extraction.SolrMatcherSupport
 
DEFAULT_THRESHOLD_DIGITS - Static variable in class org.opensextant.extractors.geo.rules.CoordinateAssociationRule
Threshold for geohash prefix similarity
DEFAULT_THRESHOLD_METERS - Static variable in class org.opensextant.extractors.geo.rules.CoordinateAssociationRule
Default threshold distance between a coordinate and a candidate location
defaultMethod - Variable in class org.opensextant.extractors.geo.rules.GeocodeRule
 
defaultScore(Place) - Method in class org.opensextant.extractors.geo.PlaceCandidate
Given this candidate, how do you score the provided place just based on those place properties (and not on context, document properties, or other evidence)? This 'should' produce a base score of something between 0 and 1.0, or 0..10.
deriveMatches(List<PlaceCandidate>, TextInput) - Static method in class org.opensextant.extractors.geo.PostalGeocoder
For situations of the form:
deriveSolrHome(String) - Static method in class org.opensextant.util.SolrProxy
A single method to help find a suitable value for SOLR HOME If given is null, then system variables are checked.
DIACRITIC - Static variable in class org.opensextant.extractors.geo.rules.NameRule
 
distinctCountryCount() - Method in class org.opensextant.extractors.geo.PlaceCandidate
How many different countries contain this name?.
distinctLocationCount() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
DOCUMENT - Enum constant in enum org.opensextant.extractors.geo.PlaceEvidence.Scope
 
doInit() - Method in class org.opensextant.xlayer.server.TaggerResource
operational parameter.

E

enableCaseSensitive(boolean) - Method in class org.opensextant.extractors.geo.TagFilter
 
enablePersonNameMatching(boolean) - Method in class org.opensextant.extractors.geo.PlaceGeocoder
Deprecated. 
enableStopwordFilter(boolean) - Method in class org.opensextant.extractors.geo.TagFilter
 
end - Variable in class org.opensextant.extractors.geo.social.GeoInference
 
error(String, Exception) - Method in class org.opensextant.xlayer.server.TaggerResource
 
error(String, Exception) - Method in class org.opensextant.xlayer.server.XlayerApp
 
evalMode - Variable in class org.opensextant.extractors.geo.social.SocialGeo
 
evaluate(List<PlaceCandidate>) - Method in class org.opensextant.extractors.geo.rules.ContextualOrganizationRule
 
evaluate(List<PlaceCandidate>) - Method in class org.opensextant.extractors.geo.rules.CountryRule
 
evaluate(List<PlaceCandidate>) - Method in class org.opensextant.extractors.geo.rules.GeocodeRule
 
evaluate(List<PlaceCandidate>) - Method in class org.opensextant.extractors.geo.rules.HeatMapRule
Identify the distinct potential named places by location Group places by geohash bins at two levels geohash 3 and geohash 4.
evaluate(List<PlaceCandidate>) - Method in class org.opensextant.extractors.geo.rules.LocationChooserRule
 
evaluate(List<PlaceCandidate>) - Method in class org.opensextant.extractors.geo.rules.MajorPlaceRule
 
evaluate(List<PlaceCandidate>) - Method in class org.opensextant.extractors.geo.rules.NameCodeRule
 
evaluate(List<PlaceCandidate>) - Method in class org.opensextant.extractors.geo.rules.NameRule
 
evaluate(List<PlaceCandidate>) - Method in class org.opensextant.extractors.geo.rules.NonsenseFilter
Evaluate the name in each list of names.
evaluate(List<PlaceCandidate>) - Method in class org.opensextant.extractors.geo.rules.PersonNameFilter
Evaluate the place name purely based on previous rules or the lexical nature of the name, and not any geography, so this parent method is overriden and returns True always.
evaluate(List<PlaceCandidate>) - Method in class org.opensextant.extractors.geo.rules.PostalCodeAssociationRule
 
evaluate(List<PlaceCandidate>) - Method in class org.opensextant.extractors.geo.rules.PostalCodeFilter
 
evaluate(List<PlaceCandidate>) - Method in class org.opensextant.extractors.geo.rules.PostalLocationChooser
 
evaluate(List<PlaceCandidate>) - Method in class org.opensextant.extractors.geo.rules.ProvinceAssociationRule
Evaluate all candidate place mentions by seeing if any resolved Province contains any geo locations with the mentioned name.
evaluate(List<PlaceCandidate>) - Method in class org.opensextant.extractors.geo.rules.ProvinceNameSetter
Apply a Province name to a chosen place
evaluate(List<PlaceCandidate>, Parameters) - Method in class org.opensextant.extractors.geo.rules.LocationChooserRule
Walk the entire list.
evaluate(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.ContextualOrganizationRule
 
evaluate(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.CoordinateAssociationRule
If a particular geo is close to a candidate name/location, then add to the candidate's score for that location.
evaluate(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.CountryRule
Assess which candidate tags are references to countries.
evaluate(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.FeatureRule
Deprecated.
Feature score is now provided as part of id_bias
evaluate(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.GeocodeRule
The one evaluation scheme that all rules must implement.
evaluate(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.HeatMapRule
 
evaluate(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.LocationChooserRule
Yet unchosen location.
evaluate(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.MajorPlaceRule
attach either a Capital or Admin region ID, giving it some weight based on various properties or context.
evaluate(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.NameCodeRule
 
evaluate(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.NameRule
 
evaluate(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.NonLatinNameRule
 
evaluate(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.NonsenseFilter
 
evaluate(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.PersonNameFilter
 
evaluate(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.PostalCodeAssociationRule
 
evaluate(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.PostalCodeFilter
 
evaluate(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.PostalLocationChooser
 
evaluate(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.ProvinceAssociationRule
 
evaluate(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.ProvinceNameSetter
 
evaluateCoordinate(Geocoding) - Method in class org.opensextant.extractors.geo.PlaceGeocoder
Compund-method that is crucial in reverse geocoding COORDINATE to KNOWN PLACE.
evaluateNamedEntities(TextInput, List<PlaceCandidate>, List<TaxonMatch>, List<TaxonMatch>, List<TaxonMatch>) - Method in class org.opensextant.extractors.geo.rules.PersonNameFilter
Use known person names to distinguish well-known persons that may or may not overlap in in the text and the namespace.
excludeTaxons(String) - Method in class org.opensextant.extractors.xtax.TaxonMatcher
Add prefixes of types of taxons you do not want returned.
extract(String) - Method in class org.opensextant.extractors.geo.PlaceGeocoder
Generic tagging.
extract(String) - Method in class org.opensextant.extractors.geo.PostalGeocoder
 
extract(String) - Method in class org.opensextant.extractors.geo.PostalTagger
 
extract(String) - Method in class org.opensextant.extractors.xtax.TaxonMatcher
Light-weight usage: text in, matches out.
extract(TextInput) - Method in class org.opensextant.extractors.geo.PlaceGeocoder
extract(TextInput) - Method in class org.opensextant.extractors.geo.PostalGeocoder
Tag, choose location if possible and emit an array of text matches.
extract(TextInput) - Method in class org.opensextant.extractors.geo.PostalTagger
Tag, choose location if possible and emit an array of text matches.
extract(TextInput) - Method in class org.opensextant.extractors.xtax.TaxonMatcher
Tag the input
extract(TextInput, Parameters) - Method in class org.opensextant.extractors.geo.PlaceGeocoder
Extractor.extract() calls first XCoord to get coordinates, then PlacenameMatcher In the end you have all geo entities ranked and scored.
extract(TextInput, Parameters) - Method in class org.opensextant.extractors.xtax.TaxonMatcher
Parameterized extraction, e.g., for REST service or other fine tuning.
extractorSet - Static variable in class org.opensextant.xlayer.server.TaggerResource
 

F

factor - Variable in class org.opensextant.extractors.geo.rules.FeatureClassMeta
Mention Weight X Relative proportion - common features are more likely to be mentioned.
FEAT_RULE - Static variable in class org.opensextant.extractors.geo.rules.FeatureRule
 
FEAT_WEIGHT - Static variable in class org.opensextant.extractors.geo.PlaceCandidate
 
FeatureClassMeta - Class in org.opensextant.extractors.geo.rules
data structure to capture our assumptions about feature types.
FeatureClassMeta(String, double) - Constructor for class org.opensextant.extractors.geo.rules.FeatureClassMeta
A set factor bias, without considering gazetteer proportions.
FeatureClassMeta(String, int, double) - Constructor for class org.opensextant.extractors.geo.rules.FeatureClassMeta
 
FeatureRule - Class in org.opensextant.extractors.geo.rules
NOT USED MUCH.
FeatureRule() - Constructor for class org.opensextant.extractors.geo.rules.FeatureRule
 
featWeights - Static variable in class org.opensextant.extractors.geo.rules.FeatureRule
 
filter - Variable in class org.opensextant.extractors.geo.GazetteerMatcher
 
filterByNameOnly(PlaceCandidate) - Method in class org.opensextant.extractors.geo.rules.GeocodeRule
Override here as needed.
filterByNameOnly(PlaceCandidate) - Method in class org.opensextant.extractors.geo.rules.NonLatinNameRule
 
filterOut(String) - Method in class org.opensextant.extractors.geo.TagFilter
Default filtering rules: (a) If filter is in case-sensitive mode (DEFAULT), all lower case matches are ignored; only mixed case or upper case passes (b) If match term, t, is in stop word list it is filtered out.
filterOut(String) - Method in class org.opensextant.extractors.xtax.TaxonFilter
Find any reason to filter out Taxons.
filterOut(String, String) - Method in class org.opensextant.extractors.geo.TagFilter
 
filterOut(PlaceCandidate) - Static method in class org.opensextant.extractors.geo.social.XponentTextGeotagger
WARNING: Copy of Deepeye Pipes default geotag filter.
filterOut(PlaceCandidate, String, boolean, boolean) - Method in class org.opensextant.extractors.geo.TagFilter
Experimental.
filterOutByFrequency(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.GeocodeRule
Certain names appear often around the world...
findPlaces(String, String, int) - Method in class org.opensextant.extractors.geo.SolrGazetteer
Given a name, find all locations matching that.
findPlacesById(String) - Method in class org.opensextant.extractors.geo.SolrGazetteer
Find all places for a given gazetteer Place ID.
findPlacesRomanizedNameOf(String, String, int) - Method in class org.opensextant.extractors.geo.SolrGazetteer
NOTE: This yields primarily ASCII transliterations/romanized versions of the given place.
flattenPrecision(Geocoding, GeocoordPrecision) - Static method in class org.opensextant.extractors.geo.social.SocialGeo
facilitate getting a simple precision metric.
FLD_FEATURES - Static variable in class org.opensextant.xlayer.server.TaggerResource
 
FLD_FILTERED - Static variable in class org.opensextant.output.Transforms
 
FLD_MATCH - Static variable in class org.opensextant.output.Transforms
 
FLD_MATCH_ID - Static variable in class org.opensextant.output.Transforms
 
FLD_STATUS - Static variable in class org.opensextant.xlayer.server.TaggerResource
 
FLD_TYPE - Static variable in class org.opensextant.output.Transforms
 
fromArray(JSONArray) - Method in class org.opensextant.xlayer.server.TaggerResource
 
fromRequest(JSONObject) - Method in class org.opensextant.xlayer.server.TaggerResource
 
fromRequest(Form) - Method in class org.opensextant.xlayer.server.TaggerResource
Get parameters for processing? None currently, but may be: - lower case tagging or filtering - coordinate parsing on|off Get parameters for formatting.

G

gazetteer - Variable in class org.opensextant.extractors.geo.social.XponentGeocoder
 
GazetteerMatcher - Class in org.opensextant.extractors.geo
Connects to a Solr sever via HTTP and tags place names in document.
GazetteerMatcher() - Constructor for class org.opensextant.extractors.geo.GazetteerMatcher
 
GazetteerMatcher(boolean) - Constructor for class org.opensextant.extractors.geo.GazetteerMatcher
 
GEO_TAGGER - Static variable in class org.opensextant.xlayer.server.TaggerResource
 
geocode - Variable in class org.opensextant.extractors.geo.social.GeoInference
a country, place or other geocoding that was inferred.
GeocodeRule - Class in org.opensextant.extractors.geo.rules
 
GeocodeRule() - Constructor for class org.opensextant.extractors.geo.rules.GeocodeRule
 
GEOHASH - Static variable in class org.opensextant.extractors.geo.rules.CoordinateAssociationRule
 
GEOHASH_CONTAINS_RULE - Static variable in class org.opensextant.extractors.geo.rules.CoordinateAssociationRule
 
GeoInference - Class in org.opensextant.extractors.geo.social
This is a light wrapper around TextMatch + Geocoding interfaces.
GeoInference() - Constructor for class org.opensextant.extractors.geo.social.GeoInference
 
geoinferencePlaceMentions(Tweet) - Method in class org.opensextant.extractors.geo.social.GeoInferencer
Extract and geocode any mentioned places, countries, coordinates in social media text.
geoinferencePlaceMentions(Tweet) - Method in class org.opensextant.extractors.geo.social.XponentGeocoder
does not infer place mentions from free text
geoinferencePlaceMentions(Tweet) - Method in class org.opensextant.extractors.geo.social.XponentTextGeotagger
Content-based geotagging.
GeoInferencer - Class in org.opensextant.extractors.geo.social
A geoinferencer infers location on users and their messages.
GeoInferencer() - Constructor for class org.opensextant.extractors.geo.social.GeoInferencer
 
geoinferenceTweetAuthor(Tweet) - Method in class org.opensextant.extractors.geo.social.GeoInferencer
Infer author's location.
geoinferenceTweetAuthor(Tweet) - Method in class org.opensextant.extractors.geo.social.XponentGeocoder
Geoinference user/author profile.
geoinferenceTweetAuthor(Tweet) - Method in class org.opensextant.extractors.geo.social.XponentTextGeotagger
This routine does not look at Author.
geoinferenceTweetStatus(Tweet) - Method in class org.opensextant.extractors.geo.social.GeoInferencer
Infer location of message, if any such metadata is present.
geoinferenceTweetStatus(Tweet) - Method in class org.opensextant.extractors.geo.social.XponentGeocoder
Geoinference the location of the message, e.g., where the message was sent from.
geoinferenceTweetStatus(Tweet) - Method in class org.opensextant.extractors.geo.social.XponentTextGeotagger
Geotag and Geocode mentions in the message of a tweet.
getAdditionalMatches() - Method in class org.opensextant.extractors.geo.social.GeoInferencer
If there are by-products of geotagging or inferencing that are worth retrieving, they can be retrieved as "additional matches"
getAdditionalMatches() - Method in class org.opensextant.extractors.geo.social.XponentGeocoder
Geocoder does not return Additional matches.
getAdditionalMatches() - Method in class org.opensextant.extractors.geo.social.XponentTextGeotagger
Geotagger does return Additional matches.
getChar(SolrDocument, String) - Static method in class org.opensextant.util.SolrUtil
 
getChosen() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
getChosenPlace() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
getConfidence() - Method in class org.opensextant.extractors.geo.PlaceCandidate
see setConfidence.
getConfidence(double) - Method in class org.opensextant.extractors.geo.social.SocialGeo
 
getContentWriter(String) - Method in class org.opensextant.extraction.SolrTaggerRequest
 
getCoordinate(String) - Static method in class org.opensextant.util.SolrUtil
Parse XY pair stored in Solr Spatial4J record.
getCoordinate(SolrDocument, String) - Static method in class org.opensextant.util.SolrUtil
Parse XY pair stored in Solr Spatial4J record.
getCoreName() - Method in class org.opensextant.extraction.SolrMatcherSupport
Be explicit about the solr core to use for tagging.
getCoreName() - Method in class org.opensextant.extractors.geo.GazetteerMatcher
 
getCoreName() - Method in class org.opensextant.extractors.geo.PostalTagger
 
getCoreName() - Method in class org.opensextant.extractors.xtax.TaxonMatcher
Be explicit about the solr core to use for tagging
getCount() - Method in class org.opensextant.extractors.geo.PlaceCount
 
getCountries() - Method in class org.opensextant.extractors.geo.SolrGazetteer
List all country names, official and variant names.
getCountry(String) - Method in class org.opensextant.extractors.geo.SolrGazetteer
Get Country by the default ISO digraph returns the Unknown country if you are not using an ISO2 code.
getCountryByFIPS(String) - Method in class org.opensextant.extractors.geo.SolrGazetteer
Gets the country by fips.
getCountryCode() - Method in class org.opensextant.extractors.geo.PlaceCount
 
getCountryNamed(String) - Method in class org.opensextant.extractors.geo.social.SocialGeo
 
getDate(SolrDocument, String) - Static method in class org.opensextant.util.SolrUtil
Get a Date object from a record
getDouble(SolrDocument, String) - Static method in class org.opensextant.util.SolrUtil
Get a double from a record
getEvidence() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
getEvidenceID(PlaceEvidence) - Static method in class org.opensextant.extractors.geo.PlaceCandidate
 
getExtractor(String) - Method in class org.opensextant.xlayer.server.TaggerResource
 
getExtractor(String) - Method in class org.opensextant.xlayer.server.xgeo.XponentsGeotagger
get Xponents Exxtractor object from global attributes.
getExtractor(String) - Method in class org.opensextant.xlayer.server.XlayerControl
get Xponents Exxtractor object from global attributes.
getFiltrationRatio() - Method in class org.opensextant.extractors.geo.GazetteerMatcher
This computes the cumulative filtering rate of user-defined and other non-place name patterns
getFirstChoice() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
getFloat(SolrDocument, String) - Static method in class org.opensextant.util.SolrUtil
Get a floating point object from a record
getFloat(SolrInputDocument, String) - Static method in class org.opensextant.util.SolrUtil
 
getGazetteer() - Method in class org.opensextant.extractors.geo.GazetteerMatcher
For use within package or by subclass
getGeocoding() - Method in class org.opensextant.extractors.geo.PlaceCandidate
After candidate has been scored and all, the final best place is the geocoding result for the given name in context.
getGeocoding(TextMatch) - Method in class org.opensextant.output.TaggerMatchInterpeter
Trivial override of the default Match Interpreter on GISDataFormatter.
getInferredCountry(Tweet) - Method in class org.opensextant.extractors.geo.social.XponentGeocoder
Determine a starting set of countries -- if TZ/UTC is set, then use that,...
getInferredCountryCount(String) - Method in class org.opensextant.extractors.geo.rules.LocationChooserRule
How likely is it that this country is substantially relevant to the document based on hard geography.
getInteger(SolrDocument, String) - Static method in class org.opensextant.util.SolrUtil
Get an integer from a record
getInteger(SolrInputDocument, String) - Static method in class org.opensextant.util.SolrUtil
get integer value from input document.
getInternalSolrClient() - Method in class org.opensextant.util.SolrProxy
 
getLinkedGeography() - Method in class org.opensextant.extractors.geo.PlaceCandidate
Get the collection of geographic slots geolocated.
getLong(SolrDocument, String) - Static method in class org.opensextant.util.SolrUtil
Get a long from a record
getMatcherParameters() - Method in class org.opensextant.extraction.SolrMatcherSupport
Return the Solr Parameters for the tagger op.
getMatcherParameters() - Method in class org.opensextant.extractors.geo.GazetteerMatcher
 
getMatcherParameters() - Method in class org.opensextant.extractors.xtax.TaxonMatcher
Return the Solr Parameters for the tagger op.
getName() - Method in class org.opensextant.extractors.geo.PlaceGeocoder
 
getName() - Method in class org.opensextant.extractors.geo.PostalGeocoder
 
getName() - Method in class org.opensextant.extractors.geo.PostalTagger
 
getName() - Method in class org.opensextant.extractors.xtax.TaxonMatcher
Extractor interface: getName
getNamesTime - Variable in class org.opensextant.extraction.SolrMatcherSupport
 
getNDTextnorm() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
getOrgNames() - Method in class org.opensextant.extractors.geo.rules.PersonNameFilter
 
getPersonNames() - Method in class org.opensextant.extractors.geo.rules.PersonNameFilter
 
getPlace() - Method in class org.opensextant.extractors.geo.ScoredPlace
 
getPlaces() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
getPostmatchTokens() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
getPrematchTokens() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
getProperty(String) - Method in class org.opensextant.xlayer.server.TaggerResource
 
getRatio() - Method in class org.opensextant.extractors.geo.CountryCount
given a total number of ALL country mentions, you can derive a ratio, e.g., text ABC is 45% about country1, 34% about country2, etc.
getRatio() - Method in class org.opensextant.extractors.geo.PlaceCount
given a total number of ALL place mentions, you can derive a ratio, e.g., text ABC is 45% about province1, 34% about province2, etc.
getRelated() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
getRetrievingNamesTime() - Method in class org.opensextant.extraction.SolrMatcherSupport
 
getRule() - Method in class org.opensextant.extractors.geo.PlaceEvidence
 
getRules() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
getScope() - Method in class org.opensextant.extractors.geo.PlaceEvidence
 
getScore() - Method in class org.opensextant.extractors.geo.ScoredPlace
 
getSecondChoice() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
getSecondChoiceScore() - Method in class org.opensextant.extractors.geo.PlaceCandidate
Only call after choose() operation.
getSolrProxy() - Method in class org.opensextant.extractors.geo.SolrGazetteer
Returns the SolrProxy used internally.
getStopwords(ResourceLoader, String) - Static method in class org.opensextant.util.LuceneStopwords
Simple wrapper around Lucene resource loading to access Solr-provided stop lists.
getString(SolrDocument, String) - Static method in class org.opensextant.util.SolrUtil
Get a String object from a record
getString(SolrInputDocument, String) - Static method in class org.opensextant.util.SolrUtil
Get a String object from a record on input.
getStrings(SolrDocument, String) - Static method in class org.opensextant.util.SolrUtil
 
getSurroundingText() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
getTaggingNamesTime() - Method in class org.opensextant.extraction.SolrMatcherSupport
Emphemeral metric for the current tagText() call.
getTaxons() - Method in class org.opensextant.extractors.xtax.TaxonMatch
 
getTokens() - Method in class org.opensextant.extractors.geo.PlaceCandidate
Tokens in word.
getTotalTime() - Method in class org.opensextant.extraction.SolrMatcherSupport
 
getUSStateByCode(String) - Method in class org.opensextant.extractors.geo.social.SocialGeo
A dot-separated code, country code + FIPS numeric
getUSStateByName(String) - Method in class org.opensextant.extractors.geo.social.SocialGeo
Lookup US States.
getVersion(String) - Static method in class org.opensextant.xlayer.server.XlayerApp
 
getWeight() - Method in class org.opensextant.extractors.geo.PlaceEvidence
 
getWordCount() - Method in class org.opensextant.extractors.geo.PlaceCandidate
a basic whitespace, punctuation delimited count of grams Set ONLY after inferTextSense() is invoked

H

hasCJKText() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
hasDiacritics - Variable in class org.opensextant.extractors.geo.PlaceCandidate
 
hasDiacritics - Variable in class org.opensextant.extractors.xtax.TaxonMatch
 
hasEvidence() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
hasInvalidPunct(String) - Method in class org.opensextant.extractors.geo.rules.PostalCodeFilter
Match only alphanumeric codes.
hasLinkedGeography(String) - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
hasMiddleEasternText() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
hasOnlyDefaultRules(PlaceCandidate) - Static method in class org.opensextant.extractors.geo.rules.RuleTool
test if candidate match has trivial evidence.
hasPlaces() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
hasPostal() - Method in class org.opensextant.extractors.geo.PlaceCandidate
Evaluate if postal matches reside in candidate locations.
hasRule(String) - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
hasRule(String) - Method in class org.opensextant.extractors.geo.ScoredPlace
 
hasTaxons() - Method in class org.opensextant.extractors.xtax.TaxonMatch
 
HAVERSINE - Static variable in class org.opensextant.extractors.geo.rules.CoordinateAssociationRule
 
HEATMAP_ADMIN_RULE - Static variable in class org.opensextant.extractors.geo.rules.HeatMapRule
 
HEATMAP_RULE - Static variable in class org.opensextant.extractors.geo.rules.HeatMapRule
 
HeatMapRule - Class in org.opensextant.extractors.geo.rules
 
HeatMapRule() - Constructor for class org.opensextant.extractors.geo.rules.HeatMapRule
 

I

incrementPlaceScore(Place, Double, String) - Method in class org.opensextant.extractors.geo.PlaceCandidate
Consolidate attaching Rules to this name when also scoring candidate locations.
incrementScore(double) - Method in class org.opensextant.extractors.geo.ScoredPlace
 
incrementScore(double, String) - Method in class org.opensextant.extractors.geo.ScoredPlace
Increment the score for a given rule exactly once.
inferCountry(String) - Method in class org.opensextant.extractors.geo.rules.LocationChooserRule
 
inferCountryName(Geocoding) - Method in class org.opensextant.extractors.geo.social.XponentGeocoder
Trivial test to see if provided place description is as simple as a country name, rather than a description of a place or non-place.
inferCountryTimezone(Tweet, Place) - Method in class org.opensextant.extractors.geo.social.XponentGeocoder
 
inferenceName - Variable in class org.opensextant.extractors.geo.social.GeoInference
a short label for this type of location.
inferencerDescription - Variable in class org.opensextant.extractors.geo.social.SocialGeo
 
inferencerID - Variable in class org.opensextant.extractors.geo.social.SocialGeo
 
inferPlaceRecursively(SolrGazetteer, Geocoding) - Method in class org.opensextant.extractors.geo.social.SocialGeo
 
inferPlaceRecursively(SolrGazetteer, Geocoding, boolean) - Method in class org.opensextant.extractors.geo.social.SocialGeo
Try to find closest P/PPL* (city or village) within 5 km.
inferProvinceByHierarchy(Tweet, Place) - Method in class org.opensextant.extractors.geo.social.XponentGeocoder
Use geographic hierarchy to find province related to this place.
infersAuthorGeo() - Method in class org.opensextant.extractors.geo.social.GeoInferencer
True if your implementation reflects anything off author profile
infersAuthors - Variable in class org.opensextant.extractors.geo.social.GeoInferencer
 
infersPlaces - Variable in class org.opensextant.extractors.geo.social.GeoInferencer
 
infersPlaces() - Method in class org.opensextant.extractors.geo.social.GeoInferencer
 
infersStatus - Variable in class org.opensextant.extractors.geo.social.GeoInferencer
 
infersStatusGeo() - Method in class org.opensextant.extractors.geo.social.GeoInferencer
True if your implementation reflects anything off status/message
inferTextSense(boolean, boolean) - Method in class org.opensextant.extractors.geo.PlaceCandidate
text hueristics
info(String) - Method in class org.opensextant.xlayer.server.TaggerResource
 
info(String) - Method in class org.opensextant.xlayer.server.XlayerApp
 
initialize() - Method in class org.opensextant.extraction.SolrMatcherSupport
Initialize.
initialize() - Method in class org.opensextant.extractors.geo.GazetteerMatcher
 
initializeHTTP(URL) - Static method in class org.opensextant.util.SolrProxy
Get an HTTP server for Solr.
internalPlaceID(Place) - Method in class org.opensextant.extractors.geo.rules.GeocodeRule
Create a location ID useful for tracking distinct named features by location.
irregularCase(String) - Method in class org.opensextant.extractors.geo.rules.NonsenseFilter
Filter out cases of acronmyms of the form AAa....
irregularCommonPunct(String) - Static method in class org.opensextant.extractors.geo.rules.NonsenseFilter
If common punctuation (), [], !, &, $ are found within the match, then the name is not likely the right thing.
irregularPunctPatterns(String) - Static method in class org.opensextant.extractors.xtax.TaxonFilter
 
isAbbreviation - Variable in class org.opensextant.extractors.geo.PlaceCandidate
Match types - Abbreviation/Code, Acronym or normal (unknown).
isAbbrevLength() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
isAcronym - Variable in class org.opensextant.extractors.geo.PlaceCandidate
 
isAmbiguous() - Method in class org.opensextant.extractors.geo.PlaceCandidate
This only makes sense if you tried choose() first to sort scored places.
isAnchor() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
isContinent - Variable in class org.opensextant.extractors.geo.PlaceCandidate
 
isCoordExtractionEnabled() - Method in class org.opensextant.extractors.geo.PlaceGeocoder
 
isCountry - Variable in class org.opensextant.extractors.geo.PlaceCandidate
Common evidence flags -- isCountry, isPerson, isOrganization, abbreviation, and acronym.
isDebug() - Method in class org.opensextant.xlayer.server.TaggerResource
 
isDebug() - Method in class org.opensextant.xlayer.server.XlayerApp
 
isDefault() - Method in class org.opensextant.extractors.xtax.TaxonMatch
 
isDerived() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
isIrregularPunct(int, int) - Static method in class org.opensextant.extractors.geo.rules.NonsenseFilter
 
isIrregularPunct(int, int, int) - Static method in class org.opensextant.extractors.geo.rules.NonsenseFilter
 
isOrganization - Variable in class org.opensextant.extractors.geo.PlaceCandidate
 
isPerson - Variable in class org.opensextant.extractors.geo.PlaceCandidate
 
isPersonNameMatchingEnabled() - Method in class org.opensextant.extractors.geo.PlaceGeocoder
Deprecated.
This has no effect. Tagging Parameters here are mainly considered for filtering output.
isRelevant() - Method in class org.opensextant.extractors.geo.rules.CoordinateAssociationRule
 
isRelevant() - Method in class org.opensextant.extractors.geo.rules.GeocodeRule
Override if rule instance has another view of relevance, e.g.
isRelevant() - Method in class org.opensextant.extractors.geo.rules.ProvinceAssociationRule
 
isReviewed() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
isRuleFor(PlaceCandidate) - Static method in class org.opensextant.extractors.geo.rules.MajorPlaceRule
Determine if this rule was applied to the candidate.
isRuleFor(PlaceCandidate) - Static method in class org.opensextant.extractors.geo.rules.NameCodeRule
 
isSameFeature(Place) - Method in class org.opensextant.extractors.geo.PlaceEvidence
if Place given has same feature class and code as the current evidence
isShort(int) - Static method in class org.opensextant.extractors.geo.rules.GeocodeRule
 
isShortName() - Method in class org.opensextant.extractors.geo.PlaceCandidate
Alias for "isAbbreviation || isAcronym" and a length criteria of less than #{PlaceCandidate.SHORT_NAME_LEN}
isValid() - Method in class org.opensextant.extractors.geo.PlaceCandidate
if candidate was marked as valid.
isValidAbbreviation(String) - Static method in class org.opensextant.extractors.geo.rules.NonsenseFilter
Test for simple abbreviations.
isValue(String) - Static method in class org.opensextant.extractors.geo.social.SocialGeo
Generally useful test of string values.
isWritable() - Method in class org.opensextant.util.SolrProxy
Is Solr server instance allowed to write to index?

J

jsonp - Variable in class org.opensextant.xlayer.XlayerClient
 

K

KMLDemoWriter - Class in org.opensextant.extractors.geo.social
A cleaner approach to outputting geocoding data to KML using GISCore.
KMLDemoWriter(String) - Constructor for class org.opensextant.extractors.geo.social.KMLDemoWriter
 
KNOWN_GEO_SLOTS - Static variable in class org.opensextant.extractors.geo.PlaceCandidate
Linked geographic slots, in no order.

L

label - Variable in class org.opensextant.extractors.geo.PlaceCount
 
label - Variable in class org.opensextant.extractors.geo.rules.FeatureClassMeta
 
lang2nameField - Static variable in class org.opensextant.extractors.geo.GazetteerMatcher
 
langidTool - Variable in class org.opensextant.extractors.geo.social.GeoInferencer
 
LEX1 - Static variable in class org.opensextant.extractors.geo.rules.GeocodeRule
 
LEX2 - Static variable in class org.opensextant.extractors.geo.rules.GeocodeRule
 
linkGeography(String, Place) - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
linkGeography(PlaceCandidate, String, String) - Method in class org.opensextant.extractors.geo.PlaceCandidate
Link geographic mention from other part of the document.
linkGeography(PlaceCandidate, String, Place) - Method in class org.opensextant.extractors.geo.PlaceCandidate
Foricbly link geography to the given slot.
linkGeography(PlaceCandidate, PlaceCandidate, String, String) - Static method in class org.opensextant.extractors.geo.PostalGeocoder
 
loadCountries(SolrClient) - Static method in class org.opensextant.extractors.geo.SolrGazetteer
This only returns Country objects that are names; It does not produce any abbreviation variants.
loadExclusions(InputStream) - Static method in class org.opensextant.extractors.geo.TagFilter
Exclusions have two columns in a CSV file.
loadProvinceNames() - Method in class org.opensextant.extractors.geo.social.SocialGeo
Geonames Helpers.
loadUSStates() - Method in class org.opensextant.extractors.geo.social.SocialGeo
CAVEAT: For now this only loads US states, despite us loading
LOCAL - Enum constant in enum org.opensextant.extractors.geo.PlaceEvidence.Scope
 
LOCATION_BIAS_WEIGHT - Static variable in class org.opensextant.extractors.geo.PlaceCandidate
 
LocationChooserRule - Class in org.opensextant.extractors.geo.rules
A final geocoding pass or two.
LocationChooserRule() - Constructor for class org.opensextant.extractors.geo.rules.LocationChooserRule
 
locationInScope(Geocoding) - Method in interface org.opensextant.extractors.geo.LocationObserver
If a given geo is in scope, fire this event.
locationInScope(Geocoding) - Method in class org.opensextant.extractors.geo.PlaceGeocoder
When coordinates are found track them.
LocationObserver - Interface in org.opensextant.extractors.geo
Apply this interface where application logic observes a coordinate or any hard location reference.
locationOnly - Variable in class org.opensextant.extractors.geo.rules.GeocodeRule
 
log - Variable in class org.opensextant.extraction.SolrMatcherSupport
 
log - Variable in class org.opensextant.extractors.geo.rules.GeocodeRule
 
log - Variable in class org.opensextant.extractors.geo.social.SocialGeo
 
log - Variable in class org.opensextant.xlayer.server.TaggerResource
The log.
log - Variable in class org.opensextant.xlayer.server.XlayerApp
The log.
log - Variable in class org.opensextant.xlayer.XlayerClient
 
logger - Variable in class org.opensextant.util.SolrProxy
 
logMsg(String, String) - Method in class org.opensextant.extractors.geo.rules.GeocodeRule
 
lookupFeature(Place) - Static method in class org.opensextant.extractors.geo.rules.FeatureRule
Find feature metadata if we have it; At a minimum
LOWERCASE - Static variable in class org.opensextant.extractors.geo.rules.GeocodeRule
 
LuceneStopwords - Class in org.opensextant.util
Utility class to help access Lucene stop words, mainly as they exist in Solr index stopword files are in either list form or snowball format.
LuceneStopwords() - Constructor for class org.opensextant.util.LuceneStopwords
 

M

main(String[]) - Static method in class org.opensextant.xlayer.server.xgeo.XlayerServer
 
MajorPlaceRule - Class in org.opensextant.extractors.geo.rules
Major Place rule -- fire this rule after Country rule.
MajorPlaceRule(Map<String, Integer>) - Constructor for class org.opensextant.extractors.geo.rules.MajorPlaceRule
Major Place assigns a score to places that are national capitals, provinces, or cities with sizable population.
makeKey(Place) - Method in class org.opensextant.extractors.geo.PlaceCandidate
Each place has an ID, but this candidate scoring mechanism must score distinct ID+NAME tuples.
markAnchor() - Method in class org.opensextant.extractors.geo.PlaceCandidate
Mark this mention as an anchor to build from, e.g., given a postal code expand the tag to gather the related mentions for city, province, etc.
markValid() - Method in class org.opensextant.extractors.geo.PlaceCandidate
Mark candidate as valid to protect it from being filtered out by downstream rules.
MATCHCONF_BARE_ACRONYM - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
 
MATCHCONF_GEODETIC - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
Absolute Confidence: Geographic location of a named place lines up with a coordinate in-scope
MATCHCONF_MANY_COUNTRIES - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
Absolute Confidence: Many locations matched, with multiple countries in scope So, Many countries mentioned in document
MATCHCONF_MANY_COUNTRY - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
Absolute Confidence: Many locations matched, but one country in scope.
MATCHCONF_MANY_LOC - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
Absolute Confidence: Many Locations matched a single name.
MATCHCONF_MINIMUM - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
The bare minimum confidence -- if rules negate confidence points, confidence may go below 20.
MATCHCONF_MINIMUM_SOCMEDIA - Variable in class org.opensextant.extractors.geo.social.XponentTextGeotagger
 
MATCHCONF_NAME_REGION - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
Absolute Confidence: Name, Region; City, State; Capital, Country; etc.
MATCHCONF_ONE_LOC - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
Absolute Confidence: Unique name in gazetteer.
MATCHCONF_PREFERRED - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
A subtle boost for locations that were preferred -- especially helps when there is no inherent context and we must rely on the caller's intuition.
MATCHCONF_QUALIFIER_AMBIGUOUS_NAME - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
Confidence Qualifier: Ambiguous
MATCHCONF_QUALIFIER_COUNTRY_MENTIONED - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
Confidence Qualifier: The chosen place happens to be in a country mentioned in the document
MATCHCONF_QUALIFIER_HIGH_SCORE - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
Confidence Qualifier: The chosen place scored high compared to the runner up
MATCHCONF_QUALIFIER_LOWERCASE - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
Confidence Qualifier: Start here if you have a lower case term that may be a place.
MATCHCONF_QUALIFIER_MAJOR_PLACE - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
Confidence Qualifier: The chosen place happens to be a major place, e.g., large city.
MATCHCONF_QUALIFIER_UNIQUE_COUNTRY - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
Confidence Qualifier: Name appears in only one country.
matchesCode() - Method in class org.opensextant.extractors.geo.PlaceCandidate
To be used sparingly -- determine if a matched place for this text span is actually a code.
MENTIONED_COUNTRY - Static variable in class org.opensextant.extractors.geo.rules.MajorPlaceRule
 
MERGED - Enum constant in enum org.opensextant.extractors.geo.PlaceEvidence.Scope
 
METHOD_DEFAULT - Static variable in class org.opensextant.extractors.geo.PlaceGeocoder
 
METHOD_DEFAULT - Static variable in class org.opensextant.extractors.geo.PostalGeocoder
 
METHOD_DEFAULT - Static variable in class org.opensextant.extractors.geo.PostalTagger
 

N

NAME - Variable in class org.opensextant.extractors.geo.rules.GeocodeRule
 
NAME_ADMCODE_RULE - Static variable in class org.opensextant.extractors.geo.rules.NameCodeRule
 
NAME_ADMNAME_RULE - Static variable in class org.opensextant.extractors.geo.rules.NameCodeRule
 
NAME_IN_ORG_RULE - Static variable in class org.opensextant.extractors.geo.rules.PersonNameFilter
Rule fired if a location is found in an organization name; Only organization should be filtered out.
NAME_WEIGHT - Static variable in class org.opensextant.extractors.geo.PlaceCandidate
 
NameCodeRule - Class in org.opensextant.extractors.geo.rules
A rule that associates a CODE with a NAME, when the pattern "NAME, CODE" appears within N characters of each other.
NameCodeRule(Parameters) - Constructor for class org.opensextant.extractors.geo.rules.NameCodeRule
 
NameRule - Class in org.opensextant.extractors.geo.rules
 
NameRule() - Constructor for class org.opensextant.extractors.geo.rules.NameRule
 
names - Variable in class org.opensextant.extractors.geo.PlaceCount
 
NonLatinNameRule - Class in org.opensextant.extractors.geo.rules
GeocodeRule called only if document is non-Latin such as C/J/K or MiddleEastern scripts.
NonLatinNameRule() - Constructor for class org.opensextant.extractors.geo.rules.NonLatinNameRule
 
NonsenseFilter - Class in org.opensextant.extractors.geo.rules
Filter out nonsense tokens that match some city or state name.
NonsenseFilter() - Constructor for class org.opensextant.extractors.geo.rules.NonsenseFilter
 
normalizeCountryName(String) - Static method in class org.opensextant.extractors.geo.SolrGazetteer
Normalize country name.

O

openIndex() - Method in class org.opensextant.util.SolrProxy
Reopen an existing solr proxy.
operation - Variable in class org.opensextant.xlayer.server.TaggerResource
 
optimize() - Method in class org.opensextant.util.SolrProxy
Optimizes the Solr server.
org.opensextant.extraction - package org.opensextant.extraction
 
org.opensextant.extractors.geo - package org.opensextant.extractors.geo
Geo Extraction: PlaceGeocoder, SolrGazetteer, GazetteerMatcher and related items
org.opensextant.extractors.geo.rules - package org.opensextant.extractors.geo.rules
GeocodeRules
org.opensextant.extractors.geo.social - package org.opensextant.extractors.geo.social
Social Geoinferencing
org.opensextant.extractors.xtax - package org.opensextant.extractors.xtax
XTax Taxonomy/Keyword Matcher
org.opensextant.output - package org.opensextant.output
 
org.opensextant.util - package org.opensextant.util
 
org.opensextant.xlayer - package org.opensextant.xlayer
 
org.opensextant.xlayer.server - package org.opensextant.xlayer.server
 
org.opensextant.xlayer.server.xgeo - package org.opensextant.xlayer.server.xgeo
 
outputStream - Variable in class org.opensextant.extractors.geo.social.KMLDemoWriter
 

P

P_prefixes - Static variable in class org.opensextant.extractors.geo.rules.NameRule
 
parseAnnotation(Object) - Static method in class org.opensextant.output.Transforms
Convert JSON object for an annotation into a Xponents TextMatch instance.
parseDate(DateMatch, JsonObject) - Static method in class org.opensextant.output.Transforms
First stab at deserializing JSON date annotation.
parseFreeTextCoordinates(Place) - Method in class org.opensextant.extractors.geo.social.XponentGeocoder
Not common, but useful.
parseGeocoding(Place, JsonObject) - Static method in class org.opensextant.output.Transforms
Given a JSON object, parse fields relevant to the geocoding and populate that JSON data TODO: implement Parsing reverse geocoding structures related_place_name and nearest_places
parseParameters(Parameters, Set<String>) - Method in class org.opensextant.xlayer.server.TaggerResource
 
parseTaxon(TaxonMatch, String, JsonObject) - Static method in class org.opensextant.output.Transforms
Parse out a taxon from JSON/REST
pct(long, long) - Method in class org.opensextant.extractors.geo.social.GeoInferencer
 
PersonNameFilter - Class in org.opensextant.extractors.geo.rules
 
PersonNameFilter(String, String, String) - Constructor for class org.opensextant.extractors.geo.rules.PersonNameFilter
Default constructor here used resource paths (which are retrieved as getResourceAsStream() Instead of retrieving resource URLs or files.
PersonNameFilter(URL, URL, URL) - Constructor for class org.opensextant.extractors.geo.rules.PersonNameFilter
Constructor for general usage if you know your files might come from file system or JAR.
PHRASE_DENSITY_CHAR_RATIO - Static variable in class org.opensextant.extractors.geo.rules.NonsenseFilter
Names of places should have about N=5 chars to non-chars.
ping() - Method in class org.opensextant.xlayer.server.TaggerResource
Ping.
place - Variable in class org.opensextant.extractors.geo.PlaceCount
 
placeAt(LatLon, int, String) - Method in class org.opensextant.extractors.geo.SolrGazetteer
This is a reasonable guess.
PlaceCandidate - Class in org.opensextant.extractors.geo
A PlaceCandidate represents a portion of a document which has been identified as a possible named geographic location.
PlaceCandidate(int, int) - Constructor for class org.opensextant.extractors.geo.PlaceCandidate
 
PlaceCount - Class in org.opensextant.extractors.geo
Place metrics.
PlaceCount(String) - Constructor for class org.opensextant.extractors.geo.PlaceCount
 
PlaceEvidence - Class in org.opensextant.extractors.geo
A PlaceEvidence represents a fragment of evidence about a Place.
PlaceEvidence() - Constructor for class org.opensextant.extractors.geo.PlaceEvidence
 
PlaceEvidence(Place, String, double) - Constructor for class org.opensextant.extractors.geo.PlaceEvidence
 
PlaceEvidence(PlaceEvidence) - Constructor for class org.opensextant.extractors.geo.PlaceEvidence
 
PlaceEvidence.Scope - Enum in org.opensextant.extractors.geo
SCOPE - Where did this evidence come from wrt to the PlaceCandidate it is part of? APRIORI - derived from the gazetteer only, not from any information in the document LOCAL - directly associated with this instance of PC COREF - associated with another (related) PC in the document MERGED - came from the merger of multiple PlaceEvidences (future use) DOCUMENT - in the same document but has no other direct association
PlaceGeocoder - Class in org.opensextant.extractors.geo
A simple variation on the geocoding algorithms: geotag all possible things and determine a best geo-location for each tagged item.
PlaceGeocoder() - Constructor for class org.opensextant.extractors.geo.PlaceGeocoder
A default Geocoding app that demonstrates how to invoke the geocoding pipline start to finish.
PlaceGeocoder(boolean) - Constructor for class org.opensextant.extractors.geo.PlaceGeocoder
 
placeMentionCount() - Method in interface org.opensextant.extractors.geo.BoundaryObserver
Calculates totals and ratios for the discovered set of boundaries, inferred or explicit.
placeMentionCount() - Method in class org.opensextant.extractors.geo.PlaceGeocoder
Weight mentions or indirect references to Provinces in the document
placeMentionCount() - Method in class org.opensextant.extractors.geo.PostalGeocoder
 
placeObserved(Place) - Method in interface org.opensextant.extractors.geo.LocationObserver
The place know by the ID, p.getKey() or p.getPlaceID() was it observed directly or indirectly in this document?
placeObserved(Place) - Method in class org.opensextant.extractors.geo.PlaceGeocoder
Tell us if this place P was inferred by hard location mentions
placesAt(LatLon) - Method in class org.opensextant.extractors.geo.GazetteerMatcher
Deprecated.
Use SolrGazetteer directly
placesAt(LatLon, int) - Method in class org.opensextant.extractors.geo.SolrGazetteer
Find places located at a particular location.
placesAt(LatLon, int, String) - Method in class org.opensextant.extractors.geo.SolrGazetteer
Variation on placesAt().
POP - Static variable in class org.opensextant.extractors.geo.rules.MajorPlaceRule
 
populateAllCountries(SolrGazetteer) - Method in class org.opensextant.extractors.geo.social.SocialGeo
Populate the allCountries listing.
populateBasicCountryNames() - Method in class org.opensextant.extractors.geo.social.SocialGeo
Create a lookup of the most common country names.
populatePlace(SolrDocument, Place) - Static method in class org.opensextant.util.SolrUtil
Populate the data card.
POSTAL_ASSOC_RULE - Static variable in class org.opensextant.extractors.geo.rules.PostalCodeAssociationRule
 
POSTAL_TAGGER - Static variable in class org.opensextant.xlayer.server.TaggerResource
 
PostalCodeAssociationRule - Class in org.opensextant.extractors.geo.rules
 
PostalCodeAssociationRule() - Constructor for class org.opensextant.extractors.geo.rules.PostalCodeAssociationRule
 
PostalCodeFilter - Class in org.opensextant.extractors.geo.rules
 
PostalCodeFilter(int) - Constructor for class org.opensextant.extractors.geo.rules.PostalCodeFilter
 
PostalGeocoder - Class in org.opensextant.extractors.geo
PostalGeocoder -- a GazetteerMatcher that uses the "postal" solr index to quickly tag any known postal codes worldwide.
PostalGeocoder() - Constructor for class org.opensextant.extractors.geo.PostalGeocoder
 
PostalLocationChooser - Class in org.opensextant.extractors.geo.rules
A trivial location chooser rule.
PostalLocationChooser() - Constructor for class org.opensextant.extractors.geo.rules.PostalLocationChooser
 
PostalTagger - Class in org.opensextant.extractors.geo
Postal Tagger tags and returns any alphanumeric token or phrase that resembles postal codes and abbreviations.
PostalTagger() - Constructor for class org.opensextant.extractors.geo.PostalTagger
 
PREF_COUNTRY - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
Preferred Country or Location -- when user supplies the context that may be missing....
PREF_LOCATION - Static variable in class org.opensextant.extractors.geo.rules.LocationChooserRule
 
presentInCountry(String) - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
presentInHierarchy(String) - Method in class org.opensextant.extractors.geo.PlaceCandidate
Given a path, 'a.b' ( province b in country a), see if this name is present there.
process(String, String, boolean) - Method in class org.opensextant.xlayer.XlayerClient
 
process(TextInput, Parameters) - Method in class org.opensextant.xlayer.server.TaggerResource
Implement the processing of a single Input given some request parameters Based on the processing and the request, format response accordingly.
process(TextInput, Parameters) - Method in class org.opensextant.xlayer.server.xgeo.XponentsGeotagger
Process the text for the given document.
process(TextInput, Parameters) - Method in class org.opensextant.xlayer.server.XlayerControl
 
processForm(JsonRepresentation) - Method in class org.opensextant.xlayer.server.xgeo.XponentsGeotagger
Contract: docid optional; 'text' | 'doc-list' required.
processGet(Representation) - Method in class org.opensextant.xlayer.server.xgeo.XponentsGeotagger
HTTP GET -- vanilla.
processLocation(Tweet, Place, String, String) - Method in class org.opensextant.extractors.geo.social.XponentGeocoder
Detailed routine to uncover additional location information in tweet noise.
processLocationMentions(Tweet, Place, String, String) - Method in class org.opensextant.extractors.geo.social.XponentTextGeotagger
This works best if your tweet provides a natural language text, Tweet.setTextNatural()
profilePlaceFilter - Variable in class org.opensextant.extractors.geo.social.XponentGeocoder
Xponents user "match filter" for PlaceGeocoder: Quickly filter out adhoc social media noise.
profileRule - Variable in class org.opensextant.extractors.geo.social.XponentGeocoder
Xponents user "geocoding rule" for PlaceGeocoder: custom metadata is fed to tagger using this rule.
proportion - Variable in class org.opensextant.extractors.geo.rules.FeatureClassMeta
Relative gazetteer proportion for this feature
ProvinceAssociationRule - Class in org.opensextant.extractors.geo.rules
Give a list of province metadata that scopes the document, mark the list of evaluated PlaceCandidates' locations as relevant or not.
ProvinceAssociationRule() - Constructor for class org.opensextant.extractors.geo.rules.ProvinceAssociationRule
 
provinceID(Place) - Method in class org.opensextant.extractors.geo.social.XponentGeocoder
Derive the Province ID if given a hard location.
ProvinceNameSetter - Class in org.opensextant.extractors.geo.rules
 
ProvinceNameSetter(GeonamesUtility) - Constructor for class org.opensextant.extractors.geo.rules.ProvinceNameSetter
Configure name helper if you want Province name resolution and other things..

R

READ_TIMEOUT_STRING - Static variable in class org.opensextant.xlayer.XlayerClient
1 minutes
recordId - Variable in class org.opensextant.extractors.geo.social.GeoInference
original data record that this inference is attached to
recordsWithCoord - Variable in class org.opensextant.extractors.geo.social.XponentGeocoder
 
recordsWithPlace - Variable in class org.opensextant.extractors.geo.social.XponentGeocoder
 
recordsWithTZ - Variable in class org.opensextant.extractors.geo.social.XponentGeocoder
 
regularAbbreviationPatterns(String) - Static method in class org.opensextant.extractors.geo.rules.NonsenseFilter
 
removeFilters() - Method in class org.opensextant.extractors.xtax.TaxonMatcher
 
removePunct(String) - Static method in class org.opensextant.extractors.geo.social.XponentGeocoder
 
report() - Method in class org.opensextant.extractors.geo.social.GeoInferencer
Processing report; This could be more structured ala ExtractionMetrics for now this is just a final message from the implementation about general performance.
report() - Method in class org.opensextant.extractors.geo.social.XponentGeocoder
Renders a string buffer with a final report -- provided you set or increment the totalRecords value.
reportMemory() - Method in class org.opensextant.extractors.geo.GazetteerMatcher
 
reportMetrics() - Method in class org.opensextant.extractors.geo.PlaceGeocoder
We have some emerging metrics to report out...
requestHandler - Variable in class org.opensextant.extraction.SolrMatcherSupport
 
reset() - Method in class org.opensextant.extractors.geo.PostalGeocoder
 
reset() - Method in class org.opensextant.extractors.geo.rules.ContextualOrganizationRule
 
reset() - Method in class org.opensextant.extractors.geo.rules.CoordinateAssociationRule
 
reset() - Method in class org.opensextant.extractors.geo.rules.GeocodeRule
no-op, unless overriden.
reset() - Method in class org.opensextant.extractors.geo.rules.HeatMapRule
 
reset() - Method in class org.opensextant.extractors.geo.rules.LocationChooserRule
 
reset() - Method in class org.opensextant.extractors.geo.rules.MajorPlaceRule
 
reset() - Method in class org.opensextant.extractors.geo.rules.NameCodeRule
 
reset() - Method in class org.opensextant.extractors.geo.rules.PersonNameFilter
 
reset() - Method in class org.opensextant.extractors.geo.rules.ProvinceAssociationRule
 
resetParameters(Parameters) - Method in class org.opensextant.xlayer.server.TaggerResource
Convenience helper to reset data.
RuleTool - Class in org.opensextant.extractors.geo.rules
 
RuleTool() - Constructor for class org.opensextant.extractors.geo.rules.RuleTool
 

S

sameBoundary(Place, Place) - Method in class org.opensextant.extractors.geo.rules.GeocodeRule
Quick test to see if two places are contained within the same boundary.
sameCountry(String, String) - Method in class org.opensextant.extractors.geo.rules.GeocodeRule
To compare places by their country code alone.
sameCountry(Place, Place) - Method in class org.opensextant.extractors.geo.rules.GeocodeRule
 
sameLexicalName(PlaceCandidate, Place) - Method in class org.opensextant.extractors.geo.rules.GeocodeRule
Increment score for lexical matches accoringly: - non-ASCII match: 2.5 pts - ASCII match: 1.5 pts - Case insenstive match: 0.5 pts Simple example, with one char in Name match, one char in Geo Name ø = ø 2.5 o = o 1.5 O = O 1.5 O = o 0.5 Mention ? Gazetteer Entry Boston != Bøstøn, no points.
saveAndReopen() - Method in class org.opensextant.util.SolrProxy
Save and reopen.
saveIndex() - Method in class org.opensextant.util.SolrProxy
Invokes saveIndex(false)
saveIndex(boolean) - Method in class org.opensextant.util.SolrProxy
Save and optionally records to server or index On failure, current accumulating request is cleared and nullified to avoid retransmitting bad data.
scoreCountryPrediction(Country, Tweet) - Method in class org.opensextant.extractors.geo.social.SocialGeo
This score as a boost for any sort of disambiguation of ties or close scores in predictions.
ScoredPlace - Class in org.opensextant.extractors.geo
A class to hold a Place and a score together.
ScoredPlace() - Constructor for class org.opensextant.extractors.geo.ScoredPlace
 
ScoredPlace(String, String) - Constructor for class org.opensextant.extractors.geo.ScoredPlace
 
scoreFeature(Place) - Method in class org.opensextant.extractors.geo.PlaceCandidate
A preference for features that are major places or boundaries.
scoreName(Place) - Method in class org.opensextant.extractors.geo.PlaceCandidate
Produce a goodness score in the range 0 to 1.0 Trivial examples of name matching:
search(String) - Method in class org.opensextant.extractors.geo.SolrGazetteer
Search the gazetteer using a phrase.
search(String) - Method in class org.opensextant.extractors.xtax.TaxonMatcher
search the current taxonomic catalog.
search(String, boolean) - Method in class org.opensextant.extractors.geo.SolrGazetteer
Instance method that reuses a set of SolrParams for optimized search.
search(SolrClient, String) - Static method in class org.opensextant.extractors.xtax.TaxonMatcher
 
search(SolrClient, SolrParams) - Static method in class org.opensextant.extractors.xtax.TaxonMatcher
 
search(SolrParams) - Method in class org.opensextant.extractors.geo.SolrGazetteer
 
search(SolrParams) - Method in class org.opensextant.extractors.xtax.TaxonMatcher
search the current taxonomic catalog.
searchAdvanced(String, boolean) - Method in class org.opensextant.extractors.geo.GazetteerMatcher
Default advanced search.
searchAdvanced(String, boolean, int) - Method in class org.opensextant.extractors.geo.GazetteerMatcher
This is a variation on SolrGazetteer.search(), just this creates ScoredPlace which is immediately usable with scoring and ranking matches.
searchGazetteer(SolrClient, SolrParams) - Static method in class org.opensextant.util.SolrProxy
Search an OpenSextant solr gazetteer.
server_url - Variable in class org.opensextant.util.SolrProxy
 
serviceAddress - Variable in class org.opensextant.xlayer.XlayerClient
 
serviceContext - Variable in class org.opensextant.xlayer.XlayerClient
 
setAllowLowerCase(boolean) - Method in class org.opensextant.extractors.geo.GazetteerMatcher
Enable/disable the match filter for lower case matches.
setAllowLowerCase(boolean) - Method in class org.opensextant.extractors.xtax.TaxonMatcher
 
setAllowLowerCaseAbbreviations(boolean) - Method in class org.opensextant.extractors.geo.GazetteerMatcher
A flag that will allow us to tag "in" or "in." as a possible abbreviation.
setBoundaryObserver(BoundaryObserver) - Method in class org.opensextant.extractors.geo.rules.GeocodeRule
 
setBuffer(String) - Method in class org.opensextant.extractors.geo.rules.PostalCodeAssociationRule
Important - set buffer so spans for tuples can be assessed.
setChosen(ScoredPlace) - Method in class org.opensextant.extractors.geo.PlaceCandidate
Unlike choose(Place), setChosen(Place) just sets the value.
setChosenPlace(Place) - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
setConfidence(int) - Method in class org.opensextant.extractors.geo.PlaceCandidate
Using a scale of 0 to 100, indicate how confident we are that the chosen place is best.
setCoordinates(List<Geocoding>) - Method in class org.opensextant.extractors.geo.rules.CoordinateAssociationRule
 
setCountryObserver(CountryObserver) - Method in class org.opensextant.extractors.geo.rules.GeocodeRule
 
setDefaultMethod(String) - Method in class org.opensextant.extractors.geo.rules.GeocodeRule
 
setDerived(boolean) - Method in class org.opensextant.extractors.geo.PlaceCandidate
Mark this candidate as something that was derived by special rules and to treat it differently, e.g., in formatting output or other situations.
setEnableCaseFilter(boolean) - Method in class org.opensextant.extractors.geo.GazetteerMatcher
Enable/disable the document-level case filter.
setEnableCodeHunter(boolean) - Method in class org.opensextant.extractors.geo.GazetteerMatcher
 
setEvaluated(boolean) - Method in class org.opensextant.extractors.geo.PlaceEvidence
 
setGeneralMatches(List<TextMatch>) - Method in class org.opensextant.extractors.geo.PostalGeocoder
OPTIMIZATION: Set the general purpose matches (geo, taxons, etc) from a prior processing step.
setGeohash(Place) - Static method in class org.opensextant.extractors.geo.rules.GeocodeRule
 
setLanguageID(LangDetect) - Method in class org.opensextant.extractors.geo.social.GeoInferencer
NOTE: the langID tool from Cybozu can only be loaded once per JVM.
setLinkedGeography(Map<String, Place>) - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
setLocationObserver(LocationObserver) - Method in class org.opensextant.extractors.geo.rules.GeocodeRule
 
setMatchFilter(MatchFilter) - Method in class org.opensextant.extractors.geo.GazetteerMatcher
User-provided filters to filter out matched names immediately.
setMinLen(int) - Method in class org.opensextant.extractors.geo.PostalTagger
Override the default MIN_LEN=4 length for a postal code.
setParameters(Parameters) - Method in class org.opensextant.extractors.geo.PlaceGeocoder
 
setPlace(Place) - Method in class org.opensextant.extractors.geo.ScoredPlace
 
setPostmatchTokens(String[]) - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
setPrematchTokens(String[]) - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
setProvinceName(Place) - Method in class org.opensextant.extractors.geo.social.SocialGeo
set Province name from given codes on somePlace.
setProvinces(Collection<PlaceCount>) - Method in class org.opensextant.extractors.geo.rules.ProvinceAssociationRule
 
setReviewed(boolean) - Method in class org.opensextant.extractors.geo.PlaceCandidate
A general purpose flag "reviewed" to indicate something was reviewed and to not repeat that task on this instance.
setRule(String) - Method in class org.opensextant.extractors.geo.PlaceEvidence
 
setRules(List<GeocodeRule>) - Method in class org.opensextant.extractors.geo.PlaceGeocoder
You don't like the default rule set,..
setScope(PlaceEvidence.Scope) - Method in class org.opensextant.extractors.geo.PlaceEvidence
 
setSurroundingTokens(String) - Method in class org.opensextant.extractors.geo.PlaceCandidate
Get some sense of tokens surrounding match.
setTaggerHandler(String) - Method in class org.opensextant.extraction.SolrMatcherSupport
Use this if you intend to set a non-default tagger path.
setText(String) - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
setText(String) - Method in class org.opensextant.extractors.xtax.TaxonMatch
 
setTextCase(TextInput) - Method in class org.opensextant.extractors.geo.rules.GeocodeRule
 
setupCore(String, String) - Static method in class org.opensextant.util.SolrProxy
Creates an EmbeddedSolrServer given solr home & the core to use.
setWeight(double) - Method in class org.opensextant.extractors.geo.PlaceEvidence
 
setWritable(boolean) - Method in class org.opensextant.util.SolrProxy
 
SHORT_NAME_LEN - Static variable in class org.opensextant.extractors.geo.PlaceCandidate
 
shortNumericText(String) - Static method in class org.opensextant.extractors.geo.rules.NonsenseFilter
5th Street -- fine.
SO_TIMEOUT_STRING - Static variable in class org.opensextant.xlayer.XlayerClient
1 minute
SocialGeo - Class in org.opensextant.extractors.geo.social
A base-class that has the various hooks for logging, dev/test/evaluation, common dictionaries/resources, and helpful connectivity items.
SocialGeo() - Constructor for class org.opensextant.extractors.geo.social.SocialGeo
 
solr - Variable in class org.opensextant.extraction.SolrMatcherSupport
 
solrClient - Variable in class org.opensextant.util.SolrProxy
 
SolrGazetteer - Class in org.opensextant.extractors.geo
Connects to a Solr sever via HTTP and tags place names in document.
SolrGazetteer() - Constructor for class org.opensextant.extractors.geo.SolrGazetteer
Instantiates a new solr gazetteer.
SolrGazetteer(String) - Constructor for class org.opensextant.extractors.geo.SolrGazetteer
Instantiates a new solr gazetteer with the specified Solr Home location.
SolrGazetteer(SolrProxy) - Constructor for class org.opensextant.extractors.geo.SolrGazetteer
 
solrHome - Variable in class org.opensextant.util.SolrProxy
 
SolrMatcherSupport - Class in org.opensextant.extraction
Connects to a Solr sever via HTTP and tags place names in document.
SolrMatcherSupport() - Constructor for class org.opensextant.extraction.SolrMatcherSupport
 
SolrProxy - Class in org.opensextant.util
As Xponents is a multi-core instance of Solr, a single default solr home and default solr core does not make sense.
SolrProxy(String) - Constructor for class org.opensextant.util.SolrProxy
Initializes a Solr server from the SOLR_HOME environment variable.
SolrProxy(String, String) - Constructor for class org.opensextant.util.SolrProxy
Initializes a Solr server from the SOLR_HOME environment variable.
SolrProxy(URL) - Constructor for class org.opensextant.util.SolrProxy
Initializes a Solr server from a URL
SolrTaggerRequest - Class in org.opensextant.extraction
 
SolrTaggerRequest(SolrParams, String) - Constructor for class org.opensextant.extraction.SolrTaggerRequest
 
SolrUtil - Class in org.opensextant.util
Utility functions better suited in their own class.
SolrUtil() - Constructor for class org.opensextant.util.SolrUtil
 
start - Variable in class org.opensextant.extractors.geo.social.GeoInference
offset bounds.
status(String, String) - Method in class org.opensextant.xlayer.server.TaggerResource
 
stop() - Method in class org.opensextant.xlayer.server.XlayerControl
 
summarize(boolean) - Method in class org.opensextant.extractors.geo.PlaceCandidate
If you need a full print out of the data, use summarize(true);.

T

TagFilter - Class in org.opensextant.extractors.geo
 
TagFilter() - Constructor for class org.opensextant.extractors.geo.TagFilter
NOTE: This expects the files are all available.
tagger - Variable in class org.opensextant.extractors.geo.social.XponentGeocoder
 
TaggerMatchInterpeter - Class in org.opensextant.output
 
TaggerMatchInterpeter() - Constructor for class org.opensextant.output.TaggerMatchInterpeter
 
TaggerResource - Class in org.opensextant.xlayer.server
 
TaggerResource() - Constructor for class org.opensextant.xlayer.server.TaggerResource
 
tagNamesTime - Variable in class org.opensextant.extraction.SolrMatcherSupport
 
tagText(String, String) - Method in class org.opensextant.extractors.geo.GazetteerMatcher
Geotag a buffer and return all candidates of gazetteer entries whose name matches phrases in the buffer.
tagText(String, String, boolean) - Method in class org.opensextant.extractors.geo.GazetteerMatcher
 
tagText(String, String, boolean, String) - Method in class org.opensextant.extractors.geo.GazetteerMatcher
 
tagText(TextInput, boolean) - Method in class org.opensextant.extractors.geo.GazetteerMatcher
More convenient way of passing input args, using tuple TextInput (buffer, docid, langid)
tagText(TextInput, boolean, String) - Method in class org.opensextant.extractors.geo.GazetteerMatcher
Geotag a document, returning PlaceCandidates for the mentions in document.
tagTextCallSolrTagger(String, String, Map<Object, Object>) - Method in class org.opensextant.extraction.SolrMatcherSupport
Solr call: tag input buffer, returning all candiate reference data that matched during tagging.
TAXON_TAGGER - Static variable in class org.opensextant.xlayer.server.TaggerResource
 
taxonCatalogs - Variable in class org.opensextant.extractors.geo.PlaceGeocoder
 
TaxonFilter - Class in org.opensextant.extractors.xtax
 
TaxonFilter() - Constructor for class org.opensextant.extractors.xtax.TaxonFilter
 
TaxonMatch - Class in org.opensextant.extractors.xtax
 
TaxonMatch(int, int) - Constructor for class org.opensextant.extractors.xtax.TaxonMatch
 
TaxonMatcher - Class in org.opensextant.extractors.xtax
TaxonMatcher uses SolrTextTagger to tag mentions of phrases in documents.
TaxonMatcher() - Constructor for class org.opensextant.extractors.xtax.TaxonMatcher
 
textCase - Variable in class org.opensextant.extractors.geo.rules.GeocodeRule
 
textCase(TextInput) - Method in class org.opensextant.extractors.geo.rules.GeocodeRule
for the purposes of Geocoder Rule reasoning determine the case.
toJSON(List<TextMatch>, Parameters) - Static method in class org.opensextant.output.Transforms
 
tokenizer - Static variable in class org.opensextant.extractors.geo.PlaceCandidate
 
toString() - Method in class org.opensextant.extractors.geo.CountryCount
 
toString() - Method in class org.opensextant.extractors.geo.PlaceCandidate
 
toString() - Method in class org.opensextant.extractors.geo.PlaceCount
 
toString() - Method in class org.opensextant.extractors.geo.PlaceEvidence
Provide a reasonable string label for this PlaceEvidence
toString() - Method in class org.opensextant.extractors.geo.rules.FeatureClassMeta
 
toString() - Method in class org.opensextant.extractors.geo.ScoredPlace
 
total - Variable in class org.opensextant.extractors.geo.CountryCount
 
total - Variable in class org.opensextant.extractors.geo.PlaceCount
 
totalRecords - Variable in class org.opensextant.extractors.geo.social.GeoInferencer
 
totalTime - Variable in class org.opensextant.extraction.SolrMatcherSupport
 
Transforms - Class in org.opensextant.output
 
Transforms() - Constructor for class org.opensextant.output.Transforms
 

U

UNK_Country - Static variable in class org.opensextant.extractors.geo.SolrGazetteer
The Constant UNK_Country.
unqualifiedPostalLocation(PlaceCandidate) - Static method in class org.opensextant.extractors.geo.PostalGeocoder
 
UPPERCASE - Static variable in class org.opensextant.extractors.geo.rules.GeocodeRule
 
UPPERCASE_NOISE - Static variable in class org.opensextant.extractors.geo.rules.NameRule
 
US_STATES - Variable in class org.opensextant.extractors.geo.social.SocialGeo
 
userlocX - Variable in class org.opensextant.extractors.geo.social.XponentGeocoder
 

V

VAL_SAME_COUNTRY - Static variable in class org.opensextant.extractors.geo.PlaceCandidate
 
valueOf(String) - Static method in enum org.opensextant.extractors.geo.PlaceEvidence.Scope
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.opensextant.extractors.geo.PlaceEvidence.Scope
Returns an array containing the constants of this enum type, in the order they are declared.
version - Variable in class org.opensextant.xlayer.server.XlayerApp
 
VERSION - Static variable in class org.opensextant.extractors.geo.PlaceGeocoder
 
VERSION - Static variable in class org.opensextant.extractors.geo.PostalGeocoder
 
VERSION - Static variable in class org.opensextant.extractors.geo.PostalTagger
 

W

wasEvaluated() - Method in class org.opensextant.extractors.geo.PlaceEvidence
 
weight - Variable in class org.opensextant.extractors.geo.rules.FeatureClassMeta
Mention Weight
weight - Variable in class org.opensextant.extractors.geo.rules.GeocodeRule
 
write(Tweet, GeoInference) - Method in class org.opensextant.extractors.geo.social.KMLDemoWriter
Save off a tweet and its geo

X

XlayerApp - Class in org.opensextant.xlayer.server
XlayerApp is an abstract "Webapp" running inside the Server....
XlayerApp(Context) - Constructor for class org.opensextant.xlayer.server.XlayerApp
 
XlayerClient - Class in org.opensextant.xlayer
 
XlayerClient(URL) - Constructor for class org.opensextant.xlayer.XlayerClient
 
XlayerControl - Class in org.opensextant.xlayer.server
 
XlayerControl() - Constructor for class org.opensextant.xlayer.server.XlayerControl
 
XlayerRestlet - Class in org.opensextant.xlayer.server.xgeo
Xlayer Restlet app constructs the application, initializes resources, etc.
XlayerRestlet(Context) - Constructor for class org.opensextant.xlayer.server.xgeo.XlayerRestlet
 
XlayerServer - Class in org.opensextant.xlayer.server.xgeo
 
XlayerServer() - Constructor for class org.opensextant.xlayer.server.xgeo.XlayerServer
 
XlayerServer(int) - Constructor for class org.opensextant.xlayer.server.xgeo.XlayerServer
 
XponentGeocoder - Class in org.opensextant.extractors.geo.social
Pipeline focused on improving the location metadata for Tweets or Weibo or other social media that has metadata about user or messaging location.
XponentGeocoder() - Constructor for class org.opensextant.extractors.geo.social.XponentGeocoder
For now "XpMeta" = geo processing tweets for province normalization.
XponentsGeotagger - Class in org.opensextant.xlayer.server.xgeo
A RESTFul application of PlaceGeocoder
XponentsGeotagger() - Constructor for class org.opensextant.xlayer.server.xgeo.XponentsGeotagger
Restlet resource that pulls its configuration from Context.
XponentTextGeotagger - Class in org.opensextant.extractors.geo.social
Variant TODO: Ideally, we would chain something like inferredLoc = geocode(Tweet, User, etc) then use the outputs from that to then mentionLocs = geocode(text, given=inferredLoc).
XponentTextGeotagger() - Constructor for class org.opensextant.extractors.geo.social.XponentTextGeotagger
 
A B C D E F G H I J K L M N O P R S T U V W X 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form