Package org.wikidata.wdtk.datamodel.interfaces

Interface LexemeDocument

All Superinterfaces:

EntityDocument, StatementDocument

All Known Implementing Classes:

LexemeDocumentImpl

public interface LexemeDocument
extends StatementDocument

Interface for datasets that describe lexemes.

Author:

Thomas Pellissier Tanon

Method Summary

Modifier and Type	Method	Description
FormDocument	createForm(List<MonolingualTextValue> representations)	Creates a new FormDocument for this lexeme.
SenseDocument	createSense(List<MonolingualTextValue> glosses)	Creates a new SenseDocument for this Lexeme.
LexemeIdValue	getEntityId()	Returns the ID of the entity that the data refers to
FormDocument	getForm(FormIdValue formId)	Return the inner form having the given id
List<FormDocument>	getForms()	Return the lexeme forms
ItemIdValue	getLanguage()	Return the ID of the language to which the lexeme belongs (French, British English...)
Map<String,MonolingualTextValue>	getLemmas()	Return the human readable representations of the lexeme indexed by Wikimedia language code
ItemIdValue	getLexicalCategory()	Return the ID of the lexical category to which the lexeme belongs (noun, verb...)
SenseDocument	getSense(SenseIdValue formId)	Return the inner sense having the given id
List<SenseDocument>	getSenses()	Return the lexeme senses
LexemeDocument	withEntityId(LexemeIdValue newEntityId)	Returns a new version of this document with updated ID.
LexemeDocument	withForm(FormDocument form)	Adds a FormDocument to this lexeme.
LexemeDocument	withLanguage(ItemIdValue newLanguage)
LexemeDocument	withLemma(MonolingualTextValue lemma)
LexemeDocument	withLexicalCategory(ItemIdValue newLexicalCategory)
LexemeDocument	withoutStatementIds(Set<String> statementIds)	Returns a new version of this document where all statements matching any of the statement ids provided have been removed.
LexemeDocument	withRevisionId(long newRevisionId)	Returns a copy of this document with an updated revision id.
LexemeDocument	withSense(SenseDocument sense)	Adds a SenseDocument to this lexeme.
LexemeDocument	withStatement(Statement statement)	Returns a new version of this document which includes the statement provided.

Methods inherited from interface org.wikidata.wdtk.datamodel.interfaces.EntityDocument

getRevisionId

Methods inherited from interface org.wikidata.wdtk.datamodel.interfaces.StatementDocument

findStatement, findStatement, findStatementEntityIdValue, findStatementEntityIdValue, findStatementGlobeCoordinatesValue, findStatementGlobeCoordinatesValue, findStatementGroup, findStatementGroup, findStatementItemIdValue, findStatementItemIdValue, findStatementMonolingualTextValue, findStatementMonolingualTextValue, findStatementPropertyIdValue, findStatementPropertyIdValue, findStatementQuantityValue, findStatementQuantityValue, findStatementStringValue, findStatementStringValue, findStatementTimeValue, findStatementTimeValue, findStatementValue, findStatementValue, getAllStatements, getStatementGroups, hasStatement, hasStatement, hasStatementValue, hasStatementValue, hasStatementValue, hasStatementValue

Method Details

getEntityId

LexemeIdValue getEntityId()

Returns the ID of the entity that the data refers to

Specified by:

getEntityId in interface EntityDocument

Returns:

lexeme id

getLexicalCategory

ItemIdValue getLexicalCategory()

Return the ID of the lexical category to which the lexeme belongs (noun, verb...)

Returns:

item id

getLanguage

ItemIdValue getLanguage()

Return the ID of the language to which the lexeme belongs (French, British English...)

Returns:

item id

getLemmas

Map<String,MonolingualTextValue> getLemmas()

Return the human readable representations of the lexeme indexed by Wikimedia language code

Returns:

a map from Wikimedia language code to the lemma

getForms

List<FormDocument> getForms()

Return the lexeme forms

Returns:

the list of forms

getForm

FormDocument getForm(FormIdValue formId)

Return the inner form having the given id

Throws:

IndexOutOfBoundsException - if there is no form with this id in the document

getSenses

List<SenseDocument> getSenses()

Return the lexeme senses

Returns:

the list of senses

getSense

SenseDocument getSense(SenseIdValue formId)

Return the inner sense having the given id

Throws:

IndexOutOfBoundsException - if there is no sense with this id in the document

withEntityId

LexemeDocument withEntityId(LexemeIdValue newEntityId)

Returns a new version of this document with updated ID.

Parameters:

newEntityId - new ID of the document

Returns:

document with updated ID

withRevisionId

LexemeDocument withRevisionId(long newRevisionId)

Returns a copy of this document with an updated revision id.

Specified by:

withRevisionId in interface EntityDocument

Specified by:

withRevisionId in interface StatementDocument

withLexicalCategory

LexemeDocument withLexicalCategory(ItemIdValue newLexicalCategory)

withLanguage

LexemeDocument withLanguage(ItemIdValue newLanguage)

withLemma

LexemeDocument withLemma(MonolingualTextValue lemma)

withStatement

LexemeDocument withStatement(Statement statement)

Returns a new version of this document which includes the statement provided. If the identifier of this statement matches that of any other statement for the same property, then the existing statement will be replaced by the new one. Otherwise, the new statement will be added at the end of the list of statements in this group.

Specified by:

withStatement in interface StatementDocument

Parameters:

statement - the statement to add or update in the document

withoutStatementIds

LexemeDocument withoutStatementIds(Set<String> statementIds)

Returns a new version of this document where all statements matching any of the statement ids provided have been removed. These statements can use different properties.

Specified by:

withoutStatementIds in interface StatementDocument

Parameters:

statementIds - the identifiers of the statements to remove

createForm

FormDocument createForm(List<MonolingualTextValue> representations)

Creates a new FormDocument for this lexeme. The form is not added to the LexemeDocument object, it should be done with withForm(org.wikidata.wdtk.datamodel.interfaces.FormDocument).

withForm

LexemeDocument withForm(FormDocument form)

Adds a FormDocument to this lexeme. The form id should be prefixed with the lexeme id.

createSense

SenseDocument createSense(List<MonolingualTextValue> glosses)

Creates a new SenseDocument for this Lexeme. The form is not added to the LexemeDocument object, it should be done with withSense(org.wikidata.wdtk.datamodel.interfaces.SenseDocument).

withSense

LexemeDocument withSense(SenseDocument sense)

Adds a SenseDocument to this lexeme. The sense id should be prefixed with the lexeme id.