Progetto Programmazione ad Oggetti

Progetto Programmazione ad Oggetti A.A. 2018/2019, Marco Esposito

Il progetto consiste nel modellare un data-set creando un insieme di classi e sfruttando i principi della Programmazione ad Oggetti, e realizzare un'applicazione che renda poi accessibile il data-set mediante API REST GET, ad esempio per ottenere statistiche, dati filtrati o altre elaborazioni sui dati e sulle classi che li modellano.

In particolare, il data-set assegnato è un elenco in formato CSV delle Farmacie nella Regione Campania. Sono state quindi create classi che modellano le suddette e gli attributi che le caratterizzano (corrispondenti ai campi dell'header del file .csv). Per creare l'API REST si è utilizzato Spring Boot, un framework di Spring usato per creare microservizi e che fornisce funzioni di autoconfigurazione e di dependencies management semplificate. Tramite richieste GET è possibile visualizzare i dati in formato JSON, filtrarli ed ottenere varie informazioni su di essi. In particolare, è possibile fare controlli e verifiche sui dati forniti (ad esempio, sulle Partite IVA) nonchè ottenere informazioni sulle Farmacie più vicine a una data Farmacia etc.

Di seguito si riportano i casi d'uso dell'applicazione, le scelte fatte per la modellazione del data-set e le fasi dell'applicazione.

Casi D'Uso

L'applicazione consente il download dei dati specificati e il loro parsing e modelizzazione. Inoltre, come già detto, scopo principale dell'applicazione è di implementare API (Application Programming Interface) tramite il modello REST (Representational State Transfer) che consente a un Client di inviare richieste verso l'applicazione, che risponde con la risposta appropriata. Le richieste vengono fatte tramite il metodo HTTP GET e specificando il tipo di richiesta, la risorsa a cui si è interessati e il tipo di azione da svolgere sulla risorsa (ex. http://localhost:8080/filtro?campo=latitudine&operatore=>&valore=40 specifica un'operazione di filtraggio sull'attributo latitudine e con l'operatore e il valore indicati). Come da specifica, sono state poi implementate anche operazioni di tipo statistico. Per la natura del data-set, però, queste non risultano particolarmente significative e sono state ristrette solo ad alcuni campi (essendo comunque pochi i campi numerici).

Sono quindi previste diverse richieste che consentono principalmente la visualizzazione del data-set o di parte di esso, il filtraggio dei dati, operazioni di controllo (ad esempio, sui codici di controllo delle Partite IVA) e di elaborazione (calcolo della distanza fra due farmacie, statistiche etc.).

Modello del Dataset

Come già detto, il data-set assegnato rappresenta le Farmacie della regione Campania. Il modello usato quindi rappresenta ogni Farmacia (una riga del file "Elenco-Farmacie.csv") come un oggetto omonimo contenente gli attributi riportati nel dataset come nome, partita IVA, tipologia etc. Ogni Farmacia contiene inoltre un riferimento ad un oggetto Comune, che rappresenta appunto il comune in cui si trova la Farmacia. La classe Comune estende la classe Localita, contenente informazioni sulla latitudine e la longitudine. Infine, ogni oggetto Comune contiene un riferimento a un oggetto Provincia, che indica appunto la provincia in cui si trova il comune.

Le classi sono quindi organizzate in maniera tale che ogni oggetto Farmacia contenga tutti i riferimenti necessari ad estrarre i dati ad esso relativi, inclusi quelli contenuti negli oggetti Comune (che ha accesso ai membri di Localita) e Provincia, creando quindi una sorta di incapsulamento dai dati più specifici a quelli più generali. La scelta di utilizzare un incapsulamento di questo tipo sta nel fatto che in questa maniera si può utilizzare un ArrayList contenente oggetti Farmacia per gestire facilmente tutti i dati tramite le classi del Package Utility, riportate in seguito.

