Package org.wikidata.wdtk.datamodel.implementation

Class LexemeDocumentImpl

java.lang.Object

org.wikidata.wdtk.datamodel.implementation.EntityDocumentImpl

org.wikidata.wdtk.datamodel.implementation.LexemeDocumentImpl

All Implemented Interfaces:

EntityDocument, LexemeDocument, StatementDocument

public class LexemeDocumentImpl
extends EntityDocumentImpl
implements LexemeDocument

Jackson implementation of LexemeDocument.

Author:

Thomas Pellissier Tanon

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,List<Statement>>	claims	This is what is called claim in the JSON model.

Fields inherited from class org.wikidata.wdtk.datamodel.implementation.EntityDocumentImpl

entityId, revisionId, siteIri

Constructor Summary

Constructors

Constructor	Description
LexemeDocumentImpl(String jsonId, String lexicalCategory, String language, Map<String,MonolingualTextValue> lemmas, Map<String,List<StatementImpl.PreStatement>> claims, List<FormDocument> forms, List<SenseDocument> senses, long revisionId, String siteIri)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected static Map<String,List<Statement>>	addStatementToGroups(Statement statement, Map<String,List<Statement>> claims)	Adds a Statement to a given collection of statement groups.
FormDocument	createForm(List<MonolingualTextValue> representations)	Creates a new FormDocument for this lexeme.
SenseDocument	createSense(List<MonolingualTextValue> glosses)	Creates a new SenseDocument for this Lexeme.
boolean	equals(Object obj)
StatementGroup	findStatementGroup(String propertyIdValue)	Find a statement group by its property id, without checking for equality with the site IRI.
Iterator<Statement>	getAllStatements()	Returns an iterator that provides access to all statements, without considering the statement groups.
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
Map<String,List<Statement>>	getJsonClaims()	Returns the "claims".
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 senseId)	Return the inner sense having the given id
List<SenseDocument>	getSenses()	Return the lexeme senses
List<StatementGroup>	getStatementGroups()	Return the list of all StatementGroups stored for this item.
int	hashCode()
protected static Map<String,List<Statement>>	removeStatements(Set<String> statementIds, Map<String,List<Statement>> claims)	Removes statement ids from a collection of statement groups.
String	toString()
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 class org.wikidata.wdtk.datamodel.implementation.EntityDocumentImpl

getJsonId, getRevisionId, getSiteIri

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

Field Details

claims

protected final Map<String,List<Statement>> claims

This is what is called claim in the JSON model. It corresponds to the statement group in the WDTK model.

Constructor Details

LexemeDocumentImpl

public LexemeDocumentImpl(String jsonId,
 String lexicalCategory,
 String language,
 Map<String,MonolingualTextValue> lemmas,
 Map<String,List<StatementImpl.PreStatement>> claims,
 List<FormDocument> forms,
 List<SenseDocument> senses,
 long revisionId,
 String siteIri)

Constructor. Creates an object that can be populated during JSON deserialization. Should only be used by Jackson for this very purpose.

Method Details

getEntityId

public LexemeIdValue getEntityId()

Description copied from interface: LexemeDocument

Returns the ID of the entity that the data refers to

Specified by:

getEntityId in interface EntityDocument

Specified by:

getEntityId in interface LexemeDocument

Returns:

lexeme id

getLexicalCategory

public ItemIdValue getLexicalCategory()

Description copied from interface: LexemeDocument

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

Specified by:

getLexicalCategory in interface LexemeDocument

Returns:

item id

getLanguage

public ItemIdValue getLanguage()

Description copied from interface: LexemeDocument

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

Specified by:

getLanguage in interface LexemeDocument

Returns:

item id

getLemmas

public Map<String,MonolingualTextValue> getLemmas()

Description copied from interface: LexemeDocument

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

Specified by:

getLemmas in interface LexemeDocument

Returns:

a map from Wikimedia language code to the lemma

getForms

public List<FormDocument> getForms()

Description copied from interface: LexemeDocument

Return the lexeme forms

Specified by:

getForms in interface LexemeDocument

Returns:

the list of forms

getSenses

public List<SenseDocument> getSenses()

Description copied from interface: LexemeDocument

Return the lexeme senses

Specified by:

getSenses in interface LexemeDocument

Returns:

the list of senses

