org.wikidata.wdtk.datamodel.interfaces

Interface DataObjectFactory

All Known Implementing Classes:

DataObjectFactoryImpl, JacksonObjectFactory

public interface DataObjectFactory

Interface for factories that create data objects that implement the interfaces from this package.

Author:

Markus Kroetzsch

Method Summary

Methods

Modifier and Type	Method and Description
Claim	getClaim(EntityIdValue subject, Snak mainSnak, List<SnakGroup> qualifiers) Creates a Claim.
DatatypeIdValue	getDatatypeIdValue(String id) Creates a DatatypeIdValue.
GlobeCoordinatesValue	getGlobeCoordinatesValue(long latitude, long longitude, long precision, String globeIri) Creates a GlobeCoordinatesValue.
ItemDocument	getItemDocument(ItemIdValue itemIdValue, List<MonolingualTextValue> labels, List<MonolingualTextValue> descriptions, List<MonolingualTextValue> aliases, List<StatementGroup> statementGroups, Map<String,SiteLink> siteLinks) Creates an ItemDocument.
ItemIdValue	getItemIdValue(String id, String siteIri) Creates an ItemIdValue.
MonolingualTextValue	getMonolingualTextValue(String text, String languageCode) Creates a MonolingualTextValue.
NoValueSnak	getNoValueSnak(PropertyIdValue propertyId) Creates a NoValueSnak.
PropertyDocument	getPropertyDocument(PropertyIdValue propertyId, List<MonolingualTextValue> labels, List<MonolingualTextValue> descriptions, List<MonolingualTextValue> aliases, DatatypeIdValue datatypeId) Creates a PropertyDocument.
PropertyIdValue	getPropertyIdValue(String id, String siteIri) Creates a PropertyIdValue.
QuantityValue	getQuantityValue(BigDecimal numericValue, BigDecimal lowerBound, BigDecimal upperBound) Creates a QuantityValue.
Reference	getReference(List<SnakGroup> snakGroups) Creates a Reference.
SiteLink	getSiteLink(String title, String siteKey, List<String> badges) Creates a SiteLink.
SnakGroup	getSnakGroup(List<? extends Snak> snaks) Creates a SnakGroup.
SomeValueSnak	getSomeValueSnak(PropertyIdValue propertyId) Creates a SomeValueSnak.
Statement	getStatement(Claim claim, List<? extends Reference> references, StatementRank rank, String statementId) Creates a Statement.
StatementGroup	getStatementGroup(List<Statement> statements) Creates a StatementGroup.
StringValue	getStringValue(String string) Creates a StringValue.
TimeValue	getTimeValue(long year, byte month, byte day, byte hour, byte minute, byte second, byte precision, int beforeTolerance, int afterTolerance, int timezoneOffset, String calendarModel) Creates a TimeValue.
ValueSnak	getValueSnak(PropertyIdValue propertyId, Value value) Creates a ValueSnak.

Method Detail

getItemIdValue

ItemIdValue getItemIdValue(String id,
                         String siteIri)

Creates an ItemIdValue.

Parameters:

id - a string of the form Qn... where n... is the string representation of a positive integer number

siteIri - IRI to identify the site, usually the first part of the entity IRI of the site this belongs to, e.g., "http://www.wikidata.org/entity/"

Returns:

an ItemIdValue corresponding to the input

getPropertyIdValue

PropertyIdValue getPropertyIdValue(String id,
                                 String siteIri)

Creates a PropertyIdValue.

Parameters:

id - a string of the form Pn... where n... is the string representation of a positive integer number

siteIri - IRI to identify the site, usually the first part of the entity IRI of the site this belongs to, e.g., "http://www.wikidata.org/entity/"

Returns:

a PropertyIdValue corresponding to the input

getDatatypeIdValue

DatatypeIdValue getDatatypeIdValue(String id)

Creates a DatatypeIdValue. The datatype IRI is usually one of the constants defined in DatatypeIdValue, but this is not enforced, since there might be extensions that provide additional types.

Parameters:

id - the IRI string that identifies the datatype

Returns:

a DatatypeIdValue corresponding to the input

getTimeValue

TimeValue getTimeValue(long year,
                     byte month,
                     byte day,
                     byte hour,
                     byte minute,
                     byte second,
                     byte precision,
                     int beforeTolerance,
                     int afterTolerance,
                     int timezoneOffset,
                     String calendarModel)

Creates a TimeValue.

Parameters:

year - a year number, where 0 refers to 1BCE

month - a month number between 1 and 12

day - a day number between 1 and 31

hour - an hour number between 0 and 23

minute - a minute number between 0 and 59

second - a second number between 0 and 60 (possible leap second)

precision - a value in the range of TimeValue.PREC_DAY, ..., TimeValue.PREC_1GY

beforeTolerance - non-negative integer tolerance before the value; see TimeValue.getBeforeTolerance()

afterTolerance - non-zero, positive integer tolerance before the value; see TimeValue.getAfterTolerance()

calendarModel - the IRI of the calendar model preferred when displaying the date; usually TimeValue.CM_GREGORIAN_PRO or TimeValue.CM_JULIAN_PRO

timezoneOffset - offset in minutes that should be applied when displaying this time

Returns:

a TimeValue corresponding to the input

