C D F G I J K M N O P R S T U W 

C

Client - Class in org.wikidata.wdtk.client
This class provides a Java command line client to process dump files.
Client(DumpProcessingController, String[]) - Constructor for class org.wikidata.wdtk.client.Client
Constructor.
clientConfiguration - Variable in class org.wikidata.wdtk.client.Client
 
ClientConfiguration - Class in org.wikidata.wdtk.client
This class handles the program arguments from the conversion command line tool.
ClientConfiguration(String[]) - Constructor for class org.wikidata.wdtk.client.ClientConfiguration
Constructs a new object for the given arguments.
close() - Method in class org.wikidata.wdtk.client.DumpProcessingOutputAction
 
close() - Method in class org.wikidata.wdtk.client.JsonSerializationAction
 
close() - Method in class org.wikidata.wdtk.client.RdfSerializationAction
 
close() - Method in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
 
CMD_OPTION_ACTION - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Short command-line alternative to ClientConfiguration.OPTION_ACTION.
CMD_OPTION_CONFIG_FILE - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Short command-line alternative to ClientConfiguration.OPTION_CONFIG_FILE.
CMD_OPTION_CREATE_REPORT - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Short command-line alternative to ClientConfiguration.OPTION_CREATE_REPORT.
CMD_OPTION_DUMP_LOCATION - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Short command-line alternative to ClientConfiguration.OPTION_DUMP_LOCATION.
CMD_OPTION_HELP - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Short command-line alternative to ClientConfiguration.OPTION_HELP.
CMD_OPTION_LOCAL_DUMPFILE - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Short command-line alternative to ClientConfiguration.OPTION_LOCAL_DUMPFILE.
CMD_OPTION_OFFLINE_MODE - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Short command-line alternative to ClientConfiguration.OPTION_OFFLINE_MODE.
CMD_OPTION_OUTPUT_COMPRESSION - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Short command-line alternative to ClientConfiguration.OPTION_OUTPUT_COMPRESSION.
CMD_OPTION_OUTPUT_DESTINATION - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Short command-line alternative to ClientConfiguration.OPTION_OUTPUT_DESTINATION.
CMD_OPTION_OUTPUT_STDOUT - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Short command-line alternative to ClientConfiguration.OPTION_OUTPUT_STDOUT.
CMD_OPTION_QUIET - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Short command-line alternative to ClientConfiguration.OPTION_QUIET.
COMPRESS_BZ2 - Static variable in class org.wikidata.wdtk.client.DumpProcessingOutputAction
 
COMPRESS_GZIP - Static variable in class org.wikidata.wdtk.client.DumpProcessingOutputAction
 
COMPRESS_NONE - Static variable in class org.wikidata.wdtk.client.DumpProcessingOutputAction
 
compressionType - Variable in class org.wikidata.wdtk.client.DumpProcessingOutputAction
String to indicate the output compression to be used, if any.
countTerms(TermedDocument, SchemaUsageAnalyzer.EntityStatistics) - Method in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
Count the terms (labels, descriptions, aliases) of an item or property document.
createRdfSerializer() - Method in class org.wikidata.wdtk.client.RdfSerializationAction
Creates a new RDF serializer based on the current configuration of this object.

D

dateStamp - Variable in class org.wikidata.wdtk.client.DumpProcessingOutputAction
Date stamp of the dump to be processed.
dateStamp - Variable in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
 
DEFAULT_ACTION_NAME - Static variable in class org.wikidata.wdtk.client.JsonSerializationAction
default action name is used to separate different DumpProcessingOutputActions from each other.
DEFAULT_ACTION_NAME - Static variable in class org.wikidata.wdtk.client.RdfSerializationAction
default action name is used to separate different DumpProcessingOutputActions from each other.
DEFAULT_FILE_NAME - Static variable in class org.wikidata.wdtk.client.JsonSerializationAction
The base file name that will be used by default.
DEFAULT_FILE_NAME - Static variable in class org.wikidata.wdtk.client.RdfSerializationAction
The base file name that will be used by default.
DumpProcessingAction - Interface in org.wikidata.wdtk.client
This interface represents an action that may be performed with Wikibase dumps.
DumpProcessingOutputAction - Class in org.wikidata.wdtk.client
Abstract implementation of DumpProcessingAction that represents actions which generate outputs (in the form of files).
DumpProcessingOutputAction() - Constructor for class org.wikidata.wdtk.client.DumpProcessingOutputAction
 
DumpProcessingOutputAction.FinishableRunnable - Interface in org.wikidata.wdtk.client
Simple interface for a Runnable that can be stopped gracefully by calling a method DumpProcessingOutputAction.FinishableRunnable.finish().

F

finish() - Method in interface org.wikidata.wdtk.client.DumpProcessingOutputAction.FinishableRunnable
Finishes the current operation gracefully.

G

getActionName() - Method in interface org.wikidata.wdtk.client.DumpProcessingAction
Returns the name of the action.
getActionName() - Method in class org.wikidata.wdtk.client.DumpProcessingOutputAction
 
getActionName() - Method in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
 
getActions() - Method in class org.wikidata.wdtk.client.ClientConfiguration
Returns the list of actions defined for this object.
getAsynchronousOutputStream(OutputStream) - Method in class org.wikidata.wdtk.client.DumpProcessingOutputAction
Creates a separate thread for writing into the given output stream and returns a pipe output stream that can be used to pass data to this thread.
getDateStamp() - Method in class org.wikidata.wdtk.client.ClientConfiguration
Returns the date stamp of the dump file.
getDefaultActionName() - Method in interface org.wikidata.wdtk.client.DumpProcessingAction
Returns the default name for an action.
getDefaultActionName() - Method in class org.wikidata.wdtk.client.JsonSerializationAction
 
getDefaultActionName() - Method in class org.wikidata.wdtk.client.RdfSerializationAction
 
getDefaultActionName() - Method in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
 
getDumpDirectoryLocation() - Method in class org.wikidata.wdtk.client.ClientConfiguration
Returns the location of the directory where downloaded dump files are stored, or null if the default is to be used.
getFilterLanguages() - Method in class org.wikidata.wdtk.client.ClientConfiguration
Returns a set of language codes that should be used as a filter, or null if no filter is set.
getFilterProperties() - Method in class org.wikidata.wdtk.client.ClientConfiguration
Returns a set of property ids that should be used as a filter for statements, or null if no filter is set.
getFilterSiteKeys() - Method in class org.wikidata.wdtk.client.ClientConfiguration
Returns a set of site keys that should be used as a filter for site links, or null if no filter is set.
getInputDumpLocation() - Method in class org.wikidata.wdtk.client.ClientConfiguration
Returns the string path to a dump file that should be processed.
getLocalDumpFile() - Method in class org.wikidata.wdtk.client.ClientConfiguration
Returns a local dump file that was previously downloaded and should be locally processed, or null if no local dump file is set.
getOfflineMode() - Method in class org.wikidata.wdtk.client.ClientConfiguration
Returns true if all operations should be performed in offline mode, without accessing the Internet.
getOutputFilename() - Method in class org.wikidata.wdtk.client.DumpProcessingOutputAction
 
getOutputStream(boolean, String, String) - Method in class org.wikidata.wdtk.client.DumpProcessingOutputAction
Creates an compressing OutputStream.
getProjectName() - Method in class org.wikidata.wdtk.client.ClientConfiguration
Returns the project name according to the dump file.
getReport() - Method in interface org.wikidata.wdtk.client.DumpProcessingAction
Returns a report message containing information about the files which were generated.
getReport() - Method in class org.wikidata.wdtk.client.JsonSerializationAction
 
getReport() - Method in class org.wikidata.wdtk.client.RdfSerializationAction
 
getReport() - Method in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
 
getReportFileName() - Method in class org.wikidata.wdtk.client.ClientConfiguration
Returns the output destination where a report file should be created.

I

insertDumpInformation(String) - Method in class org.wikidata.wdtk.client.ClientConfiguration
 
insertDumpInformation(String) - Method in class org.wikidata.wdtk.client.DumpProcessingOutputAction
 
insertDumpInformation(String, String, String) - Static method in class org.wikidata.wdtk.client.ClientConfiguration
Inserts the information about the dateStamp of a dump and the project name into a pattern.
isQuiet() - Method in class org.wikidata.wdtk.client.ClientConfiguration
Returns true if the application should not write anything to stdout.
isReady() - Method in interface org.wikidata.wdtk.client.DumpProcessingAction
Returns true if the action is ready to process a dump.
isReady() - Method in class org.wikidata.wdtk.client.JsonSerializationAction
 
isReady() - Method in class org.wikidata.wdtk.client.RdfSerializationAction
 
isReady() - Method in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
 

J

JsonSerializationAction - Class in org.wikidata.wdtk.client
This class represents an action of generating a JSON dump from data.
JsonSerializationAction() - Constructor for class org.wikidata.wdtk.client.JsonSerializationAction
Constructor.

K

KNOWN_TASKS - Static variable in class org.wikidata.wdtk.client.RdfSerializationAction
 

M

main(String[]) - Static method in class org.wikidata.wdtk.client.Client
Launches the client with the specified parameters.
mapper - Static variable in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
Object mapper that is used to serialize JSON.

N

name - Variable in class org.wikidata.wdtk.client.DumpProcessingOutputAction
The name of the action.
name - Variable in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
Name as an action, if any
needsSites() - Method in interface org.wikidata.wdtk.client.DumpProcessingAction
Returns true if processing requires a Sites object to be set.
needsSites() - Method in class org.wikidata.wdtk.client.JsonSerializationAction
 
needsSites() - Method in class org.wikidata.wdtk.client.RdfSerializationAction
 
needsSites() - Method in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
 

O

open() - Method in class org.wikidata.wdtk.client.JsonSerializationAction
 
open() - Method in class org.wikidata.wdtk.client.RdfSerializationAction
 
open() - Method in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
 
openResultFileOuputStream(Path, String) - Static method in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
Opens a new FileOutputStream for a file of the given name in the given result directory.
OPTION_ACTION - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Name of the long command line option for selecting an action that should be performed.
OPTION_COMPRESSION - Static variable in class org.wikidata.wdtk.client.DumpProcessingOutputAction
Name of the option used to define that output be compressed in a particular way.
OPTION_CONFIG_FILE - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Name of the long command line option for specifying the location of the configuration file.
OPTION_CREATE_REPORT - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Name of the long command line option to create a report file about the files produced by DumpProcessingOutputActions.
OPTION_DESTINATION - Static variable in class org.wikidata.wdtk.client.DumpProcessingOutputAction
Name of the option to set the destination file name (may include path) for outputs generated by this action.
OPTION_DUMP_LOCATION - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Name of the long command line option and configuration file field for specifying the base location of the dump files to use.
OPTION_FILTER_LANGUAGES - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Name of the long command line option and configuration file field for specifying the language filters.
OPTION_FILTER_PROPERTIES - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Name of the long command line option and configuration file field for specifying the property filters.
OPTION_FILTER_SITES - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Name of the long command line option and configuration file field for specifying the site link filters.
OPTION_HELP - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Name of the long command line option for printing the help text.
OPTION_LOCAL_DUMPFILE - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Name of the long command line option and configuration file field for defining the path to a local dump file.
OPTION_OFFLINE_MODE - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Name of the long command line option and configuration file field for switching to offline mode.
OPTION_OUTPUT_COMPRESSION - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Name of the long command line option and configuration file field for specifying the compression to use for the output.
OPTION_OUTPUT_DESTINATION - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Name of the long command line option and configuration file field for defining the destination (usually output file name) of actions that produce output.
OPTION_OUTPUT_RDF_TYPE - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Name of the long command line option and configuration file field for specifying the tasks for RDF serialization.
OPTION_OUTPUT_STDOUT - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Name of the long command line option and configuration file field for directing output to stdout.
OPTION_QUIET - Static variable in class org.wikidata.wdtk.client.ClientConfiguration
Name of the long command line option and configuration file field for requesting that no messages are logged to stdout.
OPTION_RDF_TASKS - Static variable in class org.wikidata.wdtk.client.RdfSerializationAction
Name of the option that defines the tasks of the RDF serializer.
OPTION_USE_STDOUT - Static variable in class org.wikidata.wdtk.client.DumpProcessingOutputAction
Name of the option to redirect output to stdout.
org.wikidata.wdtk.client - package org.wikidata.wdtk.client
Command-line client to download dumps and serialize its data in several formats.
outputDestination - Variable in class org.wikidata.wdtk.client.DumpProcessingOutputAction
For operations that generate output, this is the name of the output file, or null to use the default file name for the given options.
outputStreams - Variable in class org.wikidata.wdtk.client.DumpProcessingOutputAction
Output streams that were created by this class.

