Package org.wikidata.wdtk.dumpfiles

Class EntityTimerProcessor

java.lang.Object

org.wikidata.wdtk.dumpfiles.EntityTimerProcessor

All Implemented Interfaces:

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

public class EntityTimerProcessor
extends java.lang.Object
implements org.wikidata.wdtk.datamodel.interfaces.EntityDocumentDumpProcessor

Simple EntityDocumentProcessor for basic counting and time keeping. It will print statistics on elapsed time and processed entities once in a while. The class also supports a timeout mechanism: if a timeout time (in seconds) is given, then a EntityTimerProcessor.TimeoutException (unchecked) will be thrown soon after this many seconds have passed. This can be used to abort processing in a relatively clean way by catching this exception at a higher level.

Author:

Markus Kroetzsch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	EntityTimerProcessor.TimeoutException

Constructor Summary

Constructors

Constructor	Description
EntityTimerProcessor(int timeout)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()	Stops the processing and prints the final time.
void	open()
void	processItemDocument(org.wikidata.wdtk.datamodel.interfaces.ItemDocument itemDocument)
void	processPropertyDocument(org.wikidata.wdtk.datamodel.interfaces.PropertyDocument propertyDocument)
void	setReportInterval(int seconds)	Sets the interval after which the timer should report progress.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityTimerProcessor

public EntityTimerProcessor(int timeout)

Constructor.

Parameters:

timeout - the timeout in seconds or 0 if no timeout should be used

Method Detail

setReportInterval

public void setReportInterval(int seconds)

Sets the interval after which the timer should report progress. By default, this is ten seconds. When using a timeout, the timeout condition will only be checked at this interval, too, so using a very large value would lead to increasing imprecision with the timeout. The timer does not use a separate thread, and reports will only be generated after an entity was fully processed. Thus, very long processing times would also affect the accuracy of the interval.

Parameters:

seconds - time after which progress should be reported.

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

open

public void open()

Specified by:

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

close

public void close()

Stops the processing and prints the final time.

Specified by:

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