org.wikidata.wdtk.datamodel.helpers

Class DatamodelConverter

java.lang.Object

org.wikidata.wdtk.datamodel.helpers.DatamodelConverter

All Implemented Interfaces:

SnakVisitor<Snak>, ValueVisitor<Value>

public class DatamodelConverter
extends Object
implements SnakVisitor<Snak>, ValueVisitor<Value>

Class to re-create data model objects using a specified factory. This is provided in place of having copy constructors in each and every implementation of the data model. Note that data model objects are usually immutable and do not need to be copied. The use of this class is to convert data objects to a specific implementation, as might be needed for some specialized purpose (e.g., for JSON export).

Author:

Markus Kroetzsch

Constructor Summary

Constructors

Constructor and Description
DatamodelConverter(DataObjectFactory dataObjectFactory) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Claim	copy(Claim object) Copies a Claim.
DatatypeIdValue	copy(DatatypeIdValue object) Copies a DatatypeIdValue.
GlobeCoordinatesValue	copy(GlobeCoordinatesValue object) Copies a GlobeCoordinatesValue.
ItemDocument	copy(ItemDocument object) Copies an ItemDocument.
ItemIdValue	copy(ItemIdValue object) Copies an ItemIdValue.
MonolingualTextValue	copy(MonolingualTextValue object) Copies a MonolingualTextValue.
NoValueSnak	copy(NoValueSnak object) Copies a NoValueSnak.
PropertyDocument	copy(PropertyDocument object) Copies a PropertyDocument.
PropertyIdValue	copy(PropertyIdValue object) Copies a PropertyIdValue.
QuantityValue	copy(QuantityValue object) Copies a QuantityValue.
Reference	copy(Reference object) Copies a Reference.
SiteLink	copy(SiteLink object) Copies a SiteLink.
SnakGroup	copy(SnakGroup object) Copies a SnakGroup.
SomeValueSnak	copy(SomeValueSnak object) Copies a SomeValueSnak.
Statement	copy(Statement object) Copies a Statement.
StatementGroup	copy(StatementGroup object) Copies a StatementGroup.
StringValue	copy(StringValue object) Copies a StringValue.
TimeValue	copy(TimeValue object) Copies a TimeValue.
ValueSnak	copy(ValueSnak object) Copies a ValueSnak.
Snak	copySnak(Snak snak) Copies a Snak.
Value	copyValue(Value value) Copies a Value.
Set<String>	getOptionLanguageFilter() Returns the (possibly empty) set of language codes that are used to filter data while copying it, or null if no such filter is configured (default).
Set<PropertyIdValue>	getOptionPropertyFilter() Returns the (possibly empty) set of PropertyIdValue objects that are used to filter statements while copying data, or null if no such filter is configured (default).
Set<String>	getOptionSiteLinkFilter() Returns the (possibly empty) set of site keys that are used to filter SiteLink objects while copying data, or null if no such filter is configured (default).
boolean	hasOptionDeepCopy() Returns true if objects will be copied by deep copy, replacing all subobjects recursively.
boolean	hasOptionDeepCopyReferences() Returns true if references will be copied when creating a deep copy of statements.
void	setOptionDeepCopy(boolean value) Sets the value of the deep copy option.
void	setOptionDeepCopyReferences(boolean value) Sets the value of the deep copy references option.
void	setOptionLanguageFilter(Set<String> languageFilter) Sets the (possibly empty) set of language codes that are used to filter data while copying it.
void	setOptionPropertyFilter(Set<PropertyIdValue> propertyFilter) Sets the (possibly empty) set of PropertyIdValue objects that are used to filter statements while copying data.
void	setOptionSiteLinkFilter(Set<String> siteLinkFilter) Sets the (possibly empty) set of site keys that are used to filter SiteLink objects while copying data.
Value	visit(DatatypeIdValue value) Visits a DatatypeIdValue and returns a result.
Value	visit(EntityIdValue value) Visits a EntityIdValue and returns a result.
Value	visit(GlobeCoordinatesValue value) Visits a GlobeCoordinatesValue and returns a result.
Value	visit(MonolingualTextValue value) Visits a MonolingualTextValue and returns a result.
Snak	visit(NoValueSnak snak) Visits a NoValueSnak and returns a result.
Value	visit(QuantityValue value) Visits a QuantityValue and returns a result.
Snak	visit(SomeValueSnak snak) Visits a SomeValueSnak and returns a result.
Value	visit(StringValue value) Visits a StringValue and returns a result.
Value	visit(TimeValue value) Visits a TimeValue and returns a result.
Snak	visit(ValueSnak snak) Visits a ValueSnak and returns a result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DatamodelConverter

public DatamodelConverter(DataObjectFactory dataObjectFactory)

Constructor.

Parameters:

dataObjectFactory - the factory to use for creating new objects

Method Detail

hasOptionDeepCopy

public boolean hasOptionDeepCopy()

Returns true if objects will be copied by deep copy, replacing all subobjects recursively. This is the default.

Returns:

true if deep copy is to be used

setOptionDeepCopy

public void setOptionDeepCopy(boolean value)

Sets the value of the deep copy option. If true, subobjects of objects will be copied recursively.

Parameters:

value - the value of the deep copy option

hasOptionDeepCopyReferences

public boolean hasOptionDeepCopyReferences()

Returns true if references will be copied when creating a deep copy of statements. This is the default. The setting ahs no effect when shallow copies are used.

Returns:

true if references are included in deep copy

setOptionDeepCopyReferences

public void setOptionDeepCopyReferences(boolean value)

Sets the value of the deep copy references option. If true, references will be copied when creating a deep copy of statements.

Parameters:

value - the value of the deep copy references option

getOptionLanguageFilter

public Set<String> getOptionLanguageFilter()

Returns the (possibly empty) set of language codes that are used to filter data while copying it, or null if no such filter is configured (default). If not equal to null, only terms in the given language will be copied.

Returns:

set of language codes to use for filtering

setOptionLanguageFilter

public void setOptionLanguageFilter(Set<String> languageFilter)

Sets the (possibly empty) set of language codes that are used to filter data while copying it. Setting this to null disables this filter (this is the default). If not equal to null, only terms in the given language will be copied.

The language filter is not applied to monolingual text values in statements. Only labels, descriptions, and aliases are filtered.

Parameters:

languageFilter - set of language codes to restrict copying to

getOptionPropertyFilter

public Set<PropertyIdValue> getOptionPropertyFilter()

Returns the (possibly empty) set of PropertyIdValue objects that are used to filter statements while copying data, or null if no such filter is configured (default). If not equal to null, only statements using the given properties will be copied.

Returns:

set of properties to use for filtering

setOptionPropertyFilter

public void setOptionPropertyFilter(Set<PropertyIdValue> propertyFilter)

Sets the (possibly empty) set of PropertyIdValue objects that are used to filter statements while copying data. Setting this to null disables this filter (this is the default). If not equal to null, only statements using the given properties will be copied.

The property filter is not applied to qualifiers and references in statements. Only the main property of statements is filtered.

Parameters:

propertyFilter - set of properties to use for filtering

getOptionSiteLinkFilter

public Set<String> getOptionSiteLinkFilter()

Returns the (possibly empty) set of site keys that are used to filter SiteLink objects while copying data, or null if no such filter is configured (default). If not equal to null, only site links for the given sites will be copied.

Returns:

set of site keys to use for filtering

setOptionSiteLinkFilter

public void setOptionSiteLinkFilter(Set<String> siteLinkFilter)

Sets the (possibly empty) set of site keys that are used to filter SiteLink objects while copying data. Setting this to null disables this filter (this is the default). If not equal to null, only site links for the given sites will be copied.

Parameters:

siteLinkFilter - set of site keys to use for filtering

copy

public ItemIdValue copy(ItemIdValue object)

Copies an ItemIdValue.

Parameters:

object - object to copy

Returns:

copied object

copy

public PropertyIdValue copy(PropertyIdValue object)

Copies a PropertyIdValue.

Parameters:

object - object to copy

Returns:

copied object

copy

public DatatypeIdValue copy(DatatypeIdValue object)

Copies a DatatypeIdValue.

Parameters:

object - object to copy

Returns:

copied object

copy

public TimeValue copy(TimeValue object)

Copies a TimeValue.

Parameters:

object - object to copy

Returns:

copied object

copy

public GlobeCoordinatesValue copy(GlobeCoordinatesValue object)

Copies a GlobeCoordinatesValue.

Parameters:

object - object to copy

Returns:

copied object

copy

public StringValue copy(StringValue object)

Copies a StringValue.

Parameters:

object - object to copy

Returns:

copied object

copy

public MonolingualTextValue copy(MonolingualTextValue object)

Copies a MonolingualTextValue. This method is not affected by the language filter option (see setOptionLanguageFilter(Set)).

Parameters:

object - object to copy

Returns:

copied object

copy

public QuantityValue copy(QuantityValue object)

Copies a QuantityValue.

Parameters:

object - object to copy

Returns:

copied object

copy

public ValueSnak copy(ValueSnak object)

Copies a ValueSnak.

Parameters:

object - object to copy

Returns:

copied object

copy

public SomeValueSnak copy(SomeValueSnak object)

Copies a SomeValueSnak.

Parameters:

object - object to copy

Returns:

copied object

copy

public NoValueSnak copy(NoValueSnak object)

Copies a NoValueSnak.

Parameters:

object - object to copy

Returns:

copied object

copy

public SnakGroup copy(SnakGroup object)

Copies a SnakGroup.

Parameters:

object - object to copy

Returns:

copied object

copy

public Claim copy(Claim object)

Copies a Claim.

Parameters:

object - object to copy

Returns:

copied object

copy

public Reference copy(Reference object)

Copies a Reference.

Parameters:

object - object to copy

Returns:

copied object

copy

public Statement copy(Statement object)

Copies a Statement.

Parameters:

object - object to copy

Returns:

copied object

copy

public StatementGroup copy(StatementGroup object)

Copies a StatementGroup.

This method ignores filters set via setOptionPropertyFilter(Set).

Parameters:

object - object to copy

Returns:

copied object

copy

public SiteLink copy(SiteLink object)

Copies a SiteLink.

This method is not affected by the setting made via setOptionSiteLinkFilter(Set).

Parameters:

object - object to copy

Returns:

copied object

copy

public PropertyDocument copy(PropertyDocument object)

Copies a PropertyDocument.

Parameters:

object - object to copy

Returns:

copied object

copy

public ItemDocument copy(ItemDocument object)

Copies an ItemDocument.

Parameters:

object - object to copy

Returns:

copied object

copySnak

public Snak copySnak(Snak snak)

Copies a Snak.

Parameters:

snak - object to copy

Returns:

copied object

visit

public Snak visit(ValueSnak snak)

Description copied from interface: SnakVisitor

Visits a ValueSnak and returns a result.

Specified by:

visit in interface SnakVisitor<Snak>

Parameters:

snak - the snak to visit

Returns:

the result for this snak

visit

public Snak visit(SomeValueSnak snak)

Description copied from interface: SnakVisitor

Visits a SomeValueSnak and returns a result.

Specified by:

visit in interface SnakVisitor<Snak>

Parameters:

snak - the snak to visit

Returns:

the result for this snak

visit

public Snak visit(NoValueSnak snak)

Description copied from interface: SnakVisitor

Visits a NoValueSnak and returns a result.

Specified by:

visit in interface SnakVisitor<Snak>

Parameters:

snak - the snak to visit

Returns:

the result for this snak

copyValue

public Value copyValue(Value value)

Copies a Value.

Parameters:

value - object to copy

Returns:

copied object

visit

public Value visit(DatatypeIdValue value)

Description copied from interface: ValueVisitor

Visits a DatatypeIdValue and returns a result. This type of value does not occur in snaks, so some implementation will not need this method.

Specified by:

visit in interface ValueVisitor<Value>

Parameters:

value - the value to visit

Returns:

the result for this value

visit

public Value visit(EntityIdValue value)

Description copied from interface: ValueVisitor

Visits a EntityIdValue and returns a result. In practice, only specific subtypes of EntityIdValue are used, such as ItemIdValue and PropertyIdValue. Since the set of possible subtypes can be extended by extensions of Wikibase, the visitor only visits the general (abstract) supertype. Implementations will have to decide if the given specific type is supported and what to do with it.

Specified by:

visit in interface ValueVisitor<Value>

Parameters:

value - the value to visit

Returns:

the result for this value

visit

public Value visit(GlobeCoordinatesValue value)

Description copied from interface: ValueVisitor

Visits a GlobeCoordinatesValue and returns a result.

Specified by:

visit in interface ValueVisitor<Value>

Parameters:

value - the value to visit

Returns:

the result for this value

visit

public Value visit(MonolingualTextValue value)

Description copied from interface: ValueVisitor

Visits a MonolingualTextValue and returns a result.

Specified by:

visit in interface ValueVisitor<Value>

Parameters:

value - the value to visit

Returns:

the result for this value

visit

public Value visit(QuantityValue value)

Description copied from interface: ValueVisitor

Visits a QuantityValue and returns a result.

Specified by:

visit in interface ValueVisitor<Value>

Parameters:

value - the value to visit

Returns:

the result for this value

visit

public Value visit(StringValue value)

Description copied from interface: ValueVisitor

Visits a StringValue and returns a result.

Specified by:

visit in interface ValueVisitor<Value>

Parameters:

value - the value to visit

Returns:

the result for this value

visit

public Value visit(TimeValue value)

Description copied from interface: ValueVisitor

Visits a TimeValue and returns a result.

Specified by:

visit in interface ValueVisitor<Value>

Parameters:

value - the value to visit

Returns:

the result for this value