BabelSynset (babelnet-api 5.0 API)

All Superinterfaces:

Iterable<BabelSense>, Synset<BabelSense,BabelSynsetRelation,BabelPointer,BabelGloss,BabelExample>, Taggable
```
public interface BabelSynset
extends Synset<BabelSense,BabelSynsetRelation,BabelPointer,BabelGloss,BabelExample>
```
The basic BabelNet synset interface.

Author:

navigli

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`List<BabelCategory>`	`getCategories()` Gets the categories (`BabelCategory`s) of this `BabelSynset`.
`List<BabelCategory>`	`getCategories(it.uniroma1.lcl.jlt.util.Language... languages)` Gets the categories (`BabelCategory`s) of this `BabelSynset` in one or more languages.
`com.google.common.collect.HashMultimap<it.uniroma1.lcl.jlt.util.Language,String>`	`getCompounds()` Deprecated. No more supported
`Set<String>`	`getCompounds(it.uniroma1.lcl.jlt.util.Language language)` Deprecated. No more supported
`List<String>`	`getDBPediaURIs(it.uniroma1.lcl.jlt.util.Language... languages)` Deprecated. Use `Synset.toURIs(ExternalResource)`
`default List<BabelSynsetRelation>`	`getEdges()` Deprecated. use `Synset.getOutgoingEdges()` instead.
`List<BabelSynsetRelation>`	`getEdges(BabelPointer... edgeTypes)` Deprecated. use `Synset.getOutgoingEdges(SynsetRelationType...)` instead.
`Optional<FrameID>`	`getFrameID()` Get the VerbAtlas frame ids associated to the `BabelSynset`.
`List<String>`	`getGeoNamesURIs(it.uniroma1.lcl.jlt.util.Language... languages)` Deprecated. Use `Synset.toURIs(ExternalResource)`
`default BabelSynsetID`	`getId()` Deprecated. Use `getID()`
`BabelSynsetID`	`getID()` Gets the id of this `BabelSynset`.
`List<BabelImage>`	`getImages()` Gets the images (`BabelImage`s) of this `BabelSynset`.
`default List<BabelLemma>`	`getLemmas(it.uniroma1.lcl.jlt.util.Language language)` Returns the lemmas in this `BabelSynset` sorted by relevance and type
`List<BabelLemma>`	`getLemmas(it.uniroma1.lcl.jlt.util.Language language, BabelLemmaType... types)` Returns the lemmas in this `BabelSynset` sorted by relevance and type
`Optional<BabelImage>`	`getMainImage()` Gets the best image (`BabelImage`) of this `BabelSynset`.
`default Optional<BabelSense>`	`getMainSense()` Gets the main `BabelSense` by importance to this `BabelSynset` for any language.
`Optional<BabelSense>`	`getMainSense(it.uniroma1.lcl.jlt.util.Language language)` Gets the main `BabelSense` by importance to this `BabelSynset` for a given language.
`Optional<BabelSense>`	`getMainSensePreferrablyIn(it.uniroma1.lcl.jlt.util.Language language)` Gets the main `BabelSense` by importance to this `BabelSynset` preferrably for a given language.
`List<BabelSense>`	`getMainSenses(it.uniroma1.lcl.jlt.util.Language language)` Collects distinct `BabelSense`s sorted by importance to this `BabelSynset` for a given language.
`com.google.common.collect.LinkedHashMultimap<it.uniroma1.lcl.jlt.util.Language,String>`	`getOtherForms()` Deprecated. No more supported
`Set<String>`	`getOtherForms(it.uniroma1.lcl.jlt.util.Language language)` Deprecated. No more supported
`it.uniroma1.lcl.jlt.util.POS`	`getPOS()` Gets the part of speech of this `Synset`.
`List<BabelSenseSource>`	`getSenseSources()` Collects all `BabelSenseSource`s of the `BabelSense`s contained in this `BabelSynset`.
`Set<StringTag>`	`getStringTags()` Gets the `StringTag`s associated to the `BabelSynset`.
`BabelSynsetType`	`getSynsetType()` Deprecated. Use `Synset.getType()` instead
`com.google.common.collect.Multimap<BabelSense,BabelSense>`	`getTranslations()` Gets all translations between senses found in this `BabelSynset`.
`Map<WordNetSynsetID,List<WordNetSynsetID>>`	`getWordNetOffsetMapFrom(it.uniroma1.lcl.jlt.wordnet.WordNetVersion fromVersion)` Obtains a map from `WordNetSynsetID`s of the input `WordNetVersion` to the current version of WordNet (3.0 as of 2016)
`Map<WordNetSynsetID,List<WordNetSynsetID>>`	`getWordNetOffsetMapTo(it.uniroma1.lcl.jlt.wordnet.WordNetVersion toVersion)` Obtains a map from the current version of WordNet (3.0 as of 2016) to `WordNetSynsetID`s of the input `WordNetVersion`
`List<WordNetSynsetID>`	`getWordNetOffsets()` Gets the WordNet offsets (version 3.0) whose corresponding synsets this `BabelSynset` covers, if any.
`List<String>`	`getYAGOURIs()` Deprecated. Use `Synset.toURIs(ExternalResource)`
`boolean`	`isKeyConcept()` Determines if the synset is a key concept
`String`	`toString(it.uniroma1.lcl.jlt.util.Language... languages)` Returns the string representation of the `BabelSense`s of this `BabelSynset` only for a specific set of languages.

