org.wikidata.wdtk.datamodel.interfaces

Class EntityDocumentProcessorFilter

java.lang.Object

org.wikidata.wdtk.datamodel.interfaces.EntityDocumentProcessorFilter

All Implemented Interfaces:

EntityDocumentProcessor

public class EntityDocumentProcessorFilter
extends Object
implements EntityDocumentProcessor

Implementation of EntityDocumentProcessor that acts as a filter, removing some of the data from EntityDocument objects before passing them on to another processor. There is an overhead involved in using this, even if no filters are set, since a deep copy of the data is created to filter it.

Author:

Markus Kroetzsch

Constructor Summary

Constructors

Constructor and Description
EntityDocumentProcessorFilter(EntityDocumentProcessor entityDocumentProcessor) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	processItemDocument(ItemDocument itemDocument) Processes the given ItemDocument.
void	processPropertyDocument(PropertyDocument propertyDocument) Processes the given PropertyDocument.
void	setLanguageFilter(Set<String> languageFilter) Sets a language filter.
void	setPropertyFilter(Set<PropertyIdValue> propertyFilter) Sets a property filter.
void	setSiteLinkFilter(Set<String> siteLinkFilter) Sets a site link filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityDocumentProcessorFilter

public EntityDocumentProcessorFilter(EntityDocumentProcessor entityDocumentProcessor)

Constructor.

Parameters:

entityDocumentProcessor - the processor to use on the filtered data

Method Detail

setPropertyFilter

public void setPropertyFilter(Set<PropertyIdValue> propertyFilter)

Sets a property filter. If given, all data will be preprocessed to contain only statements for the given (main) properties.

Parameters:

propertyFilter - set of language codes that should be retained (can be empty)

See Also:

DatamodelConverter.setOptionPropertyFilter(Set)

setSiteLinkFilter

public void setSiteLinkFilter(Set<String> siteLinkFilter)

Sets a site link filter. If given, all data will be preprocessed to contain only data for the given site keys.

Parameters:

siteLinkFilter - set of language codes that should be retained (can be empty)

See Also:

DatamodelConverter.setOptionSiteLinkFilter(Set)

setLanguageFilter

public void setLanguageFilter(Set<String> languageFilter)

Sets a language filter. If given, all data will be preprocessed to contain only data for the given languages.

Parameters:

languageFilter - set of language codes that should be retained (can be empty)

See Also:

DatamodelConverter.setOptionLanguageFilter(Set)

processItemDocument

public void processItemDocument(ItemDocument itemDocument)

Description copied from interface: EntityDocumentProcessor

Processes the given ItemDocument.

Specified by:

processItemDocument in interface EntityDocumentProcessor

Parameters:

itemDocument - the ItemDocument

processPropertyDocument

public void processPropertyDocument(PropertyDocument propertyDocument)

Description copied from interface: EntityDocumentProcessor

Processes the given PropertyDocument.

Specified by:

processPropertyDocument in interface EntityDocumentProcessor

Parameters:

propertyDocument - the PropertyDocument