org.wikidata.wdtk.datamodel.implementation

Class FormDocumentImpl

java.lang.Object

org.wikidata.wdtk.datamodel.implementation.EntityDocumentImpl

org.wikidata.wdtk.datamodel.implementation.FormDocumentImpl

All Implemented Interfaces:

EntityDocument, FormDocument, StatementDocument

public class FormDocumentImpl
extends EntityDocumentImpl
implements FormDocument

Jackson implementation of FormDocument.

Author:

Thomas Pellissier Tanon

Field Summary

Fields

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

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

entityId, revisionId, siteIri

Method Summary

Modifier and Type	Method and 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.
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.
FormIdValue	getEntityId() Returns the ID of the entity that the data refers to
List<ItemIdValue>	getGrammaticalFeatures() Return the IDs of the grammatical features of the form (masculine, singular...)
Map<String,List<Statement>>	getJsonClaims() Returns the "claims".
Map<String,MonolingualTextValue>	getRepresentations() Return the human readable representations of the form indexed by Wikimedia language code
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()
FormDocument	withEntityId(FormIdValue newEntityId) Returns a new version of this document with updated ID.
FormDocument	withGrammaticalFeature(ItemIdValue grammaticalFeature)
FormDocument	withoutStatementIds(Set<String> statementIds) Returns a new version of this document where all statements matching any of the statement ids provided have been removed.
FormDocument	withRepresentation(MonolingualTextValue representation)
FormDocument	withRevisionId(long newRevisionId) Returns a copy of this document with an updated revision id.
FormDocument	withStatement(Statement statement) Returns a new version of this document which includes the statement provided.

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.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

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

getRevisionId

Field Detail

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.

Method Detail

getEntityId

public FormIdValue getEntityId()

Description copied from interface: FormDocument

Returns the ID of the entity that the data refers to

Specified by:

getEntityId in interface EntityDocument

Specified by:

getEntityId in interface FormDocument

Returns:

form id

getGrammaticalFeatures

public List<ItemIdValue> getGrammaticalFeatures()

Description copied from interface: FormDocument

Return the IDs of the grammatical features of the form (masculine, singular...)

Specified by:

getGrammaticalFeatures in interface FormDocument

Returns:

item ids

getRepresentations

public Map<String,MonolingualTextValue> getRepresentations()

Description copied from interface: FormDocument

Return the human readable representations of the form indexed by Wikimedia language code

Specified by:

getRepresentations in interface FormDocument

Returns:

a map from Wikimedia language code to the representations

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 FormDocument withEntityId(FormIdValue newEntityId)

Description copied from interface: FormDocument

Returns a new version of this document with updated ID.

Specified by:

withEntityId in interface FormDocument

Parameters:

newEntityId - new ID of the document

Returns:

document with updated ID

withRevisionId

public FormDocument withRevisionId(long newRevisionId)

Description copied from interface: FormDocument

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

Specified by:

withRevisionId in interface EntityDocument

Specified by:

withRevisionId in interface FormDocument

Specified by:

withRevisionId in interface StatementDocument

withRepresentation

public FormDocument withRepresentation(MonolingualTextValue representation)

Specified by:

withRepresentation in interface FormDocument

withGrammaticalFeature

public FormDocument withGrammaticalFeature(ItemIdValue grammaticalFeature)

Specified by:

withGrammaticalFeature in interface FormDocument

withStatement

public FormDocument withStatement(Statement statement)

Description copied from interface: FormDocument

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 FormDocument

Specified by:

withStatement in interface StatementDocument

Parameters:

statement - the statement to add or update in the document

withoutStatementIds

public FormDocument withoutStatementIds(Set<String> statementIds)

Description copied from interface: FormDocument

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 FormDocument

Specified by:

withoutStatementIds in interface StatementDocument

Parameters:

statementIds - the identifiers of the statements to remove

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 StatementDocumentImpl.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: