org.wikidata.query.rdf.blazegraph.mwapi

Class MWApiLimits

java.lang.Object

org.wikidata.query.rdf.blazegraph.mwapi.MWApiLimits

@NotThreadSafe
public class MWApiLimits
extends Object

Tracker for limits to MediaWiki API calls. Implements a limit on the total number of results, one on the total number of continuations, and one on the number of consecutive continuations that returned no result (“empty” continuations; only possible if miser mode is enabled on the target wiki).

Constructor Summary

Constructors

Constructor and Description
MWApiLimits(int limitResults, int limitContinuations, int limitEmptyContinuations) Create a new tracker instance.

Method Summary

Modifier and Type	Method and Description
boolean	allowContinuation() Check whether one more continuation should be allowed, without any change to the state of the tracker.
boolean	allowResult() Check whether one more API result should be allowed, without any change to the state of the tracker.
void	haveContinuation() Inform the tracker that one more continuation has been performed, and adjust the internal counters accordingly.
void	haveResult() Inform the tracker that one more API result has been retrieved, and adjust the internal counters accordingly.

Methods inherited from class java.lang.Object

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

Constructor Detail

MWApiLimits

public MWApiLimits(int limitResults,
                   int limitContinuations,
                   int limitEmptyContinuations)

Create a new tracker instance.

Parameters:

limitResults - maximum number of results to fetch

limitContinuations - maximum number of continuations to follow

limitEmptyContinuations - maximum number of consecutive empty continuations to follow

Method Detail

allowResult

public boolean allowResult()

Check whether one more API result should be allowed, without any change to the state of the tracker.

haveResult

public void haveResult()

Inform the tracker that one more API result has been retrieved, and adjust the internal counters accordingly.

allowContinuation

public boolean allowContinuation()

Check whether one more continuation should be allowed, without any change to the state of the tracker.

haveContinuation

public void haveContinuation()

Inform the tracker that one more continuation has been performed, and adjust the internal counters accordingly.