org.wikidata.wdtk.datamodel.json.jackson.datavalues

Class JacksonValueEntityId

java.lang.Object

org.wikidata.wdtk.datamodel.json.jackson.datavalues.JacksonValue

org.wikidata.wdtk.datamodel.json.jackson.datavalues.JacksonValueEntityId

All Implemented Interfaces:

EntityIdValue, IriIdentifiedValue, Value

Direct Known Subclasses:

JacksonValueItemId, JacksonValuePropertyId

public abstract class JacksonValueEntityId
extends JacksonValue
implements EntityIdValue

Abstract base implementation of EntityIdValue for Jackson.

Author:

Markus Kroetzsch

Field Summary

Fields

Modifier and Type	Field and Description
protected JacksonInnerEntityId	value Inner helper object to store the actual data.

Fields inherited from class org.wikidata.wdtk.datamodel.json.jackson.datavalues.JacksonValue

JSON_VALUE_TYPE_ENTITY_ID, JSON_VALUE_TYPE_GLOBE_COORDINATES, JSON_VALUE_TYPE_MONOLINGUAL_TEXT, JSON_VALUE_TYPE_QUANTITY, JSON_VALUE_TYPE_STRING, JSON_VALUE_TYPE_TIME

Fields inherited from interface org.wikidata.wdtk.datamodel.interfaces.EntityIdValue

ET_ITEM, ET_PROPERTY

Constructor Summary

Constructors

Constructor and Description
JacksonValueEntityId() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() Returns the id of this entity.
String	getIri() Get the IRI of this entity.
String	getSiteIri() Returns an IRI that identifies the site that this entity comes from,, e.g., "http://www.wikidata.org/entity/" for Wikidata.
JacksonInnerEntityId	getValue() Returns the inner value helper object.
void	setSiteIri(String siteIri) Sets the parent document of this value to the given value.
void	setValue(JacksonInnerEntityId value) Sets the inner value helper object to the given value.

Methods inherited from class org.wikidata.wdtk.datamodel.json.jackson.datavalues.JacksonValue

getType, setType

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.EntityIdValue

getEntityType

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

accept

Field Detail

value

protected JacksonInnerEntityId value

Inner helper object to store the actual data. Used to get the nested JSON structure that is required here.

Constructor Detail

JacksonValueEntityId

public JacksonValueEntityId()

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

Method Detail

getValue

public JacksonInnerEntityId getValue()

Returns the inner value helper object. Only for use by Jackson during serialization.

Returns:

the inner entity id value

setValue

public void setValue(JacksonInnerEntityId value)

Sets the inner value helper object to the given value. Only for use by Jackson during deserialization.

Parameters:

value - new value

getIri

public String getIri()

Description copied from interface: IriIdentifiedValue

Get the IRI of this entity.

Specified by:

getIri in interface IriIdentifiedValue

Returns:

String with the IRI

getId

public String getId()

Description copied from interface: EntityIdValue

Returns the id of this entity.

Specified by:

getId in interface EntityIdValue

Returns:

String id of this entity

getSiteIri

public String getSiteIri()

Description copied from interface: EntityIdValue

Returns an IRI that identifies the site that this entity comes from,, e.g., "http://www.wikidata.org/entity/" for Wikidata.

Specified by:

getSiteIri in interface EntityIdValue

Returns:

the site IRI string

setSiteIri

public void setSiteIri(String siteIri)

Sets the parent document of this value to the given value. This document provides the value with information about its site IRI, which is not part of the JSON serialization of values. This method should only be used during deserialization.

Parameters:

parentDocument - new value