Package org.wikidata.wdtk.datamodel.interfaces

Interface TermedStatementDocument

All Superinterfaces:

EntityDocument, LabeledDocument, LabeledStatementDocument, StatementDocument, TermedDocument

All Known Subinterfaces:

ItemDocument, PropertyDocument

All Known Implementing Classes:

ItemDocumentImpl, PropertyDocumentImpl, TermedStatementDocumentImpl

public interface TermedStatementDocument
extends TermedDocument, LabeledStatementDocument

This interface just joins TermedDocument and StatementDocument. It is necessary to introduce this interface because the conflict between the return types of the withRevisionId method in both interfaces needs to be resolved.

Author:

antonin

Method Summary

Modifier and Type	Method	Description
TermedStatementDocument	withAliases(String language, List<MonolingualTextValue> aliases)	Returns a new version of this document with a new list of aliases for the given language code.
TermedStatementDocument	withDescription(MonolingualTextValue newDescription)	Returns a new version of this document with a new description (which overrides any existing description).
TermedStatementDocument	withLabel(MonolingualTextValue newLabel)	Returns a new version of this document with a new label (which overrides any existing label for this language).
TermedStatementDocument	withoutStatementIds(Set<String> statementIds)	Returns a new version of this document where all statements matching any of the statement ids provided have been removed.
TermedStatementDocument	withRevisionId(long newRevisionId)	Returns a copy of this document with an updated revision id.
TermedStatementDocument	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

getEntityId, 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

withRevisionId

TermedStatementDocument 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

withLabel

TermedStatementDocument 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

withDescription

TermedStatementDocument 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

withAliases

TermedStatementDocument 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

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

TermedStatementDocument 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

TermedStatementDocument 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