Package org.wikidata.wdtk.datamodel.interfaces

Interface EntityDocument

All Known Subinterfaces:
EntityRedirectDocument, FormDocument, ItemDocument, LabeledDocument, LabeledStatementDocument, LexemeDocument, MediaInfoDocument, PropertyDocument, SenseDocument, StatementDocument, TermedDocument, TermedStatementDocument
All Known Implementing Classes:
EntityDocumentImpl, EntityRedirectDocumentImpl, FormDocumentImpl, ItemDocumentImpl, LexemeDocumentImpl, MediaInfoDocumentImpl, PropertyDocumentImpl, SenseDocumentImpl, TermedStatementDocumentImpl
public interface EntityDocument
Interface for datasets that describe an entity.
Author:
Markus Kroetzsch

  • Method Summary

    Modifier and Type
    Method
    Description
    EntityIdValue
    getEntityId()
    Returns the ID of the entity that the data refers to
    long
    getRevisionId()
    Returns the revision ID of this document, or 0 if no id is known.
    EntityDocument
    withRevisionId(long newRevisionId)
    Returns a copy of this document with an updated revision id.

  • Method Details

    • getEntityId

      EntityIdValue getEntityId()
      Returns the ID of the entity that the data refers to
      Returns:
      entity id

    • getRevisionId

      long getRevisionId()
      Returns the revision ID of this document, or 0 if no id is known. The revision ID is a number stored by MediaWiki to indicate the version of a document. It is based on a global counter that is incremented on each edit. Not all sources of entity document data may provide the revision ID, as it is not strictly part of the data, but part of the document metadata.
      Returns:
      revision id

    • withRevisionId

      EntityDocument withRevisionId(long newRevisionId)
      Returns a copy of this document with an updated revision id.