org.wikidata.query.rdf.tool.wikibase

Class WikibaseRepository

java.lang.Object

org.wikidata.query.rdf.tool.wikibase.WikibaseRepository

All Implemented Interfaces:

Closeable, AutoCloseable

public class WikibaseRepository
extends Object
implements Closeable

Wraps Wikibase api.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WikibaseRepository.Uris URIs used for accessing wikibase.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INPUT_DATE_FORMAT Standard representation of dates in Mediawiki API (ISO 8601).
static DateTimeFormatter	INPUT_DATE_FORMATTER DateTimeFormatter object that parses from and formats to the date in the format that wikibase returns, i.e.
static DateTimeFormatter	OUTPUT_DATE_FORMATTER DateTimeFormatter object that parses from and formats to the date in the format that wikibase wants as input, i.e.

Constructor Summary

Constructors

Constructor and Description
WikibaseRepository(String baseUrl, com.codahale.metrics.MetricRegistry metricRegistry)
WikibaseRepository(URI baseUrl, com.codahale.metrics.MetricRegistry metricRegistry)
WikibaseRepository(URI baseUrl, Set<Long> entityNamespaces, com.codahale.metrics.MetricRegistry metricRegistry)
WikibaseRepository(WikibaseRepository.Uris uris, boolean collectConstraints, com.codahale.metrics.MetricRegistry metricRegistry, StreamDumper streamDumper)

Method Summary

Modifier and Type	Method and Description
void	batchDone() Notifies repository that a batch of changes has been processed.
void	close()
void	delete(String entityId) Delete entity from repository.
Collection<org.openrdf.model.Statement>	fetchRdfForEntity(String entityId) Fetch the RDF for some entity.
RecentChangeResponse	fetchRecentChanges(Instant nextStartTime, Continue lastContinue, int batchSize) Fetch recent changes starting from nextStartTime or continuing from lastContinue depending on the contents of lastContinue way to use MediaWiki.
RecentChangeResponse	fetchRecentChangesByTime(Instant nextStartTime, int batchSize) Fetch recent changes starting from nextStartTime or continuing from lastContinue depending on the contents of lastContinue way to use MediaWiki.
String	firstEntityIdForLabelStartingWith(String label, String language, String type) Get the first id with the provided label in the provided language.
Change	getChangeFromContinue(Continue nextContinue) Extract timestamp from continue JSON object.
WikibaseRepository.Uris	getUris() Get repository URI setup.
boolean	isEntityNamespace(long namespace) Check that a namespace is valid wikibase entity namespace.
boolean	isValidEntity(String name) Check if the entity ID is a valid entity ID.
void	setCollectConstraints(boolean collectConstraints) Should we collect constraints?
String	setLabel(String entityId, String type, String label, String language) Edits or creates a page by setting a label.

Methods inherited from class java.lang.Object

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

Field Detail

INPUT_DATE_FORMAT

public static final String INPUT_DATE_FORMAT

Standard representation of dates in Mediawiki API (ISO 8601).

See Also:

Constant Field Values

INPUT_DATE_FORMATTER

public static final DateTimeFormatter INPUT_DATE_FORMATTER

DateTimeFormatter object that parses from and formats to the date in the format that wikibase returns, i.e. yyyy-MM-dd'T'HH:mm:ss

OUTPUT_DATE_FORMATTER

public static final DateTimeFormatter OUTPUT_DATE_FORMATTER

DateTimeFormatter object that parses from and formats to the date in the format that wikibase wants as input, i.e. yyyyMMddHHmmss.

Constructor Detail

WikibaseRepository

public WikibaseRepository(URI baseUrl,
                          com.codahale.metrics.MetricRegistry metricRegistry)

WikibaseRepository

public WikibaseRepository(String baseUrl,
                          com.codahale.metrics.MetricRegistry metricRegistry)

WikibaseRepository

public WikibaseRepository(URI baseUrl,
                          Set<Long> entityNamespaces,
                          com.codahale.metrics.MetricRegistry metricRegistry)

WikibaseRepository

public WikibaseRepository(WikibaseRepository.Uris uris,
                          boolean collectConstraints,
                          com.codahale.metrics.MetricRegistry metricRegistry,
                          StreamDumper streamDumper)

Method Detail

fetchRecentChangesByTime

public RecentChangeResponse fetchRecentChangesByTime(Instant nextStartTime,
                                                     int batchSize)
                                              throws RetryableException

Fetch recent changes starting from nextStartTime or continuing from lastContinue depending on the contents of lastContinue way to use MediaWiki. See RecentChangesPoller for how to poll these. Or just use it.

Parameters:

nextStartTime - if lastContinue is null then this is the start time of the query

batchSize - the number of recent changes to fetch

Returns:

result of query

Throws:

RetryableException - thrown if there is an error communicating with wikibase

fetchRecentChanges

public RecentChangeResponse fetchRecentChanges(Instant nextStartTime,
                                               Continue lastContinue,
                                               int batchSize)
                                        throws RetryableException

Fetch recent changes starting from nextStartTime or continuing from lastContinue depending on the contents of lastContinue way to use MediaWiki. See RecentChangesPoller for how to poll these. Or just use it.

Parameters:

nextStartTime - if lastContinue is null then this is the start time of the query

batchSize - the number of recent changes to fetch

lastContinue - Continuation object from last batch, or null.

Returns:

result of query

Throws:

RetryableException - thrown if there is an error communicating with wikibase

fetchRdfForEntity

public Collection<org.openrdf.model.Statement> fetchRdfForEntity(String entityId)
                                                          throws RetryableException

Fetch the RDF for some entity.

Throws:

RetryableException - thrown if there is an error communicating with wikibase

firstEntityIdForLabelStartingWith

public String firstEntityIdForLabelStartingWith(String label,
                                                String language,
                                                String type)
                                         throws RetryableException

Get the first id with the provided label in the provided language.

Throws:

RetryableException - thrown if there is an error communicating with wikibase

setLabel

public String setLabel(String entityId,
                       String type,
                       String label,
                       String language)
                throws RetryableException

Edits or creates a page by setting a label. Used for testing.

Parameters:

entityId - id of the entity - if null then the entity will be created new

type - type of entity to create or edit

label - label of the page to create

language - language of the label to add

Returns:

the entityId

Throws:

RetryableException - thrown if there is an error communicating with wikibase

delete

public void delete(String entityId)
            throws RetryableException

Delete entity from repository.

Throws:

RetryableException - thrown if there is an error communicating with wikibase

isEntityNamespace

public boolean isEntityNamespace(long namespace)

Check that a namespace is valid wikibase entity namespace.

Parameters:

namespace - the namespace index

isValidEntity

public boolean isValidEntity(String name)

Check if the entity ID is a valid entity ID.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getChangeFromContinue

public Change getChangeFromContinue(Continue nextContinue)

Extract timestamp from continue JSON object.

Returns:

Timestamp as date

Throws:

DateTimeParseException - When data is in the wrong format

NumberFormatException - When data is in the wrong format

getUris

public WikibaseRepository.Uris getUris()

Get repository URI setup.

setCollectConstraints

public void setCollectConstraints(boolean collectConstraints)

Should we collect constraints?

batchDone

public void batchDone()

Notifies repository that a batch of changes has been processed. Used for dumper maintenance for now.