From 7e1fe5023b89b229508a890c0ef6c2f1f2e6ef5d Mon Sep 17 00:00:00 2001 From: Simone Argenziano Date: Sat, 25 Jan 2014 14:46:30 +0100 Subject: [PATCH] Javadoc aggiunta a tutti i metodi di tutte le classi. --- it/unisa/info13d/Articoli/BeniDiConsumo.java | 32 +-- .../info13d/Articoli/CeneInRistoranti.java | 50 ++--- it/unisa/info13d/Articoli/Global.java | 52 +++-- .../info13d/Articoli/PrestazioniDopera.java | 87 +++++++- it/unisa/info13d/Articoli/Utilizzabile.java | 11 +- it/unisa/info13d/Articoli/Vacanze.java | 28 ++- .../GestioneCatalogo/AdminSession.java | 6 + .../info13d/GestioneCatalogo/Catalogo.java | 209 +++++++++++------- it/unisa/info13d/Gui/AdminInterface.java | 29 +-- it/unisa/info13d/Gui/LoginWindow.java | 6 + it/unisa/info13d/Gui/RegisterWindow.java | 6 + it/unisa/info13d/Gui/UserInterface.java | 11 +- it/unisa/info13d/Login/Access.java | 14 +- it/unisa/info13d/Login/Entry.java | 21 +- it/unisa/info13d/Main.java | 10 +- it/unisa/info13d/Utility/IdCounter.java | 3 +- 16 files changed, 369 insertions(+), 206 deletions(-) diff --git a/it/unisa/info13d/Articoli/BeniDiConsumo.java b/it/unisa/info13d/Articoli/BeniDiConsumo.java index e6caf41..7896dd7 100644 --- a/it/unisa/info13d/Articoli/BeniDiConsumo.java +++ b/it/unisa/info13d/Articoli/BeniDiConsumo.java @@ -21,9 +21,9 @@ public class BeniDiConsumo extends Utilizzabile implements Serializable { * Costruttore che inizializza i valori del bene di consumo * * @param idBene - * @param descrizioneBene - * @param prezzoBene - * @param beniInStock + * @param descrizioneBene - descrizione del bene + * @param prezzoBene - prezzo del bene + * @param beniInStock - quantita' del bene da vendere */ public BeniDiConsumo(int idBene, String descrizioneBene, double prezzoBene, int beniInStock, String in_fornitore, int in_giudizio){ this.idBene=idBene; @@ -43,80 +43,86 @@ public class BeniDiConsumo extends Utilizzabile implements Serializable { /** - * @return - id bene + * @return - id bene. */ public int getIdBene() { return idBene; } /** - * @return - descrizione bene + * @return - descrizione bene. */ public String getDescrizioneBene() { return descrizioneBene; } /** - * @return - prezzo del bene + * @return - prezzo del bene. */ public double getPrezzoBene() { return prezzoBene; } /** - * @return - la quantita dei beni da vendere + * @return - la quantita' dei beni da vendere. */ public int getBeniInStock() { return beniInStock; } /** - * @return - numero di oggetti venduti + * @return - numero di oggetti venduti. */ public int getBeniVenduti() { return beniVenduti; } /** - * @param descrizioneBene - descrizione del bene + * @param descrizioneBene - descrizione del bene. */ public void setDescrizioneBene(String descrizioneBene) { this.descrizioneBene = descrizioneBene; } /** - * @param prezzoBene - prezzo del bene + * @param prezzoBene - prezzo del bene. */ public void setPrezzoBene(double prezzoBene) { this.prezzoBene = prezzoBene; } /** - * @param beniInStock - quantita' del bene disponibile per la vendita + * @param beniInStock - quantita' del bene disponibile per la vendita. */ public void setBeniInStock(int beniInStock) { this.beniInStock = beniInStock; } /** - * @return - la scadenza del bene (viene considerata una data a lungo termine) + * @return - la scadenza del bene (viene considerata una data a lungo termine). */ public GregorianCalendar getScadenza() { return scadenza; } /** - * Questo metodo setta i beni venduti, decrementa la quantita in magazzino e incrementa il numero di oggeti venduti + * Questo metodo setta i beni venduti, decrementa la quantita' in magazzino e incrementa il numero di oggeti venduti. */ public void setBeniVenduti() { beniInStock--; beniVenduti++; } + /** + * @return - Il giudizio dato al fornitore. + */ public int getGiudizioFornitore() { return giudizioFornitore; } + /** + * @return - Il nome del fornitore. + */ public String getFornitore() { return fornitore; } diff --git a/it/unisa/info13d/Articoli/CeneInRistoranti.java b/it/unisa/info13d/Articoli/CeneInRistoranti.java index 0fc6b39..33ec4c3 100644 --- a/it/unisa/info13d/Articoli/CeneInRistoranti.java +++ b/it/unisa/info13d/Articoli/CeneInRistoranti.java @@ -18,16 +18,16 @@ import java.util.GregorianCalendar; public class CeneInRistoranti extends Utilizzabile implements Serializable{ /** + *Genera una nuova cena da inserire all'interno del catalogo * - * @param idCena - l'id della cena - * @param nomeRistorante - il ristorante in cui usufruire dell'offerta - * @param luogo - Ubicazione del ristorante - * @param descrizione_cena - descrizione della cena (cosa viene offerto dal ristorante) - * @param costoPerPersona - costo per singola persona - * @param dataScadenzaOffertaCena - scadenza dell'offerta - * @param numCenedaVendere - offerte disponibile per la cena + * @param idCena - l'id della cena. + * @param nomeRistorante - il ristorante in cui usufruire dell'offerta . + * @param luogo - Ubicazione del ristorante. + * @param descrizione_cena - descrizione della cena (cosa viene offerto dal ristorante). + * @param costoPerPersona - costo per singola persona. + * @param dataScadenzaOffertaCena - scadenza dell'offerta. + * @param numCenedaVendere - offerte disponibili per la cena. */ - public CeneInRistoranti(int idCena, String nomeRistorante, String luogo, String descrizione_cena, double costoPerPersona, GregorianCalendar dataScadenzaOffertaCena, int numCenedaVendere){ this.idCena=idCena; this.nomeRistorante=nomeRistorante; @@ -46,105 +46,105 @@ public class CeneInRistoranti extends Utilizzabile implements Serializable{ } /** - * @return - l'id della cena + * @return - l'id della cena. */ public int getIdCena() { return idCena; } /** - * @return - in nome del ristorante + * @return - in nome del ristorante. */ public String getNomeRistorante() { return nomeRistorante; } /** - * @return - l'ubicazione del ristorante + * @return - l'ubicazione del ristorante. */ public String getLuogo() { return luogo; } /** - * @return - descrizione della cena + * @return - descrizione della cena. */ public String getDescrizione_cena() { return descrizione_cena; } /** - * @return - il costo per ogni singola persona + * @return - il costo per ogni singola persona. */ public double getCostoPerPersona() { return costoPerPersona; } /** - * @return - data di scadenza dell'offerta + * @return - data di scadenza dell'offerta. */ public GregorianCalendar getDataScadenzaOffertaCena() { return dataScadenzaOffertaCena; } /** - * @return - il numero di cene ancora disponibili per la vendita + * @return - il numero di cene ancora disponibili per la vendita. */ public int getNumCenedaVendere() { return numCenedaVendere; } /** - * @return - il numero di cene vendute + * @return - il numero di cene vendute . */ public int getCeneVendute() { return ceneVendute; } /** - * @param nomeRistorante - setta il nome del ristorante + * @param nomeRistorante - setta il nome del ristorante. */ public void setNomeRistorante(String nomeRistorante) { this.nomeRistorante = nomeRistorante; } /** - * @param luogo - setta il l'ubicazione del ristorante + * @param luogo - setta il l'ubicazione del ristorante. */ public void setLuogo(String luogo) { this.luogo = luogo; } /** - * @param descrizione_cena - setta la descrizione della cena (Esempio: pizza margherita, patate e dolce) + * @param descrizione_cena - setta la descrizione della cena (Esempio: pizza margherita, patate e dolce). */ public void setDescrizione_cena(String descrizione_cena) { this.descrizione_cena = descrizione_cena; } /** - * @param costoPerPersona - setta il costo per singola persona + * @param costoPerPersona - setta il costo per singola persona. */ public void setCostoPerPersona(double costoPerPersona) { this.costoPerPersona = costoPerPersona; } /** - * @param dataScadenzaOffertaCena - setta la data di scadenza per l'offerta + * @param dataScadenzaOffertaCena - setta la data di scadenza per l'offerta. */ public void setDataScadenzaOffertaCena(GregorianCalendar dataScadenzaOffertaCena) { this.dataScadenzaOffertaCena = dataScadenzaOffertaCena; } /** - * @param numCenedaVendere - setta il numero di cene da vendere + * @param numCenedaVendere - setta il numero di cene da vendere. */ public void setNumCenedaVendere(int numCenedaVendere) { this.numCenedaVendere = numCenedaVendere; } /** - * Questo metodo all'atto dell'acquisto da parte di un utente, decrementa le cene da vendere ed incrementa quelle vendute + * Questo metodo all'atto dell'acquisto da parte di un utente, decrementa le cene da vendere ed incrementa quelle vendute. */ public void setCeneVendute() { @@ -154,8 +154,8 @@ public class CeneInRistoranti extends Utilizzabile implements Serializable{ @Override /** - * Questo metodo stabilisce se � possibile applicare o meno uno sconto alle cene. - * @return Restitisce il prezzo originale se la politica di socnto non � applicabile, altrienti restituisce il prezzo scontato del 10%. + * Questo metodo stabilisce se e possibile applicare o meno uno sconto alle cene. + * @return Restitisce il prezzo originale se la politica di socnto non e' applicabile, altrienti restituisce il prezzo scontato del 10%. */ public double get_prezzo_scontato() { GregorianCalendar dataOdierna = new GregorianCalendar(); diff --git a/it/unisa/info13d/Articoli/Global.java b/it/unisa/info13d/Articoli/Global.java index a004350..e3daa6f 100644 --- a/it/unisa/info13d/Articoli/Global.java +++ b/it/unisa/info13d/Articoli/Global.java @@ -9,15 +9,13 @@ package it.unisa.info13d.Articoli; /** - * * Classe che raccoglie tutti i metodi statici (globali) da usare nel progetto - * - * */ public class Global { - /** + + /** * - * @return il seguente id disponibile all'aggiunta di un nuovo prodotto + * @return il seguente id disponibile all'aggiunta di un nuovo prodotto. */ public static int get_next_id (){ general_counter++; @@ -25,7 +23,7 @@ public class Global { } /** - * Questo metodo setta il contatore generale degli id dei prodotti + * Questo metodo setta il contatore generale degli id dei prodotti. * * @param general_counter - contatore id */ @@ -42,45 +40,69 @@ public class Global { } /** - * E' il contatore statico privato + * Questo metodo setta i parametri per la politica di sconto relativa alla quantità di articoli venduti in un singolo acquisto. + * + * @param num - numero di articoli da acquistare per poter applicare lo sconto. + * @param sconto - Quantità di sconto da applicare. */ - public static void set_sconto_min_articoli (int num, double sconto){ min_num_articoli_per_sconto = num; sconto_per_min_num_articoli = sconto; } - + + /** + * Questo metodo setta la quantita' di sconto da applicare agli articoli che si trovano nell'ultima settimana di scadenza. + * @param sconto_ultima_settimana - Quantità di sconto da applicare. + */ public static void setSconto_ultima_settimana(double sconto_ultima_settimana) { Global.sconto_ultima_settimana = sconto_ultima_settimana; } + /** + * Questo metodo setta la quantita' di sconto per le cene che hanno superato il 50% delle vendite. + * + * @param sconto_cene_sup_50 - Quantità di sconto. + */ public static void setSconto_cene_sup_50(double sconto_cene_sup_50) { Global.sconto_cene_sup_50 = sconto_cene_sup_50; } + /** + * + * @return - il numero di articoli necessari per applicare lo sconto in quantità. + */ public static int getMin_num_articoli_per_sconto() { return min_num_articoli_per_sconto; } + /** + * + * @return - ritorna la quantita' di sconto applicata alla politica dello sconto in quantita'. + */ public static double getSconto_per_min_num_articoli() { return sconto_per_min_num_articoli; } + /** + * + * @return - ritorna lo sconto applicabile agli articoli che si trovano nell'ultima settimana di scadenza. + */ public static double getSconto_ultima_settimana() { return sconto_ultima_settimana; } + /** + * + * @return - ritorna lo sconto applicato alla politica di sconto delle cene. + */ public static double getSconto_cene_sup_50() { return sconto_cene_sup_50; } private static int min_num_articoli_per_sconto = 0; - private static double sconto_per_min_num_articoli = 0; - + private static double sconto_per_min_num_articoli = 0; private static double sconto_ultima_settimana = 0; private static double sconto_cene_sup_50 = 0; - private static int general_counter; - - -} + private static int general_counter; +} \ No newline at end of file diff --git a/it/unisa/info13d/Articoli/PrestazioniDopera.java b/it/unisa/info13d/Articoli/PrestazioniDopera.java index 9dcbf94..eccb9b9 100644 --- a/it/unisa/info13d/Articoli/PrestazioniDopera.java +++ b/it/unisa/info13d/Articoli/PrestazioniDopera.java @@ -2,11 +2,23 @@ package it.unisa.info13d.Articoli; import java.util.GregorianCalendar; +/** + * + * Classe che rappresenta una prestazione d'opera all'interno del catalogo. + * + */ public class PrestazioniDopera extends Utilizzabile { - - - + /** + * Genera una nuova prestazione d'opera da inserire all'interno del catalogo. + * + * @param in_id - id della prestazione + * @param in_localita - località della prestazione + * @param in_descrizione - descrizione della prestazione d'opera + * @param in_fornitore - fornitore della prestazione + * @param in_giudizio - giudizio del fornitore della prestazione + * @param in_prezzo - prezzo della prestazione + */ public PrestazioniDopera(int in_id, String in_localita, String in_descrizione, String in_fornitore, int in_giudizio, double in_prezzo){ idPrOpera = in_id; @@ -18,7 +30,6 @@ public class PrestazioniDopera extends Utilizzabile { } - @Override public boolean eAcquistabile() { return true; @@ -30,60 +41,116 @@ public class PrestazioniDopera extends Utilizzabile { return prezzoPrestazione; //Nessuno sconto applicabile } - - + /** + * + * @return - Ritorna l'id dell'opera. + */ public int getIdPrOpera() { return idPrOpera; } - + /** + * + * @return - Ritorna il giudizio dato al fornitore della prestazione. + */ public int getGiudizioFornitore() { return giudizioFornitore; } + /** + * Questo metodo setta il giudizio dal fornitore della prestazione. + * @param giudizioFornitore + */ public void setGiudizioFornitore(int giudizioFornitore) { this.giudizioFornitore = giudizioFornitore; } + /** + * + * @return - Ritorna il numero di prestazioni vendute. + */ public int getPrestazioniVendute() { return prestazioniVendute; } + /** + * + *Questo metodo incrementa il numero di prestazioni vendute. + */ public void setPrestazioniVendute() { prestazioniVendute++; } + /** + * @return - Ritorna il prezzo della prestazione. + */ public double getPrezzoPrestazione() { return prezzoPrestazione; } + /** + * Questo metodo setta il prezzo della prestazione. + * + * @param prezzoPrestazione + */ public void setPrezzoPrestazione(double prezzoPrestazione) { this.prezzoPrestazione = prezzoPrestazione; } + /** + * @return - il nome della localita' in cui si può fruire della prestazione. + */ public String getLocalita() { return Localita; } + /** + * Questo metodo setta la localita' della prestazione. + * + * @param localita - località della prestazione + */ public void setLocalita(String localita) { Localita = localita; } + /** + * @return - Ritorna la descrizione della prestazione. + */ public String getDescrizione() { return Descrizione; } + /** + * Questo metodo setta la descrizione della prestazione. + * + * @param descrizione - descrizione della prestazione. + */ public void setDescrizione(String descrizione) { Descrizione = descrizione; } + /** + * @return - Ritorna il nome del fornitore della prestazione. + */ public String getFornitore() { return Fornitore; } + /** + * Questo metodo setta il fornitore della prestazione. + * + * @param fornitore - nome del fornitore + */ public void setFornitore(String fornitore) { Fornitore = fornitore; } + + /** + * @return - la data di scadenza della prestazione. + */ + public GregorianCalendar getScadenza() { + return scadenza; + } private int idPrOpera; private int giudizioFornitore; // varia da 1 a 5 @@ -92,9 +159,5 @@ public class PrestazioniDopera extends Utilizzabile { private String Localita; private String Descrizione; private String Fornitore; - private GregorianCalendar scadenza = new GregorianCalendar(99999,0,1); - - public GregorianCalendar getScadenza() { - return scadenza; - } + private GregorianCalendar scadenza = new GregorianCalendar(99999,0,1); } \ No newline at end of file diff --git a/it/unisa/info13d/Articoli/Utilizzabile.java b/it/unisa/info13d/Articoli/Utilizzabile.java index a8bf134..d0f216a 100644 --- a/it/unisa/info13d/Articoli/Utilizzabile.java +++ b/it/unisa/info13d/Articoli/Utilizzabile.java @@ -12,10 +12,17 @@ import java.io.Serializable; public abstract class Utilizzabile implements Serializable { - public abstract boolean eAcquistabile(); + /** + * Metodo per definire se un prodotto e acqustabile + * + * @return - ritorna true se e' acquistabile false se non lo e' + */ + public abstract boolean eAcquistabile(); + /** + * Metodo per l'applicazione delle politiche di sconto relative ad un articolo. * - * @return metodo per l'applicazione delle politiche di sconto relative ad un articolo. + * @return - prezzo scontato dell'articolo. */ public abstract double get_prezzo_scontato(); diff --git a/it/unisa/info13d/Articoli/Vacanze.java b/it/unisa/info13d/Articoli/Vacanze.java index c71e31e..6a56a3d 100644 --- a/it/unisa/info13d/Articoli/Vacanze.java +++ b/it/unisa/info13d/Articoli/Vacanze.java @@ -9,10 +9,14 @@ import java.util.GregorianCalendar; * Date: 16/12/13 * Time: 18.45 */ + +/** + * Classe che rappresenta una vacanza all'interno del catalogo. + */ public class Vacanze extends Utilizzabile implements Serializable{ /** - * Costruttore per inizialiazzare una Vacanza + * Costruttore per inizialiazzare una Vacanza. * * @param idViaggio * @param localitaViaggio @@ -36,77 +40,77 @@ public class Vacanze extends Utilizzabile implements Serializable{ } /** - * @return - id del viaggio + * @return - id del viaggio. */ public int getIdViaggio() { return idViaggio; } /** - * @return - localita' del viaggio + * @return - localita' del viaggio. */ public String getLocalitaViaggio() { return localitaViaggio; } /** - * @return - data di partenza + * @return - data di partenza. */ public GregorianCalendar getDataPartenzaViaggio() { return dataPartenzaViaggio; } /** - * @return - data di scadenza dell'offerta + * @return - data di scadenza dell'offerta. */ public GregorianCalendar getScadenzaOfferta() { return scadenzaOfferta; } /** - * @return - il prezzo per singola persona + * @return - il prezzo per singola persona. */ public double getPrezzoPSingola() { return prezzoPSingola; } /** - * @return - il numero di viaggi venduti + * @return - il numero di viaggi venduti. */ public int getViaggiVenduti() { return viaggiVenduti; } /** - * @param localitaViaggio - setta la localit' del viaggio + * @param localitaViaggio - setta la localita' del viaggio. */ public void setLocalitaViaggio(String localitaViaggio) { this.localitaViaggio = localitaViaggio; } /** - * @param dataPartenzaViaggio - setta la data di patenza del viaggio + * @param dataPartenzaViaggio - setta la data di patenza del viaggio. */ public void setDataPartenzaViaggio(GregorianCalendar dataPartenzaViaggio) { this.dataPartenzaViaggio = dataPartenzaViaggio; } /** - * @param scadenzaOfferta - setta la data di scadenza dell'offerta della vacanza + * @param scadenzaOfferta - setta la data di scadenza dell'offerta della vacanza. */ public void setScadenzaOfferta(GregorianCalendar scadenzaOfferta) { this.scadenzaOfferta = scadenzaOfferta; } /** - * @param prezzoPSingola - setta il prezzo per singola persona + * @param prezzoPSingola - setta il prezzo per singola persona. */ public void setPrezzoPSingola(double prezzoPSingola) { this.prezzoPSingola = prezzoPSingola; } /** - * Questo metodo incrementa, dopo ogni acquisto, il numero di viaggi venduti + * Questo metodo incrementa, dopo ogni acquisto, il numero di viaggi venduti. */ public void setViaggiVenduti() { diff --git a/it/unisa/info13d/GestioneCatalogo/AdminSession.java b/it/unisa/info13d/GestioneCatalogo/AdminSession.java index fa800bd..cdbe75a 100644 --- a/it/unisa/info13d/GestioneCatalogo/AdminSession.java +++ b/it/unisa/info13d/GestioneCatalogo/AdminSession.java @@ -15,6 +15,12 @@ import java.util.Scanner; * Date: 17/12/13 * Time: 10.55 */ + +/** + * + * Classe si occupa di gestire l'interfaccia dell'amministratore + * + */ public class AdminSession { /** diff --git a/it/unisa/info13d/GestioneCatalogo/Catalogo.java b/it/unisa/info13d/GestioneCatalogo/Catalogo.java index 966c0d6..29bb576 100644 --- a/it/unisa/info13d/GestioneCatalogo/Catalogo.java +++ b/it/unisa/info13d/GestioneCatalogo/Catalogo.java @@ -34,6 +34,7 @@ public class Catalogo{ /** * Il costruttore definisce un nuovo catalogo nel caso non sia gia presente. + * * @throws FileNotFoundException * @throws IOException * @throws ClassNotFoundException @@ -51,7 +52,8 @@ public class Catalogo{ } /** - * Questo metodo si occupa di serializzare il catalogo (per garantire un minimo di sicurezza) e salvarlo su disco + * Questo metodo si occupa di serializzare il catalogo (per garantire un minimo di sicurezza) e salvarlo su disco. + * * @throws FileNotFoundException * @throws IOException * @throws ClassNotFoundException @@ -65,7 +67,7 @@ public class Catalogo{ /** - * Questo metodo seleziona in Menu da visualizzare in base al login effettuato dall'utente + * Questo metodo seleziona in Menu da visualizzare in base al login effettuato dall'utente. * * @param userType is the type of user obtained from the main * @throws IOException @@ -82,7 +84,8 @@ public class Catalogo{ } /** - * Questo metodo permette l'inserimento di un nuovo deal all'interno del catalogo + * Questo metodo permette l'inserimento di un nuovo deal all'interno del catalogo. + * * @throws ParseException * @throws IOException * @throws ClassNotFoundException @@ -90,8 +93,6 @@ public class Catalogo{ */ public void nuovoProdottoVacanza(String in_localita, String in_data_start, String in_data_end, String in_prezzo) throws ParseException, FileNotFoundException, ClassNotFoundException, IOException { - - //System.out.println("---------- Nuova Offerta Vacanza ----------"); //System.out.print("Localita: "); String localita = in_localita; @@ -118,6 +119,21 @@ public class Catalogo{ IdCounter.save_counter(); } + + /** + * Questo metodo aggiunge al cataologo una nuova cena. + * + * @param in_ristorante - Nome ristorante + * @param in_localita - località del ristorante + * @param in_description - descrizione della cena + * @param in_prezzo - prezzo cena + * @param in_data_scad - data di scadenza della cena + * @param in_cene_da_vend - numero di cene da vendere + * @throws ParseException + * @throws FileNotFoundException + * @throws ClassNotFoundException + * @throws IOException + */ public void nuovoProdottoCena(String in_ristorante, String in_localita, String in_description, String in_prezzo, String in_data_scad, String in_cene_da_vend) throws ParseException, FileNotFoundException, ClassNotFoundException, IOException { @@ -152,6 +168,20 @@ public class Catalogo{ IdCounter.save_counter(); } + + /** + * Questo metodo aggiunge al catalogo un nuovo bene. + * + * @param in_descrizione - descrizione del bene. + * @param in_prezzo - prezzo del bene. + * @param in_quantita - quantità dei beni da vendere. + * @param in_fornitore - fornitore del ben.e + * @param in_giudizio - giudizio del fornitore. + * @throws ParseException + * @throws FileNotFoundException + * @throws ClassNotFoundException + * @throws IOException + */ public void nuovoProdottoBene(String in_descrizione, String in_prezzo, String in_quantita, String in_fornitore, String in_giudizio) throws ParseException, FileNotFoundException, ClassNotFoundException, IOException { @@ -179,12 +209,22 @@ public class Catalogo{ IdCounter.save_counter(); } + + /** + * Questo metodo aggiunge una nuova prestazione d'opera all'interno del catalogo. + * + * @param in_localita - località dove è operativa tale prestazione. + * @param in_descrizione - descrizione della prestazione. + * @param in_fornitore - fornitore della prestazione. + * @param in_giudizio - giudizio del fornitore. + * @param in_prezzo - prezzo della prestazione. + * @throws ParseException + * @throws FileNotFoundException + * @throws ClassNotFoundException + * @throws IOException + */ public void nuovoProdottoPrestazione(String in_localita, String in_descrizione, String in_fornitore, String in_giudizio, String in_prezzo) throws ParseException, FileNotFoundException, ClassNotFoundException, IOException { - - - - //System.out.println("---------- Nuova Offerta Prestazione ----------"); String localita = in_localita; @@ -206,7 +246,8 @@ public class Catalogo{ } /** - * Questo metodo permette la cancellazione di un prodotto dal catalogo + * Questo metodo permette la cancellazione di un prodotto dal catalogo. + * * @throws FileNotFoundException * @throws ClassNotFoundException * @throws IOException @@ -253,10 +294,10 @@ public class Catalogo{ } /** - * - * Questo metodo velocizza la stampa dell informazioni scorrenndo l'array. - * - * @param a + * Questo metodo velocizza la stampa dell informazioni scorrenndo l'array. + * + * @param a - ArrayList da scorrere + * @param show_offers - TexaArea dove visualizzare l'arraylist */ public void print_cat_admin (ArrayList a,JTextArea show_offers){ for(Utilizzabile deal: a) @@ -301,12 +342,13 @@ public class Catalogo{ } } - /** - * Stamapa la lista degli oggetti utilizzabile escludendo le cene con location diversa da quelle dell'utente - * - * @param a - * @param location_user_to_compare - */ + /** + * Stampa la lista degli oggetti utilizzabile escludendo le cene con location diversa da quelle dell'utente. + * + * @param a - ArrayList da scorrere + * @param location_user_to_compare - la località dell'utente da confrontare con glia rticoli del catalogo + * @param show_offers - TexArea dove vsualizzare i risultati + */ public void print_cat_user (ArrayList a, String location_user_to_compare, JTextArea show_offers){ for(Utilizzabile deal: a) { @@ -351,6 +393,7 @@ public class Catalogo{ } /** + * Questo metodo converte una data in milli secondi. * * @param in - data da convertire in millisecondi * @return - il numero in millisencodi della data passata alla funzione. @@ -361,8 +404,9 @@ public class Catalogo{ /** * Questo metodo visualizza le offerte attive del catalogo. Viene differenziata la visualizzazione in base all'utente. - * - L'amministratore avra' la possibilita' di scegliere l'ordinamento in base dalla data di scadenza o ID prodotti - * - L'utente visualizzera' le offerte attive senza possibilita' di ordinamento + * + * - L'amministratore avra' la possibilita' di scegliere l'ordinamento in base dalla data di scadenza o ID prodotti. + * - L'utente visualizzera' le offerte attive senza possibilita' di ordinamento. * * @param user - username utente * @throws FileNotFoundException @@ -375,8 +419,7 @@ public class Catalogo{ if(!(loggedUser.getType())) { //admin - - + if (in_choice.equals("1")){ class CompareDataScadenza implements Comparator { @@ -522,10 +565,6 @@ public class Catalogo{ } } - - - - } } @@ -590,8 +629,7 @@ public class Catalogo{ if (((Vacanze)e1).getIdViaggio() < ((Vacanze)e2).getIdViaggio()) return -1; return 1; - - + }else{ //vacanza vs cena @@ -686,13 +724,10 @@ public class Catalogo{ } } - Collections.sort(catalogoOfferte,new CompareID()); print_cat_admin (catalogoOfferte,show_offers); - } - } else{ // user @@ -845,13 +880,23 @@ public class Catalogo{ } } - Collections.sort(catalogoOfferte, new CompareIDUser()); print_cat_user(catalogoOfferte, loggedUser.getLocation(), show_offers); - } } + /** + * Questo metodo genera una lista di offerte attive comprese tra una data iniziale ed una finale + * + * @param user - utente connesso + * @param show_offers - TextArea dove mostrare i risultati + * @param in_choice + * @param datastart - data di inizio della ricerca + * @param data_end - data finale della ricerca + * @throws FileNotFoundException + * @throws ClassNotFoundException + * @throws IOException + */ public void offerteAttiveConScadenza(String user, JTextArea show_offers, String in_choice, GregorianCalendar datastart, GregorianCalendar data_end) throws FileNotFoundException, ClassNotFoundException, IOException { Entry loggedUser = Access.get_user_data(user); @@ -860,9 +905,7 @@ public class Catalogo{ { //admin - if (in_choice.equals("1")){ - class CompareDataScadenza implements Comparator { @Override @@ -1006,10 +1049,6 @@ public class Catalogo{ } } - - - - } } @@ -1170,13 +1209,10 @@ public class Catalogo{ } } - Collections.sort(arrayData,new CompareID()); print_cat_admin (arrayData,show_offers); - } - } else{ // user @@ -1329,12 +1365,22 @@ public class Catalogo{ } } - Collections.sort(arrayData, new CompareIDUser()); print_cat_user(arrayData, loggedUser.getLocation(), show_offers); - } } + + /** + * Questo metodo visualizza gli articoli senza scadenza che sono offerti da fornitori con un giudizio superiore ad un valore preso come parametro. + * + * @param user - Utente connesso + * @param show_offers - TextArea dove mostrare i risultati + * @param in_choice + * @param votazione - votazione che i prodotti devono rispettare. + * @throws FileNotFoundException + * @throws ClassNotFoundException + * @throws IOException + */ public void offerteAttiveSenzaScadenza(String user, JTextArea show_offers, String in_choice, int votazione) throws FileNotFoundException, ClassNotFoundException, IOException { Entry loggedUser = Access.get_user_data(user); @@ -1343,7 +1389,6 @@ public class Catalogo{ { //admin - if (in_choice.equals("1")){ class CompareDataScadenza implements Comparator { @@ -1489,10 +1534,6 @@ public class Catalogo{ } } - - - - } } @@ -1812,18 +1853,19 @@ public class Catalogo{ } } - Collections.sort(arrayData, new CompareIDUser()); print_cat_user(arrayData, loggedUser.getLocation(), show_offers); - } } /** - * Questo metodo visualizza le offerte scadute del catalogo - * @throws IOException - * @throws ClassNotFoundException - * @throws FileNotFoundException + * Questo metodo visualizza le offerte scadute del catalogo. + * + * @param user - Utente connesso + * @param in_area - TextArea dove visualizzare i risultati. + * @throws FileNotFoundException + * @throws ClassNotFoundException + * @throws IOException */ public void offerteScadute(String user,JTextArea in_area) throws FileNotFoundException, ClassNotFoundException, IOException { @@ -1853,9 +1895,11 @@ public class Catalogo{ } } } + /** * Questa metodo aggiunge credito al conto dell'utente - * @param user + * + * @param user - Utente connesso al sistema- * @throws FileNotFoundException * @throws ClassNotFoundException * @throws IOException @@ -1872,7 +1916,7 @@ public class Catalogo{ /** * Questo metodo permette all'utente di effettuare un acquisto * - * @param user + * @param user - Utente connesso * @throws FileNotFoundException * @throws ClassNotFoundException * @throws IOException @@ -1958,7 +2002,6 @@ public class Catalogo{ deal.setPrestazioniVendute(); Access.replace_data(user, loggedUser); store_data(); - } } @@ -1973,6 +2016,16 @@ public class Catalogo{ } } + /** + * Metodo che permette la ricerca di un prodotto all'interno del catalogo in base all'id. + * + * @param user + * @param in_id - id del prodotto da ricercare + * @return - l'indice all'interno del catalogo. + * @throws FileNotFoundException + * @throws ClassNotFoundException + * @throws IOException + */ public int search_product_id(String user, String in_id) throws FileNotFoundException, ClassNotFoundException, IOException { Entry loggedUser = Access.get_user_data(user); @@ -2098,6 +2151,12 @@ public class Catalogo{ } } + /** + * Metodo che si occupa della visualizzazione dello storico dell'utente. + * + * @param in . ArrayList da scorrere. + * @param area_storico - Oggetto JTextArea dove visualizzare i risultati. + */ protected void print_storico (ArrayList in, JTextArea area_storico){ for(StoricoItem record: in) @@ -2108,10 +2167,8 @@ public class Catalogo{ int annoP = partenza.get(Calendar.YEAR); area_storico.append("Deal: " + record.getDescription() + "| Data Acquisto: " + giornoP + "/" + (meseP + 1) + "/" + annoP + "| Prezzo: " + record.getPrezzo() + "\n"); } - } - /** * Questo metodo visualizza una vacanza, descrivendone i suoi dati. * @@ -2136,18 +2193,22 @@ public class Catalogo{ * * @param dealBene - oggetto di tipo beniDiConsumo che rappresenta l'offerta del bene da visualizzare */ - public void visualizzaBene(BeniDiConsumo dealBene, JTextArea show) { show.append("#Bene-" + dealBene.getIdBene() + "# Descrizione: " + dealBene.getDescrizioneBene() + " Prezzo: " + dealBene.getPrezzoBene() + "| Quantita in magazzino: " + dealBene.getBeniInStock() + "| Fornitore: " + dealBene.getFornitore() + "| Giudizio: +" + dealBene.getGiudizioFornitore() + "\n"); } + + /** + * Questo metodo visualizza una Prestazione d'opera, descrivendone i suoi dati. + * + * @param dealBene - oggetto di tipo beniDiConsumo che rappresenta l'offerta del bene da visualizzare + */ public void visualizzaPrestazione(PrestazioniDopera deal, JTextArea show) { show.append("#Prestazione-" + deal.getIdPrOpera() + "# Descrizione: " + deal.getDescrizione() + " Prezzo: " + deal.getPrezzoPrestazione() + "| Fornitore: " + deal.getFornitore() + "| Giudizio: +" + deal.getGiudizioFornitore() + "\n"); } - /** * * Questo metodo visualizza una cena, descrivendone i suoi dati. @@ -2163,7 +2224,6 @@ public class Catalogo{ } /** - * * @return - restituisce il catalogo delle offerte */ @@ -2171,13 +2231,9 @@ public class Catalogo{ return catalogoOfferte; } - - - - /** * - * Questo emtodo restituisce tutti gli articoli con scadenza (vacanze, cene ristorante) che hanno scadenza tra una data iniziale e una data finale presi come parametri. + * Questo metodo restituisce tutti gli articoli con scadenza (vacanze, cene ristorante) che hanno scadenza tra una data iniziale e una data finale presi come parametri. * @param dataStart - data iniziale * @param dataEnd - data finale * @return un ArrayList contenente gli articoli compresi tra le due date inserite dall'utente @@ -2211,8 +2267,9 @@ public class Catalogo{ /** * Questo metodo restituisce tutti gli articoli senza scadenza (beni, prestazioni) che sono offerti da fornitori con un giudizio superiore ad un valore preso come parametro. - * @param votazione - * @return arrayDealNotExpire - Ritorna un arrayList contente tutti gli articoli senza scadenza + * + * @param votazione - è la votazione minima che deve avere un fornitore. + * @return arrayDealNotExpire - Ritorna un ArrayList contente tutti gli articoli senza scadenza */ public ArrayList getDealNotExpire(int votazione) { @@ -2235,12 +2292,6 @@ public class Catalogo{ } return arrayDealNotExpire; } - - - - - - + private ArrayList catalogoOfferte; - } diff --git a/it/unisa/info13d/Gui/AdminInterface.java b/it/unisa/info13d/Gui/AdminInterface.java index bffdf5d..ad83656 100644 --- a/it/unisa/info13d/Gui/AdminInterface.java +++ b/it/unisa/info13d/Gui/AdminInterface.java @@ -25,7 +25,16 @@ import java.util.GregorianCalendar; */ public class AdminInterface extends JFrame{ - + /** + * Genera la GUI per l'intereazione dell'admin con il sistema. + * + * @param in_login_window + * @param in_load_catalogo + * @param in_login_data + * @throws FileNotFoundException + * @throws IOException + * @throws ClassNotFoundException + */ public AdminInterface(LoginWindow in_login_window, Catalogo in_load_catalogo, LoginData in_login_data) throws FileNotFoundException,IOException,ClassNotFoundException{ login_window = in_login_window; @@ -289,9 +298,6 @@ public class AdminInterface extends JFrame{ @Override public void actionPerformed(ActionEvent e) { - - - Global.set_sconto_min_articoli(0,0); JOptionPane.showMessageDialog(location, @@ -299,9 +305,6 @@ public class AdminInterface extends JFrame{ "Completata", JOptionPane.INFORMATION_MESSAGE); - - - } private AdminInterface location; @@ -382,19 +385,12 @@ public class AdminInterface extends JFrame{ public void actionPerformed(ActionEvent e) { - - - - Global.setSconto_ultima_settimana(0); JOptionPane.showMessageDialog(location, "Politica di sconto rimossa", "Completata", JOptionPane.INFORMATION_MESSAGE); - - - } private AdminInterface location; @@ -558,10 +554,6 @@ public class AdminInterface extends JFrame{ JTextField giudizio = new JTextField(15); - - - - showInput.add(descrizionel); showInput.add(descrizione); showInput.add(prezzol); @@ -968,7 +960,6 @@ public class AdminInterface extends JFrame{ id = in_id; location= in_location; offers = in_offers; - } @Override diff --git a/it/unisa/info13d/Gui/LoginWindow.java b/it/unisa/info13d/Gui/LoginWindow.java index 05ae857..56001a7 100644 --- a/it/unisa/info13d/Gui/LoginWindow.java +++ b/it/unisa/info13d/Gui/LoginWindow.java @@ -19,6 +19,12 @@ import java.text.ParseException; * Date: 19/01/14 * Time: 16.25 */ + +/** + * + * Questa classe di occupa di gestire la GUI per l'utente. + * + */ public class LoginWindow extends JFrame { public LoginWindow () { diff --git a/it/unisa/info13d/Gui/RegisterWindow.java b/it/unisa/info13d/Gui/RegisterWindow.java index 998457c..44c0c05 100644 --- a/it/unisa/info13d/Gui/RegisterWindow.java +++ b/it/unisa/info13d/Gui/RegisterWindow.java @@ -19,6 +19,12 @@ import java.text.ParseException; */ public class RegisterWindow extends JFrame { + /** + * Genera la GUI per la procedura di registrazione dell'utente al sistema. + * + * @param in_back + * @param in_point + */ public RegisterWindow( LoginWindow in_back, Point in_point ) { setLocation(in_point); diff --git a/it/unisa/info13d/Gui/UserInterface.java b/it/unisa/info13d/Gui/UserInterface.java index 5110679..70face5 100644 --- a/it/unisa/info13d/Gui/UserInterface.java +++ b/it/unisa/info13d/Gui/UserInterface.java @@ -25,7 +25,16 @@ import java.util.concurrent.Callable; */ public class UserInterface extends JFrame{ - + /** + * Genera la GUI per l'interazione dell'utente con il sistema. + * + * @param in_login_window + * @param in_load_catalogo + * @param in_login_data + * @throws FileNotFoundException + * @throws IOException + * @throws ClassNotFoundException + */ public UserInterface( LoginWindow in_login_window ,Catalogo in_load_catalogo, LoginData in_login_data) throws FileNotFoundException,IOException,ClassNotFoundException{ login_window = in_login_window; diff --git a/it/unisa/info13d/Login/Access.java b/it/unisa/info13d/Login/Access.java index aa36ca9..4a19bac 100644 --- a/it/unisa/info13d/Login/Access.java +++ b/it/unisa/info13d/Login/Access.java @@ -14,7 +14,7 @@ public class Access { /** * Questo metodo avvia la procedura di login o di registrazione dell'utente in base alla scelta fatta nel menu. * - * @param set_user_logged_here dove memorizzare il nome dell'utente loggato o registrato + * @param set_user_logged_here - dove memorizzare il nome dell'utente loggato o registrato * @return false se Amministratore, true se Utente */ public static boolean get_access (LoggedUser set_user_logged_here, String in_name,String in_password,String in_location,boolean in_action) throws FileNotFoundException,IOException,ClassNotFoundException{ @@ -26,7 +26,7 @@ public class Access { } /** - * + * Metodo che si occupa di definire l'utente loggato (Amministratore o utente) * @param set_user_logged_here - nome dell'utente loggato o registrato * @return - Se avviene una registrazione viene restituito il valore true, poiche solo gli utenti possono registrarsi. Se viene effettuato un login, viene restituito il tipo di utente appena loggato. * @throws FileNotFoundException @@ -48,6 +48,7 @@ public class Access { } /** + * Metodo che si occupa di finalizzare la registrazione dell'utente salvandolo sul disco. * * @param set_user_logged_here - nome dell'utente loggato o registrato * @return - true poiche' e' possibile la registrazione solo degli utenti. @@ -56,8 +57,6 @@ public class Access { * @throws ClassNotFoundException */ protected static boolean register ( LoggedUser set_user_logged_here, String in_name,String in_password,String in_location ) throws FileNotFoundException,IOException,ClassNotFoundException{ - - String name = in_name; String password = in_password; String location = in_location; @@ -66,7 +65,6 @@ public class Access { set_user_logged_here.logged_user = name; return true; - } /** @@ -121,7 +119,7 @@ public class Access { } /** - * Questo metodo si occupa di restituite la tipologia dell'account dell'utente connesso + * Metodo che si occupa di restituite la tipologia dell'account dell'utente connesso * * @param in_name - username utente * @return tipo di account (admin o Client) @@ -176,7 +174,7 @@ public class Access { } /** - * Questo emtodo si occupa di prelevare i dati dell'utente dal disco + * Questo metodo si occupa di prelevare i dati dell'utente dal disco. * * @param in_nome - username utente * @return un Entry contenente tutti i dati dell'utente @@ -196,7 +194,7 @@ public class Access { return database.get(i); } } - return null; // Non puoi essere qui o altriemnti il tuo database e' corrotto + return null; // Non puoi essere qui o altrimenti il tuo database e' corrotto } /** diff --git a/it/unisa/info13d/Login/Entry.java b/it/unisa/info13d/Login/Entry.java index 321dbb8..4d696d7 100644 --- a/it/unisa/info13d/Login/Entry.java +++ b/it/unisa/info13d/Login/Entry.java @@ -17,7 +17,8 @@ import java.util.ArrayList; public class Entry implements Serializable{ /** - * Il costruttore della classe si occupa di inizializzare i dati dell'utente + * Il costruttore della classe si occupa di inizializzare i dati dell'utente. + * * @param in_user - username utente * @param in_password - password utente * @param in_type - tipologia di utente @@ -33,7 +34,7 @@ public class Entry implements Serializable{ /** * - * @return - username of user + * @return - username dell'utente. */ public String getUser() { return user; @@ -41,7 +42,7 @@ public class Entry implements Serializable{ /** * - * @return - password of user + * @return - password dell'utente. */ public String getPassword() { return password; @@ -49,7 +50,7 @@ public class Entry implements Serializable{ /** * - * @return - il tipo di utente + * @return - il tipo di utente. */ public boolean getType() { return type; @@ -57,7 +58,7 @@ public class Entry implements Serializable{ /** * - * @return - il luogo di abitazione dell'utente + * @return - il luogo di abitazione dell'utente. */ public String getLocation() { return location; @@ -65,24 +66,22 @@ public class Entry implements Serializable{ /** * - * @return - il saldo dell'utente + * @return - il saldo dell'utente. */ public double getBalance() { return balance; } /** - * - * Questo metodo aggiugne credito al saldo dell'utente. + * Questo metodo aggiunge credito al saldo dell'utente. * @param balance - valore della ricarica del saldo */ public void setBalance(double balance) { this.balance += balance; } - /** - * - * @return - un ArrayList che rappresenta lo storico degli acquisti dell'utente + /** + * @return - Un ArrayList che rappresenta lo storico degli acquisti dell'utente. */ public ArrayList getStorico() { return storico; diff --git a/it/unisa/info13d/Main.java b/it/unisa/info13d/Main.java index 79fcd24..40ee324 100644 --- a/it/unisa/info13d/Main.java +++ b/it/unisa/info13d/Main.java @@ -12,8 +12,9 @@ import java.text.ParseException; import it.unisa.info13d.Utility.IdCounter; import it.unisa.info13d.Utility.ReShow; + /** - * Questa classe rappresenta il Main dell'applicazione dalla quale si avvieranno le procedure per la gestione dell'utente e del catalogo. + * Questa classe rappresenta il Main dell'applicazione dalla quale si avviera' l'interfaccia di interazione con l'utente. * * @author Simone Argenziano e Giovanni Di Grezia * @@ -40,10 +41,5 @@ public class Main { LoginWindow l = new LoginWindow(); - } - - - - -} +} \ No newline at end of file diff --git a/it/unisa/info13d/Utility/IdCounter.java b/it/unisa/info13d/Utility/IdCounter.java index 6f0fd38..d425109 100644 --- a/it/unisa/info13d/Utility/IdCounter.java +++ b/it/unisa/info13d/Utility/IdCounter.java @@ -21,8 +21,8 @@ import java.util.ArrayList; public class IdCounter { /** - * * Questo metodo salva il contatore dell'id sul disco. + * * @throws FileNotFoundException * @throws IOException * @throws ClassNotFoundException @@ -35,7 +35,6 @@ public class IdCounter { writer.close(); } - /** * Questo metodo legge il valore del contatore e lo setta. *