Package org.wikidata.wdtk.datamodel.interfaces

Interface EntityIdValue

All Superinterfaces:

IriIdentifiedValue, Value

All Known Subinterfaces:

ItemIdValue, PropertyIdValue

All Known Implementing Classes:

ItemIdValueImpl, JacksonValueEntityId, JacksonValueItemId, JacksonValuePropertyId, PropertyIdValueImpl

public interface EntityIdValue
extends IriIdentifiedValue

An entity is a Value that is represented by a page in Wikibase. It is identified by its id, corresponding to the title of that page. Typical entities are Items (with identifiers of the form Q1234) and Properties (with identifiers of the form P1234).

When considering entities from multiple sites, the (local) ID alone is not enough to identify an entity unambiguously. In this case, the site IRI also needs to be taken into account.

An alternative to using the local ID and site IRI together is to use the full IRI. By default, this is computed by appending the local ID to the site IRI. However, for some sites and some entity types, more elaborate computations might be required, so this construction scheme for IRIs should not be presumed.

The full IRI of an entity is used in export formats like RDF, but also internally, e.g., for identifying the calendar model of time values.

Author:

Markus Kroetzsch

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ET_ITEM	IRI of the type of an entity that is an item.
static java.lang.String	ET_PROPERTY	IRI of the type of an entity that is a property.
static java.lang.String	SITE_LOCAL	The site IRI of "local" identifiers.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getEntityType()	Returns the type of this entity.
java.lang.String	getId()	Returns the id of this entity.
java.lang.String	getSiteIri()	Returns an IRI that identifies the site that this entity comes from,, e.g., "http://www.wikidata.org/entity/" for Wikidata.

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

getIri

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

accept

Field Detail

ET_ITEM

static final java.lang.String ET_ITEM

IRI of the type of an entity that is an item.

See Also:

Constant Field Values

ET_PROPERTY

static final java.lang.String ET_PROPERTY

IRI of the type of an entity that is a property.

See Also:

Constant Field Values

SITE_LOCAL

static final java.lang.String SITE_LOCAL

The site IRI of "local" identifiers. These are used to mark internal ids that are not found on any external site. Components that send data to external services or that create data exports should omit such ids, if possible.

See Also:

Constant Field Values

Method Detail

getEntityType

java.lang.String getEntityType()

Returns the type of this entity. This should be an IRI that identifies an entity type, such as ET_ITEM or ET_PROPERTY.

Returns:

IRI string to identify the type of the entity

getId

java.lang.String getId()

Returns the id of this entity.

Returns:

String id of this entity

getSiteIri

java.lang.String getSiteIri()

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

Returns:

the site IRI string