Package org.wikidata.wdtk.datamodel.interfaces

Interface ItemDocument

All Superinterfaces:

EntityDocument, LabeledDocument, LabeledStatementDocument, StatementDocument, TermedDocument, TermedStatementDocument

All Known Implementing Classes:

ItemDocumentImpl

public interface ItemDocument
extends TermedStatementDocument

Interface for datasets that describe items. It extends EntityDocument with information about site links and statements.

Author:

Markus Kroetzsch

Method Summary

Modifier and Type	Method	Description
ItemIdValue	getEntityId()	Return the ID of the item that the data refers to.
Map<String,SiteLink>	getSiteLinks()	Get a Map of site keys to SiteLink objects.
ItemDocument	withAliases(String language, List<MonolingualTextValue> aliases)	Returns a new version of this document with a new list of aliases for the given language code.
ItemDocument	withDescription(MonolingualTextValue newDescription)	Returns a new version of this document with a new description (which overrides any existing description).
ItemDocument	withEntityId(ItemIdValue newEntityId)	Returns a new version of this document with updated ID.
ItemDocument	withLabel(MonolingualTextValue newLabel)	Returns a new version of this document with a new label (which overrides any existing label for this language).
ItemDocument	withoutStatementIds(Set<String> statementIds)	Returns a new version of this document where all statements matching any of the statement ids provided have been removed.
ItemDocument	withRevisionId(long newRevisionId)	Returns a copy of this document with an updated revision id.
ItemDocument	withStatement(Statement statement)	Returns a new version of this document which includes the statement provided.

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

getRevisionId

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

findLabel, getLabels

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

findStatement, findStatement, findStatementEntityIdValue, findStatementEntityIdValue, findStatementGlobeCoordinatesValue, findStatementGlobeCoordinatesValue, findStatementGroup, findStatementGroup, findStatementItemIdValue, findStatementItemIdValue, findStatementMonolingualTextValue, findStatementMonolingualTextValue, findStatementPropertyIdValue, findStatementPropertyIdValue, findStatementQuantityValue, findStatementQuantityValue, findStatementStringValue, findStatementStringValue, findStatementTimeValue, findStatementTimeValue, findStatementValue, findStatementValue, getAllStatements, getStatementGroups, hasStatement, hasStatement, hasStatementValue, hasStatementValue, hasStatementValue, hasStatementValue

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

findDescription, getAliases, getDescriptions

Method Details

getEntityId

ItemIdValue getEntityId()

Return the ID of the item that the data refers to.

Specified by:

getEntityId in interface EntityDocument

Returns:

item id

getSiteLinks

Map<String,SiteLink> getSiteLinks()

Get a Map of site keys to SiteLink objects.

Returns:

map of SiteLinks

withEntityId

ItemDocument withEntityId(ItemIdValue newEntityId)

Returns a new version of this document with updated ID.

Parameters:

newEntityId - new ID of the document

Returns:

document with updated ID

withRevisionId

ItemDocument withRevisionId(long newRevisionId)

Description copied from interface: TermedDocument

Returns a copy of this document with an updated revision id.

Specified by:

withRevisionId in interface EntityDocument

Specified by:

withRevisionId in interface LabeledDocument

Specified by:

withRevisionId in interface LabeledStatementDocument

Specified by:

withRevisionId in interface StatementDocument

Specified by:

withRevisionId in interface TermedDocument

Specified by:

withRevisionId in interface TermedStatementDocument

withLabel

ItemDocument withLabel(MonolingualTextValue newLabel)

Description copied from interface: TermedDocument

Returns a new version of this document with a new label (which overrides any existing label for this language).

Specified by:

withLabel in interface LabeledDocument

Specified by:

withLabel in interface LabeledStatementDocument

Specified by:

withLabel in interface TermedDocument

Specified by:

withLabel in interface TermedStatementDocument

withDescription

ItemDocument withDescription(MonolingualTextValue newDescription)

Description copied from interface: TermedDocument

Returns a new version of this document with a new description (which overrides any existing description).

Specified by:

withDescription in interface TermedDocument

Specified by:

withDescription in interface TermedStatementDocument

withAliases

ItemDocument withAliases(String language,
 List<MonolingualTextValue> aliases)

Description copied from interface: TermedDocument

Returns a new version of this document with a new list of aliases for the given language code. Any existing aliases for this language will be discarded.

Specified by:

withAliases in interface TermedDocument

Specified by:

withAliases in interface TermedStatementDocument

Parameters:

language - the language code for which the aliases should be set

aliases - the aliases to set for this language. The language codes they contain should all match the supplied language.

withStatement

ItemDocument withStatement(Statement statement)

Description copied from interface: StatementDocument

Returns a new version of this document which includes the statement provided. If the identifier of this statement matches that of any other statement for the same property, then the existing statement will be replaced by the new one. Otherwise, the new statement will be added at the end of the list of statements in this group.

Specified by:

withStatement in interface LabeledStatementDocument

Specified by:

withStatement in interface StatementDocument

Specified by:

withStatement in interface TermedStatementDocument

Parameters:

statement - the statement to add or update in the document

withoutStatementIds

ItemDocument withoutStatementIds(Set<String> statementIds)

Description copied from interface: StatementDocument

Returns a new version of this document where all statements matching any of the statement ids provided have been removed. These statements can use different properties.

Specified by:

withoutStatementIds in interface LabeledStatementDocument

Specified by:

withoutStatementIds in interface StatementDocument

Specified by:

withoutStatementIds in interface TermedStatementDocument

Parameters:

statementIds - the identifiers of the statements to remove