de.tudarmstadt.ukp.jwktl.api
Interface IWiktionarySense

All Known Implementing Classes:
WiktionarySense

public interface IWiktionarySense

A IWiktionarySense represents one word sense of a lexical entry (also called a lexical unit). Each IWiktionarySense belongs to exactly one IWiktionaryEntry. Note that IWiktionaryEntry.getUnassignedSense() returns a dummy word sense carrying all information that has not been assigned to a particular sense - for this case, the IWiktionarySense does not model an actual word sense,

Author:
Christian M. Meyer

Method Summary
 IWiktionaryEntry getEntry()
          Returns a reference to the IWiktionaryEntry that contains this sense.
 List<IWikiString> getExamples()
          Returns a list of sense examples or null if no sense examples are encoded.
 IWikiString getGloss()
          Returns the sense description as a IWikiString.
 String getId()
          Returns an ID of this sense that is unique for all senses of the containing IWiktionaryEntry.
 int getIndex()
          Returns the index of this sense.
 String getKey()
          Returns a unique ID for this word sense.
 String getMarker()
          Returns the marker for this sense as defined in Wiktionary.
 IWiktionaryPage getPage()
          Returns a reference to the IWiktionaryPage that contains this sense.
 List<IQuotation> getQuotations()
          Returns a list of quotations or null if no quotations are encoded.
 List<IWikiString> getReferences()
          Returns a list of references for this sense or null if no referemces are encoded.
 List<IWiktionaryRelation> getRelations()
          Returns the list of all sense relations (or null if no relations are encoded).
 List<IWiktionaryRelation> getRelations(RelationType relationType)
          Returns the list of sense relations of the given relation type.
 List<IWiktionaryTranslation> getTranslations()
          Returns the list of all translations (or null if no translations are encoded).
 List<IWiktionaryTranslation> getTranslations(ILanguage language)
          Returns the list of translations into the given language.
 

Method Detail

getKey

String getKey()
Returns a unique ID for this word sense. The ID is unique for all IWiktionarySenses of the IWiktionaryEdition. Note however that the ID of a sense may differ between different software versions or dump dates.


getId

String getId()
Returns an ID of this sense that is unique for all senses of the containing IWiktionaryEntry. Use getKey() for a globally unique identifier.


getIndex

int getIndex()
Returns the index of this sense. That is, the running number of the sense in accordance to the list of senses of the IWiktionaryEntry. The first sense has index 1. Note that this is not generally the index marker used in Wiktionary: the first sense has for example always index 1, although it might be marked with "[2]" or "[1a]". See getMarker() for details.


getMarker

String getMarker()
Returns the marker for this sense as defined in Wiktionary. This can be different for each type of Wiktionary edition; for example, running numbers, short textual labels,...


getEntry

IWiktionaryEntry getEntry()
Returns a reference to the IWiktionaryEntry that contains this sense.


getPage

IWiktionaryPage getPage()
Returns a reference to the IWiktionaryPage that contains this sense.


getGloss

IWikiString getGloss()
Returns the sense description as a IWikiString.


getExamples

List<IWikiString> getExamples()
Returns a list of sense examples or null if no sense examples are encoded.


getQuotations

List<IQuotation> getQuotations()
Returns a list of quotations or null if no quotations are encoded.


getRelations

List<IWiktionaryRelation> getRelations()
Returns the list of all sense relations (or null if no relations are encoded).


getRelations

List<IWiktionaryRelation> getRelations(RelationType relationType)
Returns the list of sense relations of the given relation type. If there are no relations of this type, an empty list will be returned.


getReferences

List<IWikiString> getReferences()
Returns a list of references for this sense or null if no referemces are encoded.


getTranslations

List<IWiktionaryTranslation> getTranslations()
Returns the list of all translations (or null if no translations are encoded).


getTranslations

List<IWiktionaryTranslation> getTranslations(ILanguage language)
Returns the list of translations into the given language. If there are no translations of this type, an empty list will be returned.



Copyright © 2011-2013 Ubiquitous Knowledge Processing (UKP) Lab. All Rights Reserved.