de.gwdg.metadataqa.api.interfaces

Interface Calculator

All Known Implementing Classes:

CompletenessCalculator, FieldExtractor, LanguageCalculator, MultilingualitySaturationCalculator, ProblemCatalog, RuleCatalog, TfIdfCalculator, UniquenessCalculator

public interface Calculator

Calculator does the actual measurements.

Author:

Péter Király

Method Summary

Modifier and Type	Method and Description
String	getCalculatorName() Get the name of the calculator.
String	getCsv(boolean withLabels, CompressionLevel compressionLevel) Get result as comma separated string.
List<String>	getHeader() Get header (the name of metrics) as a list.
Map<String,Map<String,? extends Object>>	getLabelledResultMap() Get hierarchical result map.
List<String>	getList(boolean withLabels, CompressionLevel compressionLevel)
Map<String,? extends Object>	getResultMap() Get results as a simple map.
void	measure(PathCache cache) Measure something from the JSON input object.

Method Detail

measure

void measure(PathCache cache)

Measure something from the JSON input object.

Parameters:

cache - The JSON cache object

getResultMap

Map<String,? extends Object> getResultMap()

Get results as a simple map.

Returns:

A map where the keys are name of measured features (metrics), the values are the values of the metrics.

getLabelledResultMap

Map<String,Map<String,? extends Object>> getLabelledResultMap()

Get hierarchical result map.

Returns:

The main keys are the name of the indivitual calculators, the values are simple maps with metric name - value pairs.

getCsv

String getCsv(boolean withLabels,
              CompressionLevel compressionLevel)

Get result as comma separated string.

Parameters:

withLabels - Flag whether the individal parts should contain the metric or not.

compressionLevel - If the value is a double, it is possible to remove the zeroes from the end, so make the value a bit compressed.

Returns:

result as comma separated string.

getList

List<String> getList(boolean withLabels,
                     CompressionLevel compressionLevel)

getHeader

List<String> getHeader()

Get header (the name of metrics) as a list.

Returns:

The list of metrics.

getCalculatorName

String getCalculatorName()

Get the name of the calculator.

Returns:

The name of the calculator