ODD Object Design Document

Transcript

1 UNIVERSITA DEGLI STUDI DI PALERMO FACOLTA DI INGEGNERIA CORSO DI LAUREA IN INGEGNERIA INFORMATICA TESINA DI INGEGNERIA DEL SOFTWARE Progetto DocS (Documents Sharing) ODD Object Design Document Membri del gruppo: Calè Giuseppe Gemmellaro Claudio Lo Grasso Marco Minacori Attilio

2 INDICE 1 Introduzione 2 2 Diagramma delle classi del package ClassificaERicerca 3 3 JavaDoc del package ClassificaERicerca Classe AbstractionRicerca Classe ClassificaERicercaAdapter Classe ClassificaERicercaFacade Classe ClassificaERicercaTarget 15 4 Scheletro delle classi del package ClassificaERicerca Classe AbstractionRicerca Classe ClassificaERicercaAdapter Classe ClassificaERicercaFacade Classe ClassificaERicercaTarget

3 1 Introduzione Nel seguente documento viene presentata la descrizione dettagliata di tutte le classi del sottosistema ClassificaERicerca. Questo sottosistema è costituito da un componente centrale ClassificaERicerca che effettua la classificazione automatica dei documenti e fornisce le funzionalità di ricerca. Questo componente, essendo già esistente e non essendo stato sviluppato all interno di questo progetto, si è scelto di riutilizzarlo adattandolo al sistema. I design pattern utilizzati nel sottosistema ClassificaERicerca sono: Facade, che implementa un interfaccia più semplice per il sottosistema invocando i metodi delle classi di livello più basso AbstractionRicerca e ClassificaERicercaTarget. Adapter, che permette di adattare l interfaccia esistente ClassificaERicerca con quella che il sistema si aspetta, utilizzando a tale scopo le classi ClassificaERicercaTarget e ClassificaERicercaAdapter. Bridge, che definisce l interfaccia visibile al sistema tramite la classe astratta AbstrationRicerca e la classe ClassificaERicercaTarget che raffina i metodi presente nella classe astratta. Questo design pattern è stato inserito per permettere future espansioni delle funzionalità del sistema. 2

4 2 Diagramma delle classi del sottosistema ClassificaERicerca 3

5 3 JavaDoc delle classi del package ClassificaERicerca 3.1 Classe AbstractionRicerca Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS SUMMARY: NESTED FIELD CONSTR METHOD FRAMES NO FRAMES All Classes All Classes DETAIL: FIELD CONSTR METHOD ClassificaERicerca Class AbstractionRicerca java.lang.object ClassificaERicerca.AbstractionRicerca public abstract class AbstractionRicerca extends java.lang.object Abstraction del Pattern Bridge. Definisce l'interfaccia dell'abstraction. E' utilizzata direttamente dal Facade ClassificaERicercaFacade. Version: 0.9 Author: Attilio Minacori, Giuseppe Calè Field Summary ClassificaERicercaFacade classificaericercafacade ClassificaERicercaTarget classificaericercatarget Constructor Summary AbstractionRicerca() Method Summary void abstractionricerca() costruttore della classe java.lang.string[] cercaavanzato(java.lang.string nome, java.lang.string categoria, java.lang.string tipo, java.lang.string gruppo) ricerca avanzata per nome, categoria, gruppo e tipo utilizzando i metodi cerca(), cercacategoria(), cercatipo() e cercagruppo() di ClassificaERicercaTarget java.lang.string[] cercanome(java.lang.string nome) 4

6 ricerca semplice per nome utilizzando il metodo cerca() di ClassificaERicercaTarget java.lang.string[] cercanomecategoria(java.lang.string nome, java.lang.string categoria) ricerca per nome e categoria utilizzando il metodo cercacategaria() e cerca() di ClassificaERicercaTarget Methods inherited from class java.lang.object clone, equals, finalize, getclass, hashcode, notify, notifyall, tostring, wait, wait, wait Field Detail classificaericercatarget public ClassificaERicercaTarget classificaericercatarget classificaericercafacade public ClassificaERicercaFacade classificaericercafacade Constructor Detail AbstractionRicerca public AbstractionRicerca() Method Detail cercanome public java.lang.string[] cercanome(java.lang.string nome) ricerca semplice per nome utilizzando il metodo cerca() di ClassificaERicercaTarget nome - nome documento array di riferimento ai documenti trovati cercanomecategoria public java.lang.string[] cercanomecategoria(java.lang.string nome, java.lang.string categoria) ricerca per nome e categoria utilizzando il metodo cercacategaria() e cerca() di ClassificaERicercaTarget 5

