Javadoc aggiunta a tutti i metodi di tutte le classi.

This commit is contained in:
Simone Argenziano
2014-01-25 14:46:30 +01:00
parent c1581db721
commit 7e1fe5023b
16 changed files with 369 additions and 206 deletions

View File

@@ -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 {
/**

View File

@@ -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<69> 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<69> 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<69> dove <20> 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<Utilizzabile> 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<69> dell'utente da confrontare con glia rticoli del catalogo
* @param show_offers - TexArea dove vsualizzare i risultati
*/
public void print_cat_user (ArrayList<Utilizzabile> 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<Utilizzabile> {
@@ -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<Utilizzabile> {
@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<Utilizzabile> {
@@ -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<StoricoItem> 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 - <20> la votazione minima che deve avere un fornitore.
* @return arrayDealNotExpire - Ritorna un ArrayList contente tutti gli articoli senza scadenza
*/
public ArrayList<Utilizzabile> getDealNotExpire(int votazione)
{
@@ -2235,12 +2292,6 @@ public class Catalogo{
}
return arrayDealNotExpire;
}
private ArrayList<Utilizzabile> catalogoOfferte;
}