Package org.wikidata.wdtk.datamodel.helpers

Class AbstractTermedStatementDocument

java.lang.Object

org.wikidata.wdtk.datamodel.helpers.AbstractTermedStatementDocument

All Implemented Interfaces:

EntityDocument, StatementDocument, TermedDocument

Direct Known Subclasses:

JacksonTermedStatementDocument, TermedStatementDocumentImpl

public abstract class AbstractTermedStatementDocument
extends java.lang.Object
implements TermedDocument, StatementDocument

Abstract base class for implementations of TermedDocument and StatementDocument. It does not store any data, but it implements the required find methods that access the data. Specific implementations can overwrite some find methods with more efficient solutions based on internal data structures.

Author:

Markus Kroetzsch

Constructor Summary

Constructors

Constructor	Description
AbstractTermedStatementDocument()

Method Summary

Modifier and Type	Method	Description
protected <T extends Value> T	castValue(Value value, java.lang.Class<T> valueClass)	Casts the given value to the given class if possible, or returns null if not.
protected boolean	containsStatementValue(StatementGroup statementGroup, java.util.Set<? extends Value> values)	Returns true if the given statement group contains a statement with one of the given values.
java.lang.String	findDescription(java.lang.String languageCode)	Returns the string description for the given language code, or null if there is no description for this code.
java.lang.String	findLabel(java.lang.String languageCode)	Returns the string label for the given language code, or null if there is no label for this code.
Statement	findStatement(java.lang.String propertyId)	Returns the unique Statement for the given property, or null if there are zero or many statements for this property.
Statement	findStatement(PropertyIdValue propertyIdValue)	Returns the unique Statement for the given property, or null if there are zero or many statements for this property.
DatatypeIdValue	findStatementDatatypeIdValue(java.lang.String propertyId)	Returns the unique DatatypeIdValue for the given property, or null if there are zero or many such values given in statements for this property.
DatatypeIdValue	findStatementDatatypeIdValue(PropertyIdValue propertyIdValue)	Returns the unique DatatypeIdValue for the given property, or null if there are zero or many such values given in statements for this property.
EntityIdValue	findStatementEntityIdValue(java.lang.String propertyId)	Returns the unique EntityIdValue for the given property, or null if there are zero or many such values given in statements for this property.
EntityIdValue	findStatementEntityIdValue(PropertyIdValue propertyIdValue)	Returns the unique EntityIdValue for the given property, or null if there are zero or many such values given in statements for this property.
GlobeCoordinatesValue	findStatementGlobeCoordinatesValue(java.lang.String propertyId)	Returns the unique GlobeCoordinatesValue for the given property, or null if there are zero or many such values given in statements for this property.
GlobeCoordinatesValue	findStatementGlobeCoordinatesValue(PropertyIdValue propertyIdValue)	Returns the unique GlobeCoordinatesValue for the given property, or null if there are zero or many such values given in statements for this property.
StatementGroup	findStatementGroup(java.lang.String propertyId)	Returns the StatementGroup for the given property, or null if there are no statements for this property.
StatementGroup	findStatementGroup(PropertyIdValue propertyIdValue)	Returns the StatementGroup for the given property, or null if there are no statements for this property.
ItemIdValue	findStatementItemIdValue(java.lang.String propertyId)	Returns the unique ItemIdValue for the given property, or null if there are zero or many such values given in statements for this property.
ItemIdValue	findStatementItemIdValue(PropertyIdValue propertyIdValue)	Returns the unique ItemIdValue for the given property, or null if there are zero or many such values given in statements for this property.
MonolingualTextValue	findStatementMonolingualTextValue(java.lang.String propertyId)	Returns the unique MonolingualTextValue for the given property, or null if there are zero or many such values given in statements for this property.
MonolingualTextValue	findStatementMonolingualTextValue(PropertyIdValue propertyIdValue)	Returns the unique MonolingualTextValue for the given property, or null if there are zero or many such values given in statements for this property.
PropertyIdValue	findStatementPropertyIdValue(java.lang.String propertyId)	Returns the unique PropertyIdValue for the given property, or null if there are zero or many such values given in statements for this property.
PropertyIdValue	findStatementPropertyIdValue(PropertyIdValue propertyIdValue)	Returns the unique PropertyIdValue for the given property, or null if there are zero or many such values given in statements for this property.
QuantityValue	findStatementQuantityValue(java.lang.String propertyId)	Returns the unique QuantityValue for the given property, or null if there are zero or many such values given in statements for this property.
QuantityValue	findStatementQuantityValue(PropertyIdValue propertyIdValue)	Returns the unique QuantityValue for the given property, or null if there are zero or many such values given in statements for this property.
StringValue	findStatementStringValue(java.lang.String propertyId)	Returns the unique StringValue for the given property, or null if there are zero or many such values given in statements for this property.
StringValue	findStatementStringValue(PropertyIdValue propertyIdValue)	Returns the unique StringValue for the given property, or null if there are zero or many such values given in statements for this property.
TimeValue	findStatementTimeValue(java.lang.String propertyId)	Returns the unique TimeValue for the given property, or null if there are zero or many such values given in statements for this property.
TimeValue	findStatementTimeValue(PropertyIdValue propertyIdValue)	Returns the unique TimeValue for the given property, or null if there are zero or many such values given in statements for this property.
Value	findStatementValue(java.lang.String propertyId)	Returns the unique Value for the given property, or null if there are zero or many values given in statements for this property.
Value	findStatementValue(PropertyIdValue propertyIdValue)	Returns the unique Value for the given property, or null if there are zero or many values given in statements for this property.
java.util.Iterator<Statement>	getAllStatements()	Returns an iterator that provides access to all statements, without considering the statement groups.
protected Statement	getUniqueStatementFromStatementGroup(StatementGroup statementGroup)	Returns the unique statement in a statement group, or null if there are zero or more statements.
protected Value	getValueFromStatement(Statement statement)	Returns the Value of the given Statement, provided that the statements actually has a value.
boolean	hasStatement(java.lang.String propertyId)	Returns true if there is a statement for the given property.
boolean	hasStatement(PropertyIdValue propertyIdValue)	Returns true if there is a statement for the given property.
boolean	hasStatementValue(java.lang.String propertyId, java.util.Set<? extends Value> values)	Returns true if there is a statement for the given property and one of the given values.
boolean	hasStatementValue(java.lang.String propertyId, Value value)	Returns true if there is a statement for the given property and value.
boolean	hasStatementValue(PropertyIdValue propertyIdValue, java.util.Set<? extends Value> values)	Returns true if there is a statement for the given property and one of the given values.
boolean	hasStatementValue(PropertyIdValue propertyIdValue, Value value)	Returns true if there is a statement for the given property and value.

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

