org.wikidata.wdtk.datamodel.helpers

Class StatementDocumentUpdateBuilder

java.lang.Object

org.wikidata.wdtk.datamodel.helpers.EntityUpdateBuilder

org.wikidata.wdtk.datamodel.helpers.StatementDocumentUpdateBuilder

Direct Known Subclasses:

FormUpdateBuilder, LabeledDocumentUpdateBuilder, LexemeUpdateBuilder, SenseUpdateBuilder

public abstract class StatementDocumentUpdateBuilder
extends EntityUpdateBuilder

Builder for incremental construction of StatementDocumentUpdate objects.

See Also:

StatementUpdateBuilder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StatementDocumentUpdateBuilder(EntityIdValue entityId, long revisionId) Initializes new builder object for constructing update of entity with given ID.
protected	StatementDocumentUpdateBuilder(StatementDocument revision) Initializes new builder object for constructing update of given base entity revision.

Method Summary

Modifier and Type	Method and Description
abstract StatementDocumentUpdate	build() Creates new StatementDocumentUpdate object with contents of this builder object.
static StatementDocumentUpdateBuilder	forBaseRevision(StatementDocument revision) Creates new builder object for constructing update of given base entity revision.
static StatementDocumentUpdateBuilder	forBaseRevisionId(EntityIdValue entityId, long revisionId) Creates new builder object for constructing update of entity with given revision ID.
static StatementDocumentUpdateBuilder	forEntityId(EntityIdValue entityId) Creates new builder object for constructing update of entity with given ID.
StatementDocumentUpdateBuilder	updateStatements(StatementUpdate update) Updates entity statements.

Methods inherited from class org.wikidata.wdtk.datamodel.helpers.EntityUpdateBuilder

forBaseRevision

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StatementDocumentUpdateBuilder

protected StatementDocumentUpdateBuilder(EntityIdValue entityId,
                                         long revisionId)

Initializes new builder object for constructing update of entity with given ID.

Parameters:

entityId - ID of the entity that is to be updated

revisionId - ID of the base entity revision to be updated or zero if not available

Throws:

NullPointerException - if entityId is null

IllegalArgumentException - if entityId is a placeholder ID

StatementDocumentUpdateBuilder

protected StatementDocumentUpdateBuilder(StatementDocument revision)

Initializes new builder object for constructing update of given base entity revision.

Parameters:

revision - base entity revision to be updated

Throws:

NullPointerException - if revision is null

IllegalArgumentException - if revision has placeholder ID

Method Detail

forBaseRevisionId

public static StatementDocumentUpdateBuilder forBaseRevisionId(EntityIdValue entityId,
                                                               long revisionId)

Creates new builder object for constructing update of entity with given revision ID.

Supported entity IDs include ItemIdValue, PropertyIdValue, LexemeIdValue, FormIdValue, SenseIdValue, and MediaInfoIdValue.

Parameters:

entityId - ID of the entity that is to be updated

revisionId - ID of the base entity revision to be updated or zero if not available

Returns:

builder object matching entity type

Throws:

NullPointerException - if entityId is null

IllegalArgumentException - if entityId is of unrecognized type or it is a placeholder ID

forEntityId

public static StatementDocumentUpdateBuilder forEntityId(EntityIdValue entityId)

Creates new builder object for constructing update of entity with given ID.

Supported entity IDs include ItemIdValue, PropertyIdValue, LexemeIdValue, FormIdValue, SenseIdValue, and MediaInfoIdValue.

Parameters:

entityId - ID of the entity that is to be updated

Returns:

builder object matching entity type

Throws:

NullPointerException - if entityId is null

IllegalArgumentException - if entityId is of unrecognized type or it is a placeholder ID

forBaseRevision

public static StatementDocumentUpdateBuilder forBaseRevision(StatementDocument revision)

Creates new builder object for constructing update of given base entity revision. Provided entity document might not represent the latest revision of the entity as currently stored in Wikibase. It will be used for validation in builder methods. If the document has revision ID, it will be used to detect edit conflicts.

Supported entity types include ItemDocument, PropertyDocument, LexemeDocument, FormDocument, SenseDocument, and MediaInfoDocument.

Parameters:

revision - base entity revision to be updated

Returns:

builder object matching entity type

Throws:

NullPointerException - if revision is null

IllegalArgumentException - if revision is of unrecognized type or its ID is a placeholder ID

updateStatements

public StatementDocumentUpdateBuilder updateStatements(StatementUpdate update)

Updates entity statements. If this method is called multiple times, changes are accumulated. If base entity revision was provided, the update is checked against it and redundant changes are silently ignored, resulting in empty update.

Parameters:

update - statement update, possibly empty

Returns:

this (fluent method)

Throws:

NullPointerException - if update is null

IllegalArgumentException - if replaced or removed statement is not present in current entity revision (if available)

build

public abstract StatementDocumentUpdate build()

Creates new StatementDocumentUpdate object with contents of this builder object.

Specified by:

build in class EntityUpdateBuilder

Returns:

constructed object