Package org.wikidata.wdtk.datamodel.json.jackson

Class JacksonTermedStatementDocument

java.lang.Object

org.wikidata.wdtk.datamodel.helpers.AbstractTermedStatementDocument

org.wikidata.wdtk.datamodel.json.jackson.JacksonTermedStatementDocument

All Implemented Interfaces:

EntityDocument, StatementDocument, TermedDocument

Direct Known Subclasses:

JacksonItemDocument, JacksonPropertyDocument

public abstract class JacksonTermedStatementDocument
extends AbstractTermedStatementDocument

Abstract Jackson implementation of TermedDocument. 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

Modifier and Type	Field	Description
protected java.util.Map<java.lang.String,java.util.List<JacksonMonolingualTextValue>>	aliases
protected java.util.Map<java.lang.String,JacksonMonolingualTextValue>	descriptions
protected java.lang.String	entityId	The id of the entity that the document refers to.
static java.lang.String	JSON_TYPE_ITEM	String used to refer to items in JSON.
static java.lang.String	JSON_TYPE_PROPERTY	String used to refer to properties in JSON.
protected java.util.Map<java.lang.String,JacksonMonolingualTextValue>	labels
protected long	revisionId	The revision id of this document.
protected java.lang.String	siteIri	The site IRI that this document refers to, or null if not specified.

Constructor Summary

Constructors

Constructor	Description
JacksonTermedStatementDocument()	Constructor.

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.util.List<MonolingualTextValue>>	getAliases()	Return a Map from Wikibase language codes to lists of alias labels for a given language.
java.util.Map<java.lang.String,MonolingualTextValue>	getDescriptions()	Return a Map from Wikibase language codes to descriptions.
java.util.Map<java.lang.String,java.util.List<JacksonStatement>>	getJsonClaims()	Returns the "claims".
java.lang.String	getJsonId()	Returns the string id of the entity that this document refers to.
java.util.Map<java.lang.String,MonolingualTextValue>	getLabels()	Return a Map from Wikibase language codes to labels.
long	getRevisionId()	Returns the revision ID of this document, or 0 if no id is known.
java.lang.String	getSiteIri()
java.util.List<StatementGroup>	getStatementGroups()	Return the list of all StatementGroups stored for this item.
void	setAliases(java.util.Map<java.lang.String,java.util.List<JacksonMonolingualTextValue>> aliases)	Sets the aliases to the given value.
void	setDescriptions(java.util.Map<java.lang.String,JacksonMonolingualTextValue> descriptions)	Sets the descriptions to the given value.
void	setJsonClaims(java.util.Map<java.lang.String,java.util.List<JacksonStatement>> claims)	Sets the "claims" to the given value.
void	setJsonId(java.lang.String id)	Sets the string id of the entity that this document refers to.
void	setLabels(java.util.Map<java.lang.String,JacksonMonolingualTextValue> labels)	Sets the labels to the given value.
void	setRevisionId(long revisionId)	Sets the revision id of this document.
void	setSiteIri(java.lang.String siteIri)	Sets the site iri to the given value.

Methods inherited from class org.wikidata.wdtk.datamodel.helpers.AbstractTermedStatementDocument

castValue, containsStatementValue, findDescription, findLabel, findStatement, findStatement, findStatementDatatypeIdValue, findStatementDatatypeIdValue, findStatementEntityIdValue, findStatementEntityIdValue, findStatementGlobeCoordinatesValue, findStatementGlobeCoordinatesValue, findStatementGroup, findStatementGroup, findStatementItemIdValue, findStatementItemIdValue, findStatementMonolingualTextValue, findStatementMonolingualTextValue, findStatementPropertyIdValue, findStatementPropertyIdValue, findStatementQuantityValue, findStatementQuantityValue, findStatementStringValue, findStatementStringValue, findStatementTimeValue, findStatementTimeValue, findStatementValue, findStatementValue, getAllStatements, getUniqueStatementFromStatementGroup, getValueFromStatement, hasStatement, hasStatement, hasStatementValue, hasStatementValue, hasStatementValue, hasStatementValue

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

getEntityId

Methods inherited from class java.lang.Object

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

