Package org.wikidata.wdtk.datamodel.interfaces

Interface DataObjectFactory

All Known Implementing Classes:

DataObjectFactoryImpl

public interface DataObjectFactory

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

Author:

Markus Kroetzsch

Method Summary

Modifier and Type	Method	Description
AliasUpdate	getAliasUpdate(List<MonolingualTextValue> recreated, List<MonolingualTextValue> added, Collection<MonolingualTextValue> removed)	Creates new AliasUpdate.
Claim	getClaim(EntityIdValue subject, Snak mainSnak, List<SnakGroup> qualifiers)	Creates a Claim.
DatatypeIdValue	getDatatypeIdValue(String id)	Deprecated. use getDatatypeIdValueFromJsonId(String)
DatatypeIdValue	getDatatypeIdValueFromJsonId(String jsonId)	Creates a DatatypeIdValue.
FormDocument	getFormDocument(FormIdValue formIdValue, List<MonolingualTextValue> representations, List<ItemIdValue> grammaticalFeatures, List<StatementGroup> statementGroups, long revisionId)	Creates an FormDocument.
FormIdValue	getFormIdValue(String id, String siteIri)	Creates a FormIdValue.
FormUpdate	getFormUpdate(FormIdValue entityId, long revisionId, TermUpdate representations, Collection<ItemIdValue> grammaticalFeatures, StatementUpdate statements)	Creates new FormUpdate.
GlobeCoordinatesValue	getGlobeCoordinatesValue(double latitude, double longitude, double 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, long revisionId)	Creates an ItemDocument.
ItemIdValue	getItemIdValue(String id, String siteIri)	Creates an ItemIdValue.
ItemUpdate	getItemUpdate(ItemIdValue entityId, long revisionId, TermUpdate labels, TermUpdate descriptions, Map<String,AliasUpdate> aliases, StatementUpdate statements, Collection<SiteLink> modifiedSiteLinks, Collection<String> removedSiteLinks)	Creates new ItemUpdate.
LexemeDocument	getLexemeDocument(LexemeIdValue lexemeIdValue, ItemIdValue lexicalCategory, ItemIdValue language, List<MonolingualTextValue> lemmas, List<StatementGroup> statementGroups, List<FormDocument> forms, List<SenseDocument> senses, long revisionId)	Creates an LexemeDocument.
LexemeIdValue	getLexemeIdValue(String id, String siteIri)	Creates a LexemeIdValue.
LexemeUpdate	getLexemeUpdate(LexemeIdValue entityId, long revisionId, ItemIdValue language, ItemIdValue lexicalCategory, TermUpdate lemmas, StatementUpdate statements, Collection<SenseDocument> addedSenses, Collection<SenseUpdate> updatedSenses, Collection<SenseIdValue> removedSenses, Collection<FormDocument> addedForms, Collection<FormUpdate> updatedForms, Collection<FormIdValue> removedForms)	Creates new LexemeUpdate.
MediaInfoDocument	getMediaInfoDocument(MediaInfoIdValue mediaInfoIdValue, List<MonolingualTextValue> labels, List<StatementGroup> statementGroups, long revisionId)	Creates a MediaInfoDocument.
MediaInfoIdValue	getMediaInfoIdValue(String id, String siteIri)	Creates a MediaInfoIdValue.
MediaInfoUpdate	getMediaInfoUpdate(MediaInfoIdValue entityId, long revisionId, TermUpdate labels, StatementUpdate statements)	Creates new MediaInfoUpdate.
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, List<StatementGroup> statementGroups, DatatypeIdValue datatypeId, long revisionId)	Creates a PropertyDocument.
PropertyIdValue	getPropertyIdValue(String id, String siteIri)	Creates a PropertyIdValue.
PropertyUpdate	getPropertyUpdate(PropertyIdValue entityId, long revisionId, TermUpdate labels, TermUpdate descriptions, Map<String,AliasUpdate> aliases, StatementUpdate statements)	Creates new PropertyUpdate.
QuantityValue	getQuantityValue(BigDecimal numericValue)	Creates a QuantityValue without a unit of measurement and bounds.
QuantityValue	getQuantityValue(BigDecimal numericValue, String unit)	Deprecated. use getQuantityValue(BigDecimal, ItemIdValue)
QuantityValue	getQuantityValue(BigDecimal numericValue, BigDecimal lowerBound, BigDecimal upperBound)	Creates a QuantityValue without a unit of measurement.
QuantityValue	getQuantityValue(BigDecimal numericValue, BigDecimal lowerBound, BigDecimal upperBound, String unit)	Deprecated. use getQuantityValue(BigDecimal, BigDecimal, BigDecimal, ItemIdValue)
QuantityValue	getQuantityValue(BigDecimal numericValue, BigDecimal lowerBound, BigDecimal upperBound, ItemIdValue unit)	Creates a QuantityValue.
QuantityValue	getQuantityValue(BigDecimal numericValue, ItemIdValue unit)	Creates a QuantityValue without bounds.
Reference	getReference(List<SnakGroup> snakGroups)	Creates a Reference.
SenseDocument	getSenseDocument(SenseIdValue senseIdValue, List<MonolingualTextValue> glosses, List<StatementGroup> statementGroups, long revisionId)	Creates a SenseDocument.
SenseIdValue	getSenseIdValue(String id, String siteIri)	Creates a SenseIdValue.
SenseUpdate	getSenseUpdate(SenseIdValue entityId, long revisionId, TermUpdate glosses, StatementUpdate statements)	Creates new SenseUpdate.
SiteLink	getSiteLink(String title, String siteKey, List<ItemIdValue> 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<Reference> references, StatementRank rank, String statementId)	Creates a Statement.
Statement	getStatement(EntityIdValue subject, Snak mainSnak, List<SnakGroup> qualifiers, List<Reference> references, StatementRank rank, String statementId)	Creates a Statement.
StatementGroup	getStatementGroup(List<Statement> statements)	Creates a StatementGroup.
StatementUpdate	getStatementUpdate(Collection<Statement> added, Collection<Statement> replaced, Collection<String> removed)	Creates new StatementUpdate.
StringValue	getStringValue(String string)	Creates a StringValue.
TermUpdate	getTermUpdate(Collection<MonolingualTextValue> modified, Collection<String> removed)	Creates new TermUpdate.
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 Details

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

