org.openstreetmap.atlas.checks.event

Class MetricFileGenerator

java.lang.Object

org.openstreetmap.atlas.checks.event.FileProcessor<MetricEvent>

org.openstreetmap.atlas.checks.event.MetricFileGenerator

All Implemented Interfaces:

Processor<MetricEvent>

public final class MetricFileGenerator
extends FileProcessor<MetricEvent>

A Processor for MetricEvents to write them into files. By default this supports maximum FileProcessor.BATCH_SIZE metrics. If number of metrics go beyond that limit, the newest metrics will override the previous ones in the file, because the file name is going to be the same for both write operations.

Field Summary

Fields inherited from class org.openstreetmap.atlas.checks.event.FileProcessor

BATCH_SIZE

Constructor Summary

Constructors

Constructor and Description
MetricFileGenerator(java.lang.String label, org.openstreetmap.atlas.generator.tools.spark.utilities.SparkFileHelper fileHelper, java.lang.String outputFolder) Default constructor

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getFilename()
void	process(MetricEvent event) Method to process Event.
void	process(ShutdownEvent event) Method to process ShutdownEvent.

Methods inherited from class org.openstreetmap.atlas.checks.event.FileProcessor

doesCompressOutput, getBatchSize, getCount, process, setBatchSize, withCompression, write

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricFileGenerator

public MetricFileGenerator(java.lang.String label,
                           org.openstreetmap.atlas.generator.tools.spark.utilities.SparkFileHelper fileHelper,
                           java.lang.String outputFolder)

Default constructor

Parameters:

label - label for the metric file

fileHelper - SparkFileHelper for I/O operations

outputFolder - output folder path to write files to

Method Detail

process

public void process(MetricEvent event)

Description copied from interface: Processor

Method to process Event. If your method can process multiple events simultaneously, then mark your method with @AllowConcurrentEvents annotation.Please make sure to add @Subscribe annotation to the method that is implementing this method.

Parameters:

event - Event to process

process

public void process(ShutdownEvent event)

Description copied from interface: Processor

Method to process ShutdownEvent. This method will be called only once.
Please make sure to add @Subscribe annotation to the method that is implementing this method.

Parameters:

event - ShutdownEvent to process

getFilename

protected java.lang.String getFilename()

Overrides:

getFilename in class FileProcessor<MetricEvent>

Returns:

the name of the file to be used in #write() method to write files