Migliorata la documentazione per renderla più omogenea con il risultato finale in HTML

This commit is contained in:
Simone Argenziano
2014-01-25 16:44:26 +01:00
parent 6216e5af8c
commit 88942a648c
11 changed files with 200 additions and 178 deletions

View File

@@ -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;

View File

@@ -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;

View File

@@ -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<69> di articoli venduti in un singolo acquisto.
*
* @param num - numero di articoli da acquistare per poter applicare lo sconto.
* @param sconto - Quantit<69> di sconto da applicare.
* @param num numero di articoli da acquistare per poter applicare lo sconto.
* @param sconto Quantit<69> 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<69> di sconto da applicare.
* @param sconto_ultima_settimana Quantit<69> 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<69> di sconto.
* @param sconto_cene_sup_50 Quantit<69> 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<69>.
* @return il numero di articoli necessari per applicare lo sconto in quantit<69>.
*/
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;

View File

@@ -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<69> 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<69> 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<70> fruire della prestazione.
* @return il nome della localita' in cui si pu<70> 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<69> della prestazione
* @param localita localit<69> 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;

View File

@@ -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();
}

View File

@@ -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;