org.wikidata.wdtk.datamodel.implementation

Class ItemUpdateImpl

java.lang.Object

org.wikidata.wdtk.datamodel.implementation.EntityUpdateImpl

org.wikidata.wdtk.datamodel.implementation.StatementDocumentUpdateImpl

org.wikidata.wdtk.datamodel.implementation.LabeledDocumentUpdateImpl

org.wikidata.wdtk.datamodel.implementation.TermedDocumentUpdateImpl

org.wikidata.wdtk.datamodel.implementation.ItemUpdateImpl

All Implemented Interfaces:

EntityUpdate, ItemUpdate, LabeledDocumentUpdate, LabeledStatementDocumentUpdate, StatementDocumentUpdate, TermedDocumentUpdate, TermedStatementDocumentUpdate

public class ItemUpdateImpl
extends TermedDocumentUpdateImpl
implements ItemUpdate

Jackson implementation of ItemUpdate.

Constructor Summary

Constructors

Constructor and Description
ItemUpdateImpl(ItemIdValue entityId, long revisionId, TermUpdate labels, TermUpdate descriptions, Map<String,AliasUpdate> aliases, StatementUpdate statements, Collection<SiteLink> modifiedSiteLinks, Collection<String> removedSiteLinks) Initializes new item update.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
ItemIdValue	getEntityId() Returns ID of the entity that is being updated.
Map<String,SiteLink>	getModifiedSiteLinks() Returns site links added or modified in this update.
Set<String>	getRemovedSiteLinks() Returns site keys of site links removed in this update.
int	hashCode()
boolean	isEmpty() Checks whether the update is empty.

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

getAliases, getDescriptions

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

getLabels

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

getStatements

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

getBaseRevisionId

Methods inherited from class java.lang.Object

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

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

getAliases, getDescriptions

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

getLabels

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

getStatements

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

getBaseRevisionId

Constructor Detail

ItemUpdateImpl

public ItemUpdateImpl(ItemIdValue entityId,
                      long revisionId,
                      TermUpdate labels,
                      TermUpdate descriptions,
                      Map<String,AliasUpdate> aliases,
                      StatementUpdate statements,
                      Collection<SiteLink> modifiedSiteLinks,
                      Collection<String> removedSiteLinks)

Initializes new item update.

Parameters:

entityId - ID of the item that is to be updated

revisionId - base item revision to be updated or zero if not available

labels - changes in entity labels or null for no change

descriptions - changes in entity descriptions or null for no change

aliases - changes in entity aliases, possibly empty

statements - changes in entity statements, possibly empty

modifiedSiteLinks - added or replaced site links

removedSiteLinks - site keys of removed site links

Throws:

NullPointerException - if any required parameter or its item is null

IllegalArgumentException - if any parameters or their combination is invalid

Method Detail

getEntityId

public ItemIdValue getEntityId()

Description copied from interface: EntityUpdate

Returns ID of the entity that is being updated.

Specified by:

getEntityId in interface EntityUpdate

Specified by:

getEntityId in interface ItemUpdate

Overrides:

getEntityId in class EntityUpdateImpl

Returns:

ID of the updated entity

isEmpty

public boolean isEmpty()

Description copied from interface: EntityUpdate

Checks whether the update is empty. Empty update will not change the entity in any way.

Specified by:

isEmpty in interface EntityUpdate

Overrides:

isEmpty in class TermedDocumentUpdateImpl

Returns:

true if the update is empty, false otherwise

getModifiedSiteLinks

public Map<String,SiteLink> getModifiedSiteLinks()

Description copied from interface: ItemUpdate

Returns site links added or modified in this update. Existing site links are preserved if their site key is not listed here.

Specified by:

getModifiedSiteLinks in interface ItemUpdate

Returns:

added or modified site links indexed by site key

getRemovedSiteLinks

public Set<String> getRemovedSiteLinks()

Description copied from interface: ItemUpdate

Returns site keys of site links removed in this update.

Specified by:

getRemovedSiteLinks in interface ItemUpdate

Returns:

site keys of removed site links

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object