org.wikidata.wdtk.datamodel.implementation

Class SenseDocumentImpl

java.lang.Object

org.wikidata.wdtk.datamodel.implementation.EntityDocumentImpl

org.wikidata.wdtk.datamodel.implementation.SenseDocumentImpl

All Implemented Interfaces:

EntityDocument, SenseDocument, StatementDocument

public class SenseDocumentImpl
extends EntityDocumentImpl
implements SenseDocument

Jackson implementation of SenseDocument.

Author:

Thomas Pellissier Tanon

Field Summary

Fields

Modifier and Type	Field and Description
protected 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

Method Summary

Modifier and Type	Method and 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.
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.
SenseIdValue	getEntityId() Returns the ID of the entity that the data refers to
Map<String,MonolingualTextValue>	getGlosses() Return the human readable description of the sense indexed by Wikimedia language code
Map<String,List<Statement>>	getJsonClaims() Returns the "claims".
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()
SenseDocument	withEntityId(SenseIdValue newEntityId) Returns a new version of this document with updated ID.
SenseDocument	withGloss(MonolingualTextValue gloss)
SenseDocument	withoutStatementIds(Set<String> statementIds) Returns a new version of this document where all statements matching any of the statement ids provided have been removed.
SenseDocument	withRevisionId(long newRevisionId) Returns a copy of this document with an updated revision id.
SenseDocument	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.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

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

getRevisionId

Field Detail

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.

Method Detail

getEntityId

public SenseIdValue getEntityId()

Description copied from interface: SenseDocument

Returns the ID of the entity that the data refers to

Specified by:

getEntityId in interface EntityDocument

Specified by:

getEntityId in interface SenseDocument

Returns:

sense id

getGlosses

public Map<String,MonolingualTextValue> getGlosses()

Description copied from interface: SenseDocument

Return the human readable description of the sense indexed by Wikimedia language code

Specified by:

getGlosses in interface SenseDocument

Returns:

a map from Wikimedia language code to the representations

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 SenseDocument withEntityId(SenseIdValue newEntityId)

Description copied from interface: SenseDocument

Returns a new version of this document with updated ID.

Specified by:

withEntityId in interface SenseDocument

Parameters:

newEntityId - new ID of the document

Returns:

document with updated ID

withRevisionId

public SenseDocument withRevisionId(long newRevisionId)

Description copied from interface: SenseDocument

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

Specified by:

withRevisionId in interface EntityDocument

Specified by:

withRevisionId in interface SenseDocument

Specified by:

withRevisionId in interface StatementDocument

withGloss

public SenseDocument withGloss(MonolingualTextValue gloss)

Specified by:

withGloss in interface SenseDocument

withStatement

public SenseDocument withStatement(Statement statement)

Description copied from interface: SenseDocument

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 SenseDocument

Specified by:

withStatement in interface StatementDocument

Parameters:

statement - the statement to add or update in the document

withoutStatementIds

public SenseDocument withoutStatementIds(Set<String> statementIds)

Description copied from interface: SenseDocument

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 SenseDocument

Specified by:

withoutStatementIds in interface StatementDocument

Parameters:

statementIds - the identifiers of the statements to remove

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 StatementDocumentImpl.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: