org.wikidata.wdtk.datamodel.json.jackson

Class JacksonItemDocument

java.lang.Object

org.wikidata.wdtk.datamodel.json.jackson.JacksonTermedDocument

org.wikidata.wdtk.datamodel.json.jackson.JacksonItemDocument

All Implemented Interfaces:

EntityDocument, ItemDocument, TermedDocument

public class JacksonItemDocument
extends JacksonTermedDocument
implements ItemDocument

Jackson implementation of ItemDocument. Like all Jackson objects, it is not technically immutable, but it is strongly recommended to treat it as such in all contexts: the setters are for Jackson; never call them in your code.

Author:

Fredo Erxleben

Field Summary

Fields inherited from class org.wikidata.wdtk.datamodel.json.jackson.JacksonTermedDocument

aliases, descriptions, entityId, JSON_TYPE_ITEM, JSON_TYPE_PROPERTY, labels, siteIri

Constructor Summary

Constructors

Constructor and Description
JacksonItemDocument() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Iterator<Statement>	getAllStatements() Returns an iterator that provides access to all statements, without considering the statement groups.
EntityIdValue	getEntityId() Return the ID of the entity that the data refers to
ItemIdValue	getItemId() Return the ID of the item that the data refers to.
Map<String,List<JacksonStatement>>	getJsonClaims() Returns the "claims".
String	getJsonType() Returns the JSON type string of the entity that this document refers to.
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()
void	setJsonClaims(Map<String,List<JacksonStatement>> claims) Sets the "claims" to the given value.
void	setSiteLinks(Map<String,JacksonSiteLink> sitelinks) Sets the site links to the given value.
String	toString()

Methods inherited from class org.wikidata.wdtk.datamodel.json.jackson.JacksonTermedDocument

getAliases, getDescriptions, getJsonId, getLabels, getSiteIri, setAliases, setDescriptions, setJsonId, setLabels, setSiteIri

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

getAliases, getDescriptions, getLabels

Constructor Detail

JacksonItemDocument

public JacksonItemDocument()

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

Method Detail

getJsonType

public String getJsonType()

Description copied from class: JacksonTermedDocument

Returns the JSON type string of the entity that this document refers to. Only used by Jackson.

Specified by:

getJsonType in class JacksonTermedDocument

Returns:

either JacksonTermedDocument.JSON_TYPE_ITEM or JacksonTermedDocument.JSON_TYPE_PROPERTY

getItemId

public ItemIdValue getItemId()

Description copied from interface: ItemDocument

Return the ID of the item that the data refers to. The result is the same as that of EntityDocument.getEntityId(), but declared with a more specific result type.

Specified by:

getItemId in interface ItemDocument

Returns:

item id

getEntityId

public EntityIdValue getEntityId()

Description copied from interface: EntityDocument

Return the ID of the entity that the data refers to

Specified by:

getEntityId in interface EntityDocument

Returns:

entity id

getStatementGroups

public List<StatementGroup> getStatementGroups()

Description copied from interface: ItemDocument

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

Specified by:

getStatementGroups in interface ItemDocument

Returns:

list of StatementGroups

setSiteLinks

public void setSiteLinks(Map<String,JacksonSiteLink> sitelinks)

Sets the site links to the given value. Only for use by Jackson during deserialization.

Parameters:

sitelinks - new value

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

setJsonClaims

public void setJsonClaims(Map<String,List<JacksonStatement>> claims)

Sets the "claims" to the given value. Only for use by Jackson during deserialization.

The name refers to the JSON model, where claims are similar to statement groups. This should not be confused with claims as used in the WDTK data model. This will probably only be used by the Jacksons' ObjectMapper.

Parameters:

claims -

getJsonClaims

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

Returns the "claims". Only used by Jackson.

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

Returns:

map of statement groups

getAllStatements

public Iterator<Statement> getAllStatements()

Description copied from interface: ItemDocument

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 ItemDocument

Returns:

iterator over all statements

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