Package org.wikidata.wdtk.wikibaseapi

Interface WbSearchEntitiesResult

public interface WbSearchEntitiesResult
Represents the result of a wbsearchentities action.
Author:
Sören Brunk

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    WbSearchEntitiesResult.Match
    Represents information about how a document matched the query

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getAliases()
    A list of alias labels (returned only when an alias matched the query).
    String
    getConceptUri()
    Returns the full concept URI (the site IRI with entity ID).
    String
    getDescription()
    Returns the description of the entity The language of the returned description depends on the HTTP Accept-Language header or the uselang URL parameter.
    String
    getEntityId()
    Returns the id of the entity that the document refers to.
    String
    getLabel()
    Returns the label of the entity.
    WbSearchEntitiesResult.Match
    getMatch()
    Returns detailed information about how a document matched the query.
    long
    getPageId()
    Returns the internal Mediawiki pageid of the entity.
    String
    getTitle()
    Returns the title of the entity (currently the same as the entity ID).
    String
    getUrl()
    The URL of the wiki site that shows the concept.

  • Method Details

    • getEntityId

      String getEntityId()
      Returns the id of the entity that the document refers to.
      Returns:
      the entity ID

    • getConceptUri

      String getConceptUri()
      Returns the full concept URI (the site IRI with entity ID).
      Returns:
      full concept URI

    • getUrl

      String getUrl()
      The URL of the wiki site that shows the concept.
      Returns:
      wiki site URL

    • getTitle

      String getTitle()
      Returns the title of the entity (currently the same as the entity ID).

    • getPageId

      long getPageId()
      Returns the internal Mediawiki pageid of the entity.
      Returns:
      internal pageid

    • getLabel

      String getLabel()
      Returns the label of the entity. The language of the returned label depends on the HTTP Accept-Language header or the uselang URL parameter.
      Returns:
      the label of the entity

    • getDescription

      String getDescription()
      Returns the description of the entity The language of the returned description depends on the HTTP Accept-Language header or the uselang URL parameter.
      Returns:
      the description

    • getMatch

      WbSearchEntitiesResult.Match getMatch()
      Returns detailed information about how a document matched the query.
      Returns:
      match information

    • getAliases

      List<String> getAliases()
      A list of alias labels (returned only when an alias matched the query).
      Returns:
      a list of aliases