7 nome - nome documento categoria - categoria documento array di riferimenti ai documenti trovati cercaavanzato public java.lang.string[] cercaavanzato(java.lang.string nome, java.lang.string categoria, java.lang.string tipo, java.lang.string gruppo) ricerca avanzata per nome, categoria, gruppo e tipo utilizzando i metodi cerca(), cercacategoria(), cercatipo() e cercagruppo() di ClassificaERicercaTarget nome - nome documento categoria - categoria documento tipo - tipo documento gruppo - tipo gruppo array di riferimenti ai docuementi trovati abstractionricerca public void abstractionricerca() costruttore della classe Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS SUMMARY: NESTED FIELD CONSTR METHOD FRAMES NO FRAMES All Classes All Classes DETAIL: FIELD CONSTR METHOD 6

8 3.2 Classe ClassificaERicercaAdapter Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS SUMMARY: NESTED FIELD CONSTR METHOD FRAMES NO FRAMES All Classes All Classes DETAIL: FIELD CONSTR METHOD ClassificaERicerca Class ClassificaERicercaAdapter java.lang.object ClassificaERicerca.ClassificaERicercaTarget ClassificaERicerca.ClassificaERicercaAdapter public class ClassificaERicercaAdapter extends ClassificaERicercaTarget Adapter. Adatta l'interfaccia di ClassificaERicerca all'interfaccia ClassificaERicercaTarget. Version: 0.9 Author: Attilio Minacori Field Summary ClassificaERicerca.ClassificaERicerca classificaericerca ClassificaERicerca.Documento documento Fields inherited from class ClassificaERicerca.ClassificaERicercaTarget abstractionricerca, classificaericercafacade Constructor Summary ClassificaERicercaAdapter() Method Summary java.lang.string[ ] java.lang.string[ ] java.lang.string[ ] java.lang.string[ ] cerca(java.lang.string nome) ricerca per nome documento cercacategoria(java.lang.string categoria) ricerca per categoria di documenti cercagruppo(java.lang.string gruppo) ricerca dei documenti appartenenti ad un gruppo cercatipo(java.lang.string tipo) ricerca per tipo di documento 7

9 void ClassificaERIcercaAdapter() costruttore di default void ClassificaERicercaAdapter(ClassificaERicerca.ClassificaERice rca adaptee) Costruttore con l' Adaptee come parametro java.lang.string[ ] listacategorie() serve per avere la lista delle categorie presenti nel sistema java.lang.string[ ] listagruppi(java.lang.string nomeutente) serve ad ottenere la lista dei gruppi a cui appartiene l'utente java.lang.string[ ] listatipo() serve ad ottenere la lista dei tipi di documenti presenti nel sistema Methods inherited from class java.lang.object clone, equals, finalize, getclass, hashcode, notify, notifyall, tostring, wait, wait, wait Field Detail documento public ClassificaERicerca.Documento documento classificaericerca public ClassificaERicerca.ClassificaERicerca classificaericerca Constructor Detail ClassificaERicercaAdapter public ClassificaERicercaAdapter() Method Detail cerca public java.lang.string[] cerca(java.lang.string nome) ricerca per nome documento Overrides: cerca in class ClassificaERicercaTarget nome - nome documento array riferimento ai documenti trovati 8

10 cercacategoria public java.lang.string[] cercacategoria(java.lang.string categoria) ricerca per categoria di documenti Overrides: cercacategoria in class ClassificaERicercaTarget categoria - categoria del documento array di riferimenti ai documenti trovati cercatipo public java.lang.string[] cercatipo(java.lang.string tipo) ricerca per tipo di documento Overrides: cercatipo in class ClassificaERicercaTarget tipo - tipo documento array di riferimenti ai documenti trovati cercagruppo public java.lang.string[] cercagruppo(java.lang.string gruppo) ricerca dei documenti appartenenti ad un gruppo Overrides: cercagruppo in class ClassificaERicercaTarget gruppo - nome gruppo array di riferimenti ai documenti trovati listacategorie public java.lang.string[] listacategorie() serve per avere la lista delle categorie presenti nel sistema Overrides: listacategorie in class ClassificaERicercaTarget 9

