Lexicon

java.lang.Object
- org.grobid.core.lexicon.Lexicon

public class Lexicon
extends java.lang.Object

Class for managing all the lexical resources.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDictionary(java.lang.String path, java.lang.String lang)`
`void`	`addFirstNames(java.lang.String path)`
`void`	`addLastNames(java.lang.String path)`
`java.util.List<OffsetPosition>`	`charPositionsLocationNames(java.util.List<LayoutToken> s)` Soft look-up in location name gazetteer for a list of LayoutToken, return a list of positions referring to the character positions in the input sequence.
`java.util.List<OffsetPosition>`	`charPositionsLocationNames(java.lang.String s)` Soft look-up in location name gazetteer for a string, return a list of positions referring to the character positions within the string.
`java.util.List<OffsetPosition>`	`charPositionsOrganisationNames(java.util.List<LayoutToken> s)` Soft look-up in organisation names gazetteer for a tokenize sequence.
`java.util.List<OffsetPosition>`	`charPositionsOrganisationNames(java.lang.String s)` Soft look-up in organisation names gazetteer for a string.
`java.util.List<OffsetPosition>`	`charPositionsOrgForm(java.util.List<LayoutToken> s)` Soft look-up in org form names gazetteer for a tokenized string.
`java.util.List<OffsetPosition>`	`charPositionsOrgForm(java.lang.String s)` Soft look-up in org form names gazetteer for a string.
`java.util.List<OffsetPosition>`	`charPositionsPersonTitle(java.util.List<LayoutToken> s)` Soft look-up in person title name gazetteer for a list of LayoutToken.
`java.util.List<OffsetPosition>`	`charPositionsPersonTitle(java.lang.String s)` Soft look-up in person title name gazetteer for a string.
`java.lang.String`	`getCountryCode(java.lang.String country)`
`static Lexicon`	`getInstance()`
`boolean`	`inDictionary(java.lang.String s)` Lexical look-up, default is English
`boolean`	`inDictionary(java.lang.String s, java.lang.String lang)`
`boolean`	`inFirstNames(java.lang.String s)` Look-up in first name gazetteer
`void`	`initCities()`
`void`	`initCollaborations()`
`void`	`initConferences()`
`void`	`initJournals()`
`void`	`initLocations()`
`void`	`initOrganisations()`
`void`	`initOrgForms()`
`void`	`initPersonSuffix()`
`void`	`initPersonTitles()`
`void`	`initPublishers()`
`boolean`	`inLastNames(java.lang.String s)` Look-up in last name gazetteer
`boolean`	`isCountry(java.lang.String tok)`
`boolean`	`isPunctuation(java.lang.String s)` Indicate if we have a punctuation
`java.lang.String`	`mapLanguageCode(java.lang.String code)` Map the language codes used by the language identifier component to the normal language name.
`java.util.List<OffsetPosition>`	`tokenPositionsAbbrevJournalNames(java.util.List<LayoutToken> s)` Soft look-up in journal abbreviated name gazetteer for a given list of LayoutToken objects with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsAbbrevJournalNames(java.lang.String s)` Soft look-up in journal abbreviated name gazetteer with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsArXivPattern(java.util.List<LayoutToken> tokens, java.lang.String text)` Identify in tokenized input the positions of the arXiv identifier patterns with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsCityNames(java.util.List<LayoutToken> s)` Soft look-up in city name gazetteer for a given list of LayoutToken objects with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsCityNames(java.lang.String s)` Soft look-up in city name gazetteer for a given string with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsCollaborationNames(java.util.List<LayoutToken> s)` Soft look-up in collaboration name gazetteer for a given list of LayoutToken objects with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsConferenceNames(java.util.List<LayoutToken> s)` Soft look-up in conference/proceedings name gazetteer for a given list of LayoutToken objects with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsConferenceNames(java.lang.String s)` Soft look-up in conference/proceedings name gazetteer with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsDOIPattern(java.util.List<LayoutToken> tokens, java.lang.String text)` Identify in tokenized input the positions of the DOI patterns with token positons
`java.util.List<OffsetPosition>`	`tokenPositionsIdentifierPattern(java.util.List<LayoutToken> tokens)` Identify in tokenized input the positions of identifier patterns with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsISBNPattern(java.util.List<LayoutToken> tokens)` Identify in tokenized input the positions of ISBN patterns with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsISSNPattern(java.util.List<LayoutToken> tokens)` Identify in tokenized input the positions of ISSN patterns with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsJournalNames(java.util.List<LayoutToken> s)` Soft look-up in journal name gazetteer for a given list of LayoutToken objects with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsJournalNames(java.lang.String s)` Soft look-up in journal name gazetteer with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsLocationNames(java.util.List<LayoutToken> s)` Soft look-up in location name gazetteer for a given list of LayoutToken objects with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsLocationNames(java.lang.String s)` Soft look-up in location name gazetteer for a given string with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsOrganisationNames(java.util.List<LayoutToken> s)` Soft look-up in organisation name gazetteer for a given list of LayoutToken objects with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsOrganisationNames(java.lang.String s)` Soft look-up in organisation name gazetteer for a given string with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsOrgForm(java.util.List<LayoutToken> s)` Soft look-up in organisation form name gazetteer for a given list of LayoutToken objects with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsOrgForm(java.lang.String s)` Soft look-up in organisation form name gazetteer for a given string with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsPersonSuffix(java.util.List<LayoutToken> s)` Soft look-up in person name suffix gazetteer for a given list of LayoutToken objects with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsPersonTitle(java.util.List<LayoutToken> s)` Soft look-up in person title gazetteer for a given list of LayoutToken objects with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsPersonTitle(java.lang.String s)` Soft look-up in person title gazetteer for a given string with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsPublisherNames(java.util.List<LayoutToken> s)` Soft look-up in publisher name gazetteer for a given list of LayoutToken objects with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsPublisherNames(java.lang.String s)` Soft look-up in conference/proceedings name gazetteer with token positions
`java.util.List<OffsetPosition>`	`tokenPositionsUrlPattern(java.util.List<LayoutToken> tokens)` Identify in tokenized input the positions of an URL pattern with token positions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getInstance
```
public static Lexicon getInstance()
```
  - addDictionary
