Package org.wikidata.wdtk.datamodel.json.jackson

Class JacksonStatement

java.lang.Object

org.wikidata.wdtk.datamodel.json.jackson.JacksonStatement

All Implemented Interfaces:

Statement

public class JacksonStatement
extends java.lang.Object
implements Statement

Jackson implementation of Statement. In JSON, the corresponding structures are referred to as "claim".

Like all Jackson objects, it is not technically immutable, but it is strongly recommended to treat it as such in all contexts: the setters are for Jackson; never call them in your code.

Author:

Fredo Erxleben

Constructor Summary

Constructors

Constructor	Description
JacksonStatement()	Constructor.
JacksonStatement(java.lang.String id, JacksonSnak mainsnak)	TODO review the utility of this constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
Claim	getClaim()	Get the Claim object that this statement refers to.
java.lang.String	getJsonType()	Returns the value for the "type" field used in JSON.
JacksonSnak	getMainsnak()	Returns the main snak of the claim of this statement.
java.util.List<java.lang.String>	getPropertyOrder()	Returns the list of property ids used to order qualifiers as found in JSON.
java.util.Map<java.lang.String,java.util.List<JacksonSnak>>	getQualifiers()	Returns the qualifiers of the claim of this statement.
StatementRank	getRank()
java.util.List<? extends Reference>	getReferences()	Get a list of references for this Statement.
java.lang.String	getStatementId()	Return the id used to identify this statement.
Value	getValue()	Convenience method to get the value of the statement's claim's main snak, or null if there is none.
int	hashCode()
void	setMainsnak(JacksonSnak mainsnak)	Sets the main snak of the claim of this statement to the given value.
void	setPropertyOrder(java.util.List<java.lang.String> propertyOrder)	Sets the list of property ids to the given value.
void	setQualifiers(java.util.Map<java.lang.String,java.util.List<JacksonSnak>> qualifiers)	Sets the qualifiers to the given value.
void	setRank(StatementRank rank)	Sets the statement rank to the given value.
void	setReferences(java.util.List<JacksonReference> references)	Sets the references to the given value.
void	setStatementId(java.lang.String id)	Sets the statement id to the given value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JacksonStatement

public JacksonStatement()

Constructor. Creates an empty object that can be populated during JSON deserialization. Should only be used by Jackson for this very purpose.

JacksonStatement

public JacksonStatement(java.lang.String id,
                        JacksonSnak mainsnak)

TODO review the utility of this constructor.

Parameters:

id -

mainsnak -

Method Detail

getJsonType

public java.lang.String getJsonType()

Returns the value for the "type" field used in JSON. Only for use by Jackson during deserialization.

Returns:

"statement"

getClaim

public Claim getClaim()

Description copied from interface: Statement

Get the Claim object that this statement refers to.

Specified by:

getClaim in interface Statement

Returns:

the claim that this statement refers to

getRank

public StatementRank getRank()

Specified by:

getRank in interface Statement

Returns:

the rank of the Statement

See Also:

StatementRank

setRank

public void setRank(StatementRank rank)

Sets the statement rank to the given value. Only for use by Jackson during deserialization.

Parameters:

rank - new value

getReferences

public java.util.List<? extends Reference> getReferences()

Description copied from interface: Statement

Get a list of references for this Statement. Each reference is represented by a list of Snaks, which provide information about the reference.

Specified by:

getReferences in interface Statement

Returns:

the list of references

setReferences

public void setReferences(java.util.List<JacksonReference> references)

Sets the references to the given value. Only for use by Jackson during deserialization.

Parameters:

references - new value

getStatementId

public java.lang.String getStatementId()

Description copied from interface: Statement

Return the id used to identify this statement.

Statement ids are used by Wikibase to allow certain interactions though the API, especially the atomic modification of Statements (modifications of statements can be viewed as deletions followed by insertions, but doing this in several steps though the API is not practical). In the current Wikibase implementation, the id is a string that begins with the (sometimes lowercased) local ID of the subject of the statement, followed by a dollar sign and a randomly generated UUID. Thus statements of different subjects can never have the same id, and it is extremely unlikely that two statements of the one subject ever have the same id. However, it is possible that two statements with the same content differ in their id, since the id is not based on the content.

Wikidata Toolkit generally requires ids to be specified but you can use the empty string to indicate that a statement has no id. This will also be respected when serializing data as JSON, i.e., rather than setting the statement id to an empty string in JSON, the key will simply be omitted. This is useful for creating new statements through the API.

Callers should not make any assumptions about the stability of statement ids over time, or about the internal format of the ids.

Specified by:

getStatementId in interface Statement

Returns:

the statement string id

setStatementId

public void setStatementId(java.lang.String id)

Sets the statement id to the given value. Only for use by Jackson during deserialization.

Parameters:

id - new value

getMainsnak

public JacksonSnak getMainsnak()

Returns the main snak of the claim of this statement. Only for use by Jackson during serialization. To access this data, use getClaim().

Returns:

main snak

setMainsnak

public void setMainsnak(JacksonSnak mainsnak)

Sets the main snak of the claim of this statement to the given value. Only for use by Jackson during deserialization.

Parameters:

mainsnak - new value

getQualifiers

public java.util.Map<java.lang.String,java.util.List<JacksonSnak>> getQualifiers()

Returns the qualifiers of the claim of this statement. Only for use by Jackson during serialization. To access this data, use getClaim().

Returns:

qualifiers

setQualifiers

public void setQualifiers(java.util.Map<java.lang.String,java.util.List<JacksonSnak>> qualifiers)

Sets the qualifiers to the given value. Only for use by Jackson during deserialization.

Parameters:

qualifiers - new value

setPropertyOrder

public void setPropertyOrder(java.util.List<java.lang.String> propertyOrder)

Sets the list of property ids to the given value. Only for use by Jackson during deserialization.

Parameters:

propertyOrder - new value

getPropertyOrder

public java.util.List<java.lang.String> getPropertyOrder()

Returns the list of property ids used to order qualifiers as found in JSON. Only for use by Jackson during serialization.

Returns:

the list of property ids

getValue

public Value getValue()

Description copied from interface: Statement

Convenience method to get the value of the statement's claim's main snak, or null if there is none.

Specified by:

getValue in interface Statement

Returns:

main value of the statement, or null

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object