Package org.wikidata.wdtk.datamodel.interfaces

Interface MediaInfoDocument

All Superinterfaces:

EntityDocument, LabeledDocument, LabeledStatementDocument, StatementDocument

All Known Implementing Classes:

MediaInfoDocumentImpl

public interface MediaInfoDocument
extends LabeledStatementDocument

Interface for datasets that describe media entities.

Author:

Thomas Pellissier Tanon

Method Summary

Modifier and Type	Method	Description
MediaInfoIdValue	getEntityId()	Returns the ID of the entity that the data refers to
MediaInfoDocument	withEntityId(MediaInfoIdValue newEntityId)	Returns a new version of this document with updated ID.
MediaInfoDocument	withLabel(MonolingualTextValue newLabel)	Returns a new version of this document with a new label (which overrides any existing label for this language).
MediaInfoDocument	withoutStatementIds(Set<String> statementIds)	Returns a new version of this document where all statements matching any of the statement ids provided have been removed.
MediaInfoDocument	withRevisionId(long newRevisionId)	Returns a copy of this document with an updated revision id.
MediaInfoDocument	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

Method Details

getEntityId

MediaInfoIdValue getEntityId()

Returns the ID of the entity that the data refers to

Specified by:

getEntityId in interface EntityDocument

Returns:

media info id

withEntityId

MediaInfoDocument withEntityId(MediaInfoIdValue newEntityId)

Returns a new version of this document with updated ID.

Parameters:

newEntityId - new ID of the document

Returns:

document with updated ID

withRevisionId

MediaInfoDocument withRevisionId(long newRevisionId)

Description copied from interface: LabeledDocument

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

withLabel

MediaInfoDocument withLabel(MonolingualTextValue newLabel)

Description copied from interface: LabeledDocument

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

withStatement

MediaInfoDocument 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

Parameters:

statement - the statement to add or update in the document

withoutStatementIds

MediaInfoDocument 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

Parameters:

statementIds - the identifiers of the statements to remove