Package de.gwdg.metadataqa.marc.analysis.functional

Class FunctionalAnalyzer

java.lang.Object

de.gwdg.metadataqa.marc.analysis.functional.FunctionalAnalyzer

Direct Known Subclasses:

Marc21FunctionalAnalyzer, PicaFunctionalAnalyzer, UnimarcFunctionalAnalyzer

public abstract class FunctionalAnalyzer
extends Object

Analyzes a record and counts the FRBR functions. In other words, it counts how many FRBR user tasks are supported by the provided record.

Field Summary

Fields

Modifier and Type	Field	Description
protected FrbrFunctionLister	frbrFunctionLister
protected Map<FRBRFunction,FunctionValue>	recordCounter	The map with the counts of the FRBR functions (user tasks) in one single record.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FunctionalAnalyzer(FrbrFunctionLister frbrFunctionLister)

Method Summary

Modifier and Type	Method	Description
void	addRecordCounterToCollector(Map<FRBRFunction,FunctionValue> recordCounter)	Adds the recordCounter to the collector.
void	addRecordCounterToHistogram(Map<FRBRFunction,FunctionValue> recordCounter)
protected abstract void	analyzeRecord(BibliographicRecord bibliographicRecord)	Should be implemented to analyze a record and count the FRBR functions.
void	calculatePercentage(Map<FRBRFunction,FunctionValue> recordCounter)	Calculates the percentage of each function in the recordCounter map compared to the total count of functions possible in the schema, represented by the baselineCounter of the frbrFunctionLister.
void	consumeRecord(BibliographicRecord bibliographicRecord)	Consumes a bibliographic record.
protected abstract void	countDataField(DataFieldDefinition definition, DataField dataField, Map<FRBRFunction,FunctionValue> recordCounter)
protected final void	countDataFields(Map<FRBRFunction,FunctionValue> functionCounter, List<DataField> dataFields, Map<DataFieldDefinition,Boolean> cache)
static void	countFunctions(List<FRBRFunction> functions, Map<FRBRFunction,FunctionValue> recordCounter)	Receives a list of functions (presumably from a data field, subfield or indicator) and counts them in the recordCounter map.
Map<FRBRFunction,FunctionValue>	getCollector()
FrbrFunctionLister	getFrbrFunctionLister()
Map<FRBRFunction,Counter<FunctionValue>>	getHistogram()
protected final Map<FRBRFunction,FunctionValue>	initializeCounter()	Used to initialize a counter map with all FRBR functions and their respective values.
Map<FRBRFunction,List<Double>>	percentOf(int total)
protected void	prepareHistogram()

Methods inherited from class java.lang.Object

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

Field Details

recordCounter

protected Map<FRBRFunction,FunctionValue> recordCounter

The map with the counts of the FRBR functions (user tasks) in one single record.

frbrFunctionLister

protected FrbrFunctionLister frbrFunctionLister

Constructor Details

FunctionalAnalyzer

protected FunctionalAnalyzer(FrbrFunctionLister frbrFunctionLister)

Method Details

consumeRecord

public void consumeRecord(BibliographicRecord bibliographicRecord)

Consumes a bibliographic record. Calls the abstract method analyzeRecord() to analyze the record and count the FRBR functions. Then, it adds the recordCounter to the collector and histogram maps.

Parameters:

bibliographicRecord - The record to be analyzed and counted.

analyzeRecord

protected abstract void analyzeRecord(BibliographicRecord bibliographicRecord)

Should be implemented to analyze a record and count the FRBR functions. It should create the recordCounter map and return it. It is used in the method consumeRecord().

Parameters:

bibliographicRecord - The record to be analyzed and counted.

countDataField

protected abstract void countDataField(DataFieldDefinition definition,
 DataField dataField,
 Map<FRBRFunction,FunctionValue> recordCounter)

countDataFields

protected final void countDataFields(Map<FRBRFunction,FunctionValue> functionCounter,
 List<DataField> dataFields,
 Map<DataFieldDefinition,Boolean> cache)

initializeCounter

protected final Map<FRBRFunction,FunctionValue> initializeCounter()

Used to initialize a counter map with all FRBR functions and their respective values. This is intended to be used for the recordCounter and collector maps.

Returns:

A map with all FRBR functions and their respective values.

prepareHistogram

protected void prepareHistogram()

countFunctions

public static void countFunctions(List<FRBRFunction> functions,
 Map<FRBRFunction,FunctionValue> recordCounter)

Receives a list of functions (presumably from a data field, subfield or indicator) and counts them in the recordCounter map.

Parameters:

functions - The list of functions to be counted.

recordCounter - The map where the functions will be counted. Format: Function -> FunctionValue (count and percentage).

calculatePercentage

public void calculatePercentage(Map<FRBRFunction,FunctionValue> recordCounter)

Calculates the percentage of each function in the recordCounter map compared to the total count of functions possible in the schema, represented by the baselineCounter of the frbrFunctionLister.

Parameters:

recordCounter - The map with the counts of the FRBR functions of the current record.

See Also:

• FrbrFunctionLister

addRecordCounterToCollector

public void addRecordCounterToCollector(Map<FRBRFunction,FunctionValue> recordCounter)

Adds the recordCounter to the collector. The collector is a map that stores counts from all records.

Parameters:

recordCounter - The map with the counts of the FRBR functions.

addRecordCounterToHistogram

public void addRecordCounterToHistogram(Map<FRBRFunction,FunctionValue> recordCounter)

percentOf

public Map<FRBRFunction,List<Double>> percentOf(int total)

getCollector

public Map<FRBRFunction,FunctionValue> getCollector()

getHistogram

public Map<FRBRFunction,Counter<FunctionValue>> getHistogram()

getFrbrFunctionLister

public FrbrFunctionLister getFrbrFunctionLister()