From 88942a648cd678d700f2aabbed4963a323c240df Mon Sep 17 00:00:00 2001 From: Simone Argenziano Date: Sat, 25 Jan 2014 16:44:26 +0100 Subject: [PATCH] =?UTF-8?q?Migliorata=20la=20documentazione=20per=20render?= =?UTF-8?q?la=20pi=C3=B9=20omogenea=20con=20il=20risultato=20finale=20in?= =?UTF-8?q?=20HTML?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- it/unisa/info13d/Articoli/BeniDiConsumo.java | 50 ++++++--- .../info13d/Articoli/CeneInRistoranti.java | 44 ++++---- it/unisa/info13d/Articoli/Global.java | 21 ++-- .../info13d/Articoli/PrestazioniDopera.java | 37 ++++--- it/unisa/info13d/Articoli/Utilizzabile.java | 11 +- it/unisa/info13d/Articoli/Vacanze.java | 30 +++--- .../info13d/GestioneCatalogo/Catalogo.java | 102 +++++++++--------- it/unisa/info13d/Login/Access.java | 31 +++--- it/unisa/info13d/Login/Entry.java | 26 ++--- it/unisa/info13d/Login/LoginData.java | 12 +-- it/unisa/info13d/Login/StoricoItem.java | 14 +-- 11 files changed, 200 insertions(+), 178 deletions(-) diff --git a/it/unisa/info13d/Articoli/BeniDiConsumo.java b/it/unisa/info13d/Articoli/BeniDiConsumo.java index 7896dd7..e0c2181 100644 --- a/it/unisa/info13d/Articoli/BeniDiConsumo.java +++ b/it/unisa/info13d/Articoli/BeniDiConsumo.java @@ -20,10 +20,10 @@ public class BeniDiConsumo extends Utilizzabile implements Serializable { /** * Costruttore che inizializza i valori del bene di consumo * - * @param idBene - * @param descrizioneBene - descrizione del bene - * @param prezzoBene - prezzo del bene - * @param beniInStock - quantita' del bene da vendere + * @param idBene id del bene. + * @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,63 +43,79 @@ public class BeniDiConsumo extends Utilizzabile implements Serializable { /** - * @return - id bene. + * @return id bene. */ public int getIdBene() { return idBene; } /** - * @return - descrizione bene. + * Metodo che restituisce la descrizione del bene. + * + * @return descrizione bene. */ public String getDescrizioneBene() { return descrizioneBene; } /** - * @return - prezzo del bene. + * Metodo che restituisce il prezzo del bene. + * + * @return prezzo del bene. */ public double getPrezzoBene() { return prezzoBene; } /** - * @return - la quantita' dei beni da vendere. + * Metodo che restituisce la quantita' dei beni da vendere. + * + * @return la quantita' dei beni da vendere. */ public int getBeniInStock() { return beniInStock; } /** - * @return - numero di oggetti venduti. + * Metodo che restituisce il numero di oggetti venduti. + * + * @return numero di oggetti venduti. */ public int getBeniVenduti() { return beniVenduti; } /** - * @param descrizioneBene - descrizione del bene. + * Metodo che setta la descrizione del bene. + * + * @param descrizioneBene descrizione del bene. */ public void setDescrizioneBene(String descrizioneBene) { this.descrizioneBene = descrizioneBene; } /** - * @param prezzoBene - prezzo del bene. + * Metodo che setta il 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. + * Metodo che setta la 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). + * Metodo che ritorna la scadenza del bene. + * + * @return la scadenza del bene (viene considerata una data a lungo termine). */ public GregorianCalendar getScadenza() { return scadenza; @@ -114,14 +130,18 @@ public class BeniDiConsumo extends Utilizzabile implements Serializable { } /** - * @return - Il giudizio dato al fornitore. + * Metodo che ritorna il giudizione dato al fornitore. + * + * @return Il giudizio dato al fornitore. */ public int getGiudizioFornitore() { return giudizioFornitore; } /** - * @return - Il nome del fornitore. + * Metodo che ritorna Il nome del fornitore. + * + * @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 33ec4c3..b07eafd 100644 --- a/it/unisa/info13d/Articoli/CeneInRistoranti.java +++ b/it/unisa/info13d/Articoli/CeneInRistoranti.java @@ -18,15 +18,15 @@ import java.util.GregorianCalendar; public class CeneInRistoranti extends Utilizzabile implements Serializable{ /** - *Genera una nuova cena da inserire all'interno del catalogo + * 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 disponibili 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; @@ -46,98 +46,98 @@ 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 il 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; diff --git a/it/unisa/info13d/Articoli/Global.java b/it/unisa/info13d/Articoli/Global.java index e3daa6f..d5ff4ca 100644 --- a/it/unisa/info13d/Articoli/Global.java +++ b/it/unisa/info13d/Articoli/Global.java @@ -25,7 +25,7 @@ public class Global { /** * Questo metodo setta il contatore generale degli id dei prodotti. * - * @param general_counter - contatore id + * @param general_counter contatore id */ public static void setGeneral_counter(int general_counter) { Global.general_counter = general_counter; @@ -42,8 +42,8 @@ public class Global { /** * 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. + * @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; @@ -52,7 +52,7 @@ public class Global { /** * 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. + * @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; @@ -61,7 +61,7 @@ public class Global { /** * 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. + * @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; @@ -69,7 +69,7 @@ public class Global { /** * - * @return - il numero di articoli necessari per applicare lo sconto in quantità. + * @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; @@ -77,7 +77,7 @@ public class Global { /** * - * @return - ritorna la quantita' di sconto applicata alla politica dello sconto in quantita'. + * @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; @@ -85,15 +85,14 @@ public class Global { /** * - * @return - ritorna lo sconto applicabile agli articoli che si trovano nell'ultima settimana di scadenza. + * @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. + /** + * @return ritorna lo sconto applicato alla politica di sconto delle cene. */ public static double getSconto_cene_sup_50() { return sconto_cene_sup_50; diff --git a/it/unisa/info13d/Articoli/PrestazioniDopera.java b/it/unisa/info13d/Articoli/PrestazioniDopera.java index eccb9b9..4f90b9c 100644 --- a/it/unisa/info13d/Articoli/PrestazioniDopera.java +++ b/it/unisa/info13d/Articoli/PrestazioniDopera.java @@ -12,12 +12,12 @@ 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 + * @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){ @@ -43,7 +43,7 @@ public class PrestazioniDopera extends Utilizzabile { /** * - * @return - Ritorna l'id dell'opera. + * @return Ritorna l'id dell'opera. */ public int getIdPrOpera() { return idPrOpera; @@ -51,7 +51,7 @@ public class PrestazioniDopera extends Utilizzabile { /** * - * @return - Ritorna il giudizio dato al fornitore della prestazione. + * @return Ritorna il giudizio dato al fornitore della prestazione. */ public int getGiudizioFornitore() { return giudizioFornitore; @@ -59,6 +59,7 @@ public class PrestazioniDopera extends Utilizzabile { /** * Questo metodo setta il giudizio dal fornitore della prestazione. + * * @param giudizioFornitore */ public void setGiudizioFornitore(int giudizioFornitore) { @@ -66,15 +67,13 @@ public class PrestazioniDopera extends Utilizzabile { } /** - * - * @return - Ritorna il numero di prestazioni vendute. + * @return Ritorna il numero di prestazioni vendute. */ public int getPrestazioniVendute() { return prestazioniVendute; } /** - * *Questo metodo incrementa il numero di prestazioni vendute. */ public void setPrestazioniVendute() { @@ -82,7 +81,7 @@ public class PrestazioniDopera extends Utilizzabile { } /** - * @return - Ritorna il prezzo della prestazione. + * @return Ritorna il prezzo della prestazione. */ public double getPrezzoPrestazione() { return prezzoPrestazione; @@ -98,7 +97,7 @@ public class PrestazioniDopera extends Utilizzabile { } /** - * @return - il nome della localita' in cui si può fruire della prestazione. + * @return il nome della localita' in cui si può fruire della prestazione. */ public String getLocalita() { return Localita; @@ -107,14 +106,14 @@ public class PrestazioniDopera extends Utilizzabile { /** * Questo metodo setta la localita' della prestazione. * - * @param localita - località della prestazione + * @param localita località della prestazione */ public void setLocalita(String localita) { Localita = localita; } /** - * @return - Ritorna la descrizione della prestazione. + * @return Ritorna la descrizione della prestazione. */ public String getDescrizione() { return Descrizione; @@ -123,14 +122,14 @@ public class PrestazioniDopera extends Utilizzabile { /** * Questo metodo setta la descrizione della prestazione. * - * @param descrizione - descrizione della prestazione. + * @param descrizione descrizione della prestazione. */ public void setDescrizione(String descrizione) { Descrizione = descrizione; } /** - * @return - Ritorna il nome del fornitore della prestazione. + * @return Ritorna il nome del fornitore della prestazione. */ public String getFornitore() { return Fornitore; @@ -139,14 +138,14 @@ public class PrestazioniDopera extends Utilizzabile { /** * Questo metodo setta il fornitore della prestazione. * - * @param fornitore - nome del fornitore + * @param fornitore nome del fornitore */ public void setFornitore(String fornitore) { Fornitore = fornitore; } /** - * @return - la data di scadenza della prestazione. + * @return la data di scadenza della prestazione. */ public GregorianCalendar getScadenza() { return scadenza; diff --git a/it/unisa/info13d/Articoli/Utilizzabile.java b/it/unisa/info13d/Articoli/Utilizzabile.java index d0f216a..52b56f7 100644 --- a/it/unisa/info13d/Articoli/Utilizzabile.java +++ b/it/unisa/info13d/Articoli/Utilizzabile.java @@ -9,22 +9,25 @@ import java.io.Serializable; * Time: 18.11 */ +/** + * + * Classe astratta che definisce i metodi da integrare neglia articoli del catalogo. + * + */ public abstract class Utilizzabile implements Serializable { /** * Metodo per definire se un prodotto e acqustabile * - * @return - ritorna true se e' acquistabile false se non lo e' + * @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 - prezzo scontato dell'articolo. + * @return Ritorna il 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 6a56a3d..b0b0bae 100644 --- a/it/unisa/info13d/Articoli/Vacanze.java +++ b/it/unisa/info13d/Articoli/Vacanze.java @@ -18,11 +18,11 @@ public class Vacanze extends Utilizzabile implements Serializable{ /** * Costruttore per inizialiazzare una Vacanza. * - * @param idViaggio - * @param localitaViaggio - * @param dataPartenzaViaggio - * @param scadenzaOfferta - * @param prezzoPSingola + * @param idViaggio ide del viaggio + * @param localitaViaggio localita' del viaggio + * @param dataPartenzaViaggio data di partenza del viaggio + * @param scadenzaOfferta scadenza dell'offerta + * @param prezzoPSingola prezzo per singola persona */ public Vacanze(int idViaggio, String localitaViaggio, GregorianCalendar dataPartenzaViaggio, GregorianCalendar scadenzaOfferta, double prezzoPSingola){ this.idViaggio = idViaggio; @@ -40,70 +40,70 @@ 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 localita' 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; diff --git a/it/unisa/info13d/GestioneCatalogo/Catalogo.java b/it/unisa/info13d/GestioneCatalogo/Catalogo.java index 29bb576..6980cc9 100644 --- a/it/unisa/info13d/GestioneCatalogo/Catalogo.java +++ b/it/unisa/info13d/GestioneCatalogo/Catalogo.java @@ -69,7 +69,7 @@ public class Catalogo{ /** * 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 + * @param userType e' il tipo di utente ottenuto dal mail. * @throws IOException * @throws ParseException * @throws ClassNotFoundException @@ -123,12 +123,12 @@ public class Catalogo{ /** * 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 + * @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 @@ -213,11 +213,11 @@ public class Catalogo{ /** * 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. + * @param in_localita Localita' dove e' 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 @@ -296,8 +296,8 @@ public class Catalogo{ /** * Questo metodo velocizza la stampa dell informazioni scorrenndo l'array. * - * @param a - ArrayList da scorrere - * @param show_offers - TexaArea dove visualizzare l'arraylist + * @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) @@ -345,9 +345,9 @@ public class Catalogo{ /** * 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 + * @param a ArrayList da scorrere + * @param location_user_to_compare La localita' 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) @@ -395,8 +395,8 @@ 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. + * @param in data da convertire in millisecondi + * @return Il numero in millisencodi della data passata alla funzione. */ protected long convert_calendar_to_int (GregorianCalendar in){ return in.getTimeInMillis(); @@ -408,7 +408,7 @@ public class Catalogo{ * - 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 + * @param user username utente * @throws FileNotFoundException * @throws ClassNotFoundException * @throws IOException @@ -888,11 +888,11 @@ public class Catalogo{ /** * 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 + * @param user Utente connesso + * @param show_offers TextArea dove mostrare i risultati + * @param in_choice scelta + * @param datastart data di inizio della ricerca + * @param data_end data finale della ricerca * @throws FileNotFoundException * @throws ClassNotFoundException * @throws IOException @@ -1373,10 +1373,10 @@ public class Catalogo{ /** * 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. + * @param user Utente connesso + * @param show_offers TextArea dove mostrare i risultati + * @param in_choice scelta + * @param votazione votazione che i prodotti devono rispettare. * @throws FileNotFoundException * @throws ClassNotFoundException * @throws IOException @@ -1861,8 +1861,8 @@ public class Catalogo{ /** * Questo metodo visualizza le offerte scadute del catalogo. * - * @param user - Utente connesso - * @param in_area - TextArea dove visualizzare i risultati. + * @param user Utente connesso + * @param in_area TextArea dove visualizzare i risultati. * @throws FileNotFoundException * @throws ClassNotFoundException * @throws IOException @@ -1914,9 +1914,9 @@ public class Catalogo{ } /** - * Questo metodo permette all'utente di effettuare un acquisto + * Questo metodo permette all'utente di effettuare un acquisto. * - * @param user - Utente connesso + * @param user Utente connesso * @throws FileNotFoundException * @throws ClassNotFoundException * @throws IOException @@ -2019,9 +2019,9 @@ 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. + * @param user Utente + * @param in_id id del prodotto da ricercare + * @return L'indice all'interno del catalogo. * @throws FileNotFoundException * @throws ClassNotFoundException * @throws IOException @@ -2102,7 +2102,7 @@ public class Catalogo{ /** * Questo metodo visualizza lo storico degli ordini effettuati dall'utente. rende possibile l'ordinamento in base alla data di scadenza o per prezzo. * - * @param user + * @param user - Utente * @throws FileNotFoundException * @throws ClassNotFoundException * @throws IOException @@ -2154,8 +2154,8 @@ 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. + * @param in ArrayList da scorrere. + * @param area_storico Oggetto JTextArea dove visualizzare i risultati. */ protected void print_storico (ArrayList in, JTextArea area_storico){ @@ -2170,9 +2170,9 @@ public class Catalogo{ } /** - * Questo metodo visualizza una vacanza, descrivendone i suoi dati. + *Questo metodo visualizza una vacanza, descrivendone i suoi dati. * - * @param dealVacanza - oggetto di tipo Vacanze che rappresenta l'offerta della Vacanza da visualizzare + * @param dealVacanza Oggetto di tipo Vacanze che rappresenta l'offerta della Vacanza da visualizzare */ public void visualizzaVacanza(Vacanze dealVacanza, JTextArea show) { @@ -2189,9 +2189,9 @@ public class Catalogo{ } /** - * Questo metodo visualizza un Bene di consumo, descrivendone i suoi dati. + * Questo metodo visualizza un Bene di consumo, descrivendone i suoi dati. * - * @param dealBene - oggetto di tipo beniDiConsumo che rappresenta l'offerta del bene da visualizzare + * @param dealBene Oggetto di tipo beniDiConsumo che rappresenta l'offerta del bene da visualizzare */ public void visualizzaBene(BeniDiConsumo dealBene, JTextArea show) { @@ -2210,9 +2210,9 @@ public class Catalogo{ } /** - * * Questo metodo visualizza una cena, descrivendone i suoi dati. - * @param dealCena - oggetto di tipo CeneInRistoranti che rappresenta l'offerta della cena da visualizzare + * + * @param dealCena Oggetto di tipo CeneInRistoranti che rappresenta l'offerta della cena da visualizzare */ public void visualizzaCena(CeneInRistoranti dealCena, JTextArea show) { @@ -2224,7 +2224,7 @@ public class Catalogo{ } /** - * @return - restituisce il catalogo delle offerte + * @return Restituisce il catalogo delle offerte */ public ArrayList getCatalogo() { @@ -2232,10 +2232,10 @@ public class Catalogo{ } /** - * * 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 + * + * @param dataStart data iniziale + * @param dataEnd data finale * @return un ArrayList contenente gli articoli compresi tra le due date inserite dall'utente */ public ArrayList getDataExpire(GregorianCalendar dataStart, GregorianCalendar dataEnd) @@ -2268,8 +2268,8 @@ 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 - è la votazione minima che deve avere un fornitore. - * @return arrayDealNotExpire - Ritorna un ArrayList contente tutti gli articoli senza scadenza + * @param votazione E' la votazione minima che deve avere un fornitore. + * @return arrayDealNotExpire Ritorna un ArrayList contente tutti gli articoli senza scadenza */ public ArrayList getDealNotExpire(int votazione) { diff --git a/it/unisa/info13d/Login/Access.java b/it/unisa/info13d/Login/Access.java index 4a19bac..7beec0c 100644 --- a/it/unisa/info13d/Login/Access.java +++ b/it/unisa/info13d/Login/Access.java @@ -12,9 +12,9 @@ import java.util.Scanner; */ public class Access { /** - * Questo metodo avvia la procedura di login o di registrazione dell'utente in base alla scelta fatta nel menu. + * 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{ @@ -27,8 +27,9 @@ 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. + * + * @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 * @throws IOException * @throws ClassNotFoundException @@ -50,8 +51,8 @@ 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. + * @param set_user_logged_here nome dell'utente loggato o registrato + * @return true poiche' e' possibile la registrazione solo degli utenti. * @throws FileNotFoundException * @throws IOException * @throws ClassNotFoundException @@ -70,8 +71,8 @@ public class Access { /** * Questo metodo si occupa della ricerca dei dati dell'utente all'interno del "database". * - * @param in_name - username dell'utente - * @param in_password - password dell'utente + * @param in_name username dell'utente + * @param in_password password dell'utente * @return true se la ricerca ha avuto esito, false altrimenti */ public static boolean search_username (String in_name, String in_password) throws FileNotFoundException,IOException,ClassNotFoundException{ @@ -121,8 +122,8 @@ public class Access { /** * 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) + * @param in_name username utente + * @return Tipo di account (admin o Client) */ protected static boolean getAccountType(String in_name) throws FileNotFoundException,IOException,ClassNotFoundException{ @@ -146,8 +147,8 @@ public class Access { /** * Questo metodo si occupa di salvare i dati su disco dell'utente. * - * @param in_nome - username utente - * @param in_password - password utente + * @param in_nome username utente + * @param in_password password utente */ protected static void store_data (String in_nome, String in_password, String in_location) throws FileNotFoundException,IOException,ClassNotFoundException{ @@ -176,7 +177,7 @@ public class Access { /** * Questo metodo si occupa di prelevare i dati dell'utente dal disco. * - * @param in_nome - username utente + * @param in_nome username utente * @return un Entry contenente tutti i dati dell'utente * @throws FileNotFoundException * @throws IOException @@ -200,8 +201,8 @@ public class Access { /** * Questo metodo scrive su disco le modifiche apportate agli attributi di un utente. (Ad esempio bilancio incrementato) * - * @param in_nome - username utente - * @param new_entry - Oggetto di tipo Entry + * @param in_nome Username utente + * @param new_entry Oggetto di tipo Entry * @throws FileNotFoundException * @throws IOException * @throws ClassNotFoundException diff --git a/it/unisa/info13d/Login/Entry.java b/it/unisa/info13d/Login/Entry.java index 4d696d7..413f021 100644 --- a/it/unisa/info13d/Login/Entry.java +++ b/it/unisa/info13d/Login/Entry.java @@ -19,10 +19,10 @@ public class Entry implements Serializable{ /** * 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 - * @param in_location - luogo abitazione utente + * @param in_user Username utente + * @param in_password Password utente + * @param in_type Tipologia di utente + * @param in_location Luogo abitazione utente */ public Entry (String in_user, String in_password, boolean in_type, String in_location) { user = in_user; @@ -32,9 +32,8 @@ public class Entry implements Serializable{ storico = new ArrayList(); } - /** - * - * @return - username dell'utente. + /** + * @return Ritorna l'username dell'utente. */ public String getUser() { return user; @@ -42,7 +41,7 @@ public class Entry implements Serializable{ /** * - * @return - password dell'utente. + * @return Ritorna la password dell'utente. */ public String getPassword() { return password; @@ -50,7 +49,7 @@ public class Entry implements Serializable{ /** * - * @return - il tipo di utente. + * @return Ritorna il tipo di utente. */ public boolean getType() { return type; @@ -58,7 +57,7 @@ public class Entry implements Serializable{ /** * - * @return - il luogo di abitazione dell'utente. + * @return Ritorna il luogo di abitazione dell'utente. */ public String getLocation() { return location; @@ -66,7 +65,7 @@ public class Entry implements Serializable{ /** * - * @return - il saldo dell'utente. + * @return Ritorna il saldo dell'utente. */ public double getBalance() { return balance; @@ -74,14 +73,15 @@ public class Entry implements Serializable{ /** * Questo metodo aggiunge credito al saldo dell'utente. - * @param balance - valore della ricarica del saldo + * + * @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 Ritorna un ArrayList che rappresenta lo storico degli acquisti dell'utente. */ public ArrayList getStorico() { return storico; diff --git a/it/unisa/info13d/Login/LoginData.java b/it/unisa/info13d/Login/LoginData.java index 91ebcee..7d5ffff 100644 --- a/it/unisa/info13d/Login/LoginData.java +++ b/it/unisa/info13d/Login/LoginData.java @@ -8,10 +8,10 @@ import java.io.IOException; * User: xgiovio * Date: 17/12/13 * Time: 1.47 - * + */ +/** * Questa classe si occupa della gestione del login dell'utente e dell'amministratore * - * */ public class LoginData { @@ -35,8 +35,8 @@ public class LoginData { /** * Questo metodo si occupa di convertire un valore bolleano nel tipo di account dll'utente connesso * - * @param value - tipo di account (Admin o Client) ottenuto dalla chiamata alla funzione Access.get_access(LoggedUser set_user_logged_here) - * @return restituisce un valore booleano, che rappresenta il tipo di utente connesso, false=>Admin true=>Client + * @param value Tipo di account (Admin o Client) ottenuto dalla chiamata alla funzione Access.get_access(LoggedUser set_user_logged_here) + * @return Restituisce un valore booleano, che rappresenta il tipo di utente connesso, false=>Admin true=>Client */ protected String convert_type (boolean value){ if (value == false) @@ -45,14 +45,14 @@ public class LoginData { } /** - * @return restituisce l'username dell'utente connesso + * @return Restituisce l'username dell'utente connesso */ public String getUsername() { return username; } /** - * @return restituisce il tipo di account associato all'utente connesso + * @return Restituisce il tipo di account associato all'utente connesso */ public String getType() { return type; diff --git a/it/unisa/info13d/Login/StoricoItem.java b/it/unisa/info13d/Login/StoricoItem.java index 7316e90..f3d9554 100644 --- a/it/unisa/info13d/Login/StoricoItem.java +++ b/it/unisa/info13d/Login/StoricoItem.java @@ -17,9 +17,9 @@ public class StoricoItem implements Serializable { /** * - * @param in_description - descrizione articolo acquistato - * @param in_data_acquisto - data dell'acquisto (Generata al momento dell'acquisto) - * @param in_prezzo - prezzo dell'articolo + * @param in_description Descrizione articolo acquistato + * @param in_data_acquisto Data dell'acquisto (Generata al momento dell'acquisto) + * @param in_prezzo Prezzo dell'articolo */ public StoricoItem (String in_description, GregorianCalendar in_data_acquisto, double in_prezzo){ description = in_description; @@ -30,7 +30,7 @@ public class StoricoItem implements Serializable { /** * - * @return - descrizione deall'articolo acquistato + * @return Ritorna descrizione deall'articolo acquistato */ public String getDescription() { return description; @@ -38,14 +38,14 @@ public class StoricoItem implements Serializable { /** * - * @return - la data dell'acquisto dell'oggeto + * @return Ritorna la data dell'acquisto dell'oggeto */ public GregorianCalendar getData_acquisto() { return data_acquisto; } + /** - * - * @return - il prezzo dell'oggetto acquistato + * @return Ritorna il prezzo dell'oggetto acquistato */ public double getPrezzo() { return prezzo;