Package org.wikidata.wdtk.client

Class SchemaUsageAnalyzer

java.lang.Object

org.wikidata.wdtk.client.SchemaUsageAnalyzer

All Implemented Interfaces:

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

public class SchemaUsageAnalyzer
extends java.lang.Object
implements DumpProcessingAction

Author:

Markus Kroetzsch

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	dateStamp
protected static com.fasterxml.jackson.databind.ObjectMapper	mapper	Object mapper that is used to serialize JSON.
protected java.lang.String	name	Name as an action, if any
protected java.lang.String	project
protected java.nio.file.Path	resultDirectory	The place where result files will be stored.
protected org.wikidata.wdtk.datamodel.interfaces.Sites	sites	Sites information used to extract site data.

Constructor Summary

Constructors

Constructor	Description
SchemaUsageAnalyzer()

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	countTerms(org.wikidata.wdtk.datamodel.interfaces.TermedDocument termedDocument, org.wikidata.wdtk.client.SchemaUsageAnalyzer.EntityStatistics entityStatistics)	Count the terms (labels, descriptions, aliases) of an item or property document.
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	open()
static java.io.FileOutputStream	openResultFileOuputStream(java.nio.file.Path resultDirectory, java.lang.String filename)	Opens a new FileOutputStream for a file of the given name in the given result directory.
void	processItemDocument(org.wikidata.wdtk.datamodel.interfaces.ItemDocument itemDocument)
void	processPropertyDocument(org.wikidata.wdtk.datamodel.interfaces.PropertyDocument propertyDocument)
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.
void	writeStatisticsData(java.io.PrintStream out)

Methods inherited from class java.lang.Object

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

Field Detail

mapper

protected static final com.fasterxml.jackson.databind.ObjectMapper mapper

Object mapper that is used to serialize JSON.

resultDirectory

protected java.nio.file.Path resultDirectory

The place where result files will be stored.

sites

protected org.wikidata.wdtk.datamodel.interfaces.Sites sites

Sites information used to extract site data.

name

protected java.lang.String name

Name as an action, if any

dateStamp

protected java.lang.String dateStamp

project

protected java.lang.String project

Constructor Detail

SchemaUsageAnalyzer

public SchemaUsageAnalyzer()

Method Detail

openResultFileOuputStream

public static java.io.FileOutputStream openResultFileOuputStream(java.nio.file.Path resultDirectory,
                                                                 java.lang.String filename)
                                                          throws java.io.IOException

Opens a new FileOutputStream for a file of the given name in the given result directory. Any file of this name that exists already will be replaced. The caller is responsible for eventually closing the stream.

Parameters:

resultDirectory - the path to the result directory

filename - the name of the file to write to

Returns:

FileOutputStream for the file

Throws:

java.io.IOException - if the file or example output directory could not be created

processItemDocument

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

Specified by:

processItemDocument in interface org.wikidata.wdtk.datamodel.interfaces.EntityDocumentProcessor

processPropertyDocument

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

Specified by:

processPropertyDocument in interface org.wikidata.wdtk.datamodel.interfaces.EntityDocumentProcessor

countTerms

protected void countTerms(org.wikidata.wdtk.datamodel.interfaces.TermedDocument termedDocument,
                          org.wikidata.wdtk.client.SchemaUsageAnalyzer.EntityStatistics entityStatistics)

Count the terms (labels, descriptions, aliases) of an item or property document.

Parameters:

termedDocument - document to count the terms of

entityStatistics - record where statistics are counted

writeStatisticsData

public void writeStatisticsData(java.io.PrintStream out)
                         throws com.fasterxml.jackson.core.JsonGenerationException,
                                com.fasterxml.jackson.databind.JsonMappingException,
                                java.io.IOException

Throws:

com.fasterxml.jackson.core.JsonGenerationException

com.fasterxml.jackson.databind.JsonMappingException

java.io.IOException

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.

Specified by:

needsSites in interface DumpProcessingAction

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.

Specified by:

isReady in interface DumpProcessingAction

Returns:

true if ready to run

getReport

public java.lang.String getReport()

Description copied from interface: DumpProcessingAction

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

Specified by:

getReport in interface DumpProcessingAction

Returns:

report message

open

public void open()

Specified by:

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

close

public void close()

Specified by:

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

setSites

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

Description copied from interface: DumpProcessingAction

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

Specified by:

setSites in interface DumpProcessingAction

Parameters:

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

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

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

public boolean useStdOut()

Description copied from interface: DumpProcessingAction

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.

Specified by:

useStdOut in interface DumpProcessingAction

Returns:

true if the action is configured to write results to stdout

setDumpInformation

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

Description copied from interface: DumpProcessingAction

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.

Specified by:

setDumpInformation in interface DumpProcessingAction

Parameters:

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

dateStamp - the datestamp (YYYYMMDD) for the dump

setActionName

public void setActionName(java.lang.String name)

Description copied from interface: DumpProcessingAction

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

Specified by:

setActionName in interface DumpProcessingAction

getActionName

public java.lang.String getActionName()

Description copied from interface: DumpProcessingAction

Returns the name of the action.

Specified by:

getActionName in interface DumpProcessingAction

Returns:

name

getDefaultActionName

public java.lang.String getDefaultActionName()

Description copied from interface: DumpProcessingAction

Returns the default name for an action.

Specified by:

getDefaultActionName in interface DumpProcessingAction

Returns:

default name