Package org.wikidata.wdtk.datamodel.implementation

Class MediaInfoDocumentImpl

java.lang.Object

org.wikidata.wdtk.datamodel.implementation.EntityDocumentImpl

org.wikidata.wdtk.datamodel.implementation.MediaInfoDocumentImpl

All Implemented Interfaces:

EntityDocument, LabeledDocument, LabeledStatementDocument, MediaInfoDocument, StatementDocument

public class MediaInfoDocumentImpl
extends EntityDocumentImpl
implements MediaInfoDocument

Jackson implementation of MediaInfoDocument.

We serialize back statements in JSON with the "claims" key for compatibility with the other entity types and the wbeditentity API mdodule

Author:

Thomas Pellissier Tanon

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,List<Statement>>	claims	This is what is called claim in the JSON model.
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
	MediaInfoDocumentImpl(String jsonId, Map<String,MonolingualTextValue> labels, Map<String,List<StatementImpl.PreStatement>> claims, Map<String,List<StatementImpl.PreStatement>> statements, long revisionId, String siteIri)	Constructor.
	MediaInfoDocumentImpl(MediaInfoIdValue id, List<MonolingualTextValue> labels, List<StatementGroup> statements, long revisionId)	Constructor.
protected	MediaInfoDocumentImpl(MediaInfoIdValue subject, Map<String,MonolingualTextValue> labels, Map<String,List<Statement>> claims, long revisionId)	Protected constructor, meant to be used to create modified copies of instances.

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)
boolean	equals(Object obj)
StatementGroup	findStatementGroup(String propertyIdValue)	Find a statement group by its property id, without checking for equality with the site IRI.
Iterator<Statement>	getAllStatements()	Returns an iterator that provides access to all statements, without considering the statement groups.
MediaInfoIdValue	getEntityId()	Returns the ID of the entity that the data refers to
Map<String,List<Statement>>	getJsonClaims()	Returns the "claims".
Map<String,MonolingualTextValue>	getLabels()	Return a Map from Wikibase language codes to labels.
List<StatementGroup>	getStatementGroups()	Return the list of all StatementGroups stored for this item.
int	hashCode()
protected static Map<String,List<Statement>>	removeStatements(Set<String> statementIds, Map<String,List<Statement>> claims)	Removes statement ids from a collection of statement groups.
String	toString()
MediaInfoDocument	withEntityId(MediaInfoIdValue newEntityId)	Returns a new version of this document with updated ID.
MediaInfoDocument	withLabel(MonolingualTextValue newLabel)	Returns a new version of this document with a new label (which overrides any existing label for this language).
MediaInfoDocument	withoutStatementIds(Set<String> statementIds)	Returns a new version of this document where all statements matching any of the statement ids provided have been removed.
MediaInfoDocument	withRevisionId(long newRevisionId)	Returns a copy of this document with an updated revision id.
MediaInfoDocument	withStatement(Statement statement)	Returns a new version of this document which includes the statement provided.
protected static Map<String,MonolingualTextValue>	withTerm(Map<String,MonolingualTextValue> values, MonolingualTextValue value)

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

getJsonId, getRevisionId, getSiteIri

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getRevisionId

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

findLabel, getLabels

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

Field Details

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

MediaInfoDocumentImpl

public MediaInfoDocumentImpl(MediaInfoIdValue id,
 List<MonolingualTextValue> labels,
 List<StatementGroup> statements,
 long revisionId)

Constructor.

Parameters:

id - the id of the media that data is about

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

statements - the list of statement groups of this media info; all of them must have the given itemIdValue as their subject

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

MediaInfoDocumentImpl

public MediaInfoDocumentImpl(String jsonId,
 Map<String,MonolingualTextValue> labels,
 Map<String,List<StatementImpl.PreStatement>> claims,
 Map<String,List<StatementImpl.PreStatement>> statements,
 long revisionId,
 String siteIri)

Constructor. Creates an object that can be populated during JSON deserialization. Should only be used by Jackson for this very purpose. The claims parameter is here for compatibility with wbeditentity.

MediaInfoDocumentImpl

protected MediaInfoDocumentImpl(MediaInfoIdValue subject,
 Map<String,MonolingualTextValue> labels,
 Map<String,List<Statement>> claims,
 long revisionId)

Protected constructor, meant to be used to create modified copies of instances.

Method Details

getEntityId

public MediaInfoIdValue getEntityId()

Description copied from interface: MediaInfoDocument

Returns the ID of the entity that the data refers to

Specified by:

getEntityId in interface EntityDocument

Specified by:

getEntityId in interface MediaInfoDocument

Returns:

media info id

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

withEntityId

public MediaInfoDocument withEntityId(MediaInfoIdValue newEntityId)

Description copied from interface: MediaInfoDocument

Returns a new version of this document with updated ID.

Specified by:

withEntityId in interface MediaInfoDocument

Parameters:

newEntityId - new ID of the document

Returns:

document with updated ID

withRevisionId

public MediaInfoDocument withRevisionId(long newRevisionId)

Description copied from interface: LabeledDocument

Returns a copy of this document with an updated revision id.

Specified by:

withRevisionId in interface EntityDocument

Specified by:

withRevisionId in interface LabeledDocument

Specified by:

withRevisionId in interface LabeledStatementDocument

Specified by:

withRevisionId in interface MediaInfoDocument

Specified by:

withRevisionId in interface StatementDocument

withLabel

public MediaInfoDocument withLabel(MonolingualTextValue newLabel)

Description copied from interface: LabeledDocument

Returns a new version of this document with a new label (which overrides any existing label for this language).

Specified by:

withLabel in interface LabeledDocument

Specified by:

withLabel in interface LabeledStatementDocument

Specified by:

withLabel in interface MediaInfoDocument

withStatement

public MediaInfoDocument withStatement(Statement statement)

Description copied from interface: StatementDocument

Returns a new version of this document which includes the statement provided. If the identifier of this statement matches that of any other statement for the same property, then the existing statement will be replaced by the new one. Otherwise, the new statement will be added at the end of the list of statements in this group.

Specified by:

withStatement in interface LabeledStatementDocument

Specified by:

withStatement in interface MediaInfoDocument

Specified by:

withStatement in interface StatementDocument

Parameters:

statement - the statement to add or update in the document

withoutStatementIds

public MediaInfoDocument withoutStatementIds(Set<String> statementIds)

Description copied from interface: StatementDocument

Returns a new version of this document where all statements matching any of the statement ids provided have been removed. These statements can use different properties.

Specified by:

withoutStatementIds in interface LabeledStatementDocument

Specified by:

withoutStatementIds in interface MediaInfoDocument

Specified by:

withoutStatementIds in interface StatementDocument

Parameters:

statementIds - the identifiers of the statements to remove

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: