de.gwdg.metadataqa.api.calculator

Class CompletenessCalculator<T extends XmlFieldInstance>

java.lang.Object

de.gwdg.metadataqa.api.calculator.CompletenessCalculator<T>

Type Parameters:

T -

All Implemented Interfaces:

Calculator, Serializable

public class CompletenessCalculator<T extends XmlFieldInstance>
extends Object
implements Calculator, Serializable

Author:

Péter Király

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CALCULATOR_NAME

Constructor Summary

Constructors

Constructor and Description
CompletenessCalculator()
CompletenessCalculator(Schema schema)

Method Summary

Modifier and Type	Method and Description
void	collectFields(boolean collectFields)
void	evaluateJsonBranch(JsonBranch jsonBranch, PathCache cache, CompletenessCounter completenessCounter, String address, Object jsonFragment)
String	getCalculatorName() Get the name of the calculator.
FieldCounter<Integer>	getCardinalityCounter()
Map<String,Integer>	getCardinalityMap()
CompletenessCounter	getCompletenessCounter()
String	getCsv(boolean withLabel, CompressionLevel compressionLevel) Get result as comma separated string.
List<String>	getEmptyFields()
FieldCounter<Boolean>	getExistenceCounter()
Map<String,Boolean>	getExistenceMap()
List<String>	getExistingFields()
List<String>	getHeader() Get header (the name of metrics) as a list.
String	getInputFileName()
Map<String,Map<String,? extends Object>>	getLabelledResultMap() Get hierarchical result map.
List<String>	getList(boolean withLabel, CompressionLevel compressionLevel)
List<String>	getMissingFields()
Map<String,? extends Object>	getResultMap() Get results as a simple map.
Schema	getSchema()
SkippedEntryChecker	getSkippedEntryChecker()
void	handleEmptyFragment(JsonBranch collection)
void	initializeCounters()
boolean	isCardinality()
boolean	isCompleteness()
boolean	isExistence()
void	measure(PathCache cache) Measure something from the JSON input object.
void	setCardinality(boolean cardinality)
void	setCompleteness(boolean completeness)
void	setExistence(boolean existence)
void	setInputFileName(String inputFileName)
void	setSkippedEntryChecker(SkippedEntryChecker skippedEntryChecker)

Methods inherited from class java.lang.Object

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

Field Detail

CALCULATOR_NAME

public static final String CALCULATOR_NAME

See Also:

Constant Field Values

Constructor Detail

CompletenessCalculator

public CompletenessCalculator()

CompletenessCalculator

public CompletenessCalculator(Schema schema)

Method Detail

getCalculatorName

public String getCalculatorName()

Description copied from interface: Calculator

Get the name of the calculator.

Specified by:

getCalculatorName in interface Calculator

Returns:

The name of the calculator

measure

public void measure(PathCache cache)
             throws com.jayway.jsonpath.InvalidJsonException

Description copied from interface: Calculator

Measure something from the JSON input object.

Specified by:

measure in interface Calculator

Parameters:

cache - The JSON cache object

Throws:

com.jayway.jsonpath.InvalidJsonException

initializeCounters

public void initializeCounters()

handleEmptyFragment

public void handleEmptyFragment(JsonBranch collection)

evaluateJsonBranch

public void evaluateJsonBranch(JsonBranch jsonBranch,
                               PathCache cache,
                               CompletenessCounter completenessCounter,
                               String address,
                               Object jsonFragment)

collectFields

public void collectFields(boolean collectFields)

getMissingFields

public List<String> getMissingFields()

getEmptyFields

public List<String> getEmptyFields()

getExistingFields

public List<String> getExistingFields()

setInputFileName

public void setInputFileName(String inputFileName)

getInputFileName

public String getInputFileName()

getResultMap

public Map<String,? extends Object> getResultMap()

Description copied from interface: Calculator

Get results as a simple map.

Specified by:

getResultMap in interface Calculator

Returns:

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

getLabelledResultMap

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

Description copied from interface: Calculator

Get hierarchical result map.

Specified by:

getLabelledResultMap in interface Calculator

Returns:

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

getCsv

public String getCsv(boolean withLabel,
                     CompressionLevel compressionLevel)

Description copied from interface: Calculator

Get result as comma separated string.

Specified by:

getCsv in interface Calculator

Parameters:

withLabel - 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

public List<String> getList(boolean withLabel,
                            CompressionLevel compressionLevel)

Specified by:

getList in interface Calculator

getHeader

public List<String> getHeader()

Description copied from interface: Calculator

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

Specified by:

getHeader in interface Calculator

Returns:

The list of metrics.

getExistenceMap

public Map<String,Boolean> getExistenceMap()

getCardinalityMap

public Map<String,Integer> getCardinalityMap()

getCompletenessCounter

public CompletenessCounter getCompletenessCounter()

getExistenceCounter

public FieldCounter<Boolean> getExistenceCounter()

getCardinalityCounter

public FieldCounter<Integer> getCardinalityCounter()

isCompleteness

public boolean isCompleteness()

setCompleteness

public void setCompleteness(boolean completeness)

isExistence

public boolean isExistence()

setExistence

public void setExistence(boolean existence)

isCardinality

public boolean isCardinality()

setCardinality

public void setCardinality(boolean cardinality)

getSchema

public Schema getSchema()

getSkippedEntryChecker

public SkippedEntryChecker getSkippedEntryChecker()

setSkippedEntryChecker

public void setSkippedEntryChecker(SkippedEntryChecker skippedEntryChecker)