org.wikidata.wdtk.datamodel.json.jackson

Class JacksonTermedDocument

java.lang.Object

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

All Implemented Interfaces:

EntityDocument, TermedDocument

Direct Known Subclasses:

JacksonItemDocument, JacksonPropertyDocument

public abstract class JacksonTermedDocument
extends Object
implements TermedDocument

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 and Description
protected Map<String,List<JacksonMonolingualTextValue>>	aliases
protected Map<String,JacksonMonolingualTextValue>	descriptions
protected String	entityId The id of the entity that the document refers to.
static String	JSON_TYPE_ITEM String used to refer to items in JSON.
static String	JSON_TYPE_PROPERTY String used to refer to properties in JSON.
protected Map<String,JacksonMonolingualTextValue>	labels
protected String	siteIri The site IRI that this document refers to, or null if not specified.

Constructor Summary

Constructors

Constructor and Description
JacksonTermedDocument() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,List<MonolingualTextValue>>	getAliases() Return a Map from Wikibase language codes to lists of alias labels for a given language.
Map<String,MonolingualTextValue>	getDescriptions() Return a Map from Wikibase language codes to descriptions.
String	getJsonId() Returns the string id of the entity that this document refers to.
abstract String	getJsonType() Returns the JSON type string of the entity that this document refers to.
Map<String,MonolingualTextValue>	getLabels() Return a Map from Wikibase language codes to labels.
String	getSiteIri()
void	setAliases(Map<String,List<JacksonMonolingualTextValue>> aliases) Sets the aliases to the given value.
void	setDescriptions(Map<String,JacksonMonolingualTextValue> descriptions) Sets the descriptions to the given value.
void	setJsonId(String id) Sets the string id of the entity that this document refers to.
void	setLabels(Map<String,JacksonMonolingualTextValue> labels) Sets the labels to the given value.
void	setSiteIri(String siteIri) Sets the site iri to the given value.

Methods inherited from class java.lang.Object

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

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

getEntityId

Field Detail

JSON_TYPE_ITEM

public static final String JSON_TYPE_ITEM

String used to refer to items in JSON.

See Also:

Constant Field Values

JSON_TYPE_PROPERTY

public static final String JSON_TYPE_PROPERTY

String used to refer to properties in JSON.

See Also:

Constant Field Values

aliases

protected Map<String,List<JacksonMonolingualTextValue>> aliases

labels

protected Map<String,JacksonMonolingualTextValue> labels

descriptions

protected Map<String,JacksonMonolingualTextValue> descriptions

entityId

protected 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 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()

Constructor Detail

JacksonTermedDocument

public JacksonTermedDocument()

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(Map<String,List<JacksonMonolingualTextValue>> aliases)

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

Parameters:

aliases - new value

getAliases

public Map<String,List<MonolingualTextValue>> getAliases()

Description copied from interface: TermedDocument

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

Specified by:

getAliases in interface TermedDocument

Returns:

the aliases for this language

setDescriptions

public void setDescriptions(Map<String,JacksonMonolingualTextValue> descriptions)

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

Parameters:

descriptions - new value

getDescriptions

public Map<String,MonolingualTextValue> getDescriptions()

Description copied from interface: TermedDocument

Return a Map from Wikibase language codes to descriptions.

Specified by:

getDescriptions in interface TermedDocument

Returns:

the map of descriptions

setLabels

public void setLabels(Map<String,JacksonMonolingualTextValue> labels)

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

Parameters:

labels - new value

getLabels

public Map<String,MonolingualTextValue> getLabels()

Description copied from interface: TermedDocument

Return a Map from Wikibase language codes to labels.

Specified by:

getLabels in interface TermedDocument

Returns:

the map of labels

setJsonId

public void setJsonId(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 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(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 String getSiteIri()

getJsonType

public abstract String getJsonType()

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

Returns:

either JSON_TYPE_ITEM or JSON_TYPE_PROPERTY