11 la lista delle categorie presenti nel sistema listatipo public java.lang.string[] listatipo() serve ad ottenere la lista dei tipi di documenti presenti nel sistema Overrides: listatipo in class ClassificaERicercaTarget la lista dei tipi presenti nel sistema listagruppi public java.lang.string[] listagruppi(java.lang.string nomeutente) serve ad ottenere la lista dei gruppi a cui appartiene l'utente Overrides: listagruppi in class ClassificaERicercaTarget nomeutente - nome dell'utente di cui si vuole conoscere i gruppi a cui appartiene lista dei gruppi a cui appartiene l'utente ClassificaERIcercaAdapter public void ClassificaERIcercaAdapter() costruttore di default ClassificaERicercaAdapter public void ClassificaERicercaAdapter(ClassificaERicerca.ClassificaERicerca adaptee) Costruttore con l' Adaptee come parametro adaptee - oggetto che viene adattato al sistema Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES All Classes All Classes SUMMARY: NESTED FIELD CONSTR METHOD DETAIL: FIELD CONSTR METHOD 3.3 Classe ClassificaERicercaFacade 10

12 Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS SUMMARY: NESTED FIELD CONSTR METHOD FRAMES NO FRAMES All Classes All Classes DETAIL: FIELD CONSTR METHOD ClassificaERicerca Class ClassificaERicercaFacade java.lang.object ClassificaERicerca.ClassificaERicercaFacade public class ClassificaERicercaFacade extends java.lang.object Facade. Assegna le richieste del client alle appropriate classi del sottosistema. Version: 0.9 Author: Giuseppe Calè e Attilio Minacori Field Summary AbstractionRicerca abstractionricerca ClassificaERicercaTarget classificaericercatarget Constructor Summary ClassificaERicercaFacade() Method Summary java.lang.string[] cerca(java.lang.string nome) ricerca semplice per nome documento java.lang.string[] cercaavanzata(java.lang.string nome, java.lang.string categoria, java.lang.string tipo, java.lang.string gruppo) ricerca avanzata per nome, categoria, tipo e gruppo di appartenenza java.lang.string[] cercanomecategoria(java.lang.string nome, java.lang.string categoria) ricerca semplice per nome e categoria java.lang.string[] cercanomegruppo(java.lang.string nome, java.lang.string gruppo) ricerca per nome e gruppo void ClassificaERicercaFacade() 11

13 costruttore di default java.lang.string[] listacategorie() ritorna la lista delle categorie presenti nel sistema java.lang.string[] listagruppi(java.lang.string nomeutente) ritorna la lista dei gruppi a cui appartienen l'utente che richiede la ricerca java.lang.string[] listatipo() ritorna la lista dei tipi presenti nel sistema Methods inherited from class java.lang.object clone, equals, finalize, getclass, hashcode, notify, notifyall, tostring, wait, wait, wait Field Detail abstractionricerca public AbstractionRicerca abstractionricerca classificaericercatarget public ClassificaERicercaTarget classificaericercatarget Constructor Detail ClassificaERicercaFacade public ClassificaERicercaFacade() Method Detail cerca public java.lang.string[] cerca(java.lang.string nome) ricerca semplice per nome documento nome - nome del documento da cercare un'array di riferimenti ai documenti trovati cercanomecategoria public java.lang.string[] cercanomecategoria(java.lang.string nome, java.lang.string categoria) 12

14 ricerca semplice per nome e categoria nome - nome del documento da ricercare categoria - categoria del documento da ricercare un'array di riferimenti ai documenti trovati cercaavanzata public java.lang.string[] cercaavanzata(java.lang.string nome, java.lang.string categoria, java.lang.string tipo, java.lang.string gruppo) ricerca avanzata per nome, categoria, tipo e gruppo di appartenenza nome - nome documento categoria - categoria documenti tipo - tipo del documento gruppo - gruppo a cui appartiene il documento un'array di riferimenti ai documenti trovati cercanomegruppo public java.lang.string[] cercanomegruppo(java.lang.string nome, java.lang.string gruppo) ricerca per nome e gruppo nome - nome del documento gruppo - gruppo a cui appartiene il documento un'array di riferimenti ai documenti trovati listacategorie public java.lang.string[] listacategorie() ritorna la lista delle categorie presenti nel sistema lista di tutte le categorie listatipo 13

15 public java.lang.string[] listatipo() ritorna la lista dei tipi presenti nel sistema lista di tutti i tipi di documento listagruppi public java.lang.string[] listagruppi(java.lang.string nomeutente) ritorna la lista dei gruppi a cui appartienen l'utente che richiede la ricerca nomeutente - nome dell'utente lista dei gruppi a cui appartiene l'utente ClassificaERicercaFacade public void ClassificaERicercaFacade() costruttore di default Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS SUMMARY: NESTED FIELD CONSTR METHOD FRAMES NO FRAMES All Classes All Classes DETAIL: FIELD CONSTR METHOD 14

