5. Utilizzo delle Classi Java.

Attualmente sono supportate tre classi principali definite nelle sezioni CGI, Email e HTML. Sto considerando di aggiungere le classi per trattare l'input e l'output MIME-formatted rispettivamente con MIMEin & MIMEout.

Esistono anche classi di supporto e di test definite nelle sezioni CGI_Test, Email_Test e HTML_Test. L'utilizzo di queste classi è stato concepito con lo scopo di testare la vostra installazione. Ciononostante possono essere utilizzate come punto di partenza per i vostri programmi in Java che fanno uso di questa libreria di classi. La classe descritta nella sezione Text è la superclasse per entrambe le classi Email e HTML.

5.1 CGI

Sintassi della Classe

public class CGI

Descrizione della Classe

La classe CGI mantiene la variabile d'ambiente ``CGI Information'' impostata dal server web e il nome/valore inviato da un form quando si decide di selezionare l'azione submit. Tutte le informazioni sono memorizzate in un oggetto della classe Properties.

Questa classe è nel pacchetto ``Orbits.net''.

Sommario dei membri della Classe

        CGI()         //  Costruttore.
        getNames()    //  Prende la lista di nomi.
        getValue()    //  Prende il valore del form specificando il nome.

Vedi Anche

CGI_Test.

CGI()

Obiettivo

Costruisce un oggetto che contiene i dati CGI disponibili.

Sintassi

public CGI()

Descrizione

Quando viene costruito un oggetto CGI, tutte le informazioni disponibili vengono assorbite ed immagazzinate localmente al nuovo oggetto.

getNames()

Obiettivo

Lista i nomi che sono definiti per avere valori corrispondenti.

Sintassi

public Enumeration getKeys ()

Descrizione

Fornisce la lista intera di nome per i quali sono definiti valori corrispondenti.

Restituisce

Una Enumerazione di tutti i nomi definiti.

getValue()

Obiettivo

Ricerca i valori associati al nome specificato.

Sintassi

public String getValue ( String name )

Descrizione

Questo metodo fornisce una corrispondenza tra nomi e valori inviati da un form HTML.

Parametri

name

La chiave con la quale i valori vengono selezionati.

Restituisce

Una Stringa che contiene il valore.

5.2 CGI_Test

Questa classe fornisce un esempio di come usare la classe CGI ed anche un programma di test che può essere usato per avere la conferma che il pacchetto Java CGI funzioni correttamente.

Sommario dei membri della Classe

        main()      //  Programma main().

Vedi Anche

CGI.

main()

Obiettivo

Fornire un metodo main().

Sintassi

public static void main( String argv[] )

Descrizione

Questo è il punto di ingresso del programma CGI che restituisce una lista delle coppie nomi/valori disponibili e il loro valore attuale.

Parametri

argv[]

Argomenti passati al programma dallo script java.cgi. Attualmente inutilizzato.

5.3 Email

Sintassi della Classe

public class Email extends Text

Descrizione della Classe

I Messaggi sono costruiti con la classe Text e i metodi add*() e i metodi specifici e-mail-specific aggiunti a da questa classe. Quando completo, il messaggio viene inviato ai suoi destinatari.

Questa classe è contenuta nel pacchetto ``Orbits.net''.

Sommario dei membri della Classe

        Email()      //  Costruttore.
        send()       //  Invia un messaggio e-mail.
        sendTo()     //  Aggiunge un destinatario al messaggio.
        subject()    //  Imposta il Subject del messaggio.

Vedi Anche

Email_Test, Text.

Email()

Obiettivo

Costruisce un oggetto che conterrà un messaggio email.

Sintassi

public Email()

Descrizione

Costruisce un messaggio vuoto da completare da parte dei metodi Email.

Vedi Anche

Text.

send()

Obiettivo

Invia un messaggio e-mail.

Sintassi

public void send ()

Descrizione