getLexemeIdValue

LexemeIdValue getLexemeIdValue(String id,
 String siteIri)

Creates a LexemeIdValue.

Parameters:

id - a string of the form Ln... 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 LexemeIdValue corresponding to the input

getFormIdValue

FormIdValue getFormIdValue(String id,
 String siteIri)

Creates a FormIdValue.

Parameters:

id - a string of the form Ln...-Fm... where n... and m... are 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 FormIdValue corresponding to the input

getSenseIdValue

SenseIdValue getSenseIdValue(String id,
 String siteIri)

Creates a SenseIdValue.

Parameters:

id - a string of the form Ln...-Sm... where n... and m... are 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 SenseIdValue corresponding to the input

getMediaInfoIdValue

MediaInfoIdValue getMediaInfoIdValue(String id,
 String siteIri)

Creates a MediaInfoIdValue.

Parameters:

id - a string of the form Mn... 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 MediaInfoIdValue corresponding to the input

getDatatypeIdValue

DatatypeIdValue getDatatypeIdValue(String id)

Deprecated.

use getDatatypeIdValueFromJsonId(String)

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

getDatatypeIdValueFromJsonId

DatatypeIdValue getDatatypeIdValueFromJsonId(String jsonId)

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. The JSON string is its representation in the JSON serialization of properties.

Parameters:

jsonId - the JSON representation of this datatype, which cannot be null

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(double latitude,
 double longitude,
 double precision,
 String globeIri)

Creates a GlobeCoordinatesValue.

Parameters:

latitude - the latitude of the coordinates in degrees

longitude - the longitude of the coordinates in degrees

precision - the precision of the coordinates in degrees

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)

Creates a QuantityValue without a unit of measurement and bounds.

Parameters:

numericValue - the numeric value of this quantity

Returns:

a QuantityValue corresponding to the input

getQuantityValue

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

Creates a QuantityValue without a unit of measurement.

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

getQuantityValue

@Deprecated
QuantityValue getQuantityValue(BigDecimal numericValue,
 String unit)

Deprecated.

use getQuantityValue(BigDecimal, ItemIdValue)

Creates a QuantityValue without bounds.

Parameters:

numericValue - the numeric value of this quantity

unit - the unit of this quantity, or the empty string if there is no unit

Returns:

a QuantityValue corresponding to the input

getQuantityValue

QuantityValue getQuantityValue(BigDecimal numericValue,
 ItemIdValue unit)

Creates a QuantityValue without bounds.

Parameters:

numericValue - the numeric value of this quantity

unit - the unit of this quantity, or null if there is no unit

Returns:

a QuantityValue corresponding to the input

getQuantityValue

@Deprecated
QuantityValue getQuantityValue(BigDecimal numericValue,
 BigDecimal lowerBound,
 BigDecimal upperBound,
 String unit)

Deprecated.

use getQuantityValue(BigDecimal, BigDecimal, BigDecimal, ItemIdValue)

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

unit - the unit of this quantity, or the empty string if there is no unit

Returns:

a QuantityValue corresponding to the input

getQuantityValue

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

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

unit - the unit of this quantity, or null if there is no unit

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. It might be more convenient to use getStatement(org.wikidata.wdtk.datamodel.interfaces.EntityIdValue, org.wikidata.wdtk.datamodel.interfaces.Snak, java.util.List<org.wikidata.wdtk.datamodel.interfaces.SnakGroup>, java.util.List<org.wikidata.wdtk.datamodel.interfaces.Reference>, org.wikidata.wdtk.datamodel.interfaces.StatementRank, java.lang.String) directly if you want to build a statement.

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. It might be more convenient to use ReferenceBuilder instead.

Parameters:

snakGroups - list of snak groups

Returns:

a Reference corresponding to the input

getStatement

Statement getStatement(EntityIdValue subject,
 Snak mainSnak,
 List<SnakGroup> qualifiers,
 List<Reference> references,
 StatementRank rank,
 String statementId)

Creates a Statement. It might be more convenient to use StatementBuilder instead.

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:

subject - the subject the Statement refers to

mainSnak - the main Snak of the Statement

qualifiers - the qualifiers of the Statement, grouped in SnakGroups

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

getStatement

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

Creates a Statement. It might be more convenient to use StatementBuilder instead.

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<ItemIdValue> 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,
 List<StatementGroup> statementGroups,
 DatatypeIdValue datatypeId,
 long revisionId)

Creates a PropertyDocument. It might be more convenient to use the PropertyDocumentBuilder instead.

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

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

datatypeId - the datatype of that property

revisionId - the revision ID or 0 if not known; see EntityDocument.getRevisionId()

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,
 long revisionId)

Creates an ItemDocument. It might be more convenient to use the ItemDocumentBuilder instead.

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

revisionId - the revision ID or 0 if not known; see EntityDocument.getRevisionId()

Returns:

an ItemDocument corresponding to the input

getLexemeDocument

LexemeDocument getLexemeDocument(LexemeIdValue lexemeIdValue,
 ItemIdValue lexicalCategory,
 ItemIdValue language,
 List<MonolingualTextValue> lemmas,
 List<StatementGroup> statementGroups,
 List<FormDocument> forms,
 List<SenseDocument> senses,
 long revisionId)

Creates an LexemeDocument.

Parameters:

lexemeIdValue - the id of the lexeme that data is about

lexicalCategory - the lexical category to which the lexeme belongs (noun, verb...)

language - the language to which the lexeme belongs (French, British English...)

lemmas - the human readable representations of the lexeme

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

forms - the forms of the lexeme

senses - the senses of the lexeme

revisionId - the revision ID or 0 if not known; see EntityDocument.getRevisionId()

Returns:

a LexemeDocument corresponding to the input

getFormDocument

FormDocument getFormDocument(FormIdValue formIdValue,
 List<MonolingualTextValue> representations,
 List<ItemIdValue> grammaticalFeatures,
 List<StatementGroup> statementGroups,
 long revisionId)

Creates an FormDocument.

Parameters:

formIdValue - the id of the form that data is about

representations - the list of representations of this lexeme, with at most one lemma for each language code

grammaticalFeatures - the grammatical features of the lexeme

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

revisionId - the revision ID or 0 if not known; see EntityDocument.getRevisionId()

Returns:

a FormDocument corresponding to the input

getSenseDocument

SenseDocument getSenseDocument(SenseIdValue senseIdValue,
 List<MonolingualTextValue> glosses,
 List<StatementGroup> statementGroups,
 long revisionId)

Creates a SenseDocument.

Parameters:

senseIdValue - the id of the form that data is about

glosses - the list of glosses of this lexeme, with at most one gloss for each language code

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

revisionId - the revision ID or 0 if not known; see EntityDocument.getRevisionId()

Returns:

a SenseDocument corresponding to the input

getMediaInfoDocument

MediaInfoDocument getMediaInfoDocument(MediaInfoIdValue mediaInfoIdValue,
 List<MonolingualTextValue> labels,
 List<StatementGroup> statementGroups,
 long revisionId)

Creates a MediaInfoDocument.

Parameters:

mediaInfoIdValue - the id of the form that data is about

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

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

revisionId - the revision ID or 0 if not known; see EntityDocument.getRevisionId()

Returns:

a MediaInfoDocument corresponding to the input

getTermUpdate

TermUpdate getTermUpdate(Collection<MonolingualTextValue> modified,
 Collection<String> removed)

Creates new TermUpdate. It might be more convenient to use TermUpdateBuilder.

Parameters:

modified - added or changed values

removed - language codes of removed values

Returns:

new TermUpdate

Throws:

NullPointerException - if any required parameter is null

IllegalArgumentException - if any parameters or their combination is invalid

getAliasUpdate

AliasUpdate getAliasUpdate(List<MonolingualTextValue> recreated,
 List<MonolingualTextValue> added,
 Collection<MonolingualTextValue> removed)

Creates new AliasUpdate. Callers should specify either recreated parameter or added and removed parameters, because combination of the two update approaches is not possible. To remove all aliases, pass empty list in recreated parameter.

Parameters:

recreated - new list of aliases that completely replaces the old ones or null to not recreate aliases

added - aliases added in this update or empty collection for no additions

removed - aliases removed in this update or empty collection for no removals

Returns:

new AliasUpdate

Throws:

NullPointerException - if added, removed, or any alias is null

IllegalArgumentException - if given invalid combination of parameters

getStatementUpdate

StatementUpdate getStatementUpdate(Collection<Statement> added,
 Collection<Statement> replaced,
 Collection<String> removed)

Creates new StatementUpdate. It might be more convenient to use StatementUpdateBuilder.

Parameters:

added - added statements

replaced - replaced statements

removed - IDs of removed statements

Returns:

new StatementUpdate

Throws:

NullPointerException - if any required parameter is null

IllegalArgumentException - if any parameters or their combination is invalid

getSenseUpdate

SenseUpdate getSenseUpdate(SenseIdValue entityId,
 long revisionId,
 TermUpdate glosses,
 StatementUpdate statements)

Creates new SenseUpdate. It might be more convenient to use SenseUpdateBuilder.

Parameters:

entityId - ID of the sense that is to be updated

revisionId - base sense revision to be updated or zero if not available

glosses - changes in sense glosses or null for no change

statements - changes in entity statements, possibly empty

Returns:

new SenseUpdate

Throws:

NullPointerException - if any required parameter is null

IllegalArgumentException - if any parameters or their combination is invalid

getFormUpdate

FormUpdate getFormUpdate(FormIdValue entityId,
 long revisionId,
 TermUpdate representations,
 Collection<ItemIdValue> grammaticalFeatures,
 StatementUpdate statements)

Creates new FormUpdate. It might be more convenient to use FormUpdateBuilder.

Parameters:

entityId - ID of the form that is to be updated

revisionId - base form revision to be updated or zero if not available

representations - changes in form representations or null for no change

grammaticalFeatures - new grammatical features of the form or null for no change

statements - changes in entity statements, possibly empty

Returns:

new FormUpdate

Throws:

NullPointerException - if any required parameter is null

IllegalArgumentException - if any parameters or their combination is invalid

getLexemeUpdate

LexemeUpdate getLexemeUpdate(LexemeIdValue entityId,
 long revisionId,
 ItemIdValue language,
 ItemIdValue lexicalCategory,
 TermUpdate lemmas,
 StatementUpdate statements,
 Collection<SenseDocument> addedSenses,
 Collection<SenseUpdate> updatedSenses,
 Collection<SenseIdValue> removedSenses,
 Collection<FormDocument> addedForms,
 Collection<FormUpdate> updatedForms,
 Collection<FormIdValue> removedForms)

Creates new LexemeUpdate. It might be more convenient to use LexemeUpdateBuilder.

Parameters:

entityId - ID of the lexeme that is to be updated

revisionId - base lexeme revision to be updated or zero if not available

language - new lexeme language or null for no change

lexicalCategory - new lexical category of the lexeme or null for no change

lemmas - changes in lemmas or null for no change

statements - changes in entity statements, possibly empty

addedSenses - added senses

updatedSenses - updated senses

removedSenses - IDs of removed senses

addedForms - added forms

updatedForms - updated forms

removedForms - IDs of removed forms

Returns:

new LexemeUpdate

Throws:

NullPointerException - if any required parameter is null

IllegalArgumentException - if any parameters or their combination is invalid

getMediaInfoUpdate

MediaInfoUpdate getMediaInfoUpdate(MediaInfoIdValue entityId,
 long revisionId,
 TermUpdate labels,
 StatementUpdate statements)

Creates new MediaInfoUpdate. It might be more convenient to use MediaInfoUpdateBuilder.

Parameters:

entityId - ID of the media that is to be updated

revisionId - base media revision to be updated or zero if not available

labels - changes in entity labels or null for no change

statements - changes in entity statements, possibly empty

Returns:

new MediaInfoUpdate

Throws:

NullPointerException - if any required parameter is null

IllegalArgumentException - if any parameters or their combination is invalid

getItemUpdate

ItemUpdate getItemUpdate(ItemIdValue entityId,
 long revisionId,
 TermUpdate labels,
 TermUpdate descriptions,
 Map<String,AliasUpdate> aliases,
 StatementUpdate statements,
 Collection<SiteLink> modifiedSiteLinks,
 Collection<String> removedSiteLinks)

Creates new ItemUpdate. It might be more convenient to use ItemUpdateBuilder.

Parameters:

entityId - ID of the item that is to be updated

revisionId - base item revision to be updated or zero if not available

labels - changes in entity labels or null for no change

descriptions - changes in entity descriptions or null for no change

aliases - changes in entity aliases, possibly empty

statements - changes in entity statements, possibly empty

modifiedSiteLinks - added or replaced site links

removedSiteLinks - site keys of removed site links

Returns:

new ItemUpdate

Throws:

NullPointerException - if any required parameter is null

IllegalArgumentException - if any parameters or their combination is invalid

getPropertyUpdate

PropertyUpdate getPropertyUpdate(PropertyIdValue entityId,
 long revisionId,
 TermUpdate labels,
 TermUpdate descriptions,
 Map<String,AliasUpdate> aliases,
 StatementUpdate statements)

Creates new PropertyUpdate. It might be more convenient to use PropertyUpdateBuilder.

Parameters:

entityId - ID of the property entity that is to be updated

revisionId - base property revision to be updated or zero if not available

labels - changes in entity labels or null for no change

descriptions - changes in entity descriptions or null for no change

aliases - changes in entity aliases, possibly empty

statements - changes in entity statements, possibly empty

Returns:

new PropertyUpdate

Throws:

NullPointerException - if any required parameter is null

IllegalArgumentException - if any parameters or their combination is invalid