16 3.4 Classe ClassificaERicercaTarget Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS SUMMARY: NESTED FIELD CONSTR METHOD FRAMES NO FRAMES All Classes All Classes DETAIL: FIELD CONSTR METHOD ClassificaERicerca Class ClassificaERicercaTarget java.lang.object ClassificaERicerca.ClassificaERicercaTarget Direct Known Subclasses: ClassificaERicercaAdapter public class ClassificaERicercaTarget extends java.lang.object Target. Definisce l'interfaccia dell'adapter ClassificaERicercaAdapter. E' anche parte del pattern Bridge e fa da "Implementor" per la classe AbstractionRicerca. Version: 0.9 Author: Giuseppe Calè Field Summary AbstractionRicerca abstractionricerca ClassificaERicercaFacade classificaericercafacade Constructor Summary ClassificaERicercaTarget() Method Summary java.lang.string[] cerca(java.lang.string nome) ricerca semplice per nome void cercacategoria(java.lang.string categoria) ricerca semplice per categoria java.lang.string[] cercagruppo(java.lang.string gruppo) ricerca semplice per gruppo java.lang.string[] cercatipo(java.lang.string tipo) ricerca semplice per tipo 15

17 java.lang.string[] listacategorie() lista delle categorie presenti nel sistema java.lang.string[] listagruppi(java.lang.string nomeutente) lista dei gruppi a cui un utente appartiene java.lang.string[] listatipo() lista dei tipi presenti nel sistema Methods inherited from class java.lang.object clone, equals, finalize, getclass, hashcode, notify, notifyall, tostring, wait, wait, wait Field Detail abstractionricerca public AbstractionRicerca abstractionricerca classificaericercafacade public ClassificaERicercaFacade classificaericercafacade Constructor Detail ClassificaERicercaTarget public ClassificaERicercaTarget() Method Detail cerca public java.lang.string[] cerca(java.lang.string nome) ricerca semplice per nome nome - nome documento un'array di riferimenti ai documenti trovati cercacategoria public void cercacategoria(java.lang.string categoria) ricerca semplice per categoria 16

18 categoria - nome categoria cercatipo public java.lang.string[] cercatipo(java.lang.string tipo) ricerca semplice per tipo tipo - tipo documento un'array di riferimenti ai documenti trovati cercagruppo public java.lang.string[] cercagruppo(java.lang.string gruppo) ricerca semplice per gruppo gruppo - nome del gruppo o archivio un'array di riferimenti ai documenti trovati listacategorie public java.lang.string[] listacategorie() lista delle categorie presenti nel sistema lista delle categorie listatipo public java.lang.string[] listatipo() lista dei tipi presenti nel sistema lista dei tipi di documenti listagruppi public java.lang.string[] listagruppi(java.lang.string nomeutente) 17

19 lista dei gruppi a cui un utente appartiene nomeutente - nome utente lista dei a cui appartiene l'utente Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS SUMMARY: NESTED FIELD CONSTR METHOD FRAMES NO FRAMES All Classes All Classes DETAIL: FIELD CONSTR METHOD 18

20 4 Scheletro delle classi del package ClassificaERicerca 4.1 Scheletro della classe AbstractionRicerca package ClassificaERicerca; / Abstraction del Pattern Bridge. Definisce l'interfaccia dell'abstraction. E' utilizzata direttamente dal Facade Attilio Giuseppe 0.9 / public abstract class AbstractionRicerca { / <p>ricerca semplice per nome utilizzando il metodo cerca() di nome nome array di riferimento ai documenti trovati / public String[] cercanome(string nome) { / <p>ricerca per nome e categoria utilizzando il metodo cercacategaria() e cerca() di nome nome categoria categoria array di riferimenti ai documenti trovati / public String[] cercanomecategoria(string nome, String categoria) { / <p>ricerca avanzata per nome, categoria, gruppo e tipo utilizzando i metodi cerca(), cercacategoria(), cercatipo() e cercagruppo() di nome nome categoria categoria tipo tipo gruppo tipo array di riferimenti ai docuementi trovati / public String[] cercaavanzato(string nome, String categoria, String tipo, String gruppo) { 19