Formatta ed invia il messaggio. Se non viene specificato un indirizzo di destinazione, non viene intrapresa alcuna azione.

sendTo()

Obiettivo

Aggiunge una destinazione per questo messaggio.

Sintassi

public String sendTo ( String address )

Descrizione

Aggiunge address alla lista delle destinazioni per questo metodo. Non esiste limite al numero di destinatari che un messaggio e-mail può avere. Sono sicuro che costruendo una lista abbastanza grande, potreste fare in modo da superare la memoria oppure eccedere la dimensione della lista di parametri che il vostro Agente di Trasporto della Posta è in grado di accettare.

Parametri

address

Una destinazione a cui inviare il messaggio.

subject()

Obiettivo

Imposta l'oggetto/subject per questo messaggio.

Sintassi

public void subject ( String subject )

Descrizione

Questo metodo imposta il testo per la riga Subject: di un messaggio email. Se vengono chiamati più di una volta, viene utilizzato il subject più recente.

Parametri

subject

Il testo della riga Subject: del messaggio.

5.4 Email_Test

Questa classe fornisce sia un esempio di come utilizzare la classe Email sia un programma di test per verificare che il pacchetto Java CGI funzioni correttamente.

Sommario dei membri della Classe

        main()      //  Programma main().

Vedi Anche

Email.

main()

Obiettivo

Fornisce un metodo main().

Sintassi

public static void main( String argv[] )

Descrizione

Questo è il punto di ingresso del programma CGI che restituisce una lista delle coppie nomi/valori disponibili e il loro valore attuale. Invierà anche questa lista agli indirizzi specificati nella variabile Email.

Parametri

argv[]

Argomenti passati al programma dallo script java.cgi. Attualmente inutilizzato.

5.5 HTML

Sintassi della Classe

public class HTML extends Text

Descrizione della Classe

I Messaggi vengono costruiti con i metodi Text class add*() e dai metodi specifici-HTML aggiunti da questa classe. Quando completo, il messaggio viene inviato alle sue destinazioni.

Attualmente non esiste un controllo di errore per avere la conferma che i metodi di costruzione delle liste siano usati nell'ordine corretto: il programmatore deve prestare attenzione a non violare la sintassi HTML.

Questa classe è nel pacchetto ``Orbits.net''.

Sommario dei membri della Classe

    HTML()                //  Costruttore.
    author()              //  Imposta il nome dell'autore del documento.
    definitionList()      //  Avvia una definition list.
    definitionListTerm()  //  Aggiunge un termine ad una definition list.
    endList()             //  Termina una lista.
    listItem()            //  Aggiunge una entrata ad una lista.
    send()                //  Invia un messaggio HTML.
    title()               //  Imposta il testo per il titolo del documento.

Vedi Anche

HTML_Test, Text.

HTML()

Obiettivo

Costruisce un oggetto che contiene un messaggio HTML.

Sintassi

public HTML()

Descrizione

Costruisce un messaggio vuoto da completare con i metodi HTML.

Vedi Anche

Text.

author()

Obiettivo

Imposta il nome dell'autore del documento.

Sintassi

public void author ( String author )

Descrizione

Imposta il nome dell'autore del documento in author.

Parametri

author

Il testo da usare come autore di questo messaggio.

Vedi Anche

title().

definitionList()

Obiettivo

Avvia una definition list.

Sintassi

public void definitionList ()

Descrizione

Avvia una definition list. Una definition list è una particolare lista per la quale ogni elemento di ingresso della lista è term seguito dalla definizione text per quel termine. L'avvio di una definition list dovrebbe essere seguito dalla creazione di almeno un termine/testo e una chiamata al metodo endList(). Da notare che, attualmente, le liste non possono essere nidificate

Vedi Anche

definitionListTerm(), endList(), listItem().

definitionListTerm()

Obiettivo

Aggiunge un termine alla definition list.

Sintassi

public void definitionListTerm ()

Descrizione

