org.wikidata.wdtk.datamodel.helpers

Class ItemDocumentBuilder

java.lang.Object

org.wikidata.wdtk.datamodel.helpers.AbstractDataObjectBuilder<T,O>

org.wikidata.wdtk.datamodel.helpers.EntityDocumentBuilder<ItemDocumentBuilder,ItemDocument>

org.wikidata.wdtk.datamodel.helpers.ItemDocumentBuilder

public class ItemDocumentBuilder
extends EntityDocumentBuilder<ItemDocumentBuilder,ItemDocument>

Builder class to construct ItemDocument objects.

Author:

Markus Kroetzsch

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ItemDocumentBuilder(ItemDocument initialDocument) Constructor to start the build from an existing item.
protected	ItemDocumentBuilder(ItemIdValue itemIdValue) Constructor to start the build from a blank item.

Method Summary

Modifier and Type	Method and Description
ItemDocument	build() Returns the ItemDocument that has been built.
static ItemDocumentBuilder	forItemId(ItemIdValue itemIdValue) Starts the construction of an ItemDocument with the given id.
static ItemDocumentBuilder	fromItemDocument(ItemDocument initialDocument) Starts the construction of an ItemDocument from an existing value.
protected ItemDocumentBuilder	getThis() Returns the current object with the correct builder type.
ItemDocumentBuilder	withEntityId(EntityIdValue entityId) Changes the entity value id for the constructed document.
ItemDocumentBuilder	withSiteLink(SiteLink siteLink) Adds an additional site link to the constructed document.
ItemDocumentBuilder	withSiteLink(String title, String siteKey, ItemIdValue... badges) Adds an additional site link to the constructed document.

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

getStatementGroups, withAlias, withAlias, withDescription, withDescription, withLabel, withLabel, withRevisionId, withStatement

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

prepareBuild

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemDocumentBuilder

protected ItemDocumentBuilder(ItemIdValue itemIdValue)

Constructor to start the build from a blank item.

Parameters:

itemIdValue -

ItemDocumentBuilder

protected ItemDocumentBuilder(ItemDocument initialDocument)

Constructor to start the build from an existing item.

Parameters:

initialDocument - the item to start the build from

Method Detail

forItemId

public static ItemDocumentBuilder forItemId(ItemIdValue itemIdValue)

Starts the construction of an ItemDocument with the given id.

Parameters:

itemIdValue - id of the newly constructed item document

Returns:

builder object to continue construction

fromItemDocument

public static ItemDocumentBuilder fromItemDocument(ItemDocument initialDocument)

Starts the construction of an ItemDocument from an existing value.

Parameters:

initialDocument - the item to start the construction from

Returns:

builder object to continue construction

build

public ItemDocument build()

Returns the ItemDocument that has been built.

Specified by:

build in class AbstractDataObjectBuilder<ItemDocumentBuilder,ItemDocument>

Returns:

constructed item document

Throws:

IllegalStateException - if the object was built already

withSiteLink

public ItemDocumentBuilder withSiteLink(SiteLink siteLink)

Adds an additional site link to the constructed document.

Parameters:

siteLink - the additional site link

withSiteLink

public ItemDocumentBuilder withSiteLink(String title,
                                        String siteKey,
                                        ItemIdValue... badges)

Adds an additional site link to the constructed document.

Parameters:

title - the title of the linked page

siteKey - identifier of the site, e.g., "enwiki"

badges - one or more badges

withEntityId

public ItemDocumentBuilder withEntityId(EntityIdValue entityId)

Changes the entity value id for the constructed document. See EntityDocument.getEntityId().

Overrides:

withEntityId in class EntityDocumentBuilder<ItemDocumentBuilder,ItemDocument>

Parameters:

entityId - the entity id, which must be an ItemIdValue

Returns:

builder object to continue construction

getThis

protected ItemDocumentBuilder getThis()

Description copied from class: AbstractDataObjectBuilder

Returns the current object with the correct builder type.

Specified by:

getThis in class AbstractDataObjectBuilder<ItemDocumentBuilder,ItemDocument>

Returns:

this