org.wikidata.wdtk.datamodel.helpers

Class LabeledDocumentUpdateBuilder

java.lang.Object

org.wikidata.wdtk.datamodel.helpers.EntityUpdateBuilder

org.wikidata.wdtk.datamodel.helpers.StatementDocumentUpdateBuilder

org.wikidata.wdtk.datamodel.helpers.LabeledDocumentUpdateBuilder

Direct Known Subclasses:

MediaInfoUpdateBuilder, TermedDocumentUpdateBuilder

public abstract class LabeledDocumentUpdateBuilder
extends StatementDocumentUpdateBuilder

Builder for incremental construction of LabeledStatementDocumentUpdate objects.

Constructor Summary

Constructors

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

Method Summary

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

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

forBaseRevision

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

LabeledDocumentUpdateBuilder

protected LabeledDocumentUpdateBuilder(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

LabeledDocumentUpdateBuilder

protected LabeledDocumentUpdateBuilder(LabeledStatementDocument 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 LabeledDocumentUpdateBuilder forBaseRevisionId(EntityIdValue entityId,
                                                             long revisionId)

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

Supported entity IDs include ItemIdValue, PropertyIdValue, 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 LabeledDocumentUpdateBuilder forEntityId(EntityIdValue entityId)

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

Supported entity IDs include ItemIdValue, PropertyIdValue, 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 LabeledDocumentUpdateBuilder forBaseRevision(LabeledStatementDocument 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, 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 LabeledDocumentUpdateBuilder updateStatements(StatementUpdate update)

Description copied from class: StatementDocumentUpdateBuilder

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.

Overrides:

updateStatements in class StatementDocumentUpdateBuilder

Parameters:

update - statement update, possibly empty

Returns:

this (fluent method)

updateLabels

public LabeledDocumentUpdateBuilder updateLabels(TermUpdate update)

Updates entity labels. If this method is called multiple times, changes are accumulated. If base entity revision was provided, redundant changes are silently ignored, resulting in empty update.

Parameters:

update - changes in entity labels

Returns:

this (fluent method)

Throws:

NullPointerException - if update is null

build

public abstract LabeledStatementDocumentUpdate build()

Creates new LabeledStatementDocumentUpdate object with contents of this builder object.

Specified by:

build in class StatementDocumentUpdateBuilder

Returns:

constructed object