```
public final void addDictionary(java.lang.String path,
                                java.lang.String lang)
```
  - isCountry
```
public boolean isCountry(java.lang.String tok)
```
  - getCountryCode
```
public java.lang.String getCountryCode(java.lang.String country)
```
  - addFirstNames
```
public final void addFirstNames(java.lang.String path)
```
  - addLastNames
```
public final void addLastNames(java.lang.String path)
```
  - inDictionary
```
public boolean inDictionary(java.lang.String s)
```
    Lexical look-up, default is English
    
    Parameters:
    
    s - a string to test
    
    Returns:
    
    true if in the dictionary
  - inDictionary
```
public boolean inDictionary(java.lang.String s,
                            java.lang.String lang)
```
  - initJournals
```
public void initJournals()
```
  - initConferences
```
public void initConferences()
```
  - initPublishers
```
public void initPublishers()
```
  - initCities
```
public void initCities()
```
  - initCollaborations
```
public void initCollaborations()
```
  - initOrganisations
```
public void initOrganisations()
```
  - initOrgForms
```
public void initOrgForms()
```
  - initLocations
```
public void initLocations()
```
  - initPersonTitles
```
public void initPersonTitles()
```
  - initPersonSuffix
```
public void initPersonSuffix()
```
  - inFirstNames
```
public boolean inFirstNames(java.lang.String s)
```
    Look-up in first name gazetteer
  - inLastNames
```
public boolean inLastNames(java.lang.String s)
```
    Look-up in last name gazetteer
  - isPunctuation
```
public boolean isPunctuation(java.lang.String s)
```
    Indicate if we have a punctuation
  - mapLanguageCode
```
public java.lang.String mapLanguageCode(java.lang.String code)
```
    Map the language codes used by the language identifier component to the normal language name.
    
    Parameters:
    
    code - the language to be mapped
  - tokenPositionsJournalNames
```
public java.util.List<OffsetPosition> tokenPositionsJournalNames(java.lang.String s)
```
    Soft look-up in journal name gazetteer with token positions
  - tokenPositionsJournalNames
```
public java.util.List<OffsetPosition> tokenPositionsJournalNames(java.util.List<LayoutToken> s)
```
    Soft look-up in journal name gazetteer for a given list of LayoutToken objects with token positions
  - tokenPositionsAbbrevJournalNames
```
public java.util.List<OffsetPosition> tokenPositionsAbbrevJournalNames(java.lang.String s)
```
    Soft look-up in journal abbreviated name gazetteer with token positions
  - tokenPositionsAbbrevJournalNames
```
public java.util.List<OffsetPosition> tokenPositionsAbbrevJournalNames(java.util.List<LayoutToken> s)
```
    Soft look-up in journal abbreviated name gazetteer for a given list of LayoutToken objects with token positions
  - tokenPositionsConferenceNames
```
public java.util.List<OffsetPosition> tokenPositionsConferenceNames(java.lang.String s)
```
    Soft look-up in conference/proceedings name gazetteer with token positions
  - tokenPositionsConferenceNames
```
public java.util.List<OffsetPosition> tokenPositionsConferenceNames(java.util.List<LayoutToken> s)
```
    Soft look-up in conference/proceedings name gazetteer for a given list of LayoutToken objects with token positions
  - tokenPositionsPublisherNames