Field Detail

JSON_TYPE_ITEM

public static final java.lang.String JSON_TYPE_ITEM

String used to refer to items in JSON.

See Also:

Constant Field Values

JSON_TYPE_PROPERTY

public static final java.lang.String JSON_TYPE_PROPERTY

String used to refer to properties in JSON.

See Also:

Constant Field Values

aliases

protected java.util.Map<java.lang.String,java.util.List<JacksonMonolingualTextValue>> aliases

labels

protected java.util.Map<java.lang.String,JacksonMonolingualTextValue> labels

descriptions

protected java.util.Map<java.lang.String,JacksonMonolingualTextValue> descriptions

entityId

protected java.lang.String entityId

The id of the entity that the document refers to. This is not mapped to JSON directly by Jackson but split into two fields, "type" and "id". The type field is ignored during deserialization since the type is clear for a concrete document. For serialization, the type is hard-coded.

The site IRI, which would also be required to create a complete EntityIdValue, is not encoded in JSON. It needs to be injected from the outside (if not, we default to Wikidata).

siteIri

protected java.lang.String siteIri

The site IRI that this document refers to, or null if not specified. In the latter case, we assume Wikidata as the default.

See Also:

EntityIdValue.getSiteIri()

revisionId

protected long revisionId

The revision id of this document.

See Also:

EntityDocument.getRevisionId()

Constructor Detail

JacksonTermedStatementDocument

public JacksonTermedStatementDocument()

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

Method Detail

setAliases

public void setAliases(java.util.Map<java.lang.String,java.util.List<JacksonMonolingualTextValue>> aliases)

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

Parameters:

aliases - new value

getAliases

public java.util.Map<java.lang.String,java.util.List<MonolingualTextValue>> getAliases()

Description copied from interface: TermedDocument

Return a Map from Wikibase language codes to lists of alias labels for a given language.

Returns:

the aliases for this language

setDescriptions

public void setDescriptions(java.util.Map<java.lang.String,JacksonMonolingualTextValue> descriptions)

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

Parameters:

descriptions - new value

getDescriptions

public java.util.Map<java.lang.String,MonolingualTextValue> getDescriptions()

Description copied from interface: TermedDocument

Return a Map from Wikibase language codes to descriptions.

Returns:

the map of descriptions

setLabels

public void setLabels(java.util.Map<java.lang.String,JacksonMonolingualTextValue> labels)

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

Parameters:

labels - new value

getLabels

public java.util.Map<java.lang.String,MonolingualTextValue> getLabels()

Description copied from interface: TermedDocument

Return a Map from Wikibase language codes to labels.

Returns:

the map of labels

setJsonId

public void setJsonId(java.lang.String id)

Sets the string id of the entity that this document refers to. Only for use by Jackson during deserialization.

Parameters:

id - new value

getJsonId

public java.lang.String getJsonId()

Returns the string id of the entity that this document refers to. Only for use by Jackson during serialization.

Returns:

string id

setSiteIri

public void setSiteIri(java.lang.String siteIri)

Sets the site iri to the given value. This can be used to inject information about the site the object belongs to after the object is constructed. This is needed since this information is not part of the JSON serialization.

Parameters:

siteIri - the site IRI

See Also:

EntityIdValue.getSiteIri()

getSiteIri

public java.lang.String getSiteIri()

getStatementGroups

public java.util.List<StatementGroup> getStatementGroups()

Description copied from interface: StatementDocument

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

Returns:

list of StatementGroups

setJsonClaims

public void setJsonClaims(java.util.Map<java.lang.String,java.util.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 java.util.Map<java.lang.String,java.util.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

setRevisionId

public void setRevisionId(long revisionId)

Sets the revision id of this document. Only for use by Jackson during deserialization.

Parameters:

revisionId - new value

getRevisionId

public long getRevisionId()

Description copied from interface: EntityDocument

Returns the revision ID of this document, or 0 if no id is known. The revision ID is a number stored by MediaWiki to indicate the version of a document. It is based on a global counter that is incremented on each edit. Not all sources of entity document data may provide the revision ID, as it is not strictly part of the data, but part of the document metadata.

Returns:

revision id