Methods inherited from interface it.uniroma1.lcl.kb.Synset
addStringTag, getDomains, getExamples, getExamples, getExamples, getExamples, getGlosses, getGlosses, getGlosses, getGlosses, getLanguages, getMainExample, getMainExample, getMainGloss, getMainGloss, getOutgoingEdges, getOutgoingEdges, getSenses, getSenses, getSenses, getSenses, getSenses, getSenses, getType, retainSenses, retainSenses, size, toURIs, toURIs, toURIs

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

Methods inherited from interface it.uniroma1.lcl.babelnet.data.Taggable
getTags, getTags, isTaggedAs, isTaggedAs, isTaggedAs

- Method Detail
  - getID
```
BabelSynsetID getID()
```
    Gets the id of this BabelSynset.
    
    Specified by:
    
    getID in interface Synset<BabelSense,BabelSynsetRelation,BabelPointer,BabelGloss,BabelExample>
    
    Returns:
    
    the id of this BabelSynset.
  - getId
```
@Deprecated
default BabelSynsetID getId()
```
    Deprecated. Use getID()
    
    Gets the id of this BabelSynset.
    
    Returns:
    
    the id of this BabelSynset.
  - getPOS
```
it.uniroma1.lcl.jlt.util.POS getPOS()
```
    Description copied from interface: Synset
    
    Gets the part of speech of this Synset.
    
    Specified by:
    
    getPOS in interface Synset<BabelSense,BabelSynsetRelation,BabelPointer,BabelGloss,BabelExample>
    
    Returns:
    
    the part of speech of this Synset.
  - getSenseSources
```
List<BabelSenseSource> getSenseSources()
```
    Collects all BabelSenseSources of the BabelSenses contained in this BabelSynset.
    
    Specified by:
    
    getSenseSources in interface Synset<BabelSense,BabelSynsetRelation,BabelPointer,BabelGloss,BabelExample>
    
    Returns:
    
    a list of BabelSenseSources
  - getCompounds
```
@Deprecated
Set<String> getCompounds(it.uniroma1.lcl.jlt.util.Language language)
```
    Deprecated. No more supported
    
    Get the compounds of this BabelSynset for a given language.
    
    Parameters:
    
    language - the search language
    
    Returns:
    
    the compounds of this BabelSynset in a specific language.
  - getCompounds
```
@Deprecated
com.google.common.collect.HashMultimap<it.uniroma1.lcl.jlt.util.Language,String> getCompounds()
```
    Deprecated. No more supported
    
    Gets the compounds of this BabelSynset.
    
    Returns:
    
    the compounds of this BabelSynset.
  - getOtherForms
```
@Deprecated
Set<String> getOtherForms(it.uniroma1.lcl.jlt.util.Language language)
```
    Deprecated. No more supported
    
    Get the other forms of this BabelSynset for a given language.
    
    Parameters:
    
    language - the search language
    
    Returns:
    
    the other forms of this BabelSynset in a specific language.
  - getOtherForms
```
@Deprecated
com.google.common.collect.LinkedHashMultimap<it.uniroma1.lcl.jlt.util.Language,String> getOtherForms()
```
    Deprecated. No more supported
    
    Gets the other forms of this BabelSynset.
    
    Returns:
    
    the other forms of this BabelSynset.
  - getImages
