Package org.wikidata.wdtk.datamodel.helpers

Class EntityDocumentBuilder<T extends EntityDocumentBuilder<T,O>,O>

java.lang.Object

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

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

Type Parameters:

T - the type of the eventual concrete builder implementation

O - the type of the object that is being built

Direct Known Subclasses:

ItemDocumentBuilder, PropertyDocumentBuilder

public abstract class EntityDocumentBuilder<T extends EntityDocumentBuilder<T,O>,O>
extends AbstractDataObjectBuilder<T,O>

Abstract base class for builders that construct EntityDocument objects.

Author:

Markus Kroetzsch

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EntityDocumentBuilder(EntityIdValue entityIdValue)

Method Summary

Modifier and Type	Method	Description
protected java.util.List<StatementGroup>	getStatementGroups()	Returns a list of StatementGroup objects for the currently stored statements.
T	withAlias(java.lang.String text, java.lang.String languageCode)	Adds an additional alias to the constructed document.
T	withAlias(MonolingualTextValue mtv)	Adds an additional alias to the constructed document.
T	withDescription(java.lang.String text, java.lang.String languageCode)	Adds an additional description to the constructed document.
T	withDescription(MonolingualTextValue mtv)	Adds an additional description to the constructed document.
T	withLabel(java.lang.String text, java.lang.String languageCode)	Adds an additional label to the constructed document.
T	withLabel(MonolingualTextValue mtv)	Adds an additional label to the constructed document.
T	withRevisionId(long revisionId)	Sets the revision id for the constructed document.
T	withStatement(Statement statement)	Adds an additional statement to the constructed document.

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

build, getThis, prepareBuild

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityDocumentBuilder

protected EntityDocumentBuilder(EntityIdValue entityIdValue)

Method Detail

withRevisionId

public T withRevisionId(long revisionId)

Sets the revision id for the constructed document. See EntityDocument.getRevisionId().

Parameters:

revisionId - the revision id

Returns:

builder object to continue construction

withLabel

public T withLabel(MonolingualTextValue mtv)

Adds an additional label to the constructed document.

Parameters:

mtv - the additional label

Returns:

builder object to continue construction

withLabel

public T withLabel(java.lang.String text,
                   java.lang.String languageCode)

Adds an additional label to the constructed document.

Parameters:

text - the text of the label

languageCode - the language code of the label

Returns:

builder object to continue construction

withDescription

public T withDescription(MonolingualTextValue mtv)

Adds an additional description to the constructed document.

Parameters:

mtv - the additional description

Returns:

builder object to continue construction

withDescription

public T withDescription(java.lang.String text,
                         java.lang.String languageCode)

Adds an additional description to the constructed document.

Parameters:

text - the text of the description

languageCode - the language code of the description

Returns:

builder object to continue construction

withAlias

public T withAlias(MonolingualTextValue mtv)

Adds an additional alias to the constructed document.

Parameters:

mtv - the additional alias

Returns:

builder object to continue construction

withAlias

public T withAlias(java.lang.String text,
                   java.lang.String languageCode)

Adds an additional alias to the constructed document.

Parameters:

text - the text of the alias

languageCode - the language code of the alias

Returns:

builder object to continue construction

withStatement

public T withStatement(Statement statement)

Adds an additional statement to the constructed document.

Parameters:

statement - the additional statement

Returns:

builder object to continue construction

getStatementGroups

protected java.util.List<StatementGroup> getStatementGroups()

Returns a list of StatementGroup objects for the currently stored statements.

Returns: