org.wikidata.wdtk.datamodel.helpers

Class PropertyDocumentBuilder

java.lang.Object

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

org.wikidata.wdtk.datamodel.helpers.EntityDocumentBuilder<PropertyDocumentBuilder,PropertyDocument>

org.wikidata.wdtk.datamodel.helpers.PropertyDocumentBuilder

public class PropertyDocumentBuilder
extends EntityDocumentBuilder<PropertyDocumentBuilder,PropertyDocument>

Builder class to construct PropertyDocument objects.

Author:

Markus Kroetzsch

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PropertyDocumentBuilder(PropertyDocument initialDocument) Constructor when building the property document from an existing one.
protected	PropertyDocumentBuilder(PropertyIdValue propertyIdValue, DatatypeIdValue datatype) Constructor when building the property document from scratch.

Method Summary

Modifier and Type	Method and Description
PropertyDocument	build() Returns the ItemDocument that has been built.
static PropertyDocumentBuilder	forPropertyIdAndDatatype(PropertyIdValue propertyIdValue, DatatypeIdValue datatype) Starts the construction of an PropertyDocument with the given id.
static PropertyDocumentBuilder	forPropertyIdAndDatatype(PropertyIdValue propertyIdValue, String datatypeId) Deprecated. use forPropertyIdAndJsonDatatype(PropertyIdValue, String)
static PropertyDocumentBuilder	forPropertyIdAndJsonDatatype(PropertyIdValue propertyIdValue, String datatypeId) Starts the construction of an PropertyDocument with the given id.
static PropertyDocumentBuilder	fromPropertyDocument(PropertyDocument initialDocument) Starts the construction of an PropertyDocument from the existing document.
protected PropertyDocumentBuilder	getThis() Returns the current object with the correct builder type.
PropertyDocumentBuilder	withEntityId(EntityIdValue entityId) Changes the entity value id for 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

PropertyDocumentBuilder

protected PropertyDocumentBuilder(PropertyIdValue propertyIdValue,
                                  DatatypeIdValue datatype)

Constructor when building the property document from scratch.

Parameters:

propertyIdValue - id of the newly constructed property document

datatype - the datatype of the newly constructed property document

PropertyDocumentBuilder

protected PropertyDocumentBuilder(PropertyDocument initialDocument)

Constructor when building the property document from an existing one.

Parameters:

initialDocument - the initial property document to start the build from

Method Detail

forPropertyIdAndDatatype

public static PropertyDocumentBuilder forPropertyIdAndDatatype(PropertyIdValue propertyIdValue,
                                                               DatatypeIdValue datatype)

Starts the construction of an PropertyDocument with the given id.

Parameters:

propertyIdValue - id of the newly constructed property document

datatype - the datatype of the newly constructed property document

Returns:

builder object to continue construction

fromPropertyDocument

public static PropertyDocumentBuilder fromPropertyDocument(PropertyDocument initialDocument)

Starts the construction of an PropertyDocument from the existing document.

Parameters:

initialDocument - the existing document to start the build from

Returns:

builder object to continue construction

forPropertyIdAndDatatype

public static PropertyDocumentBuilder forPropertyIdAndDatatype(PropertyIdValue propertyIdValue,
                                                               String datatypeId)

Deprecated. use forPropertyIdAndJsonDatatype(PropertyIdValue, String)

Starts the construction of an PropertyDocument with the given id.

Parameters:

propertyIdValue - id of the newly constructed property document

datatypeId - the datatype id of the newly constructed property document, e.g., DatatypeIdValue.DT_ITEM.

Returns:

builder object to continue construction

forPropertyIdAndJsonDatatype

public static PropertyDocumentBuilder forPropertyIdAndJsonDatatype(PropertyIdValue propertyIdValue,
                                                                   String datatypeId)

Starts the construction of an PropertyDocument with the given id.

Parameters:

propertyIdValue - id of the newly constructed property document

datatypeId - the datatype id of the newly constructed property document, e.g., DatatypeIdValue.DT_ITEM.

Returns:

builder object to continue construction

withEntityId

public PropertyDocumentBuilder withEntityId(EntityIdValue entityId)

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

Overrides:

withEntityId in class EntityDocumentBuilder<PropertyDocumentBuilder,PropertyDocument>

Parameters:

entityId - the entity id, which must be an ItemIdValue

Returns:

builder object to continue construction

build

public PropertyDocument build()

Returns the ItemDocument that has been built.

Specified by:

build in class AbstractDataObjectBuilder<PropertyDocumentBuilder,PropertyDocument>

Returns:

constructed item document

Throws:

IllegalStateException - if the object was built already

getThis

protected PropertyDocumentBuilder getThis()

Description copied from class: AbstractDataObjectBuilder

Returns the current object with the correct builder type.

Specified by:

getThis in class AbstractDataObjectBuilder<PropertyDocumentBuilder,PropertyDocument>

Returns:

this