org.wikidata.wdtk.datamodel.helpers

Class Datamodel

java.lang.Object

org.wikidata.wdtk.datamodel.helpers.Datamodel

public class Datamodel
extends Object

This class contains static methods to create WDTK data objects. This is the preferred way of creating data objects in WDTK.

Author:

Markus Kroetzsch

Field Summary

Fields

Modifier and Type	Field and Description
static String	SITE_WIKIDATA The site IRI of Wikidata.

Constructor Summary

Constructors

Constructor and Description
Datamodel()

Method Summary

Methods

Modifier and Type	Method and Description
static Claim	makeClaim(EntityIdValue subject, Snak mainSnak, List<SnakGroup> qualifiers) Creates a Claim.
static DatatypeIdValue	makeDatatypeIdValue(String id) Creates a DatatypeIdValue.
static GlobeCoordinatesValue	makeGlobeCoordinatesValue(long latitude, long longitude, long precision, String globeIri) Creates a GlobeCoordinatesValue.
static ItemDocument	makeItemDocument(ItemIdValue itemIdValue, List<MonolingualTextValue> labels, List<MonolingualTextValue> descriptions, List<MonolingualTextValue> aliases, List<StatementGroup> statementGroups, Map<String,SiteLink> siteLinks) Creates an ItemDocument.
static ItemIdValue	makeItemIdValue(String id, String siteIri) Creates an ItemIdValue.
static MonolingualTextValue	makeMonolingualTextValue(String text, String languageCode) Creates a MonolingualTextValue.
static NoValueSnak	makeNoValueSnak(PropertyIdValue propertyId) Creates a NoValueSnak.
static PropertyDocument	makePropertyDocument(PropertyIdValue propertyId, List<MonolingualTextValue> labels, List<MonolingualTextValue> descriptions, List<MonolingualTextValue> aliases, DatatypeIdValue datatypeId) Creates a PropertyDocument.
static PropertyIdValue	makePropertyIdValue(String id, String siteIri) Creates a PropertyIdValue.
static QuantityValue	makeQuantityValue(BigDecimal numericValue, BigDecimal lowerBound, BigDecimal upperBound) Creates a QuantityValue.
static QuantityValue	makeQuantityValue(long numericValue, long lowerBound, long upperBound) Creates a QuantityValue from long numbers.
static Reference	makeReference(List<SnakGroup> snakGroups) Creates a Reference.
static SiteLink	makeSiteLink(String title, String siteKey, List<String> badges) Creates a SiteLink.
static SnakGroup	makeSnakGroup(List<? extends Snak> snaks) Creates a SnakGroup.
static SomeValueSnak	makeSomeValueSnak(PropertyIdValue propertyId) Creates a SomeValueSnak.
static Statement	makeStatement(Claim claim, List<? extends Reference> references, StatementRank rank, String statementId) Creates a Statement.
static StatementGroup	makeStatementGroup(List<Statement> statements) Creates a StatementGroup.
static StringValue	makeStringValue(String string) Creates a StringValue.
static TimeValue	makeTimeValue(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.
static TimeValue	makeTimeValue(long year, byte month, byte day, byte hour, byte minute, byte second, int timezoneOffset, String calendarModel) Creates a TimeValue for a given date and time.
static TimeValue	makeTimeValue(long year, byte month, byte day, String calendarModel) Creates a TimeValue for a given date.
static ValueSnak	makeValueSnak(PropertyIdValue propertyId, Value value) Creates a ValueSnak.
static ItemIdValue	makeWikidataItemIdValue(String id) Creates an ItemIdValue for Wikidata.
static PropertyIdValue	makeWikidataPropertyIdValue(String id) Creates a PropertyIdValue.

Methods inherited from class java.lang.Object

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

Field Detail

SITE_WIKIDATA

public static String SITE_WIKIDATA

The site IRI of Wikidata.

Constructor Detail

Datamodel

public Datamodel()

Method Detail

makeItemIdValue

public static ItemIdValue makeItemIdValue(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

makeWikidataItemIdValue

public static ItemIdValue makeWikidataItemIdValue(String id)

Creates an ItemIdValue for Wikidata.

Parameters:

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

Returns:

an ItemIdValue corresponding to the input

makePropertyIdValue

public static PropertyIdValue makePropertyIdValue(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

makeWikidataPropertyIdValue

public static PropertyIdValue makeWikidataPropertyIdValue(String id)

Creates a PropertyIdValue.

Parameters:

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

Returns:

a PropertyIdValue corresponding to the input

makeDatatypeIdValue

public static DatatypeIdValue makeDatatypeIdValue(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

makeTimeValue

public static TimeValue makeTimeValue(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()

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

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

Returns:

a TimeValue corresponding to the input

makeTimeValue

public static TimeValue makeTimeValue(long year,
                      byte month,
                      byte day,
                      byte hour,
                      byte minute,
                      byte second,
                      int timezoneOffset,
                      String calendarModel)

Creates a TimeValue for a given date and time. The precision is automatically set to TimeValue.PREC_SECOND.

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)

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

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

Returns:

a TimeValue corresponding to the input

makeTimeValue

public static TimeValue makeTimeValue(long year,
                      byte month,
                      byte day,
                      String calendarModel)

Creates a TimeValue for a given date. The precision is automatically set to TimeValue.PREC_DAY.

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

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

Returns:

a TimeValue corresponding to the input

makeGlobeCoordinatesValue

public static GlobeCoordinatesValue makeGlobeCoordinatesValue(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

makeStringValue

public static StringValue makeStringValue(String string)

Creates a StringValue.

Parameters:

string -

Returns:

a StringValue corresponding to the input

makeMonolingualTextValue

public static MonolingualTextValue makeMonolingualTextValue(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

makeQuantityValue

public static QuantityValue makeQuantityValue(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

makeQuantityValue

public static QuantityValue makeQuantityValue(long numericValue,
                              long lowerBound,
                              long upperBound)

Creates a QuantityValue from long numbers.

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

makeValueSnak

public static ValueSnak makeValueSnak(PropertyIdValue propertyId,
                      Value value)

Creates a ValueSnak.

Parameters:

propertyId -

value -

Returns:

a ValueSnak corresponding to the input

makeSomeValueSnak

public static SomeValueSnak makeSomeValueSnak(PropertyIdValue propertyId)

Creates a SomeValueSnak.

Parameters:

propertyId -

Returns:

a SomeValueSnak corresponding to the input

makeNoValueSnak

public static NoValueSnak makeNoValueSnak(PropertyIdValue propertyId)

Creates a NoValueSnak.

Parameters:

propertyId -

Returns:

a NoValueSnak corresponding to the input

makeSnakGroup

public static SnakGroup makeSnakGroup(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

makeClaim

public static Claim makeClaim(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

makeReference

public static Reference makeReference(List<SnakGroup> snakGroups)

Creates a Reference.

Parameters:

snakGroups - list of snak groups

Returns:

a Reference corresponding to the input

makeStatement

public static Statement makeStatement(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

makeStatementGroup

public static StatementGroup makeStatementGroup(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

makeSiteLink

public static SiteLink makeSiteLink(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

makePropertyDocument

public static PropertyDocument makePropertyDocument(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

makeItemDocument

public static ItemDocument makeItemDocument(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