```
public java.util.List<OffsetPosition> tokenPositionsPublisherNames(java.lang.String s)
```
    Soft look-up in conference/proceedings name gazetteer with token positions
  - tokenPositionsPublisherNames
```
public java.util.List<OffsetPosition> tokenPositionsPublisherNames(java.util.List<LayoutToken> s)
```
    Soft look-up in publisher name gazetteer for a given list of LayoutToken objects with token positions
  - tokenPositionsCollaborationNames
```
public java.util.List<OffsetPosition> tokenPositionsCollaborationNames(java.util.List<LayoutToken> s)
```
    Soft look-up in collaboration name gazetteer for a given list of LayoutToken objects with token positions
  - tokenPositionsCityNames
```
public java.util.List<OffsetPosition> tokenPositionsCityNames(java.lang.String s)
```
    Soft look-up in city name gazetteer for a given string with token positions
  - tokenPositionsCityNames
```
public java.util.List<OffsetPosition> tokenPositionsCityNames(java.util.List<LayoutToken> s)
```
    Soft look-up in city name gazetteer for a given list of LayoutToken objects with token positions
  - tokenPositionsOrganisationNames
```
public java.util.List<OffsetPosition> tokenPositionsOrganisationNames(java.lang.String s)
```
    Soft look-up in organisation name gazetteer for a given string with token positions
  - tokenPositionsOrganisationNames
```
public java.util.List<OffsetPosition> tokenPositionsOrganisationNames(java.util.List<LayoutToken> s)
```
    Soft look-up in organisation name gazetteer for a given list of LayoutToken objects with token positions
  - charPositionsOrganisationNames
```
public java.util.List<OffsetPosition> charPositionsOrganisationNames(java.lang.String s)
```
    Soft look-up in organisation names gazetteer for a string. It return a list of positions referring to the character positions within the string.
    
    Parameters:
    
    s - the input string
    
    Returns:
    
    a list of positions referring to the character position in the input string
  - charPositionsOrganisationNames
```
public java.util.List<OffsetPosition> charPositionsOrganisationNames(java.util.List<LayoutToken> s)
```
    Soft look-up in organisation names gazetteer for a tokenize sequence. It return a list of positions referring to the character positions within the input sequence.
    
    Parameters:
    
    s - the input list of LayoutToken
    
    Returns:
    
    a list of positions referring to the character position in the input sequence
  - tokenPositionsOrgForm
```
public java.util.List<OffsetPosition> tokenPositionsOrgForm(java.lang.String s)
```
    Soft look-up in organisation form name gazetteer for a given string with token positions
  - tokenPositionsOrgForm
```
public java.util.List<OffsetPosition> tokenPositionsOrgForm(java.util.List<LayoutToken> s)
```
    Soft look-up in organisation form name gazetteer for a given list of LayoutToken objects with token positions
  - charPositionsOrgForm
```
public java.util.List<OffsetPosition> charPositionsOrgForm(java.lang.String s)
```
    Soft look-up in org form names gazetteer for a string. It return a list of positions referring to the character positions within the string.
    
    Parameters:
    
    s - the input string
    
    Returns:
    
    a list of positions referring to the character position in the input string
  - charPositionsOrgForm
```
public java.util.List<OffsetPosition> charPositionsOrgForm(java.util.List<LayoutToken> s)
```
    Soft look-up in org form names gazetteer for a tokenized string. It return a list of positions referring to the character positions within the sequence.
    
    Parameters:
    
    s - the input list of LayoutToken
    
    Returns:
    
    a list of positions referring to the character position in the input sequence
  - tokenPositionsLocationNames
```
public java.util.List<OffsetPosition> tokenPositionsLocationNames(java.lang.String s)
```
    Soft look-up in location name gazetteer for a given string with token positions
  - tokenPositionsLocationNames
```
public java.util.List<OffsetPosition> tokenPositionsLocationNames(java.util.List<LayoutToken> s)
```
    Soft look-up in location name gazetteer for a given list of LayoutToken objects with token positions
  - charPositionsLocationNames
```
public java.util.List<OffsetPosition> charPositionsLocationNames(java.lang.String s)
```
    Soft look-up in location name gazetteer for a string, return a list of positions referring to the character positions within the string. For example "The car is in Milan" as Milan is a location, would return OffsetPosition(14,19)
    
    Parameters:
    
    s - the input string
    
    Returns:
    
    a list of positions referring to the character position in the input string
  - charPositionsLocationNames
