# kamaladafrica/codice-fiscale architecture

> Architecture diagram of the GitHub repository kamaladafrica/codice-fiscale, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-02-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/kamaladafrica/codice-fiscale
- Repository: https://github.com/kamaladafrica/codice-fiscale

## Overview

##### Project Type Analysis
This is a specialized Java library focused on calculating, validating, and managing Italian tax codes. It's a standalone utility library with no external service dependencies.

##### Main Components

Core Components:
- Tax Code Calculator (CodiceFiscale class)
- Person Data Manager (Person class)
- City Management System (City-related classes)
- Data Providers (CityProvider interface and implementations)

A. Core Components Layer:
**┌─ Core Domain ─────────────────────┐**
- CodiceFiscale                     │
- Calculation                     │
- Validation                      │
- Comparison                      │
- Omocode Management             │
- ┬────────────────┘

**┌─ Domain Models ──┴────────────────┐**
- Person                            │
- City                              │
- ┘

B. City Management Layer:
**┌─ City Provider Interface ─────────┐**
- CityByName                       │
- CityByBelfiore                   │
- ┬───────────────────┘

**┌─ Implementations ─┴──────────────┐**
- CityProviderImpl                 │
- CompositeCityStreamSupplier      │
- ┬───────────────────┘

**┌─ Data Sources ─┴──────────────────┐**
- CSV Files (Italia, Esteri)        │
- ┘

C. Internal Components Layer:
**┌─ Tax Code Parts ─────────────────┐**
- LastnamePart                     │
- NamePart                         │
- DatePart                         │
- BelfiorePart                     │
- ControlPart                      │
- ┘

##### Implementation Details to Highlight

- Relationship between CodiceFiscale and its parts
- City provider chain (CityProvider → CityStreamSupplier → CSV files)
- Demonstrate the validation and calculation flow
- Omocode management system

##### Additional Elements

- Component types and their visual representations
- Important notes about omocode levels (0-127)

##### Technical Notes

- The library's independence from external services
- The flexible city provider system
- The component-based architecture for tax code parts
- The validation and calculation workflows

## Diagram (Mermaid)

