ClientConfiguration (Wikidata Toolkit Command-line Tool 0.8.0 API)

java.lang.Object
- org.wikidata.wdtk.client.ClientConfiguration

```
public class ClientConfiguration
extends java.lang.Object
```
This class handles the program arguments from the conversion command line tool.

Author:

Michael Günther, Markus Kroetzsch

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`CMD_OPTION_ACTION`	Short command-line alternative to `OPTION_ACTION`.
`static java.lang.String`	`CMD_OPTION_CONFIG_FILE`	Short command-line alternative to `OPTION_CONFIG_FILE`.
`static java.lang.String`	`CMD_OPTION_CREATE_REPORT`	Short command-line alternative to `OPTION_CREATE_REPORT`.
`static java.lang.String`	`CMD_OPTION_DUMP_LOCATION`	Short command-line alternative to `OPTION_DUMP_LOCATION`.
`static java.lang.String`	`CMD_OPTION_HELP`	Short command-line alternative to `OPTION_HELP`.
`static java.lang.String`	`CMD_OPTION_LOCAL_DUMPFILE`	Short command-line alternative to `OPTION_LOCAL_DUMPFILE`.
`static java.lang.String`	`CMD_OPTION_OFFLINE_MODE`	Short command-line alternative to `OPTION_OFFLINE_MODE`.
`static java.lang.String`	`CMD_OPTION_OUTPUT_COMPRESSION`	Short command-line alternative to `OPTION_OUTPUT_COMPRESSION`.
`static java.lang.String`	`CMD_OPTION_OUTPUT_DESTINATION`	Short command-line alternative to `OPTION_OUTPUT_DESTINATION`.
`static java.lang.String`	`CMD_OPTION_OUTPUT_STDOUT`	Short command-line alternative to `OPTION_OUTPUT_STDOUT`.
`static java.lang.String`	`CMD_OPTION_QUIET`	Short command-line alternative to `OPTION_QUIET`.
`static java.lang.String`	`OPTION_ACTION`	Name of the long command line option for selecting an action that should be performed.
`static java.lang.String`	`OPTION_CONFIG_FILE`	Name of the long command line option for specifying the location of the configuration file.
`static java.lang.String`	`OPTION_CREATE_REPORT`	Name of the long command line option to create a report file about the files produced by DumpProcessingOutputActions.
`static java.lang.String`	`OPTION_DUMP_LOCATION`	Name of the long command line option and configuration file field for specifying the base location of the dump files to use.
`static java.lang.String`	`OPTION_FILTER_LANGUAGES`	Name of the long command line option and configuration file field for specifying the language filters.
`static java.lang.String`	`OPTION_FILTER_PROPERTIES`	Name of the long command line option and configuration file field for specifying the property filters.
`static java.lang.String`	`OPTION_FILTER_SITES`	Name of the long command line option and configuration file field for specifying the site link filters.
`static java.lang.String`	`OPTION_HELP`	Name of the long command line option for printing the help text.
`static java.lang.String`	`OPTION_LOCAL_DUMPFILE`	Name of the long command line option and configuration file field for defining the path to a local dump file.
`static java.lang.String`	`OPTION_OFFLINE_MODE`	Name of the long command line option and configuration file field for switching to offline mode.
`static java.lang.String`	`OPTION_OUTPUT_COMPRESSION`	Name of the long command line option and configuration file field for specifying the compression to use for the output.
`static java.lang.String`	`OPTION_OUTPUT_DESTINATION`	Name of the long command line option and configuration file field for defining the destination (usually output file name) of actions that produce output.
`static java.lang.String`	`OPTION_OUTPUT_RDF_TYPE`	Name of the long command line option and configuration file field for specifying the tasks for RDF serialization.
`static java.lang.String`	`OPTION_OUTPUT_STDOUT`	Name of the long command line option and configuration file field for directing output to stdout.
`static java.lang.String`	`OPTION_QUIET`	Name of the long command line option and configuration file field for requesting that no messages are logged to stdout.

Constructor Summary

Constructors
Constructor Description

ClientConfiguration(java.lang.String[] args)
Constructs a new object for the given arguments.

Constructors
Constructor	Description
`ClientConfiguration(java.lang.String[] args)`	Constructs a new object for the given arguments.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.List<DumpProcessingAction>`	`getActions()`	Returns the list of actions defined for this object.
`java.lang.String`	`getDateStamp()`	Returns the date stamp of the dump file.
`java.lang.String`	`getDumpDirectoryLocation()`	Returns the location of the directory where downloaded dump files are stored, or null if the default is to be used.
`java.util.Set<java.lang.String>`	`getFilterLanguages()`	Returns a set of language codes that should be used as a filter, or null if no filter is set.
`java.util.Set<org.wikidata.wdtk.datamodel.interfaces.PropertyIdValue>`	`getFilterProperties()`	Returns a set of property ids that should be used as a filter for statements, or null if no filter is set.
`java.util.Set<java.lang.String>`	`getFilterSiteKeys()`	Returns a set of site keys that should be used as a filter for site links, or null if no filter is set.
`java.lang.String`	`getInputDumpLocation()`	Returns the string path to a dump file that should be processed.
`org.wikidata.wdtk.dumpfiles.MwLocalDumpFile`	`getLocalDumpFile()`	Returns a local dump file that was previously downloaded and should be locally processed, or null if no local dump file is set.
`boolean`	`getOfflineMode()`	Returns true if all operations should be performed in offline mode, without accessing the Internet.
`java.lang.String`	`getProjectName()`	Returns the project name according to the dump file.
`java.lang.String`	`getReportFileName()`	Returns the output destination where a report file should be created.
`java.lang.String`	`insertDumpInformation(java.lang.String pattern)`
`static java.lang.String`	`insertDumpInformation(java.lang.String pattern, java.lang.String dateStamp, java.lang.String project)`	Inserts the information about the dateStamp of a dump and the project name into a pattern.
`boolean`	`isQuiet()`	Returns true if the application should not write anything to stdout.
`void`	`printHelp()`	Prints a help text to the console.
`void`	`setDateStamp(java.lang.String dateStamp)`	Sets the date stamp of the dump file.
`void`	`setProjectName(java.lang.String project)`	Sets the project name of the dump file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CMD_OPTION_HELP
```
public static final java.lang.String CMD_OPTION_HELP
```
    Short command-line alternative to OPTION_HELP.
    
    See Also:
    
    Constant Field Values
  - CMD_OPTION_CONFIG_FILE
```
public static final java.lang.String CMD_OPTION_CONFIG_FILE
```
    Short command-line alternative to OPTION_CONFIG_FILE.
    
    See Also:
    
    Constant Field Values
  - CMD_OPTION_DUMP_LOCATION
```
public static final java.lang.String CMD_OPTION_DUMP_LOCATION
```
    Short command-line alternative to OPTION_DUMP_LOCATION.
    
    See Also:
    
    Constant Field Values
  - CMD_OPTION_QUIET
```
public static final java.lang.String CMD_OPTION_QUIET
```
    Short command-line alternative to OPTION_QUIET.
    
    See Also:
    
    Constant Field Values
  - CMD_OPTION_OFFLINE_MODE
```
public static final java.lang.String CMD_OPTION_OFFLINE_MODE
```
    Short command-line alternative to OPTION_OFFLINE_MODE.
    
    See Also:
    
    Constant Field Values
  - CMD_OPTION_ACTION
```
public static final java.lang.String CMD_OPTION_ACTION
```
    Short command-line alternative to OPTION_ACTION.
    
    See Also:
    
    Constant Field Values
  - CMD_OPTION_OUTPUT_DESTINATION
```
public static final java.lang.String CMD_OPTION_OUTPUT_DESTINATION
```
    Short command-line alternative to OPTION_OUTPUT_DESTINATION.
    
    See Also:
    
    Constant Field Values
  - CMD_OPTION_OUTPUT_COMPRESSION
```
public static final java.lang.String CMD_OPTION_OUTPUT_COMPRESSION
```
    Short command-line alternative to OPTION_OUTPUT_COMPRESSION.
    
    See Also:
    
    Constant Field Values
  - CMD_OPTION_OUTPUT_STDOUT
```
public static final java.lang.String CMD_OPTION_OUTPUT_STDOUT
```
    Short command-line alternative to OPTION_OUTPUT_STDOUT.
    
    See Also:
    
    Constant Field Values
  - CMD_OPTION_CREATE_REPORT
```
public static final java.lang.String CMD_OPTION_CREATE_REPORT
```
    Short command-line alternative to OPTION_CREATE_REPORT.
    
    See Also:
    
    Constant Field Values
  - CMD_OPTION_LOCAL_DUMPFILE
```
public static final java.lang.String CMD_OPTION_LOCAL_DUMPFILE
```
    Short command-line alternative to OPTION_LOCAL_DUMPFILE.
    
    See Also:
    
    Constant Field Values
  - OPTION_HELP
```
public static final java.lang.String OPTION_HELP
```
    Name of the long command line option for printing the help text.
    
    See Also:
    
    Constant Field Values
  - OPTION_CONFIG_FILE
```
public static final java.lang.String OPTION_CONFIG_FILE
```
    Name of the long command line option for specifying the location of the configuration file.
    
    See Also:
    
    Constant Field Values
  - OPTION_DUMP_LOCATION
```
public static final java.lang.String OPTION_DUMP_LOCATION
```
    Name of the long command line option and configuration file field for specifying the base location of the dump files to use.
    
    See Also:
    
    Constant Field Values
  - OPTION_OFFLINE_MODE
```
public static final java.lang.String OPTION_OFFLINE_MODE
```
    Name of the long command line option and configuration file field for switching to offline mode.
    
    See Also:
    
    Constant Field Values
  - OPTION_QUIET
```
public static final java.lang.String OPTION_QUIET
```
    Name of the long command line option and configuration file field for requesting that no messages are logged to stdout.
    
    See Also:
    
    Constant Field Values
  - OPTION_ACTION
```
public static final java.lang.String OPTION_ACTION
```
    Name of the long command line option for selecting an action that should be performed. Available actions are registered in the field KNOWN_ACTIONS.
    
    See Also:
    
    Constant Field Values
  - OPTION_FILTER_LANGUAGES
```
public static final java.lang.String OPTION_FILTER_LANGUAGES
```
    Name of the long command line option and configuration file field for specifying the language filters.
    
    See Also:
    
    Constant Field Values
  - OPTION_FILTER_SITES
```
public static final java.lang.String OPTION_FILTER_SITES
```
    Name of the long command line option and configuration file field for specifying the site link filters.
    
    See Also:
    
    Constant Field Values
  - OPTION_FILTER_PROPERTIES
```
public static final java.lang.String OPTION_FILTER_PROPERTIES
```
    Name of the long command line option and configuration file field for specifying the property filters.
    
    See Also:
    
    Constant Field Values
  - OPTION_CREATE_REPORT
```
public static final java.lang.String OPTION_CREATE_REPORT
```
    Name of the long command line option to create a report file about the files produced by DumpProcessingOutputActions.
    
    See Also:
    
    Constant Field Values
  - OPTION_OUTPUT_DESTINATION
```
public static final java.lang.String OPTION_OUTPUT_DESTINATION
```
    Name of the long command line option and configuration file field for defining the destination (usually output file name) of actions that produce output.
    
    See Also:
    
    Constant Field Values
  - OPTION_OUTPUT_COMPRESSION
```
public static final java.lang.String OPTION_OUTPUT_COMPRESSION
```
    Name of the long command line option and configuration file field for specifying the compression to use for the output.
    
    See Also:
    
    Constant Field Values
  - OPTION_OUTPUT_STDOUT
```
public static final java.lang.String OPTION_OUTPUT_STDOUT
```
    Name of the long command line option and configuration file field for directing output to stdout.
    
    See Also:
    
    Constant Field Values
  - OPTION_OUTPUT_RDF_TYPE
```
public static final java.lang.String OPTION_OUTPUT_RDF_TYPE
```
    Name of the long command line option and configuration file field for specifying the tasks for RDF serialization.
    
    See Also:
    
    Constant Field Values
  - OPTION_LOCAL_DUMPFILE
```
public static final java.lang.String OPTION_LOCAL_DUMPFILE
```
    Name of the long command line option and configuration file field for defining the path to a local dump file.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ClientConfiguration
```
public ClientConfiguration(java.lang.String[] args)
```
    Constructs a new object for the given arguments.
    
    Parameters:
    
    args - command-line arguments
- Method Detail
  - insertDumpInformation
```
public static java.lang.String insertDumpInformation(java.lang.String pattern,
                                                     java.lang.String dateStamp,
                                                     java.lang.String project)