getEntityId, 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.StatementDocument

getStatementGroups

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

getAliases, getDescriptions, getLabels

Constructor Detail

AbstractTermedStatementDocument

public AbstractTermedStatementDocument()

Method Detail

findLabel

public java.lang.String findLabel(java.lang.String languageCode)

Description copied from interface: TermedDocument

Returns the string label for the given language code, or null if there is no label for this code. This is a convenience method for accessing the data that can be obtained via TermedDocument.getLabels().

Specified by:

findLabel in interface TermedDocument

Parameters:

languageCode - a string that represents language

Returns:

the label string

findDescription

public java.lang.String findDescription(java.lang.String languageCode)

Description copied from interface: TermedDocument

Returns the string description for the given language code, or null if there is no description for this code. This is a convenience method for accessing the data that can be obtained via TermedDocument.getDescriptions().

Specified by:

findDescription in interface TermedDocument

Parameters:

languageCode - a string that represents language

Returns:

the description string

getAllStatements

public java.util.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

findStatementGroup

public StatementGroup findStatementGroup(PropertyIdValue propertyIdValue)

Description copied from interface: StatementDocument

Returns the StatementGroup for the given property, or null if there are no statements for this property. This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementGroup in interface StatementDocument

Parameters:

propertyIdValue - the property to search for

Returns:

StatementGroup or null

findStatementGroup

public StatementGroup findStatementGroup(java.lang.String propertyId)

Description copied from interface: StatementDocument

Returns the StatementGroup for the given property, or null if there are no statements for this property. Only the string id of the property is compared, not the site id. This is useful in situations where all data is known to come from a single site.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementGroup in interface StatementDocument

Parameters:

propertyId - the property to search for

Returns:

