Package org.wikidata.wdtk.client

Interface DumpProcessingAction

All Superinterfaces:

org.wikidata.wdtk.datamodel.interfaces.EntityDocumentDumpProcessor, org.wikidata.wdtk.datamodel.interfaces.EntityDocumentProcessor

All Known Implementing Classes:

DumpProcessingOutputAction, JsonSerializationAction, RdfSerializationAction, SchemaUsageAnalyzer

public interface DumpProcessingAction
extends org.wikidata.wdtk.datamodel.interfaces.EntityDocumentDumpProcessor

This interface represents an action that may be performed with Wikibase dumps. The processing as such is achieved by implementing EntityDocumentDumpProcessor. Additional methods provide a generic interface for setting options and other auxiliary information that the action might require.

Author:

Markus Kroetzsch

Method Summary

Modifier and Type	Method	Description
java.lang.String	getActionName()	Returns the name of the action.
java.lang.String	getDefaultActionName()	Returns the default name for an action.
java.lang.String	getReport()	Returns a report message containing information about the files which were generated.
boolean	isReady()	Returns true if the action is ready to process a dump.
boolean	needsSites()	Returns true if processing requires a Sites object to be set.
void	setActionName(java.lang.String name)	Sets the name of the action.
void	setDumpInformation(java.lang.String project, java.lang.String dateStamp)	Provides the action with general information about the dump that is to be processed.
boolean	setOption(java.lang.String option, java.lang.String value)	Sets the options of the specified name to the given value.
void	setSites(org.wikidata.wdtk.datamodel.interfaces.Sites sites)	Sets the sites information to the given value.
boolean	useStdOut()	Returns true if this action will write results (not log messages) to stdout.

Methods inherited from interface org.wikidata.wdtk.datamodel.interfaces.EntityDocumentDumpProcessor

close, open

Methods inherited from interface org.wikidata.wdtk.datamodel.interfaces.EntityDocumentProcessor

processItemDocument, processPropertyDocument

Method Detail

needsSites

boolean needsSites()

Returns true if processing requires a Sites object to be set. This is the case for some operations that process site links.

Returns:

true if sites information is needed.

isReady

boolean isReady()

Returns true if the action is ready to process a dump. An action that is insufficiently or wrongly configured can return false here to avoid being run.

If this method is called on an action that is not ready, the action should print helpful information on the missing configuration to stdout as a side effect.

Returns:

true if ready to run

setSites

void setSites(org.wikidata.wdtk.datamodel.interfaces.Sites sites)

Sets the sites information to the given value. The method needsSites() is used to find out if this is actually needed.

Parameters:

sites - the sites information for the data that will be processed

setOption

boolean setOption(java.lang.String option,
                  java.lang.String value)

Sets the options of the specified name to the given value. Returns true if the option was known, and false otherwise. Implementation should overwrite this function to support additional options.

Parameters:

option - name of the option to be set

value - the new value of the option

Returns:

true if the option was known (no matter if the given value could actually be used or not)

useStdOut

boolean useStdOut()

Returns true if this action will write results (not log messages) to stdout. The default implementation returns true if no other output destination has been specified. Subclasses that do not write results to stdout in this case should overwrite this method.

Returns:

true if the action is configured to write results to stdout

setDumpInformation

void setDumpInformation(java.lang.String project,
                        java.lang.String dateStamp)

Provides the action with general information about the dump that is to be processed. This may be used, e.g., to define file names to use for the output.

Parameters:

project - the name of the project that the dump is from

dateStamp - the datestamp (YYYYMMDD) for the dump

getReport

java.lang.String getReport()

Returns a report message containing information about the files which were generated.

Returns:

report message

setActionName

void setActionName(java.lang.String name)

Sets the name of the action. If this is not set, a default name will be used.

Parameters:

name -

getActionName

java.lang.String getActionName()

Returns the name of the action.

Returns:

name

getDefaultActionName

java.lang.String getDefaultActionName()

Returns the default name for an action.

Returns:

default name