Aggiunge un termine alla definition list. Il testo dell'elemento lista corrente deve essere appeso al messaggio dopo che questo metodo viene chiamato e prima di un corrispondente metodo listItem venga chiamato.

Vedi Anche

definitionList(), listItem().

endList()

Obiettivo

Termina una lista.

Sintassi

public void endList ()

Descrizione

Termina una lista. Questo metodo elimina una lista. Da notare che al momento attuale, le liste non possono essere nidificate.

Vedi Anche

definitionList().

listItem()

Obiettivo

Aggiunge una voce nella lista.

Sintassi

public void listItem ()

public void listItem ( String item )

public boolean listItem ( String term, String item )

Descrizione

Aggiunge una voce alla lista. Se viene usato il primo form, il testo dell'elemento lista corrente deve essere accodato al messaggio dopo che questo metodo viene chiamato e prima che venga chiamata ogni altra lista di metodi. Nel secondo e terzo form, il testo item è specificato come un parametro al metodo invece di (o in aggiunta) essere accodato al messaggio. Il terzo form è specifico per le definition lists e fornisce sia i termini che una definizione dell'ingresso della lista.

Parametri

item

Il testo di questo ingresso di lista.

term

Il testo di questa parte del termine di ingresso della definition list.

Vedi Anche

definitionList(), definitionListTerm(), endList().

send()

Obiettivo

Invia un messaggio HTML.

Sintassi

public void send ()

Descrizione

Invia un messaggio HTML.

title()

Obiettivo

Imposta il testo per il titolo del documento.

Sintassi

public void title ( String title )

Descrizione

Imposta il testo per il titolo del documento.

Parametri

title

Il testo del titolo del documento.

Vedi Anche

author().

5.6 HTML_Test

Questa classe fornisce sia un esempio di come usare la classe HTML sia un programma di test che può essere usato per avere la conferma che il pacchetto Java CGI funzioni correttamente.

Sommario dei membri della Classe

        main()      //  Programma main().

Vedi Anche

HTML.

main()

Obiettivo

Fornire un metodo main().

Sintassi

public static void main( String argv[] )

Descrizione

Questo è il punto di ingresso del programma CGI che restituisce una lista delle coppie nomi/valori disponibili e il loro valore attuale.

Parametri

argv[]

Argomenti passati al programma dallo java.cgi. Attualmente inutilizzato.

5.7 Text

Sintassi delle Classi

public abstract class Text

Descrizione delle Classi

Questa classe è la superclasse delle classi Email e HTML. I Messaggi sono costruiti con i metodi di questa classe poi completati e formattati con i metodi delle sottoclassi.

Questa classe è contenuta nel pacchetto ``Orbits.text''.

Member Summary

        Text()            //  Costruttore.
        add()             //  Aggiunge testo a questo oggetto.
        addLineBreak()    //  Aggiunge un terminatore di riga.
        addParagraph()    //  Aggiunge un terminatore di paragrafo.

Vedi Anche

Email, HTML.

add()

Obiettivo

Aggiunge del testo a questo elemento.

Sintassi

public void add ( char addition )

public void add ( String addition )

public void add ( StringBuffer addition )

Descrizione

Aggiunge addition ai contenuti di questo elemento di testo.

Parameter

addition

Testo da aggiungere all'elemento di testo.

Vedi Anche

addLineBreak(), addParagraph().

addLineBreak()

Obiettivo

Forza una terminazione di riga nel punto esatto del testo.

Sintassi

public void addLineBreak ()

Descrizione

Aggiunge una terminazione di riga al testo nel punto attuale.

Vedi Anche

add(), addParagraph().

addParagraph()

Obiettivo

Comincia un nuovo paragrafo.

Sintassi

public void add ()

Descrizione

Cominicia un nuovo paragrafo in questo punto del testo.

Vedi Anche

add(), addLineBreak().

Hosting by: hurra.com
Generated: 2007-01-26 17:56:18