StatementGroup or null

hasStatement

public boolean hasStatement(PropertyIdValue propertyIdValue)

Description copied from interface: StatementDocument

Returns true if there is a statement for the given property. This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

hasStatement in interface StatementDocument

Parameters:

propertyIdValue - the property to search for

Returns:

true if a statement for this property exists

hasStatement

public boolean hasStatement(java.lang.String propertyId)

Description copied from interface: StatementDocument

Returns true if there is a statement for the given property. Only the string id of the property is compared, not the site id. This is useful in situations where all data is known to come from a single site.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

hasStatement in interface StatementDocument

Parameters:

propertyId - the property to search for

Returns:

true if a statement for this property exists

hasStatementValue

public boolean hasStatementValue(PropertyIdValue propertyIdValue,
                                 Value value)

Description copied from interface: StatementDocument

Returns true if there is a statement for the given property and value. This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

hasStatementValue in interface StatementDocument

Parameters:

propertyIdValue - the property to search for

value - the value to search

Returns:

true if a statement for this property and value exists

hasStatementValue

public boolean hasStatementValue(java.lang.String propertyId,
                                 Value value)

Description copied from interface: StatementDocument

Returns true if there is a statement for the given property and value. Only the string id of the property is compared, not the site id. This is useful in situations where all data is known to come from a single site.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

hasStatementValue in interface StatementDocument

Parameters:

propertyId - the property to search for

value - the value to search

Returns:

true if a statement for this property and value exists

hasStatementValue

public boolean hasStatementValue(PropertyIdValue propertyIdValue,
                                 java.util.Set<? extends Value> values)

Description copied from interface: StatementDocument

Returns true if there is a statement for the given property and one of the given values. This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

hasStatementValue in interface StatementDocument

Parameters:

propertyIdValue - the property to search for

values - the set of values to search

Returns:

true if a statement for this property and value exists

hasStatementValue

public boolean hasStatementValue(java.lang.String propertyId,
                                 java.util.Set<? extends Value> values)

Description copied from interface: StatementDocument

Returns true if there is a statement for the given property and one of the given values. Only the string id of the property is compared, not the site id. This is useful in situations where all data is known to come from a single site.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

hasStatementValue in interface StatementDocument

Parameters:

propertyId - the property to search for

values - the set of values to search

Returns:

true if a statement for this property and value exists

findStatement

public Statement findStatement(PropertyIdValue propertyIdValue)

Description copied from interface: StatementDocument

Returns the unique Statement for the given property, or null if there are zero or many statements for this property. This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatement in interface StatementDocument

Parameters:

propertyIdValue - the property to search for

Returns:

Statement or null

findStatement

public Statement findStatement(java.lang.String propertyId)

Description copied from interface: StatementDocument

Returns the unique Statement for the given property, or null if there are zero or many statements for this property. Only the string id of the property is compared, not the site id. This is useful in situations where all data is known to come from a single site.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatement in interface StatementDocument

Parameters:

propertyId - the property to search for

Returns:

Statement or null

findStatementValue

public Value findStatementValue(PropertyIdValue propertyIdValue)

Description copied from interface: StatementDocument

Returns the unique Value for the given property, or null if there are zero or many values given in statements for this property.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementValue in interface StatementDocument

Parameters:

propertyIdValue - the property to search for

Returns:

Value or null

findStatementValue

public Value findStatementValue(java.lang.String propertyId)

Description copied from interface: StatementDocument

Returns the unique Value for the given property, or null if there are zero or many values given in statements for this property. Only the string id of the property is compared, not the site id. This is useful in situations where all data is known to come from a single site.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementValue in interface StatementDocument

Parameters:

propertyId - the property to search for

Returns:

Value or null

findStatementStringValue

public StringValue findStatementStringValue(PropertyIdValue propertyIdValue)

Description copied from interface: StatementDocument

Returns the unique StringValue for the given property, or null if there are zero or many such values given in statements for this property.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementStringValue in interface StatementDocument

Parameters:

propertyIdValue - the property to search for

Returns:

StringValue or null

findStatementStringValue

public StringValue findStatementStringValue(java.lang.String propertyId)

Description copied from interface: StatementDocument