MetaData infine è un'interfaccia che si occupa di definire il metodo getMetaDati(), che viene implementato da tutte le classi precedenti per fornire i propri metadati (che includono l'alias dell'attributo, il campo del file .csv da cui deriva e il tipo), incapsulandoli in un oggetti di tipo MetaDataStore. MetaData contiene un metodo statico che consente di ricavare dai metodi di ogni classe le stringhe contenenti i metadati e convertirle in oggetti di tipo JSON, che possono poi essere visualizzati da Spring quando viene ricevuta una richiesta di GET per i metadati. Il metodo è generico (prende in ingresso un oggetto Classe generico e un elenco di campi generico) e viene utilizzato da tutte le classi che implementano l'interfaccia.

Ulteriori delucidazioni sui singoli metodi usati sono nel JavaDoc del progetto (cartella ProgettoJav/doc/modelloDataSet).

Il Package Utility

Il Package Utility presenta diverse classi utilizzate per effettuare elaborazioni, filtraggio e controlli sui dati. In particolare sono presenti le seguenti classi:

• Parser, utilizzata per fare operazioni di parsing, sia per ricavare (come descritto meglio in seguito) l'URL del dataset, sia per fare il parsing di quest'ultimo e ricavarne header e dati. Inoltre si occupa di utilizzare i dati ricavati dal parsing per creare gli oggetti che modellano il dataset;
• Calcolatrice, utilizzata per effettuare calcoli, medie statistiche, confronti e per il calcolo della Formula di Lunn e della Spherical Law of Cosines, utilizzate rispettivamente in Checker e GPS;
• scannerDati, classe per il filtraggio, lo scorrimento, il calcolo di statistiche e la ricerca di elementi. Viene inizializzata dal costruttore con un ArrayList di oggetti Farmacia, sui quali effettua direttamente le operazioni elencate. Implementa l'interfaccia Filters;
• GPS, classe utilizzata per elaborare i campi latitudine e longitudine del data-set. In particolare, permette di trovare la distanza fra due date farmacie (tramite la Spherical Law of Cosines) e consente di trovare la Farmacia più vicina ad un'altra. Estende scannerDati, di cui utilizza in particolare i metodi per la ricerca entro l'ArrayList di oggetti Farmacia.
• Checker, classe che fa controlli sui dati. Ad esempio, controlla possibili mismatch nella Partite IVA utilizzando la Formula di Lunn, che consente di calcolare il codice di controllo di una Partita IVA per confrontarlo con quello della Farmacia, per verificare se è esatto. Inoltre controlla eventuali mismatch fra Provincia e codice Provincia della partita IVA, oltre che controllare se una riga del data-set presenta campi vuoti o non definiti. Anche Checker estende scannerDati.
• MetaDataStore, classe utilizzata per conservare i metadati, come già riportato sopra.

Il package Filters contenuto in Utility possiede infine:

• Filter, interfaccia implementata da scannerDati contenente il metodo filterField;
• FilterUtils, classe che contiene metodi utilizzati per il filtraggio, in particolare per effettuare confronti e per costruire le Collection contenenti i valori filtrati. I metodi sono volutamente generici per permettere di filtrare diversi tipi di Collection e con diversi operatori. Consente inoltre di estrarre una colonna dal data-set (un attributo).

Maggiori dettagli sui singoli metodi delle varie classi sono contenuti nel JavaDoc del progetto (cartella ProgettoJava/doc/Utility).

Fasi dell'Applicazione

Come specifica, è stato fornito l'URL del data-set ID contenente a sua volta l'URL del data-set in formato CSV. All'avvio, l'applicazione (nel metodo main) esegue quindi il download del data-set ID (formato JSON) all'URL specificato, dopodichè utilizza un'istanza della classe Parser per effettuare il parsing del data-set ID. In particolare, utilizza il metodo getURL(String data) di Parser per ottenere l'URL del file Elenco-Farmacie.csv. Da questo effettua quindi il download del file e , sempre tramite Parser, realizza il parsing del file CSV, da cui vengono estratti l'header e i dati.

