Package org.wikidata.wdtk.client

Class JsonSerializationAction

java.lang.Object

org.wikidata.wdtk.client.DumpProcessingOutputAction

org.wikidata.wdtk.client.JsonSerializationAction

All Implemented Interfaces:

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

public class JsonSerializationAction
extends DumpProcessingOutputAction

This class represents an action of generating a JSON dump from data. It has no specific options.

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.

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
JsonSerializationAction()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()
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)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

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

JsonSerializationAction

public JsonSerializationAction()

Constructor. See DumpProcessingOutputAction for more details.

Method Detail

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

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