Package org.wikidata.wdtk.datamodel.interfaces

Interface StatementDocument

All Superinterfaces:

EntityDocument

All Known Subinterfaces:

ItemDocument, PropertyDocument

All Known Implementing Classes:

AbstractTermedStatementDocument, ItemDocumentImpl, JacksonItemDocument, JacksonPropertyDocument, JacksonTermedStatementDocument, PropertyDocumentImpl, TermedStatementDocumentImpl

public interface StatementDocument
extends EntityDocument

Interface for EntityDocuments that can have statements.

Author:

Markus Kroetzsch

Method Summary

Modifier and Type	Method	Description
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.
java.util.List<StatementGroup>	getStatementGroups()	Return the list of all StatementGroups stored for this item.
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

Method Detail

getStatementGroups

java.util.List<StatementGroup> getStatementGroups()

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

Returns:

list of StatementGroups

getAllStatements

java.util.Iterator<Statement> getAllStatements()

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

Returns:

iterator over all statements

findStatementGroup

StatementGroup findStatementGroup(PropertyIdValue propertyIdValue)

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 getStatementGroups().

Parameters:

propertyIdValue - the property to search for

Returns:

StatementGroup or null

findStatementGroup

StatementGroup findStatementGroup(java.lang.String propertyId)

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 getStatementGroups().

Parameters:

propertyId - the property to search for

Returns:

StatementGroup or null

hasStatement

boolean hasStatement(PropertyIdValue propertyIdValue)

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 getStatementGroups().

Parameters:

propertyIdValue - the property to search for

Returns:

true if a statement for this property exists

hasStatement

boolean hasStatement(java.lang.String propertyId)

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 getStatementGroups().

Parameters:

propertyId - the property to search for

Returns:

true if a statement for this property exists

hasStatementValue

boolean hasStatementValue(PropertyIdValue propertyIdValue,
                          Value value)

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 getStatementGroups().

Parameters:

propertyIdValue - the property to search for

value - the value to search

Returns:

true if a statement for this property and value exists

hasStatementValue

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

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 getStatementGroups().

Parameters:

propertyId - the property to search for

value - the value to search

Returns:

true if a statement for this property and value exists

hasStatementValue

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. This is a convenience method for accessing the data that can be obtained via getStatementGroups().

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

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. 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 getStatementGroups().

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

Statement findStatement(PropertyIdValue propertyIdValue)

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 getStatementGroups().

Parameters:

propertyIdValue - the property to search for

Returns:

Statement or null

findStatement

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. 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 getStatementGroups().

Parameters:

propertyId - the property to search for

Returns:

Statement or null

findStatementValue

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.

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

Parameters:

propertyIdValue - the property to search for

Returns:

Value or null

findStatementValue

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. 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 getStatementGroups().

Parameters:

propertyId - the property to search for

Returns:

Value or null

findStatementStringValue

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.

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

Parameters:

propertyIdValue - the property to search for

Returns:

StringValue or null

findStatementStringValue

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. 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 getStatementGroups().

Parameters:

propertyId - the property to search for

Returns:

StringValue or null

findStatementQuantityValue

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.

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

Parameters:

propertyIdValue - the property to search for

Returns:

QuantityValue or null

findStatementQuantityValue

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. 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 getStatementGroups().

Parameters:

propertyId - the property to search for

Returns:

QuantityValue or null

findStatementGlobeCoordinatesValue

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.

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

Parameters:

propertyIdValue - the property to search for

Returns:

GlobeCoordinatesValue or null

findStatementGlobeCoordinatesValue

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. 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 getStatementGroups().

Parameters:

propertyId - the property to search for

Returns:

GlobeCoordinatesValue or null

findStatementTimeValue

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.

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

Parameters:

propertyIdValue - the property to search for

Returns:

TimeValue or null

findStatementTimeValue

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. 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 getStatementGroups().

Parameters:

propertyId - the property to search for

Returns:

TimeValue or null

findStatementMonolingualTextValue

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.

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

Parameters:

propertyIdValue - the property to search for

Returns:

MonolingualTextValue or null

findStatementMonolingualTextValue

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. 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 getStatementGroups().

Parameters:

propertyId - the property to search for

Returns:

MonolingualTextValue or null

findStatementItemIdValue

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.

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

Parameters:

propertyIdValue - the property to search for

Returns:

ItemIdValue or null

findStatementItemIdValue

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. 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 getStatementGroups().

Parameters:

propertyId - the property to search for

Returns:

ItemIdValue or null

findStatementPropertyIdValue

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.

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

Parameters:

propertyIdValue - the property to search for

Returns:

PropertyIdValue or null

findStatementPropertyIdValue

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. 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 getStatementGroups().

Parameters:

propertyId - the property to search for

Returns:

PropertyIdValue or null

findStatementEntityIdValue

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.

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

Parameters:

propertyIdValue - the property to search for

Returns:

EntityIdValue or null

findStatementEntityIdValue

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. 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 getStatementGroups().

Parameters:

propertyId - the property to search for

Returns:

EntityIdValue or null

findStatementDatatypeIdValue

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.

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

Parameters:

propertyIdValue - the property to search for

Returns:

DatatypeIdValue or null

findStatementDatatypeIdValue

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. 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 getStatementGroups().

Parameters:

propertyId - the property to search for

Returns:

DatatypeIdValue or null