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

Class JacksonInnerEntityId

java.lang.Object

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

public class JacksonInnerEntityId
extends Object

This class represents the inner anonymous object in the JSON type of "wikibase-entityid". Not to be confused with the entityId of the main document.

Author:

Fredo Erxleben

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_ENTITY_TYPE_ITEM The string used in JSON to denote the type of entity id values that are items.
static String	JSON_ENTITY_TYPE_PROPERTY The string used in JSON to denote the type of entity id values that are properties.

Constructor Summary

Constructors

Constructor and Description
JacksonInnerEntityId() Constructor.
JacksonInnerEntityId(String entityType, int numericId) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getJsonEntityType() Returns the entity type string as used in JSON.
int	getNumericId() Returns the numeric item id as used in JSON.
String	getStringId() Returns the standard string version of the entity id encoded in this value.
void	setJsonEntityType(String entityType) Sets the entity type string to the given value.
void	setNumericId(int numericId) Sets the numeric item id to the given value.

Methods inherited from class java.lang.Object

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

Field Detail

JSON_ENTITY_TYPE_ITEM

public static final String JSON_ENTITY_TYPE_ITEM

The string used in JSON to denote the type of entity id values that are items.

See Also:

Constant Field Values

JSON_ENTITY_TYPE_PROPERTY

public static final String JSON_ENTITY_TYPE_PROPERTY

The string used in JSON to denote the type of entity id values that are properties.

See Also:

Constant Field Values

Constructor Detail

JacksonInnerEntityId

public JacksonInnerEntityId()

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

JacksonInnerEntityId

public JacksonInnerEntityId(String entityType,
                    int numericId)

Constructor. Supported entity types so far are "item" and "property".

Parameters:

entityType - (case-sensitive)

numericId -

Method Detail

getJsonEntityType

public String getJsonEntityType()

Returns the entity type string as used in JSON. Only for use by Jackson during serialization.

Returns:

the entity type string

setJsonEntityType

public void setJsonEntityType(String entityType)

Sets the entity type string to the given value. Only for use by Jackson during deserialization.

Parameters:

entityType - new value

getNumericId

public int getNumericId()

Returns the numeric item id as used in JSON. Only for use by Jackson during serialization.

Returns:

the numeric entity id

setNumericId

public void setNumericId(int numericId)

Sets the numeric item id to the given value. Only for use by Jackson during deserialization.

Parameters:

numericId - new value

getStringId

public String getStringId()
                   throws IllegalArgumentException

Returns the standard string version of the entity id encoded in this value. For example, an id with entityType "item" and numericId "42" is normally identified as "Q42".

Returns:

the string id

Throws:

IllegalArgumentException - if the entity type of this value is unknown and can thus not be mapped to a string id

equals

public boolean equals(Object o)

Overrides:

equals in class Object