org.wikidata.wdtk.datamodel.implementation

Class ItemDocumentImpl

java.lang.Object

org.wikidata.wdtk.datamodel.implementation.EntityDocumentImpl

org.wikidata.wdtk.datamodel.implementation.TermedStatementDocumentImpl

org.wikidata.wdtk.datamodel.implementation.ItemDocumentImpl

All Implemented Interfaces:

EntityDocument, ItemDocument, LabeledDocument, LabeledStatementDocument, StatementDocument, TermedDocument, TermedStatementDocument

public class ItemDocumentImpl
extends TermedStatementDocumentImpl
implements ItemDocument

Jackson implementation of ItemDocument.

Author:

Fredo Erxleben, Antonin Delpeuch

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.
protected Map<String,MonolingualTextValue>	labels

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

aliases, descriptions

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

entityId, revisionId, siteIri

Constructor Summary

Constructors

Modifier	Constructor and Description
	ItemDocumentImpl(ItemIdValue id, List<MonolingualTextValue> labels, List<MonolingualTextValue> descriptions, List<MonolingualTextValue> aliases, List<StatementGroup> statements, List<SiteLink> siteLinks, long revisionId) Constructor.
protected	ItemDocumentImpl(ItemIdValue subject, Map<String,MonolingualTextValue> labels, Map<String,MonolingualTextValue> descriptions, Map<String,List<MonolingualTextValue>> aliases, Map<String,List<Statement>> claims, Map<String,SiteLink> siteLinks, long revisionId) Protected constructor, meant to be used to create modified copies of instances.
	ItemDocumentImpl(String jsonId, Map<String,MonolingualTextValue> labels, Map<String,MonolingualTextValue> descriptions, Map<String,List<MonolingualTextValue>> aliases, Map<String,List<StatementImpl.PreStatement>> claims, Map<String,SiteLink> sitelinks, long revisionId, String siteIri) Constructor.

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.
protected static Map<String,MonolingualTextValue>	constructTermMap(List<MonolingualTextValue> terms)
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.
ItemIdValue	getEntityId() Return the ID of the item that the data refers to.
Map<String,List<Statement>>	getJsonClaims() Returns the "claims".
Map<String,MonolingualTextValue>	getLabels() Return a Map from Wikibase language codes to labels.
Map<String,SiteLink>	getSiteLinks() Get a Map of site keys to SiteLink objects.
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()
ItemDocument	withAliases(String language, List<MonolingualTextValue> aliases) Returns a new version of this document with a new list of aliases for the given language code.
ItemDocument	withDescription(MonolingualTextValue newDescription) Returns a new version of this document with a new description (which overrides any existing description).
ItemDocument	withEntityId(ItemIdValue itemId) Returns a new version of this document with updated ID.
ItemDocument	withLabel(MonolingualTextValue newLabel) Returns a new version of this document with a new label (which overrides any existing label for this language).
ItemDocument	withoutStatementIds(Set<String> statementIds) Returns a new version of this document where all statements matching any of the statement ids provided have been removed.
ItemDocument	withRevisionId(long newRevisionId) Returns a copy of this document with an updated revision id.
ItemDocument	withStatement(Statement statement) Returns a new version of this document which includes the statement provided.
protected static Map<String,MonolingualTextValue>	withTerm(Map<String,MonolingualTextValue> values, MonolingualTextValue value)

Methods inherited from class org.wikidata.wdtk.datamodel.implementation.TermedStatementDocumentImpl

getAliases, getDescriptions, getSiteIri, withAliases

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

getJsonId, getRevisionId

Methods inherited from class java.lang.Object

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

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

findDescription, getAliases, getDescriptions

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

findLabel, getLabels

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

labels

protected final Map<String,MonolingualTextValue> labels

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 Detail

ItemDocumentImpl

public ItemDocumentImpl(ItemIdValue id,
                        List<MonolingualTextValue> labels,
                        List<MonolingualTextValue> descriptions,
                        List<MonolingualTextValue> aliases,
                        List<StatementGroup> statements,
                        List<SiteLink> siteLinks,
                        long revisionId)

Constructor.

Parameters:

id - the id of the item that data is about

labels - the list of labels of this item, with at most one label for each language code

descriptions - the list of descriptions of this item, with at most one description for each language code

aliases - the list of aliases of this item

statements - the list of statement groups of this item; all of them must have the given itemIdValue as their subject

siteLinks - the sitelinks of this item

revisionId - the revision ID or 0 if not known; see EntityDocument.getRevisionId()

ItemDocumentImpl