getGlobeCoordinatesValue

GlobeCoordinatesValue getGlobeCoordinatesValue(long latitude,
                                             long longitude,
                                             long precision,
                                             String globeIri)

Creates a GlobeCoordinatesValue.

Parameters:

latitude - the latitude of the coordinates in nanodegrees

longitude - the longitude of the coordinates in nanodegrees

precision - the precision of the coordinates in nanodegrees

globeIri - IRI specifying the celestial objects of the coordinates

Returns:

a GlobeCoordinatesValue corresponding to the input

getStringValue

StringValue getStringValue(String string)

Creates a StringValue.

Parameters:

string -

Returns:

a StringValue corresponding to the input

getMonolingualTextValue

MonolingualTextValue getMonolingualTextValue(String text,
                                           String languageCode)

Creates a MonolingualTextValue.

Parameters:

text - the text of the value

languageCode - the language code of the value

Returns:

a MonolingualTextValue corresponding to the input

getQuantityValue

QuantityValue getQuantityValue(BigDecimal numericValue,
                             BigDecimal lowerBound,
                             BigDecimal upperBound)

Creates a QuantityValue.

Parameters:

numericValue - the numeric value of this quantity

lowerBound - the lower bound of the numeric value of this quantity

upperBound - the upper bound of the numeric value of this quantity

Returns:

a QuantityValue corresponding to the input

getValueSnak

ValueSnak getValueSnak(PropertyIdValue propertyId,
                     Value value)

Creates a ValueSnak.

Parameters:

propertyId -

value -

Returns:

a ValueSnak corresponding to the input

getSomeValueSnak

SomeValueSnak getSomeValueSnak(PropertyIdValue propertyId)

Creates a SomeValueSnak.

Parameters:

propertyId -

Returns:

a SomeValueSnak corresponding to the input

getNoValueSnak

NoValueSnak getNoValueSnak(PropertyIdValue propertyId)

Creates a NoValueSnak.

Parameters:

propertyId -

Returns:

a NoValueSnak corresponding to the input

getSnakGroup

SnakGroup getSnakGroup(List<? extends Snak> snaks)

Creates a SnakGroup.

Parameters:

snaks - a non-empty list of snaks that use the same property

Returns:

a SnakGroup corresponding to the input

getClaim

Claim getClaim(EntityIdValue subject,
             Snak mainSnak,
             List<SnakGroup> qualifiers)

Creates a Claim.

Parameters:

subject - the subject the Statement refers to

mainSnak - the main Snak of the Statement

qualifiers - the qualifiers of the Statement, grouped in SnakGroups

Returns:

a Claim corresponding to the input

getReference

Reference getReference(List<SnakGroup> snakGroups)

Creates a Reference.

Parameters:

snakGroups - list of snak groups

Returns:

a Reference corresponding to the input

getStatement

Statement getStatement(Claim claim,
                     List<? extends Reference> references,
                     StatementRank rank,
                     String statementId)

Creates a Statement.

The string id is used mainly for communication with a Wikibase site, in order to refer to statements of that site. When creating new statements that are not on any site, the empty string can be used.

Parameters:

claim - the main claim the Statement refers to

references - the references for the Statement

rank - the rank of the Statement

statementId - the string id of the Statement

Returns:

a Statement corresponding to the input

getStatementGroup

StatementGroup getStatementGroup(List<Statement> statements)

Creates a StatementGroup.

Parameters:

statements - a non-empty list of statements that use the same subject and main-snak property in their claim

Returns:

a StatementGroup corresponding to the input

getSiteLink

SiteLink getSiteLink(String title,
                   String siteKey,
                   List<String> badges)

Creates a SiteLink.

Parameters:

title - the title string of the linked page, including namespace prefixes if any

siteKey - the string key of the site of the linked article

badges - the list of badges of the linked article

Returns:

a SiteLink corresponding to the input

getPropertyDocument

PropertyDocument getPropertyDocument(PropertyIdValue propertyId,
                                   List<MonolingualTextValue> labels,
                                   List<MonolingualTextValue> descriptions,
                                   List<MonolingualTextValue> aliases,
                                   DatatypeIdValue datatypeId)

Creates a PropertyDocument.

Parameters:

propertyId - the id of the property that data is about

labels - the list of labels of this property, with at most one label for each language code

descriptions - the list of descriptions of this property, with at most one description for each language code

aliases - the list of aliases of this property

datatypeId - the datatype of that property

Returns:

a PropertyDocument corresponding to the input

getItemDocument

ItemDocument getItemDocument(ItemIdValue itemIdValue,
                           List<MonolingualTextValue> labels,
                           List<MonolingualTextValue> descriptions,
                           List<MonolingualTextValue> aliases,
                           List<StatementGroup> statementGroups,
                           Map<String,SiteLink> siteLinks)

Creates an ItemDocument.

Parameters:

itemIdValue - the id of the item that data is about

labels - the list of labels of this item, with at most one label for each language code

descriptions - the list of descriptions of this item, with at most one description for each language code

aliases - the list of aliases of this item

statementGroups - the list of statement groups of this item; all of them must have the given itemIdValue as their subject

siteLinks - the sitelinks of this item by site key

Returns:

an ItemDocument corresponding to the input