21 / <p>costruttore della classe</p> / public void abstractionricerca() { / / public ClassificaERicerca.ClassificaERicercaTarget classificaericercatarget; / / public ClassificaERicerca.ClassificaERicercaFacade classificaericercafacade; 20

22 4.2 Scheletro della classe ClassificaERicercaAdapter package ClassificaERicerca; / Adapter. Adatta l'interfaccia di ClassificaERicerca all'interfaccia Attilio 0.9 / public class ClassificaERicercaAdapter extends ClassificaERicerca.ClassificaERicercaTarget { / / public ClassificaERicerca.Documento documento; / <p>ricerca per nome nome nome array riferimento ai documenti trovati / public String[] cerca(string nome) { / <p>ricerca per categoria di categoria categoria del array di riferimenti ai documenti trovati / public String[] cercacategoria(string categoria) { / <p>ricerca per tipo di tipo tipo array di riferimenti ai documenti trovati / public String[] cercatipo(string tipo) { / <p>ricerca dei documenti appartenenti ad un gruppo</p> 21

23 @param gruppo nome array di riferimenti ai documenti trovati / public String[] cercagruppo(string gruppo) { / <p>serve per avere la lista delle categorie presenti nel la lista delle categorie presenti nel sistema / public String[] listacategorie() { / <p>serve ad ottenere la lista dei tipi di documenti presenti nel la lista dei tipi presenti nel sistema / public String[] listatipo() { / <p>serve ad ottenere la lista dei gruppi a cui appartiene nomeutente nome dell'utente di cui si vuole conoscere i gruppi a cui lista dei gruppi a cui appartiene l'utente / public String[] listagruppi(string nomeutente) { / <p>costruttore di default</p> / public void ClassificaERIcercaAdapter() { / <p>costruttore con l' Adaptee come adaptee oggetto che viene adattato al sistema / public void ClassificaERicercaAdapter(ClassificaERicerca.ClassificaERicerca adaptee) { 22

24 / / public ClassificaERicerca.ClassificaERicerca classificaericerca; 23

25 4.3 Scheletro della classe ClassificaERicercaFacade package ClassificaERicerca; / Facade. Assegna le richieste del client alle appropriate classi del Giuseppe Calè e Attilio 1.01 / public class ClassificaERicercaFacade { / <p>ricerca semplice per nome nome nome del documento da un'array di riferimenti ai documenti trovati / public String[] cerca(string nome) { / <p>ricerca semplice per nome e nome nome del documento da categoria categoria del documento da un'array di riferimenti ai documenti trovati / public String[] cercanomecategoria(string nome, String categoria) { / <p>ricerca avanzata per nome, categoria, tipo e gruppo di nome nome categoria categoria tipo tipo del gruppo gruppo a cui appartiene il un'array di riferimenti ai documenti trovati / public String[] cercaavanzata(string nome, String categoria, String tipo, String gruppo) { / <p>ricerca per nome e nome nome del gruppo gruppo a cui appartiene il documento 24

26 @return un'array di riferimenti ai documenti trovati / public String[] cercanomegruppo(string nome, String gruppo) { / <p>ritorna la lista delle categorie presenti nel lista di tutte le categorie / public String[] listacategorie() { / <p>ritorna la lista dei tipi presenti nel lista di tutti i tipi di documento / public String[] listatipo() { / <p>ritorna la lista dei gruppi a cui appartienen l'utente che richiede la nomeutente nome lista dei gruppi a cui appartiene l'utente / public String[] listagruppi(string nomeutente) { / <p>costruttore di default</p> / public void ClassificaERicercaFacade() { / / public ClassificaERicerca.AbstractionRicerca abstractionricerca; / 25

27 / public ClassificaERicerca.ClassificaERicercaTarget classificaericercatarget; 26

28 4.4 Scheletro della classe ClassificaERicercaTarget package ClassificaERicerca; / Target. Definisce l'interfaccia dell'adapter ClassificaERicercaAdapter. E' anche parte del pattern Bridge e fa da "Implementor" per la classe Giuseppe 0.9 / public class ClassificaERicercaTarget { / <p>ricerca semplice per nome nome un'array di riferimenti ai documenti trovati / public String[] cerca(string nome) { / <p>ricerca semplice per categoria nome categoria / public void cercacategoria(string categoria) { / <p>ricerca semplice per tipo tipo un'array di riferimenti ai documenti trovati / public String[] cercatipo(string tipo) { / <p>ricerca semplice per gruppo nome del gruppo o un'array di riferimenti ai documenti trovati / public String[] cercagruppo(string gruppo) { 27

29 / <p>lista delle categorie presenti nel lista delle categorie / public String[] listacategorie() { / <p>lista dei tipi presenti nel lista dei tipi di documenti / public String[] listatipo() { / <p>lista dei gruppi a cui un utente nomeutente nome lista dei a cui appartiene l'utente / public String[] listagruppi(string nomeutente) { / / public ClassificaERicerca.AbstractionRicerca abstractionricerca; / / public ClassificaERicerca.ClassificaERicercaFacade classificaericercafacade; 28