Returns the unique StringValue for the given property, or null if there are zero or many such values given in statements for this property. Only the string id of the property is compared, not the site id. This is useful in situations where all data is known to come from a single site.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementStringValue in interface StatementDocument

Parameters:

propertyId - the property to search for

Returns:

StringValue or null

findStatementQuantityValue

public QuantityValue findStatementQuantityValue(PropertyIdValue propertyIdValue)

Description copied from interface: StatementDocument

Returns the unique QuantityValue for the given property, or null if there are zero or many such values given in statements for this property.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementQuantityValue in interface StatementDocument

Parameters:

propertyIdValue - the property to search for

Returns:

QuantityValue or null

findStatementQuantityValue

public QuantityValue findStatementQuantityValue(java.lang.String propertyId)

Description copied from interface: StatementDocument

Returns the unique QuantityValue for the given property, or null if there are zero or many such values given in statements for this property. Only the string id of the property is compared, not the site id. This is useful in situations where all data is known to come from a single site.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementQuantityValue in interface StatementDocument

Parameters:

propertyId - the property to search for

Returns:

QuantityValue or null

findStatementTimeValue

public TimeValue findStatementTimeValue(PropertyIdValue propertyIdValue)

Description copied from interface: StatementDocument

Returns the unique TimeValue for the given property, or null if there are zero or many such values given in statements for this property.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementTimeValue in interface StatementDocument

Parameters:

propertyIdValue - the property to search for

Returns:

TimeValue or null

findStatementTimeValue

public TimeValue findStatementTimeValue(java.lang.String propertyId)

Description copied from interface: StatementDocument

Returns the unique TimeValue for the given property, or null if there are zero or many such values given in statements for this property. Only the string id of the property is compared, not the site id. This is useful in situations where all data is known to come from a single site.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementTimeValue in interface StatementDocument

Parameters:

propertyId - the property to search for

Returns:

TimeValue or null

findStatementMonolingualTextValue

public MonolingualTextValue findStatementMonolingualTextValue(PropertyIdValue propertyIdValue)

Description copied from interface: StatementDocument

Returns the unique MonolingualTextValue for the given property, or null if there are zero or many such values given in statements for this property.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementMonolingualTextValue in interface StatementDocument

Parameters:

propertyIdValue - the property to search for

Returns:

MonolingualTextValue or null

findStatementMonolingualTextValue

public MonolingualTextValue findStatementMonolingualTextValue(java.lang.String propertyId)

Description copied from interface: StatementDocument

Returns the unique MonolingualTextValue for the given property, or null if there are zero or many such values given in statements for this property. Only the string id of the property is compared, not the site id. This is useful in situations where all data is known to come from a single site.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementMonolingualTextValue in interface StatementDocument

Parameters:

propertyId - the property to search for

Returns:

MonolingualTextValue or null

findStatementItemIdValue

public ItemIdValue findStatementItemIdValue(PropertyIdValue propertyIdValue)

Description copied from interface: StatementDocument

Returns the unique ItemIdValue for the given property, or null if there are zero or many such values given in statements for this property.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementItemIdValue in interface StatementDocument

Parameters:

propertyIdValue - the property to search for

Returns:

ItemIdValue or null

findStatementItemIdValue

public ItemIdValue findStatementItemIdValue(java.lang.String propertyId)

Description copied from interface: StatementDocument

Returns the unique ItemIdValue for the given property, or null if there are zero or many such values given in statements for this property. Only the string id of the property is compared, not the site id. This is useful in situations where all data is known to come from a single site.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementItemIdValue in interface StatementDocument

Parameters:

propertyId - the property to search for

Returns:

ItemIdValue or null

findStatementPropertyIdValue

public PropertyIdValue findStatementPropertyIdValue(PropertyIdValue propertyIdValue)

Description copied from interface: StatementDocument

Returns the unique PropertyIdValue for the given property, or null if there are zero or many such values given in statements for this property.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementPropertyIdValue in interface StatementDocument

Parameters:

propertyIdValue - the property to search for

Returns:

PropertyIdValue or null

findStatementPropertyIdValue

public PropertyIdValue findStatementPropertyIdValue(java.lang.String propertyId)

Description copied from interface: StatementDocument