```
    Inserts the information about the dateStamp of a dump and the project name into a pattern.
    
    Parameters:
    
    pattern - String with wildcards
    
    dateStamp -
    
    project -
    
    Returns:
    
    String with injected information.
  - getActions
```
public java.util.List<DumpProcessingAction> getActions()
```
    Returns the list of actions defined for this object.
    
    Returns:
    
    list of actions
  - getDumpDirectoryLocation
```
public java.lang.String getDumpDirectoryLocation()
```
    Returns the location of the directory where downloaded dump files are stored, or null if the default is to be used.
    
    Returns:
    
    string path to dump file directory
  - getOfflineMode
```
public boolean getOfflineMode()
```
    Returns true if all operations should be performed in offline mode, without accessing the Internet.
    
    Returns:
    
    true if in offline mode
  - isQuiet
```
public boolean isQuiet()
```
    Returns true if the application should not write anything to stdout. This can be set explicitly or indirectly if one of the actions wants to write to stdout.
    
    Returns:
    
    true if the application should not log messages to stdout
  - getReportFileName
```
public java.lang.String getReportFileName()
```
    Returns the output destination where a report file should be created. If the client should not create such a file the function will return null.
    
    Returns:
    
    report filename
  - getFilterLanguages
```
public java.util.Set<java.lang.String> getFilterLanguages()
```
    Returns a set of language codes that should be used as a filter, or null if no filter is set. An empty set means that all languages should be filtered.
    
    Returns:
    
    language filter
  - getFilterSiteKeys
```
public java.util.Set<java.lang.String> getFilterSiteKeys()
```
    Returns a set of site keys that should be used as a filter for site links, or null if no filter is set. An empty set means that all site links should be filtered.
    
    Returns:
    
    site key filter
  - getFilterProperties
```
public java.util.Set<org.wikidata.wdtk.datamodel.interfaces.PropertyIdValue> getFilterProperties()
```
    Returns a set of property ids that should be used as a filter for statements, or null if no filter is set. An empty set means that all statements should be filtered.
    
    Returns:
    
    property filter
  - getInputDumpLocation
```
public java.lang.String getInputDumpLocation()
```
    Returns the string path to a dump file that should be processed.
    
    Returns:
    
    string path to file
  - getLocalDumpFile
```
public org.wikidata.wdtk.dumpfiles.MwLocalDumpFile getLocalDumpFile()
```
    Returns a local dump file that was previously downloaded and should be locally processed, or null if no local dump file is set.
    The dump file object will be created based on the current configuration.
    
    Returns:
    
    dump file that should be locally processed
  - setProjectName
```
public void setProjectName(java.lang.String project)
```
    Sets the project name of the dump file.
    
    Parameters:
    
    project -
  - setDateStamp
```
public void setDateStamp(java.lang.String dateStamp)
```
    Sets the date stamp of the dump file.
    
    Parameters:
    
    dateStamp -
  - getProjectName
```
public java.lang.String getProjectName()
```
    Returns the project name according to the dump file.
    
    Returns:
    
    project name
  - getDateStamp
```
public java.lang.String getDateStamp()
```
    Returns the date stamp of the dump file.
    
    Returns:
    
    date stamp
  - printHelp
```
public void printHelp()
```
    Prints a help text to the console.
  - insertDumpInformation
```
public java.lang.String insertDumpInformation(java.lang.String pattern)
```

Class ClientConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CMD_OPTION_HELP

CMD_OPTION_CONFIG_FILE

CMD_OPTION_DUMP_LOCATION

CMD_OPTION_QUIET

CMD_OPTION_OFFLINE_MODE

CMD_OPTION_ACTION

CMD_OPTION_OUTPUT_DESTINATION

CMD_OPTION_OUTPUT_COMPRESSION

CMD_OPTION_OUTPUT_STDOUT

CMD_OPTION_CREATE_REPORT

CMD_OPTION_LOCAL_DUMPFILE

OPTION_HELP

OPTION_CONFIG_FILE

OPTION_DUMP_LOCATION

OPTION_OFFLINE_MODE

OPTION_QUIET

OPTION_ACTION

OPTION_FILTER_LANGUAGES

OPTION_FILTER_SITES

OPTION_FILTER_PROPERTIES

OPTION_CREATE_REPORT

OPTION_OUTPUT_DESTINATION

OPTION_OUTPUT_COMPRESSION

OPTION_OUTPUT_STDOUT

OPTION_OUTPUT_RDF_TYPE

OPTION_LOCAL_DUMPFILE

Constructor Detail

ClientConfiguration

Method Detail

insertDumpInformation

getActions

getDumpDirectoryLocation

getOfflineMode

isQuiet

getReportFileName

getFilterLanguages

getFilterSiteKeys

getFilterProperties

getInputDumpLocation

getLocalDumpFile

setProjectName

setDateStamp

getProjectName

getDateStamp

printHelp

insertDumpInformation