```mermaid
graph TB
    %% Core Domain Layer
    subgraph CoreDomain
        CF[CodiceFiscale]:::core
        Person[Person]:::core
        City[City]:::core
    end

    %% City Management Layer
    subgraph CityManagement
        CityProvider[CityProvider Interface]:::interface
        CityByName[CityByName]:::interface
        CityByBelfiore[CityByBelfiore]:::interface
        CityProviderImpl[CityProviderImpl]:::implementation
        CompositeCitySupplier[CompositeCityStreamSupplier]:::implementation
    end

    %% Data Sources Layer
    subgraph DataSources
        ItaliaCsv[(Italia CSV)]:::datasource
        EsteriCsv[(Esteri CSV)]:::datasource
        ItaliaCsvSupplier[ItaliaCsvSupplier]:::implementation
        EsteriCsvSupplier[EsteriCsvSupplier]:::implementation
    end

    %% Internal Components Layer
    subgraph InternalComponents
        LastnamePart[LastnamePart]:::internal
        NamePart[NamePart]:::internal
        DatePart[DatePart]:::internal
        BelfiorePart[BelfiorePart]:::internal
        ControlPart[ControlPart]:::internal
        Omocode[Omocode]:::internal
    end

    %% Relationships
    CF --> Person
    CF --> City
    CF --> LastnamePart
    CF --> NamePart
    CF --> DatePart
    CF --> BelfiorePart
    CF --> ControlPart
    CF --> Omocode

    CityProvider --> |implements| CityByName
    CityProvider --> |implements| CityByBelfiore
    CityProviderImpl --> CityProvider
    CompositeCitySupplier --> CityProviderImpl

    ItaliaCsvSupplier --> ItaliaCsv
    EsteriCsvSupplier --> EsteriCsv
    CompositeCitySupplier --> ItaliaCsvSupplier
    CompositeCitySupplier --> EsteriCsvSupplier

    %% Click Events
    click CF "https://github.com/kamaladafrica/codice-fiscale/blob/master/src/main/java/it/kamaladafrica/codicefiscale/CodiceFiscale.java"
    click Person "https://github.com/kamaladafrica/codice-fiscale/blob/master/src/main/java/it/kamaladafrica/codicefiscale/Person.java"
    click City "https://github.com/kamaladafrica/codice-fiscale/blob/master/src/main/java/it/kamaladafrica/codicefiscale/City.java"
    click CityProvider "https://github.com/kamaladafrica/codice-fiscale/blob/master/src/main/java/it/kamaladafrica/codicefiscale/city/CityProvider.java"
    click CityByName "https://github.com/kamaladafrica/codice-fiscale/blob/master/src/main/java/it/kamaladafrica/codicefiscale/city/CityByName.java"
    click CityByBelfiore "https://github.com/kamaladafrica/codice-fiscale/blob/master/src/main/java/it/kamaladafrica/codicefiscale/city/CityByBelfiore.java"
    click CityProviderImpl "https://github.com/kamaladafrica/codice-fiscale/blob/master/src/main/java/it/kamaladafrica/codicefiscale/city/impl/CityProviderImpl.java"
    click CompositeCitySupplier "https://github.com/kamaladafrica/codice-fiscale/blob/master/src/main/java/it/kamaladafrica/codicefiscale/city/impl/CompositeCityStreamSupplier.java"
    click LastnamePart "https://github.com/kamaladafrica/codice-fiscale/blob/master/src/main/java/it/kamaladafrica/codicefiscale/internal/LastnamePart.java"
    click NamePart "https://github.com/kamaladafrica/codice-fiscale/blob/master/src/main/java/it/kamaladafrica/codicefiscale/internal/NamePart.java"
    click DatePart "https://github.com/kamaladafrica/codice-fiscale/blob/master/src/main/java/it/kamaladafrica/codicefiscale/internal/DatePart.java"
    click BelfiorePart "https://github.com/kamaladafrica/codice-fiscale/blob/master/src/main/java/it/kamaladafrica/codicefiscale/internal/BelfiorePart.java"
    click ControlPart "https://github.com/kamaladafrica/codice-fiscale/blob/master/src/main/java/it/kamaladafrica/codicefiscale/internal/ControlPart.java"
    click Omocode "https://github.com/kamaladafrica/codice-fiscale/blob/master/src/main/java/it/kamaladafrica/codicefiscale/internal/Omocode.java"
    click ItaliaCsv "https://github.com/kamaladafrica/codice-fiscale/blob/master/src/main/resources/it/kamaladafrica/codicefiscale/city/impl/italia.csv"
    click EsteriCsv "https://github.com/kamaladafrica/codice-fiscale/blob/master/src/main/resources/it/kamaladafrica/codicefiscale/city/impl/esteri.csv"
    click ItaliaCsvSupplier "https://github.com/kamaladafrica/codice-fiscale/blob/master/src/main/java/it/kamaladafrica/codicefiscale/city/impl/csv/ItaliaCsvSupplier.java"
    click EsteriCsvSupplier "https://github.com/kamaladafrica/codice-fiscale/blob/master/src/main/java/it/kamaladafrica/codicefiscale/city/impl/csv/EsteriCsvSupplier.java"

    %% Styles
    classDef core fill:#dae8fc,stroke:#6c8ebf
    classDef interface fill:#d5e8d4,stroke:#82b366
    classDef implementation fill:#e1d5e7,stroke:#9673a6
    classDef internal fill:#fff2cc,stroke:#d6b656
    classDef datasource fill:#f8cecc,stroke:#b85450

    %% Legend
    subgraph Legend
        L1[Core Components]:::core
        L2[Interfaces]:::interface
        L3[Implementations]:::implementation
        L4[Internal Components]:::internal
        L5[(Data Sources)]:::datasource
    end
```