Returns the unique PropertyIdValue for the given property, or null if there are zero or many such values given in statements for this property. Only the string id of the property is compared, not the site id. This is useful in situations where all data is known to come from a single site.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementPropertyIdValue in interface StatementDocument

Parameters:

propertyId - the property to search for

Returns:

PropertyIdValue or null

findStatementEntityIdValue

public EntityIdValue findStatementEntityIdValue(PropertyIdValue propertyIdValue)

Description copied from interface: StatementDocument

Returns the unique EntityIdValue for the given property, or null if there are zero or many such values given in statements for this property.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementEntityIdValue in interface StatementDocument

Parameters:

propertyIdValue - the property to search for

Returns:

EntityIdValue or null

findStatementEntityIdValue

public EntityIdValue findStatementEntityIdValue(java.lang.String propertyId)

Description copied from interface: StatementDocument

Returns the unique EntityIdValue for the given property, or null if there are zero or many such values given in statements for this property. Only the string id of the property is compared, not the site id. This is useful in situations where all data is known to come from a single site.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementEntityIdValue in interface StatementDocument

Parameters:

propertyId - the property to search for

Returns:

EntityIdValue or null

findStatementDatatypeIdValue

public DatatypeIdValue findStatementDatatypeIdValue(PropertyIdValue propertyIdValue)

Description copied from interface: StatementDocument

Returns the unique DatatypeIdValue for the given property, or null if there are zero or many such values given in statements for this property.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementDatatypeIdValue in interface StatementDocument

Parameters:

propertyIdValue - the property to search for

Returns:

DatatypeIdValue or null

findStatementDatatypeIdValue

public DatatypeIdValue findStatementDatatypeIdValue(java.lang.String propertyId)

Description copied from interface: StatementDocument

Returns the unique DatatypeIdValue for the given property, or null if there are zero or many such values given in statements for this property. Only the string id of the property is compared, not the site id. This is useful in situations where all data is known to come from a single site.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementDatatypeIdValue in interface StatementDocument

Parameters:

propertyId - the property to search for

Returns:

DatatypeIdValue or null

findStatementGlobeCoordinatesValue

public GlobeCoordinatesValue findStatementGlobeCoordinatesValue(PropertyIdValue propertyIdValue)

Description copied from interface: StatementDocument

Returns the unique GlobeCoordinatesValue for the given property, or null if there are zero or many such values given in statements for this property.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementGlobeCoordinatesValue in interface StatementDocument

Parameters:

propertyIdValue - the property to search for

Returns:

GlobeCoordinatesValue or null

findStatementGlobeCoordinatesValue

public GlobeCoordinatesValue findStatementGlobeCoordinatesValue(java.lang.String propertyId)

Description copied from interface: StatementDocument

Returns the unique GlobeCoordinatesValue for the given property, or null if there are zero or many such values given in statements for this property. Only the string id of the property is compared, not the site id. This is useful in situations where all data is known to come from a single site.

This is a convenience method for accessing the data that can be obtained via StatementDocument.getStatementGroups().

Specified by:

findStatementGlobeCoordinatesValue in interface StatementDocument

Parameters:

propertyId - the property to search for

Returns:

GlobeCoordinatesValue or null

containsStatementValue

protected boolean containsStatementValue(StatementGroup statementGroup,
                                         java.util.Set<? extends Value> values)

Returns true if the given statement group contains a statement with one of the given values.

Parameters:

statementGroup - the group of statements to search

values - set of acceptable values

Returns:

true if found

getUniqueStatementFromStatementGroup

protected Statement getUniqueStatementFromStatementGroup(StatementGroup statementGroup)

Returns the unique statement in a statement group, or null if there are zero or more statements. The given statement group can be null; then null will be returned, too.

Parameters:

statementGroup - the statement group or null

Returns:

the unique statement or null

getValueFromStatement

protected Value getValueFromStatement(Statement statement)

Returns the Value of the given Statement, provided that the statements actually has a value. Otherwise null is returned.

Parameters:

statement - the statement to process

Returns:

the value, or null if there is none

castValue

protected <T extends Value> T castValue(Value value,
                                        java.lang.Class<T> valueClass)

Casts the given value to the given class if possible, or returns null if not.

Parameters:

value - the Value to cast

valueClass - the class to cast to

Returns:

casted value or null