Skip to content

Merged Data DTO

merged_data_dto

Merged Data Data Transfer Object.

Defines the MergedDataDTO, an immutable data transfer object that encapsulates results from database merge operations. Provides structured data for presenting merge outcomes across multiple databases.

Classes:

Name Description
MergedDataDTO

Immutable DTO containing merge operation results

Classes

MergedDataDTO dataclass 

MergedDataDTO(biorempp_data: DataFrame, hadeg_data: Optional[DataFrame], toxcsm_data: Optional[DataFrame], match_count: int, total_records: int, cache_key: str, processing_time_seconds: float = 0.0)

Immutable DTO for database merge operation results.

Encapsulates merged data from BioRemPP, HADEG, and ToxCSM databases along with metadata about the merge operation.

Parameters:

Name Type Description Default
biorempp_data DataFrame

Data merged with BioRemPP database

 required
hadeg_data Optional[DataFrame]

Data merged with HADEG database (None if not merged)

 required
toxcsm_data Optional[DataFrame]

Data merged with ToxCSM database (None if not merged)

 required
match_count int

Number of successful matches across all databases

 required
total_records int

Total number of input records processed

 required
cache_key str

Cache key for storing/retrieving this merge result

 required
processing_time_seconds float

Time taken for merge operation in seconds

 0.0

Attributes:

Name Type Description
biorempp_data DataFrame

BioRemPP merged data
hadeg_data Optional[DataFrame]

HADEG merged data
toxcsm_data Optional[DataFrame]

ToxCSM merged data
match_count int

Match count
total_records int

Total records
cache_key str

Cache key
processing_time_seconds float

Processing time
Notes
  • This DTO is immutable (frozen)
  • DataFrames should be copied before modification to maintain immutability
Functions
__post_init__ 
__post_init__() -> None

Validate DTO consistency.

Raises:

Type Description
ValueError

If counts are negative or match_count > total_records
TypeError

If biorempp_data is not a DataFrame
Source code in src/application/dto/merged_data_dto.py 
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
def __post_init__(self) -> None:
    """
    Validate DTO consistency.

    Raises
    ------
    ValueError
        If counts are negative or match_count > total_records
    TypeError
        If biorempp_data is not a DataFrame
    """
    if not isinstance(self.biorempp_data, pd.DataFrame):
        raise TypeError("biorempp_data must be a pandas DataFrame")

    if self.match_count < 0 or self.total_records < 0:
        raise ValueError("Counts cannot be negative")

    if self.match_count > self.total_records:
        raise ValueError("match_count cannot exceed total_records")

    if self.processing_time_seconds < 0:
        raise ValueError("processing_time_seconds cannot be negative")
match_rate 
match_rate() -> float

Calculate match rate percentage.

Returns:

Type Description
float

Percentage of records matched (0.0 to 100.0)
Source code in src/application/dto/merged_data_dto.py 
 99
100
101
102
103
104
105
106
107
108
109
110
def match_rate(self) -> float:
    """
    Calculate match rate percentage.

    Returns
    -------
    float
        Percentage of records matched (0.0 to 100.0)
    """
    if self.total_records == 0:
        return 0.0
    return (self.match_count / self.total_records) * 100.0
has_hadeg_data 
has_hadeg_data() -> bool

Check if HADEG data is available.

Returns:

Type Description
bool

True if HADEG data exists
Source code in src/application/dto/merged_data_dto.py 
112
113
114
115
116
117
118
119
120
121
def has_hadeg_data(self) -> bool:
    """
    Check if HADEG data is available.

    Returns
    -------
    bool
        True if HADEG data exists
    """
    return self.hadeg_data is not None and not self.hadeg_data.empty
has_toxcsm_data 
has_toxcsm_data() -> bool

Check if ToxCSM data is available.

Returns:

Type Description
bool

True if ToxCSM data exists
Source code in src/application/dto/merged_data_dto.py 
123
124
125
126
127
128
129
130
131
132
def has_toxcsm_data(self) -> bool:
    """
    Check if ToxCSM data is available.

    Returns
    -------
    bool
        True if ToxCSM data exists
    """
    return self.toxcsm_data is not None and not self.toxcsm_data.empty