getForm

public FormDocument getForm(FormIdValue formId)

Description copied from interface: LexemeDocument

Return the inner form having the given id

Specified by:

getForm in interface LexemeDocument

getSense

public SenseDocument getSense(SenseIdValue senseId)

Description copied from interface: LexemeDocument

Return the inner sense having the given id

Specified by:

getSense in interface LexemeDocument

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

withEntityId

public LexemeDocument withEntityId(LexemeIdValue newEntityId)

Description copied from interface: LexemeDocument

Returns a new version of this document with updated ID.

Specified by:

withEntityId in interface LexemeDocument

Parameters:

newEntityId - new ID of the document

Returns:

document with updated ID

withLexicalCategory

public LexemeDocument withLexicalCategory(ItemIdValue newLexicalCategory)

Specified by:

withLexicalCategory in interface LexemeDocument

withLanguage

public LexemeDocument withLanguage(ItemIdValue newLanguage)

Specified by:

withLanguage in interface LexemeDocument

withLemma

public LexemeDocument withLemma(MonolingualTextValue lemma)

Specified by:

withLemma in interface LexemeDocument

withStatement

public LexemeDocument withStatement(Statement statement)

Description copied from interface: LexemeDocument

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 LexemeDocument

Specified by:

withStatement in interface StatementDocument

Parameters:

statement - the statement to add or update in the document

withoutStatementIds

public LexemeDocument withoutStatementIds(Set<String> statementIds)

Description copied from interface: LexemeDocument

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 LexemeDocument

Specified by:

withoutStatementIds in interface StatementDocument

Parameters:

statementIds - the identifiers of the statements to remove

createForm

public FormDocument createForm(List<MonolingualTextValue> representations)

Description copied from interface: LexemeDocument

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

Specified by:

createForm in interface LexemeDocument

withForm

public LexemeDocument withForm(FormDocument form)

Description copied from interface: LexemeDocument

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

Specified by:

withForm in interface LexemeDocument

createSense

public SenseDocument createSense(List<MonolingualTextValue> glosses)

Description copied from interface: LexemeDocument

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

Specified by:

createSense in interface LexemeDocument

withSense

public LexemeDocument withSense(SenseDocument sense)

Description copied from interface: LexemeDocument

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

Specified by:

withSense in interface LexemeDocument

withRevisionId

public LexemeDocument withRevisionId(long newRevisionId)

Description copied from interface: LexemeDocument

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

Specified by:

withRevisionId in interface EntityDocument

Specified by:

withRevisionId in interface LexemeDocument

Specified by:

withRevisionId in interface StatementDocument

getStatementGroups

public List<StatementGroup> getStatementGroups()

Description copied from interface: StatementDocument

Return the list of all StatementGroups stored for this item. The order of StatementGroups is significant.

Specified by:

getStatementGroups in interface StatementDocument

Returns:

list of StatementGroups

findStatementGroup

public StatementGroup findStatementGroup(String propertyIdValue)

Find a statement group by its property id, without checking for equality with the site IRI. More efficient implementation than the default one.

Specified by:

findStatementGroup in interface StatementDocument

Parameters:

propertyIdValue - the property to search for

Returns:

StatementGroup or null

getJsonClaims

public Map<String,List<Statement>> getJsonClaims()

Returns the "claims". Only used by Jackson.

JSON "claims" correspond to statement groups in the WDTK model. You should use StatementDocument.getStatementGroups() to obtain this data.

Returns:

map of statement groups

getAllStatements

public Iterator<Statement> getAllStatements()

Description copied from interface: StatementDocument

Returns an iterator that provides access to all statements, without considering the statement groups. The order of statements is preserved.

Specified by:

getAllStatements in interface StatementDocument

Returns:

iterator over all statements

addStatementToGroups

protected static Map<String,List<Statement>> addStatementToGroups(Statement statement,
 Map<String,List<Statement>> claims)

Adds a Statement to a given collection of statement groups. If the statement id is not null and matches that of an existing statement, this statement will be replaced.

Parameters:

statement -

claims -

Returns:

removeStatements

protected static Map<String,List<Statement>> removeStatements(Set<String> statementIds,
 Map<String,List<Statement>> claims)

Removes statement ids from a collection of statement groups.

Parameters:

statementIds -

claims -

Returns: