- getAccessSecret() - Method in class org.wikidata.wdtk.wikibaseapi.OAuthApiConnection
-
- getAccessToken() - Method in class org.wikidata.wdtk.wikibaseapi.OAuthApiConnection
-
- getAddedAliases(String) - Method in class org.wikidata.wdtk.wikibaseapi.TermStatementUpdate
-
Deprecated.
Retrieves the list of aliases that will be added in a
given language, after all the optimizations have been done
(replacing empty labels by new aliases in the same language,
for instance).
- getAliases() - Method in interface org.wikidata.wdtk.wikibaseapi.WbSearchEntitiesResult
-
A list of alias labels (returned only when an alias matched the query).
- getAliasUpdates() - Method in class org.wikidata.wdtk.wikibaseapi.TermStatementUpdate
-
Deprecated.
Alias accessor provided for JSON serialization only
- getApiBaseUrl() - Method in class org.wikidata.wdtk.wikibaseapi.ApiConnection
-
Getter for the apiBaseUrl.
- getAverageTimePerEdit() - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Returns the average time in milliseconds that one edit will take.
- getAverageTimePerEdit() - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataEditor
-
Returns the average time that a single edit should take, measured in
milliseconds.
- getClientBuilder() - Method in class org.wikidata.wdtk.wikibaseapi.ApiConnection
-
Subclasses can customize their own OkHttpClient.Builder instances.
- getClientBuilder() - Method in class org.wikidata.wdtk.wikibaseapi.BasicApiConnection
-
- getClientBuilder() - Method in class org.wikidata.wdtk.wikibaseapi.OAuthApiConnection
-
- getClientLoginText() - Method in enum org.wikidata.wdtk.wikibaseapi.LoginValue
-
- getConceptUri() - Method in interface org.wikidata.wdtk.wikibaseapi.WbSearchEntitiesResult
-
Returns the full concept URI (the site IRI with entity ID).
- getConnectTimeout() - Method in class org.wikidata.wdtk.wikibaseapi.ApiConnection
-
Maximum time to wait for when establishing a connection, in milliseconds.
- getConsumerKey() - Method in class org.wikidata.wdtk.wikibaseapi.OAuthApiConnection
-
- getConsumerSecret() - Method in class org.wikidata.wdtk.wikibaseapi.OAuthApiConnection
-
- getCookies() - Method in class org.wikidata.wdtk.wikibaseapi.BasicApiConnection
-
Returns the map of cookies currently used in this connection.
- getCurrentLag() - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Retrieves the current lag from the target site, by making an API call.
- getCurrentUser() - Method in class org.wikidata.wdtk.wikibaseapi.ApiConnection
-
Returns the username of the user who is currently logged in.
- getCurrentUser() - Method in class org.wikidata.wdtk.wikibaseapi.OAuthApiConnection
-
- getDatamodelObjectFromResponse(JsonNode, List<String>, Class<T>) - Method in class org.wikidata.wdtk.wikibaseapi.StatementUpdate
-
Deprecated.
Extracts a particular data model instance from a JSON response
returned by MediaWiki.
- getDescription() - Method in interface org.wikidata.wdtk.wikibaseapi.WbSearchEntitiesResult
-
Returns the description of the entity
The language of the returned description depends on the HTTP
Accept-Language header or the uselang URL parameter.
- getDescriptionUpdates() - Method in class org.wikidata.wdtk.wikibaseapi.TermStatementUpdate
-
Deprecated.
Description accessor provided for JSON serialization only.
- getEntityDocument(String) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataFetcher
-
Fetches the documents for the entity of the given string IDs.
- getEntityDocumentByTitle(String, String) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataFetcher
-
Fetches the document for the entity that has a page of the given title on
the given site.
- getEntityDocumentFromResponse(JsonNode) - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
TODO: TO BE REFACTORED
- getEntityDocuments(String...) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataFetcher
-
Fetches the documents for the entities of the given string IDs.
- getEntityDocuments(List<String>) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataFetcher
-
Fetches the documents for the entities of the given string IDs.
- getEntityDocumentsByTitle(String, String...) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataFetcher
-
Fetches the documents for the entities that have pages of the given
titles on the given site.
- getEntityDocumentsByTitle(String, List<String>) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataFetcher
-
Fetches the documents for the entities that have pages of the given
titles on the given site.
- getEntityId() - Method in interface org.wikidata.wdtk.wikibaseapi.WbSearchEntitiesResult
-
Returns the id of the entity that the document refers to.
- getErrorCode() - Method in exception org.wikidata.wdtk.wikibaseapi.apierrors.MediaWikiApiErrorException
-
Returns the MediaWiki code of the error that has causes this exception.
- getErrorMessage() - Method in exception org.wikidata.wdtk.wikibaseapi.apierrors.MediaWikiApiErrorException
-
Returns the MediaWiki message string for the error that has causes this
exception.
- getFilter() - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataFetcher
-
- getJsonUpdateString() - Method in class org.wikidata.wdtk.wikibaseapi.StatementUpdate
-
Deprecated.
Returns a JSON serialization of the marked insertions and deletions of
statements, in the format required by the Wikibase "wbeditentity" action.
- getLabel() - Method in interface org.wikidata.wdtk.wikibaseapi.WbSearchEntitiesResult
-
Returns the label of the entity.
- getLabelUpdates() - Method in class org.wikidata.wdtk.wikibaseapi.TermStatementUpdate
-
Deprecated.
Label accessor provided for JSON serialization only.
- getLag() - Method in exception org.wikidata.wdtk.wikibaseapi.apierrors.MaxlagErrorException
-
Retrieves the amount of lag announced by the server when this
error was emitted.
- getLanguage() - Method in interface org.wikidata.wdtk.wikibaseapi.WbSearchEntitiesResult.Match
-
Returns the language of the matching term field.
- getLastRevisionId() - Method in class org.wikidata.wdtk.wikibaseapi.EditingResult
-
The identifier of the revision of the last edit made by the editing action,
if any edit was made.
- getLoginText() - Method in enum org.wikidata.wdtk.wikibaseapi.LoginValue
-
- getMatch() - Method in interface org.wikidata.wdtk.wikibaseapi.WbSearchEntitiesResult
-
Returns detailed information about how a document matched the query.
- getMaxLag() - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Returns the current value of the maxlag parameter.
- getMaxLag() - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataEditor
-
Returns the current value of the maxlag parameter.
- getMaxLagBackOffFactor() - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Factor by which the wait time between two maxlag retries should be
multiplied at each attempt.
- getMaxLagBackOffFactor() - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataEditor
-
Factor by which the wait time between two maxlag retries should be
multiplied at each attempt.
- getMaxLagFirstWaitTime() - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Initial wait time in milliseconds, when an edit fails for the first
time because of a high lag.
- getMaxLagFirstWaitTime() - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataEditor
-
Initial wait time in milliseconds, when an edit fails for the first
time because of a high lag.
- getMaxLagMaxRetries() - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Number of times we should retry if an editing action fails because
the lag is too high.
- getMaxLagMaxRetries() - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataEditor
-
Number of times we should retry if an editing action fails because
the lag is too high.
- getMediaInfoIdByFileName(String) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataFetcher
-
Fetches the MediaInfoId of a file with the given name.
- getMediaInfoIds(List<String>) - Method in class org.wikidata.wdtk.wikibaseapi.MediaInfoIdQueryAction
-
Fetches the MediaInfoIds of files with the given names.
- getMediaInfoIdsByFileName(String...) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataFetcher
-
Fetches the MediaInfoIds of files with the given names.
- getMediaInfoIdsByFileName(List<String>) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataFetcher
-
Fetches the MediaInfoIds of files with the given names.
- getMessage(String) - Method in enum org.wikidata.wdtk.wikibaseapi.LoginValue
-
- getMonolingualUpdatedValues(Map<String, TermStatementUpdate.NameWithUpdate>) - Method in class org.wikidata.wdtk.wikibaseapi.TermStatementUpdate
-
Deprecated.
Helper to format term updates as expected by the Wikibase API
- getPageId() - Method in interface org.wikidata.wdtk.wikibaseapi.WbSearchEntitiesResult
-
Returns the internal Mediawiki pageid of the entity.
- getReadTimeout() - Method in class org.wikidata.wdtk.wikibaseapi.ApiConnection
-
Maximum time to wait for a server response once the connection was established.
- getRemainingEdits() - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Returns the number of edits that will be performed before entering
simulation mode, or -1 if there is no limit on the number of edits
(default).
- getRemainingEdits() - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataEditor
-
Returns the number of edits that will be performed before entering
simulation mode, or -1 if there is no limit on the number of edits
(default).
- getRemovedAliases(String) - Method in class org.wikidata.wdtk.wikibaseapi.TermStatementUpdate
-
Deprecated.
Retrieves the list of aliases that will be removed in a
given language, after all the optimizations have been done
(replacing empty labels by new aliases in the same language,
for instance).
- getRevisionIdFromResponse(JsonNode) - Method in class org.wikidata.wdtk.wikibaseapi.StatementUpdate
-
Deprecated.
Extracts the last revision id from the JSON response returned
by the API after an edit
- getRevisionIdFromResponse(JsonNode) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataEditor
-
Extracts the last revision id from the JSON response returned
by the API after an edit
- getTestWikidataApiConnection() - Static method in class org.wikidata.wdtk.wikibaseapi.BasicApiConnection
-
Creates an API connection to test.wikidata.org.
- getText() - Method in interface org.wikidata.wdtk.wikibaseapi.WbSearchEntitiesResult.Match
-
Returns the text of the matching term.
- getTitle() - Method in interface org.wikidata.wdtk.wikibaseapi.WbSearchEntitiesResult
-
Returns the title of the entity (currently the same as the entity ID).
- getTokens() - Method in class org.wikidata.wdtk.wikibaseapi.ApiConnection
-
Returns the map of tokens (such as csrf token and login token) currently used in this connection.
- getType() - Method in interface org.wikidata.wdtk.wikibaseapi.WbSearchEntitiesResult.Match
-
Returns the type (field) of the matching term
e.g "entityId", "label" or "alias".
- getUpdatedStatements() - Method in class org.wikidata.wdtk.wikibaseapi.StatementUpdate
-
Deprecated.
- getUrl() - Method in interface org.wikidata.wdtk.wikibaseapi.WbSearchEntitiesResult
-
The URL of the wiki site that shows the concept.
- getWikidataApiConnection() - Static method in class org.wikidata.wdtk.wikibaseapi.BasicApiConnection
-
Creates an API connection to wikidata.org.
- getWikidataDataFetcher() - Static method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataFetcher
-
Creates an object to fetch data from wikidata.org.
- getWikimediaCommonsApiConnection() - Static method in class org.wikidata.wdtk.wikibaseapi.BasicApiConnection
-
Creates an API connection to commons.wikimedia.org.
- getWikimediaCommonsDataFetcher() - Static method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataFetcher
-
Creates an object to fetch data from commons.wikimedia.org.
- GuidGenerator - Interface in org.wikidata.wdtk.wikibaseapi
-
- search - Variable in class org.wikidata.wdtk.wikibaseapi.WbGetEntitiesSearchData
-
search for this text.
- searchEntities(String) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataFetcher
-
- searchEntities(String, String) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataFetcher
-
- searchEntities(String, Long) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataFetcher
-
- searchEntities(String, String, Long) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataFetcher
-
- searchEntities(WbGetEntitiesSearchData) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataFetcher
-
- sendJsonRequest(String, Map<String, String>) - Method in class org.wikidata.wdtk.wikibaseapi.ApiConnection
-
Sends a request to the API with the given parameters and the given
request method and returns the result JSON tree.
- sendJsonRequest(String, Map<String, String>, Map<String, ImmutablePair<String, File>>) - Method in class org.wikidata.wdtk.wikibaseapi.ApiConnection
-
Sends a request to the API with the given parameters and the given
request method and returns the result JSON tree.
- sendRequest(String, Map<String, String>, Map<String, ImmutablePair<String, File>>) - Method in class org.wikidata.wdtk.wikibaseapi.ApiConnection
-
Sends a request to the API with the given parameters and the given
request method and returns the result string.
- setAverageTimePerEdit(int) - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Sets the average time that a single edit should take, measured in
milliseconds.
- setAverageTimePerEdit(int) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataEditor
-
Sets the average time that a single edit should take, measured in
milliseconds.
- setConnectTimeout(int) - Method in class org.wikidata.wdtk.wikibaseapi.ApiConnection
-
Sets the maximum time to wait for when establishing a connection, in milliseconds.
- setEditAsBot(boolean) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataEditor
-
Switches the use of the bot parameter on or of.
- setGuidGenerator(GuidGenerator) - Method in class org.wikidata.wdtk.wikibaseapi.StatementUpdate
-
Deprecated.
Sets the GUID generator for this statement update.
- setMaxLag(int) - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Set the value of the maxlag parameter.
- setMaxLag(int) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataEditor
-
Set the value of the maxlag parameter.
- setMaxLagBackOffFactor(double) - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Factor by which the wait time between two maxlag retries should be
multiplied at each attempt.
- setMaxLagBackOffFactor(double) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataEditor
-
Factor by which the wait time between two maxlag retries should be
multiplied at each attempt.
- setMaxLagFirstWaitTime(int) - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Initial wait time in milliseconds, when an edit fails for the first
time because of a high lag.
- setMaxLagFirstWaitTime(int) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataEditor
-
Initial wait time in milliseconds, when an edit fails for the first
time because of a high lag.
- setMaxLagMaxRetries(int) - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Number of times we should retry if an editing action fails because
the lag is too high.
- setMaxLagMaxRetries(int) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataEditor
-
Number of times we should retry if an editing action fails because
the lag is too high.
- setReadTimeout(int) - Method in class org.wikidata.wdtk.wikibaseapi.ApiConnection
-
Sets the maximum time to wait for a server response once the connection was established, in milliseconds.
- setRemainingEdits(int) - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Sets the number of edits that this object can still perform.
- setRemainingEdits(int) - Method in class org.wikidata.wdtk.wikibaseapi.WikibaseDataEditor
-
Sets the number of edits that this object can still perform.
- sitefilter - Variable in class org.wikidata.wdtk.wikibaseapi.WbGetEntitiesActionData
-
List of site keys for restricting site links.
- sites - Variable in class org.wikidata.wdtk.wikibaseapi.WbGetEntitiesActionData
-
List of site keys.
- STATEMENT_GUID_SEPARATOR - Static variable in interface org.wikidata.wdtk.wikibaseapi.GuidGenerator
-
- StatementUpdate - Class in org.wikidata.wdtk.wikibaseapi
-
- StatementUpdate(StatementDocument, List<Statement>, List<Statement>) - Constructor for class org.wikidata.wdtk.wikibaseapi.StatementUpdate
-
Deprecated.
Constructor.
- strictlanguage - Variable in class org.wikidata.wdtk.wikibaseapi.WbGetEntitiesSearchData
-
whether to disable language fallback.
- wbEditEntity(String, String, String, String, String, boolean, boolean, long, String, List<String>) - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Executes the API action "wbeditentity" for the given parameters.
- WbEditingAction - Class in org.wikidata.wdtk.wikibaseapi
-
Java implementation for the wbeditentity API action.
- WbEditingAction(ApiConnection, String) - Constructor for class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Creates an object to modify data on a Wikibase site.
- wbGetEntities(WbGetEntitiesActionData) - Method in class org.wikidata.wdtk.wikibaseapi.WbGetEntitiesAction
-
Creates a map of identifiers or page titles to documents retrieved via
the API URL
- wbGetEntities(String, String, String, String, String, String) - Method in class org.wikidata.wdtk.wikibaseapi.WbGetEntitiesAction
-
Creates a map of identifiers or page titles to documents retrieved via
the API.
- WbGetEntitiesAction - Class in org.wikidata.wdtk.wikibaseapi
-
Java implementation of the wbgetentities action.
- WbGetEntitiesAction(ApiConnection, String) - Constructor for class org.wikidata.wdtk.wikibaseapi.WbGetEntitiesAction
-
Creates an object to fetch data from the given ApiConnection.
- WbGetEntitiesActionData - Class in org.wikidata.wdtk.wikibaseapi
-
This class is a simple record that holds the properties of an wbgetentities
action request.
- WbGetEntitiesActionData() - Constructor for class org.wikidata.wdtk.wikibaseapi.WbGetEntitiesActionData
-
- WbGetEntitiesSearchData - Class in org.wikidata.wdtk.wikibaseapi
-
This class is a simple record that holds the properties of an wbgetentities
action request.
- WbGetEntitiesSearchData() - Constructor for class org.wikidata.wdtk.wikibaseapi.WbGetEntitiesSearchData
-
- wbRemoveClaims(List<String>, boolean, long, String, List<String>) - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Executes the API action "wbremoveclaims" for the given parameters.
- wbSearchEntities(WbGetEntitiesSearchData) - Method in class org.wikidata.wdtk.wikibaseapi.WbSearchEntitiesAction
-
- wbSearchEntities(String, String, Boolean, String, Long, Long) - Method in class org.wikidata.wdtk.wikibaseapi.WbSearchEntitiesAction
-
- wbSearchEntities(String, String, Boolean, String, Long, Long, String) - Method in class org.wikidata.wdtk.wikibaseapi.WbSearchEntitiesAction
-
Executes the API action "wbsearchentity" for the given parameters.
- WbSearchEntitiesAction - Class in org.wikidata.wdtk.wikibaseapi
-
Java implementation of the wbsearchentities action.
- WbSearchEntitiesAction(ApiConnection, String) - Constructor for class org.wikidata.wdtk.wikibaseapi.WbSearchEntitiesAction
-
Creates an object to fetch data from the given ApiConnection.
- WbSearchEntitiesResult - Interface in org.wikidata.wdtk.wikibaseapi
-
Represents the result of a wbsearchentities action.
- WbSearchEntitiesResult.Match - Interface in org.wikidata.wdtk.wikibaseapi
-
Represents information about how a document matched the query
- wbSetAliases(String, String, String, String, String, List<String>, List<String>, List<String>, boolean, long, String, List<String>) - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Executes the API action "wbsetaliases" for the given parameters.
- wbSetClaim(String, boolean, long, String, List<String>) - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Executes the API action "wbsetclaim" for the given parameters.
- wbSetDescription(String, String, String, String, String, String, boolean, long, String, List<String>) - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Executes the API action "wbsetlabel" for the given parameters.
- wbSetLabel(String, String, String, String, String, String, boolean, long, String, List<String>) - Method in class org.wikidata.wdtk.wikibaseapi.WbEditingAction
-
Executes the API action "wbsetlabel" for the given parameters.
- WikibaseDataEditor - Class in org.wikidata.wdtk.wikibaseapi
-
Class that provides high-level editing functionality for Wikibase data.
- WikibaseDataEditor(ApiConnection, String) - Constructor for class org.wikidata.wdtk.wikibaseapi.WikibaseDataEditor
-
Creates an object to edit data via the Web API of the given
ApiConnection object.
- WikibaseDataEditor(ApiConnection, String, GuidGenerator) - Constructor for class org.wikidata.wdtk.wikibaseapi.WikibaseDataEditor
-
Creates an object to edit data via the Web API of the given
ApiConnection object.
- WikibaseDataFetcher - Class in org.wikidata.wdtk.wikibaseapi
-
Simple class to fetch data from Wikibase via the online API.
- WikibaseDataFetcher(ApiConnection, String) - Constructor for class org.wikidata.wdtk.wikibaseapi.WikibaseDataFetcher
-
Creates an object to fetch data from API with the given
ApiConnection object.