Package org.wikidata.wdtk.client

Class RdfSerializationAction

java.lang.Object

org.wikidata.wdtk.client.DumpProcessingOutputAction

org.wikidata.wdtk.client.RdfSerializationAction

All Implemented Interfaces:

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

public class RdfSerializationAction
extends DumpProcessingOutputAction

This class represents an action of generating an RDF dump from data. It provides the additional option OPTION_RDF_TASKS, which is required for generating any output.

Author:

Markus Kroetzsch

Nested Class Summary

Nested classes/interfaces inherited from class org.wikidata.wdtk.client.DumpProcessingOutputAction

DumpProcessingOutputAction.FinishableRunnable

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_ACTION_NAME	default action name is used to separate different DumpProcessingOutputActions from each other.
static java.lang.String	DEFAULT_FILE_NAME	The base file name that will be used by default.
static java.util.Map<java.lang.String,java.lang.Integer>	KNOWN_TASKS
static java.lang.String	OPTION_RDF_TASKS	Name of the option that defines the tasks of the RDF serializer.
static java.util.Map<java.lang.String,java.lang.String>	TASK_HELP

Fields inherited from class org.wikidata.wdtk.client.DumpProcessingOutputAction

COMPRESS_BZ2, COMPRESS_GZIP, COMPRESS_NONE, compressionType, dateStamp, name, OPTION_COMPRESSION, OPTION_DESTINATION, OPTION_USE_STDOUT, outputDestination, outputStreams, project, sites, useStdOut

Constructor Summary

Constructors

Constructor	Description
RdfSerializationAction()

Method Summary

Modifier and Type	Method	Description
void	close()
protected RdfSerializer	createRdfSerializer()	Creates a new RDF serializer based on the current configuration of this object.
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	open()
void	processItemDocument(org.wikidata.wdtk.datamodel.interfaces.ItemDocument itemDocument)
void	processPropertyDocument(org.wikidata.wdtk.datamodel.interfaces.PropertyDocument propertyDocument)
boolean	setOption(java.lang.String option, java.lang.String value)	Sets the options of the specified name to the given value.

Methods inherited from class org.wikidata.wdtk.client.DumpProcessingOutputAction

getActionName, getAsynchronousOutputStream, getOutputFilename, getOutputStream, insertDumpInformation, setActionName, setDumpInformation, setSites, useStdOut

Methods inherited from class java.lang.Object

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

Field Detail

OPTION_RDF_TASKS

public static final java.lang.String OPTION_RDF_TASKS

Name of the option that defines the tasks of the RDF serializer. The value of this option should be a space-free, comma-separated list of task names. Tasks define the data that should be processed ("items", "properties", "entities") and what information should be written for each ("statements", "sitelinks", "datatypes", "labels", "desciptions", "aliases", "terms" meaning "labels,descriptions,aliases", "alldata" meaning "statements,terms,sitelinks,datatypes", "taxonomy", "instanceof", "simplestatements").

See Also:

Constant Field Values

KNOWN_TASKS

public static final java.util.Map<java.lang.String,java.lang.Integer> KNOWN_TASKS

TASK_HELP

public static final java.util.Map<java.lang.String,java.lang.String> TASK_HELP

DEFAULT_FILE_NAME

public static final java.lang.String DEFAULT_FILE_NAME

The base file name that will be used by default. File endings for indicating compression will be appended where required.

See Also:

Constant Field Values

DEFAULT_ACTION_NAME

public static final java.lang.String DEFAULT_ACTION_NAME

default action name is used to separate different DumpProcessingOutputActions from each other.

See Also:

Constant Field Values

Constructor Detail

RdfSerializationAction

public RdfSerializationAction()

Method Detail

setOption

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

Description copied from interface: DumpProcessingAction

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.

Specified by:

setOption in interface DumpProcessingAction

Overrides:

setOption in class DumpProcessingOutputAction

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)

needsSites

public boolean needsSites()

Description copied from interface: DumpProcessingAction

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

public boolean isReady()

Description copied from interface: DumpProcessingAction

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

open

public void open()

processItemDocument

public void processItemDocument(org.wikidata.wdtk.datamodel.interfaces.ItemDocument itemDocument)

processPropertyDocument

public void processPropertyDocument(org.wikidata.wdtk.datamodel.interfaces.PropertyDocument propertyDocument)

close

public void close()

Specified by:

close in interface org.wikidata.wdtk.datamodel.interfaces.EntityDocumentDumpProcessor

Overrides:

close in class DumpProcessingOutputAction

createRdfSerializer

protected RdfSerializer createRdfSerializer()
                                     throws java.io.IOException

Creates a new RDF serializer based on the current configuration of this object.

Returns:

the newly created RDF serializer

Throws:

java.io.IOException - if there were problems opening the output files

getReport

public java.lang.String getReport()

Description copied from interface: DumpProcessingAction

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

Returns:

report message

getDefaultActionName

public java.lang.String getDefaultActionName()

Description copied from interface: DumpProcessingAction

Returns the default name for an action.

Returns:

default name