Questi vengono poi utilizzati da Parser per creare il modello del data-set come riportato sopra. In particolare, creerà quindi tanti oggetti Farmacia quante sono le righe del file (ognuna corrispondente appunto ad una farmacia), creando ovviamente anche gli oggetti Comune, Localita e Provincia relativi. Gli oggetti Farmacia sono quindi inseriti in un ArrayList e ritornati al metodo main, che è stato marcato come @SpringBootApplication e rappresenta quindi il punto d'accesso di Spring Boot. Il main crea quindi i @Bean che vengono utilizzati dai RestController per rispondere alle richieste GET. In particolare, sono creati Bean per l'ArrayList e per le classi principali del Package Utility (scannerDati, GPS, Checker), inizializzandoli con l'ArrayList contenente gli oggetti Farmacia. All'avvio dell'applicazione, Spring Boot esamina i Bean e le annotazioni inserite, e inietta nei RestController i Bean configurati. Sono stati creati 3 Rest Controller, per gestire richieste riguardanti rispettivamente la scansione e il filtraggio dei dati, il controllo sui dati e le funzioni della classe GPS. I Rest Controller gestiscono quindi le richieste che mappano, ritornando oggetti in formato JSON contenenti le risposte. Sono definite eccezioni nel caso in cui sia passato un numero errato di attributi in una richiesta, se un certo attributo non esiste etc.

Ogni Rest Controller utilizza l'istanza della classe di Utility che le è stata iniettata per ottenere i dati necessari a rispondere alla richiesta. Ad esempio, quando il Rest Controller DataController riceva una richiesta /metaF, si ha la seguente sequenza per l'ottenimento dei metadati degli oggetti Farmacia.

Un'ulteriore esempio di interazione è riportato in seguito, per quel che riguarda il filtraggio dei dati, in particolare per il filtraggio del campo latitudine (attributo appartenente alla classe Localita). Si mostra di seguito come il Rest Controller ottiene un ArrayList di oggetti Farmacia opportunamente filtrati in base alla latitudine, tenendo conto che latitudine non è un campo di Farmacia bensì di Localita (superclasse di Comune) e quindi operando di conseguenza.

Query String di esempio

Altre richieste possibili per testare i Rest Controller sono le seguenti:

• http://localhost:8080/dati (visualizza tutti i dati, organizzati in oggetti Farmacia);
• http://localhost:8080/filtro?campo=longitudine&operatore=%3C&valore=14 (farmacie con longitudine <14);
• http://localhost:8080/metaC (metadati degli oggetti Comune);
• http://localhost:8080/cerca?nome=FARMACIA%20PADULA%20SNC%20DI%20PASQUALE%20PADULA%20E%20C (cerca la farmacia, dato il nome);
• http://localhost:8080/coordinate?lat=41.16866648&long=15.11105952 (cerca la farmacia, date le coordinate);
• http://localhost:8080/comune?nome=BENEVENTO (ritorna le farmacie in un comune);
• http://localhost:8080/provincia?nome=BENEVENTO (ritorna le farmacie in una provincia);
• http://localhost:8080/dispensari?provincia=CASERTA (ritorna i dispensari in una provincia)
• http://localhost:8080/dispensari?comune=SESSA%20AURUNCA (ritorna i dispensari in un comune)
• http://localhost:8080/stat?campo=latitudine&operatore=max (trova la latitudine massima)
• http://localhost:8080/checkIVA?provincia=BENEVENTO (controlla le partite IVA delle farmacie nella provincia data)
• http://localhost:8080/partitaIVA?provincia=BENEVENTO (ritorna le partite IVA delle farmacie in una provincia)
• http://localhost:8080/campiVuoti?attributo=latitudine (conta il numero di campi vuoti per quell'attributo)
• http://localhost:8080/PiuVicina?nome=FLOVILLA%20MARIO (trova la farmacia più vicina a quella data)
• http://localhost:8080/Distanza?nome1=IACOBELLI%20CINZIA%20ROSA&nome2=FLOVILLA%20MARIO (calcola la distanza in km, dati i nomi)