de.gwdg.metadataqa.api.calculator

Class FieldExtractor

java.lang.Object

de.gwdg.metadataqa.api.calculator.FieldExtractor

All Implemented Interfaces:

Calculator, Serializable

public class FieldExtractor
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
static String	FIELD_NAME
protected FieldCounter<String>	resultMap
protected Schema	schema

Constructor Summary

Constructors

Constructor and Description
FieldExtractor()
FieldExtractor(Schema schema)
FieldExtractor(String idPath)

Method Summary

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

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

FIELD_NAME

public static final String FIELD_NAME

See Also:

Constant Field Values

resultMap

protected FieldCounter<String> resultMap

schema

protected Schema schema

Constructor Detail

FieldExtractor

public FieldExtractor()

FieldExtractor

public FieldExtractor(Schema schema)

FieldExtractor

public FieldExtractor(String idPath)

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

getIdPath

public String getIdPath()

setIdPath

public void setIdPath(String idPath)

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.