P

performActions() - Method in class org.wikidata.wdtk.client.Client
Performs all actions that have been configured.
printHelp() - Method in class org.wikidata.wdtk.client.ClientConfiguration
Prints a help text to the console.
processItemDocument(ItemDocument) - Method in class org.wikidata.wdtk.client.JsonSerializationAction
 
processItemDocument(ItemDocument) - Method in class org.wikidata.wdtk.client.RdfSerializationAction
 
processItemDocument(ItemDocument) - Method in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
 
processPropertyDocument(PropertyDocument) - Method in class org.wikidata.wdtk.client.JsonSerializationAction
 
processPropertyDocument(PropertyDocument) - Method in class org.wikidata.wdtk.client.RdfSerializationAction
 
processPropertyDocument(PropertyDocument) - Method in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
 
project - Variable in class org.wikidata.wdtk.client.DumpProcessingOutputAction
String name of the site that the processed dump file comes from.
project - Variable in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
 

R

RdfSerializationAction - Class in org.wikidata.wdtk.client
This class represents an action of generating an RDF dump from data.
RdfSerializationAction() - Constructor for class org.wikidata.wdtk.client.RdfSerializationAction
 
resultDirectory - Variable in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
The place where result files will be stored.

S

SchemaUsageAnalyzer - Class in org.wikidata.wdtk.client
 
SchemaUsageAnalyzer() - Constructor for class org.wikidata.wdtk.client.SchemaUsageAnalyzer
 
setActionName(String) - Method in interface org.wikidata.wdtk.client.DumpProcessingAction
Sets the name of the action.
setActionName(String) - Method in class org.wikidata.wdtk.client.DumpProcessingOutputAction
 
setActionName(String) - Method in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
 
setDateStamp(String) - Method in class org.wikidata.wdtk.client.ClientConfiguration
Sets the date stamp of the dump file.
setDumpInformation(String, String) - Method in interface org.wikidata.wdtk.client.DumpProcessingAction
Provides the action with general information about the dump that is to be processed.
setDumpInformation(String, String) - Method in class org.wikidata.wdtk.client.DumpProcessingOutputAction
 
setDumpInformation(String, String) - Method in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
 
setOption(String, String) - Method in interface org.wikidata.wdtk.client.DumpProcessingAction
Sets the options of the specified name to the given value.
setOption(String, String) - Method in class org.wikidata.wdtk.client.DumpProcessingOutputAction
 
setOption(String, String) - Method in class org.wikidata.wdtk.client.RdfSerializationAction
 
setOption(String, String) - Method in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
 
setProjectName(String) - Method in class org.wikidata.wdtk.client.ClientConfiguration
Sets the project name of the dump file.
setSites(Sites) - Method in interface org.wikidata.wdtk.client.DumpProcessingAction
Sets the sites information to the given value.
setSites(Sites) - Method in class org.wikidata.wdtk.client.DumpProcessingOutputAction
 
setSites(Sites) - Method in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
 
sites - Variable in class org.wikidata.wdtk.client.DumpProcessingOutputAction
The Sites object if provided.
sites - Variable in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
Sites information used to extract site data.

T

TASK_HELP - Static variable in class org.wikidata.wdtk.client.RdfSerializationAction
 

U

useStdOut - Variable in class org.wikidata.wdtk.client.DumpProcessingOutputAction
Specifies if output should be redirected to stdout rather than being written to a file.
useStdOut() - Method in interface org.wikidata.wdtk.client.DumpProcessingAction
Returns true if this action will write results (not log messages) to stdout.
useStdOut() - Method in class org.wikidata.wdtk.client.DumpProcessingOutputAction
 
useStdOut() - Method in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
 

W

writeStatisticsData(PrintStream) - Method in class org.wikidata.wdtk.client.SchemaUsageAnalyzer
 
C D F G I J K M N O P R S T U W 
Skip navigation links

Copyright © 2014–2017 Wikidata Toolkit Developers. Generated from source code published under the Apache License 2.0. For more information, see the Wikidata Toolkit homepage