```
List<BabelImage> getImages()
```
    Gets the images (BabelImages) of this BabelSynset.
    
    Returns:
    
    the images (BabelImages) of this BabelSynset.
  - getMainImage
```
Optional<BabelImage> getMainImage()
```
    Gets the best image (BabelImage) of this BabelSynset.
    
    Returns:
    
    the best image (BabelImage) of this BabelSynset. (null if doesn't exist)
  - getCategories
```
List<BabelCategory> getCategories()
```
    Gets the categories (BabelCategorys) of this BabelSynset.
    
    Returns:
    
    the categories (BabelCategorys) of this BabelSynset.
  - getCategories
```
List<BabelCategory> getCategories(it.uniroma1.lcl.jlt.util.Language... languages)
```
    Gets the categories (BabelCategorys) of this BabelSynset in one or more languages.
    
    Parameters:
    
    languages - the search languages
    
    Returns:
    
    the categories (BabelCategorys) of this BabelSynset in the languages specified.
  - getWordNetOffsets
```
List<WordNetSynsetID> getWordNetOffsets()
```
    Gets the WordNet offsets (version 3.0) whose corresponding synsets this BabelSynset covers, if any.
    
    Returns:
    
    the WordNet offsets corresponding to this BabelSynset.
  - getWordNetOffsetMapFrom
```
Map<WordNetSynsetID,List<WordNetSynsetID>> getWordNetOffsetMapFrom(it.uniroma1.lcl.jlt.wordnet.WordNetVersion fromVersion)
```
    Obtains a map from WordNetSynsetIDs of the input WordNetVersion to the current version of WordNet (3.0 as of 2016)
    
    Parameters:
    
    fromVersion - the source WordNet version
    
    Returns:
    
    a map from WordNetSynsetID to list of WordNetSynsetID
  - getWordNetOffsetMapTo
```
Map<WordNetSynsetID,List<WordNetSynsetID>> getWordNetOffsetMapTo(it.uniroma1.lcl.jlt.wordnet.WordNetVersion toVersion)
```
    Obtains a map from the current version of WordNet (3.0 as of 2016) to WordNetSynsetIDs of the input WordNetVersion
    
    Parameters:
    
    toVersion - the target WordNet version
    
    Returns:
    
    a map from WordNetSynsetID to list of WordNetSynsetID
  - getLemmas
```
default List<BabelLemma> getLemmas(it.uniroma1.lcl.jlt.util.Language language)
```
    Returns the lemmas in this BabelSynset sorted by relevance and type
    
    Parameters:
    
    language - the language of interest
    
    Returns:
    
    the lemmas in the synset sorted by relevance and type
  - getLemmas
```
List<BabelLemma> getLemmas(it.uniroma1.lcl.jlt.util.Language language,
                           BabelLemmaType... types)
```
    Returns the lemmas in this BabelSynset sorted by relevance and type
    
    Parameters:
    
    language - the language of interest
    
    types - the types for the requested synset lemmas
    
    Returns:
    
    the lemmas in the synset sorted by relevance and type
  - getMainSense
```
default Optional<BabelSense> getMainSense()
```
    Gets the main BabelSense by importance to this BabelSynset for any language.
    
    Returns:
    
    the main sense of this Babel synset.
  - getMainSense
```
Optional<BabelSense> getMainSense(it.uniroma1.lcl.jlt.util.Language language)
```
    Gets the main BabelSense by importance to this BabelSynset for a given language.
    
    Parameters:
    
    language - the language of the main sense
    
    Returns:
    
    the main sense of this Babel synset in a specific language.
  - getMainSensePreferrablyIn
```
Optional<BabelSense> getMainSensePreferrablyIn(it.uniroma1.lcl.jlt.util.Language language)
```
    Gets the main BabelSense by importance to this BabelSynset preferrably for a given language.
    
    Parameters:
    
    language - the preferred language of the main sense
    
    Returns:
    
    the senses of this Babel synset in a specific language sorted by importance.
  - getMainSenses
```
List<BabelSense> getMainSenses(it.uniroma1.lcl.jlt.util.Language language)
```
    Collects distinct BabelSenses sorted by importance to this BabelSynset for a given language.
    
    Parameters:
    
    language - the search language
    
    Returns:
    
    the senses of this Babel synset in a specific language sorted by importance.
  - getDBPediaURIs
```
@Deprecated
List<String> getDBPediaURIs(it.uniroma1.lcl.jlt.util.Language... languages)
```
    Deprecated. Use Synset.toURIs(ExternalResource)
    
    Get the DBPedia URIs of the BabelSenses in a specific language found in this BabelSynset.
    
    Parameters:
    
    languages - the search languages
    
    Returns:
    
    the DBPedia URIs of the BabelSenses in this synset.
    
    See Also:
    
    BabelSense.getDBPediaURI()
  - getYAGOURIs
```
@Deprecated
List<String> getYAGOURIs()
```
    Deprecated. Use Synset.toURIs(ExternalResource)
    
    Get the YAGO URIs of the BabelSenses found in this BabelSynset.
    
    Returns:
    
    the YAGO URIs of the BabelSenses in this synset.
    
    See Also:
    
    BabelSense.getYAGOURI()
  - getGeoNamesURIs
```
@Deprecated
List<String> getGeoNamesURIs(it.uniroma1.lcl.jlt.util.Language... languages)
```
    Deprecated. Use Synset.toURIs(ExternalResource)
    
    Get the GeoNames URIs of the BabelSenses in a specific language found in this BabelSynset.
    
    Parameters:
    
    languages - the search languages
    
    Returns:
    
    the GeoNames URIs of the BabelSenses in this synset.
    
    See Also:
    
    BabelSense.getGeoNamesURI()
  - toString
```
String toString(it.uniroma1.lcl.jlt.util.Language... languages)
```
    Returns the string representation of the BabelSenses of this BabelSynset only for a specific set of languages.
    
    Parameters:
    
    languages - the languages to use for the string representation
    
    Returns:
    
    a stringified representation of this Babel synset using only the senses in a specific set of languages
  - getEdges
```
@Deprecated
default List<BabelSynsetRelation> getEdges()
```
    Deprecated. use Synset.getOutgoingEdges() instead.
    
    Collects all BabelSynset edges incident on this BabelSynset.
    
    Returns:
    
    the BabelSynsetRelations incident on this BabelSynset
  - getEdges
```
@Deprecated
List<BabelSynsetRelation> getEdges(BabelPointer... edgeTypes)
```
    Deprecated. use Synset.getOutgoingEdges(SynsetRelationType...) instead.
    
    Collects all BabelSynset edges of the BabelPointers given as input for this BabelSynset.
    
    Parameters:
    
    edgeTypes - the types of the edges connecting this synset to other synsets
    
    Returns:
    
    only the BabelSynsetRelations tagged with the BabelPointers given as input
  - getSynsetType
```
BabelSynsetType getSynsetType()
```
    Deprecated. Use Synset.getType() instead
    
    Gets the type of this BabelSynset, namely whether it's an entity, a concept, etc.
    
    Returns:
    
    the kind of BabelSynset.
  - getTranslations
```
com.google.common.collect.Multimap<BabelSense,BabelSense> getTranslations()
```
    Gets all translations between senses found in this BabelSynset.
    
    Returns:
    
    the map associating each BabelSense in this Babel synset with its translations.
  - isKeyConcept
```
boolean isKeyConcept()
```
    Determines if the synset is a key concept
    
    Returns:
    
    true if the synset is a key concept, false otherwise
  - getStringTags
```
Set<StringTag> getStringTags()
```
    Gets the StringTags associated to the BabelSynset.
    
    Returns:
    
    the StringTags of this BabelSynset
  - getFrameID
```
Optional<FrameID> getFrameID()
```
    Get the VerbAtlas frame ids associated to the BabelSynset.
    
    Returns:
    
    the VerbAtlas frame ids of this BabelSynset

Interface BabelSynset

Method Summary

Methods inherited from interface it.uniroma1.lcl.kb.Synset

Methods inherited from interface java.lang.Iterable

Methods inherited from interface it.uniroma1.lcl.babelnet.data.Taggable

Method Detail

getID

getId

getPOS

getSenseSources

getCompounds

getCompounds

getOtherForms

getOtherForms

getImages

getMainImage

getCategories

getCategories

getWordNetOffsets

getWordNetOffsetMapFrom

getWordNetOffsetMapTo

getLemmas

getLemmas

getMainSense

getMainSense

getMainSensePreferrablyIn

getMainSenses

getDBPediaURIs

getYAGOURIs

getGeoNamesURIs

toString

getEdges

getEdges

getSynsetType

getTranslations

isKeyConcept

getStringTags

getFrameID