```
public java.util.List<OffsetPosition> charPositionsLocationNames(java.util.List<LayoutToken> s)
```
    Soft look-up in location name gazetteer for a list of LayoutToken, return a list of positions referring to the character positions in the input sequence. For example "The car is in Milan" as Milan is a location, would return OffsetPosition(14,19)
    
    Parameters:
    
    s - the input list of LayoutToken
    
    Returns:
    
    a list of positions referring to the character position in the input sequence
  - tokenPositionsPersonTitle
```
public java.util.List<OffsetPosition> tokenPositionsPersonTitle(java.lang.String s)
```
    Soft look-up in person title gazetteer for a given string with token positions
  - tokenPositionsPersonTitle
```
public java.util.List<OffsetPosition> tokenPositionsPersonTitle(java.util.List<LayoutToken> s)
```
    Soft look-up in person title gazetteer for a given list of LayoutToken objects with token positions
  - tokenPositionsPersonSuffix
```
public java.util.List<OffsetPosition> tokenPositionsPersonSuffix(java.util.List<LayoutToken> s)
```
    Soft look-up in person name suffix gazetteer for a given list of LayoutToken objects with token positions
  - charPositionsPersonTitle
```
public java.util.List<OffsetPosition> charPositionsPersonTitle(java.lang.String s)
```
    Soft look-up in person title name gazetteer for a string. It return a list of positions referring to the character positions within the string.
    
    Parameters:
    
    s - the input string
    
    Returns:
    
    a list of positions referring to the character position in the input string
  - charPositionsPersonTitle
```
public java.util.List<OffsetPosition> charPositionsPersonTitle(java.util.List<LayoutToken> s)
```
    Soft look-up in person title name gazetteer for a list of LayoutToken. It return a list of positions referring to the character positions in the input sequence.
    
    Parameters:
    
    s - the input list of LayoutToken
    
    Returns:
    
    a list of positions referring to the character position in the input sequence
  - tokenPositionsIdentifierPattern
```
public java.util.List<OffsetPosition> tokenPositionsIdentifierPattern(java.util.List<LayoutToken> tokens)
```
    Identify in tokenized input the positions of identifier patterns with token positions
  - tokenPositionsDOIPattern
```
public java.util.List<OffsetPosition> tokenPositionsDOIPattern(java.util.List<LayoutToken> tokens,
                                                               java.lang.String text)
```
    Identify in tokenized input the positions of the DOI patterns with token positons
  - tokenPositionsArXivPattern
```
public java.util.List<OffsetPosition> tokenPositionsArXivPattern(java.util.List<LayoutToken> tokens,
                                                                 java.lang.String text)
```
    Identify in tokenized input the positions of the arXiv identifier patterns with token positions
  - tokenPositionsISSNPattern
```
public java.util.List<OffsetPosition> tokenPositionsISSNPattern(java.util.List<LayoutToken> tokens)
```
    Identify in tokenized input the positions of ISSN patterns with token positions
  - tokenPositionsISBNPattern
```
public java.util.List<OffsetPosition> tokenPositionsISBNPattern(java.util.List<LayoutToken> tokens)
```
    Identify in tokenized input the positions of ISBN patterns with token positions
  - tokenPositionsUrlPattern
```
public java.util.List<OffsetPosition> tokenPositionsUrlPattern(java.util.List<LayoutToken> tokens)
```
    Identify in tokenized input the positions of an URL pattern with token positions

Class Lexicon

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

addDictionary

isCountry

getCountryCode

addFirstNames

addLastNames

inDictionary

inDictionary

initJournals

initConferences

initPublishers

initCities

initCollaborations

initOrganisations

initOrgForms

initLocations

initPersonTitles

initPersonSuffix

inFirstNames

inLastNames

isPunctuation

mapLanguageCode

tokenPositionsJournalNames

tokenPositionsJournalNames

tokenPositionsAbbrevJournalNames

tokenPositionsAbbrevJournalNames

tokenPositionsConferenceNames

tokenPositionsConferenceNames

tokenPositionsPublisherNames

tokenPositionsPublisherNames

tokenPositionsCollaborationNames

tokenPositionsCityNames

tokenPositionsCityNames

tokenPositionsOrganisationNames

tokenPositionsOrganisationNames

charPositionsOrganisationNames

charPositionsOrganisationNames

tokenPositionsOrgForm

tokenPositionsOrgForm

charPositionsOrgForm

charPositionsOrgForm

tokenPositionsLocationNames

tokenPositionsLocationNames

charPositionsLocationNames

charPositionsLocationNames

tokenPositionsPersonTitle

tokenPositionsPersonTitle

tokenPositionsPersonSuffix

charPositionsPersonTitle

charPositionsPersonTitle

tokenPositionsIdentifierPattern

tokenPositionsDOIPattern

tokenPositionsArXivPattern

tokenPositionsISSNPattern

tokenPositionsISBNPattern

tokenPositionsUrlPattern