Package de.bcxp.challenge.common.analysis.csv

Class CsvAnalysisUtility

java.lang.Object

de.bcxp.challenge.common.analysis.csv.CsvAnalysisUtility

public final class CsvAnalysisUtility
extends Object

Utility class providing common analytical operations for Document objects.

This class contains static helper methods that perform reusable data analysis tasks, such as identifying the best-matching document entries based on numeric column comparisons.

The utility class is declared final and has a private constructor to prevent instantiation. All functionality is provided via static methods.

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.apache.logging.log4j.Logger	logger

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CsvAnalysisUtility()	Private constructor to prevent instantiation of this utility class.

Method Summary

Modifier and Type	Method	Description
private static Set<DocumentEntry>	getAllDocumentEntriesWithBestScore(Set<IEntryWithComparableNumericTuple> comparableEntries, double bestScore)	Retrieves all entries from the given set that have the determined score.
static Set<DocumentEntry>	getBestMatchesForNumericColumnComparison(Document document, NumericComparisonType type)	Finds all entries in the given Document that share the "best" numeric score, according to the specified Comparator.
private static Set<IEntryWithComparableNumericTuple>	getEntriesWithComparableNumericTuples(Document document)	Maps all DocumentEntry objects from a Document to IEntryWithComparableNumericTuple

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final org.apache.logging.log4j.Logger logger

Constructor Details

CsvAnalysisUtility

private CsvAnalysisUtility()

Private constructor to prevent instantiation of this utility class.

Method Details

getBestMatchesForNumericColumnComparison

public static Set<DocumentEntry> getBestMatchesForNumericColumnComparison(Document document,
 NumericComparisonType type)
                                                                   throws NoSuchElementException

Finds all entries in the given Document that share the "best" numeric score, according to the specified Comparator.

The method performs the following steps:

1. Validates that the document and its entries are not null and meet the required type constraints.
2. Validates that all entries implement IEntryWithComparableNumericTuple.
3. Calculates a numeric score for each entry via IEntryWithComparableNumericTuple.getBestMatchScore().
4. Determines the best score according to type.comparator.
5. Collects and returns all entries that have this best score.

Parameters:

document - the Document containing entries to analyze

type - the NumericComparisonType providing the Comparator for best score determination

Returns:

a Set of entries with the best score according to the given comparator; never null but may be empty

Throws:

NoSuchElementException - if the document contains no valid entries or no score could be computed

IllegalArgumentException - if the document entries are not of type IEntryWithComparableNumericTuple

IllegalStateException - if the document contains a null entry

See Also:

• Document
• DocumentEntry
• IEntryWithComparableNumericTuple

getEntriesWithComparableNumericTuples

private static Set<IEntryWithComparableNumericTuple> getEntriesWithComparableNumericTuples(Document document)
                                                                                    throws IllegalArgumentException

Maps all DocumentEntry objects from a Document to IEntryWithComparableNumericTuple

Parameters:

document - Document with numeric tuples

Returns:

a Set of IEntryWithComparableNumericTuple objects representing the entries from the given document

Throws:

IllegalArgumentException - if the entries are empty, null, or not all the same concrete type implementing IEntryWithComparableNumericTuple

getAllDocumentEntriesWithBestScore

private static Set<DocumentEntry> getAllDocumentEntriesWithBestScore(Set<IEntryWithComparableNumericTuple> comparableEntries,
 double bestScore)

Retrieves all entries from the given set that have the determined score.

Parameters:

comparableEntries - Set containing all entries from the document.

bestScore - Score to filter for

Returns:

Set of all DocumentEntry objects with the best score.