public ItemDocumentImpl(String jsonId,
                        Map<String,MonolingualTextValue> labels,
                        Map<String,MonolingualTextValue> descriptions,
                        Map<String,List<MonolingualTextValue>> aliases,
                        Map<String,List<StatementImpl.PreStatement>> claims,
                        Map<String,SiteLink> sitelinks,
                        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.

ItemDocumentImpl

protected ItemDocumentImpl(ItemIdValue subject,
                           Map<String,MonolingualTextValue> labels,
                           Map<String,MonolingualTextValue> descriptions,
                           Map<String,List<MonolingualTextValue>> aliases,
                           Map<String,List<Statement>> claims,
                           Map<String,SiteLink> siteLinks,
                           long revisionId)

Protected constructor, meant to be used to create modified copies of instances.

Method Detail

getEntityId

public ItemIdValue getEntityId()

Description copied from interface: ItemDocument

Return the ID of the item that the data refers to.

Specified by:

getEntityId in interface EntityDocument

Specified by:

getEntityId in interface ItemDocument

Returns:

item id

getSiteLinks

public Map<String,SiteLink> getSiteLinks()

Description copied from interface: ItemDocument

Get a Map of site keys to SiteLink objects.

Specified by:

getSiteLinks in interface ItemDocument

Returns:

map of SiteLinks

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 ItemDocument withEntityId(ItemIdValue itemId)

Description copied from interface: ItemDocument

Returns a new version of this document with updated ID.

Specified by:

withEntityId in interface ItemDocument

Parameters:

itemId - new ID of the document

Returns:

document with updated ID

withRevisionId

public ItemDocument withRevisionId(long newRevisionId)

Description copied from interface: TermedDocument

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

Specified by:

withRevisionId in interface EntityDocument

Specified by:

withRevisionId in interface ItemDocument

Specified by:

withRevisionId in interface LabeledDocument

Specified by:

withRevisionId in interface LabeledStatementDocument

Specified by:

withRevisionId in interface StatementDocument

Specified by:

withRevisionId in interface TermedDocument

Specified by:

withRevisionId in interface TermedStatementDocument

withLabel

public ItemDocument withLabel(MonolingualTextValue newLabel)

Description copied from interface: TermedDocument

Returns a new version of this document with a new label (which overrides any existing label for this language).

Specified by:

withLabel in interface ItemDocument

Specified by:

withLabel in interface LabeledDocument

Specified by:

withLabel in interface LabeledStatementDocument

Specified by:

withLabel in interface TermedDocument

Specified by:

withLabel in interface TermedStatementDocument

withDescription

public ItemDocument withDescription(MonolingualTextValue newDescription)

Description copied from interface: TermedDocument

Returns a new version of this document with a new description (which overrides any existing description).

Specified by:

withDescription in interface ItemDocument

Specified by:

withDescription in interface TermedDocument

Specified by:

withDescription in interface TermedStatementDocument

withAliases

public ItemDocument withAliases(String language,
                                List<MonolingualTextValue> aliases)

Description copied from interface: TermedDocument

Returns a new version of this document with a new list of aliases for the given language code. Any existing aliases for this language will be discarded.

Specified by:

withAliases in interface ItemDocument

Specified by:

withAliases in interface TermedDocument

Specified by:

withAliases in interface TermedStatementDocument

Parameters:

language - the language code for which the aliases should be set

aliases - the aliases to set for this language. The language codes they contain should all match the supplied language.

withStatement

public ItemDocument withStatement(Statement statement)

Description copied from interface: StatementDocument

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 ItemDocument

Specified by:

withStatement in interface LabeledStatementDocument

Specified by:

withStatement in interface StatementDocument

Specified by:

withStatement in interface TermedStatementDocument

Parameters:

statement - the statement to add or update in the document

withoutStatementIds

public ItemDocument withoutStatementIds(Set<String> statementIds)

Description copied from interface: StatementDocument

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 ItemDocument

Specified by:

withoutStatementIds in interface LabeledStatementDocument

Specified by:

withoutStatementIds in interface StatementDocument

Specified by:

withoutStatementIds in interface TermedStatementDocument

Parameters:

statementIds - the identifiers of the statements to remove

getLabels

public Map<String,MonolingualTextValue> getLabels()

Description copied from interface: LabeledDocument

Return a Map from Wikibase language codes to labels.

Specified by:

getLabels in interface LabeledDocument

Returns:

the map of labels

constructTermMap

protected static Map<String,MonolingualTextValue> constructTermMap(List<MonolingualTextValue> terms)

withTerm

protected static Map<String,MonolingualTextValue> withTerm(Map<String,MonolingualTextValue> values,
                                                           MonolingualTextValue value)

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: