Package org.wikidata.wdtk.datamodel.implementation

Class TermedStatementDocumentImpl

java.lang.Object

org.wikidata.wdtk.datamodel.implementation.EntityDocumentImpl

org.wikidata.wdtk.datamodel.implementation.TermedStatementDocumentImpl

All Implemented Interfaces:

EntityDocument, LabeledDocument, LabeledStatementDocument, StatementDocument, TermedDocument, TermedStatementDocument

Direct Known Subclasses:

ItemDocumentImpl, PropertyDocumentImpl

public abstract class TermedStatementDocumentImpl
extends EntityDocumentImpl
implements TermedStatementDocument

Abstract Jackson implementation of TermedDocument and StatementDocument. You should not rely on it directly but build instances with the Datamodel helper and use EntityDocumentImpl for deserialization.

Author:

Fredo Erxleben, Antonin Delpeuch, Thomas Pellissier Tanon

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,List<MonolingualTextValue>>	aliases
protected final Map<String,List<Statement>>	claims	This is what is called claim in the JSON model.
protected final Map<String,MonolingualTextValue>	descriptions
protected final Map<String,MonolingualTextValue>	labels

Fields inherited from class org.wikidata.wdtk.datamodel.implementation.EntityDocumentImpl

entityId, revisionId, siteIri

Constructor Summary

Constructors

Modifier	Constructor	Description
	TermedStatementDocumentImpl(EntityIdValue id, List<MonolingualTextValue> labels, List<MonolingualTextValue> descriptions, List<MonolingualTextValue> aliases, List<StatementGroup> claims, long revisionId)	Constructor.
protected	TermedStatementDocumentImpl(EntityIdValue subject, Map<String,MonolingualTextValue> labels, Map<String,MonolingualTextValue> descriptions, Map<String,List<MonolingualTextValue>> aliases, Map<String,List<Statement>> claims, long revisionId)	Protected constructor provided to ease the creation of copies.

Method Summary

Modifier and Type	Method	Description
protected static Map<String,List<Statement>>	addStatementToGroups(Statement statement, Map<String,List<Statement>> claims)	Adds a Statement to a given collection of statement groups.
protected static Map<String,MonolingualTextValue>	constructTermMap(List<MonolingualTextValue> terms)
StatementGroup	findStatementGroup(String propertyIdValue)	Find a statement group by its property id, without checking for equality with the site IRI.
Map<String,List<MonolingualTextValue>>	getAliases()	Return a Map from Wikibase language codes to lists of alias labels for a given language.
Iterator<Statement>	getAllStatements()	Returns an iterator that provides access to all statements, without considering the statement groups.
Map<String,MonolingualTextValue>	getDescriptions()	Return a Map from Wikibase language codes to descriptions.
Map<String,List<Statement>>	getJsonClaims()	Returns the "claims".
Map<String,MonolingualTextValue>	getLabels()	Return a Map from Wikibase language codes to labels.
String	getSiteIri()
List<StatementGroup>	getStatementGroups()	Return the list of all StatementGroups stored for this item.
protected static Map<String,List<Statement>>	removeStatements(Set<String> statementIds, Map<String,List<Statement>> claims)	Removes statement ids from a collection of statement groups.
protected static Map<String,List<MonolingualTextValue>>	withAliases(Map<String,List<MonolingualTextValue>> values, String language, List<MonolingualTextValue> aliases)
protected static Map<String,MonolingualTextValue>	withTerm(Map<String,MonolingualTextValue> values, MonolingualTextValue value)

Methods inherited from class org.wikidata.wdtk.datamodel.implementation.EntityDocumentImpl

getJsonId, getRevisionId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wikidata.wdtk.datamodel.interfaces.EntityDocument

getEntityId, getRevisionId

Methods inherited from interface org.wikidata.wdtk.datamodel.interfaces.LabeledDocument

findLabel, getLabels

Methods inherited from interface org.wikidata.wdtk.datamodel.interfaces.LabeledStatementDocument

withLabel, withRevisionId

Methods inherited from interface org.wikidata.wdtk.datamodel.interfaces.StatementDocument

findStatement, findStatement, findStatementEntityIdValue, findStatementEntityIdValue, findStatementGlobeCoordinatesValue, findStatementGlobeCoordinatesValue, findStatementGroup, findStatementGroup, findStatementItemIdValue, findStatementItemIdValue, findStatementMonolingualTextValue, findStatementMonolingualTextValue, findStatementPropertyIdValue, findStatementPropertyIdValue, findStatementQuantityValue, findStatementQuantityValue, findStatementStringValue, findStatementStringValue, findStatementTimeValue, findStatementTimeValue, findStatementValue, findStatementValue, getAllStatements, getStatementGroups, hasStatement, hasStatement, hasStatementValue, hasStatementValue, hasStatementValue, hasStatementValue, withRevisionId

Methods inherited from interface org.wikidata.wdtk.datamodel.interfaces.TermedDocument

findDescription

Methods inherited from interface org.wikidata.wdtk.datamodel.interfaces.TermedStatementDocument

withAliases, withDescription, withLabel, withoutStatementIds, withRevisionId, withStatement

Field Details

descriptions

protected final Map<String,MonolingualTextValue> descriptions

aliases

protected final Map<String,List<MonolingualTextValue>> aliases

labels

protected final Map<String,MonolingualTextValue> labels

claims

protected final Map<String,List<Statement>> claims

This is what is called claim in the JSON model. It corresponds to the statement group in the WDTK model.

Constructor Details

TermedStatementDocumentImpl

public TermedStatementDocumentImpl(EntityIdValue id,
 List<MonolingualTextValue> labels,
 List<MonolingualTextValue> descriptions,
 List<MonolingualTextValue> aliases,
 List<StatementGroup> claims,
 long revisionId)

Constructor.

Parameters:

id - the identifier of the subject of this document

labels - the labels for this entity, at most one per language

descriptions - the descriptions for this entity, at most one per language

aliases - the aliases for this language. Their relative order in a given language will be preserved.

claims - the statement groups contained in this document

revisionId - the id of the last revision of this document

TermedStatementDocumentImpl

protected TermedStatementDocumentImpl(EntityIdValue subject,
 Map<String,MonolingualTextValue> labels,
 Map<String,MonolingualTextValue> descriptions,
 Map<String,List<MonolingualTextValue>> aliases,
 Map<String,List<Statement>> claims,
 long revisionId)

Protected constructor provided to ease the creation of copies. No check is made and each field is reused without copying.

Parameters:

labels - a map from language codes to monolingual values with the same language codes

descriptions - a map from language codes to monolingual values with the same language codes

aliases - a map from language codes to lists of monolingual values with the same language codes

claims -

revisionId -

Method Details

getAliases

public Map<String,List<MonolingualTextValue>> getAliases()

Description copied from interface: TermedDocument

Return a Map from Wikibase language codes to lists of alias labels for a given language.

Specified by:

getAliases in interface TermedDocument

Returns:

the aliases for this language

getDescriptions

public Map<String,MonolingualTextValue> getDescriptions()

Description copied from interface: TermedDocument

Return a Map from Wikibase language codes to descriptions.

Specified by:

getDescriptions in interface TermedDocument

Returns:

the map of descriptions

getSiteIri

public String getSiteIri()

Overrides:

getSiteIri in class EntityDocumentImpl

withAliases

protected static Map<String,List<MonolingualTextValue>> withAliases(Map<String,List<MonolingualTextValue>> values,
 String language,
 List<MonolingualTextValue> aliases)

getLabels

public Map<String,MonolingualTextValue> getLabels()

Description copied from interface: LabeledDocument

Return a Map from Wikibase language codes to labels.

Specified by:

getLabels in interface LabeledDocument

Returns:

the map of labels

constructTermMap

protected static Map<String,MonolingualTextValue> constructTermMap(List<MonolingualTextValue> terms)

withTerm

protected static Map<String,MonolingualTextValue> withTerm(Map<String,MonolingualTextValue> values,
 MonolingualTextValue value)

getStatementGroups

public List<StatementGroup> getStatementGroups()

Description copied from interface: StatementDocument

Return the list of all StatementGroups stored for this item. The order of StatementGroups is significant.

Specified by:

getStatementGroups in interface StatementDocument

Returns:

list of StatementGroups

findStatementGroup

public StatementGroup findStatementGroup(String propertyIdValue)

Find a statement group by its property id, without checking for equality with the site IRI. More efficient implementation than the default one.

Specified by:

findStatementGroup in interface StatementDocument

Parameters:

propertyIdValue - the property to search for

Returns:

StatementGroup or null

getJsonClaims

public Map<String,List<Statement>> getJsonClaims()

Returns the "claims". Only used by Jackson.

JSON "claims" correspond to statement groups in the WDTK model. You should use StatementDocument.getStatementGroups() to obtain this data.

Returns:

map of statement groups

getAllStatements

public Iterator<Statement> getAllStatements()

Description copied from interface: StatementDocument

Returns an iterator that provides access to all statements, without considering the statement groups. The order of statements is preserved.

Specified by:

getAllStatements in interface StatementDocument

Returns:

iterator over all statements

addStatementToGroups

protected static Map<String,List<Statement>> addStatementToGroups(Statement statement,
 Map<String,List<Statement>> claims)

Adds a Statement to a given collection of statement groups. If the statement id is not null and matches that of an existing statement, this statement will be replaced.

Parameters:

statement -

claims -

Returns:

removeStatements

protected static Map<String,List<Statement>> removeStatements(Set<String> statementIds,
 Map<String,List<Statement>> claims)

Removes statement ids from a collection of statement groups.

Parameters:

statementIds -

claims -

Returns: