org.wikidata.wdtk.datamodel.json.jackson

Class JacksonPropertyDocument

java.lang.Object

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

org.wikidata.wdtk.datamodel.json.jackson.JacksonPropertyDocument

All Implemented Interfaces:

EntityDocument, PropertyDocument, TermedDocument

public class JacksonPropertyDocument
extends JacksonTermedDocument
implements PropertyDocument

Jackson implementation of PropertyDocument. 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
JacksonPropertyDocument() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
DatatypeIdValue	getDatatype() Get the datatype id of the datatype defined for this property.
EntityIdValue	getEntityId() Return the ID of the entity that the data refers to
String	getJsonDatatype() Returns the JSON string version of the property's datatype.
String	getJsonType() Returns the JSON type string of the entity that this document refers to.
PropertyIdValue	getPropertyId() Return the ID of the property that the data refers to.
int	hashCode()
void	setJsonDatatype(String datatype) Sets the datatype to the given JSON datatype string.
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

JacksonPropertyDocument

public JacksonPropertyDocument()

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

Method Detail

getJsonDatatype

public String getJsonDatatype()

Returns the JSON string version of the property's datatype. Note that getDatatype() is already used for another function of the interface.

Returns:

string datatype

See Also:

setJsonDatatype(String)

setJsonDatatype

public void setJsonDatatype(String datatype)

Sets the datatype to the given JSON datatype string. Only for use by Jackson during deserialization.

Parameters:

datatype -

See Also:

getJsonDatatype()

getPropertyId

public PropertyIdValue getPropertyId()

Description copied from interface: PropertyDocument

Return the ID of the property 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:

getPropertyId in interface PropertyDocument

Returns:

property 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

getDatatype

public DatatypeIdValue getDatatype()

Description copied from interface: PropertyDocument

Get the datatype id of the datatype defined for this property.

Specified by:

getDatatype in interface PropertyDocument

Returns:

DatatypeIdValue

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

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