Package org.wikidata.wdtk.datamodel.interfaces

Interface TermedDocument

All Superinterfaces:

EntityDocument

All Known Subinterfaces:

ItemDocument, PropertyDocument

All Known Implementing Classes:

AbstractTermedStatementDocument, ItemDocumentImpl, JacksonItemDocument, JacksonPropertyDocument, JacksonTermedStatementDocument, PropertyDocumentImpl, TermedStatementDocumentImpl

public interface TermedDocument
extends EntityDocument

Interface for EntityDocuments that can be described by terms in several languages. These terms consist labels, descriptions, and aliases.

Author:

Markus Kroetzsch

Method Summary

Modifier and Type	Method	Description
java.lang.String	findDescription(java.lang.String languageCode)	Returns the string description for the given language code, or null if there is no description for this code.
java.lang.String	findLabel(java.lang.String languageCode)	Returns the string label for the given language code, or null if there is no label for this code.
java.util.Map<java.lang.String,java.util.List<MonolingualTextValue>>	getAliases()	Return a Map from Wikibase language codes to lists of alias labels for a given language.
java.util.Map<java.lang.String,MonolingualTextValue>	getDescriptions()	Return a Map from Wikibase language codes to descriptions.
java.util.Map<java.lang.String,MonolingualTextValue>	getLabels()	Return a Map from Wikibase language codes to labels.

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

getEntityId, getRevisionId

Method Detail

getLabels

java.util.Map<java.lang.String,MonolingualTextValue> getLabels()

Return a Map from Wikibase language codes to labels.

Returns:

the map of labels

getDescriptions

java.util.Map<java.lang.String,MonolingualTextValue> getDescriptions()

Return a Map from Wikibase language codes to descriptions.

Returns:

the map of descriptions

getAliases

java.util.Map<java.lang.String,java.util.List<MonolingualTextValue>> getAliases()

Return a Map from Wikibase language codes to lists of alias labels for a given language.

Returns:

the aliases for this language

findLabel

java.lang.String findLabel(java.lang.String languageCode)

Returns the string label for the given language code, or null if there is no label for this code. This is a convenience method for accessing the data that can be obtained via getLabels().

Parameters:

languageCode - a string that represents language

Returns:

the label string

findDescription

java.lang.String findDescription(java.lang.String languageCode)

Returns the string description for the given language code, or null if there is no description for this code. This is a convenience method for accessing the data that can be obtained via getDescriptions().

Parameters:

languageCode - a string that represents language

Returns:

the description string