java.lang.Object com.ibm.etools.sqltoxml.SQLToXML
public class SQLToXML extends java.lang.Object
Questa classe fornisce i metodi utilizzati dalle applicazioni (ad esempio la procedura guidata Da SQL a XML) per eseguire le query del database. Il risultato della query viene visualizzato in formato XML. Facoltativamente, possono essere generati DTD, schema XML e file XSL del risultato corrispondenti.
Costruttore | Descrizione |
---|---|
SQLToXML(QueryProperties) | L'unico costruttore. |
Metodo | Descrizione |
---|---|
void execute() | Esegue una query basata sulle informazioni di QueryProperties fornite come argomento del costruttore. |
void execute(PrintWriter, , String, PrintWriter) Obsoleto. | Esegue una query basata sulle informazioni di QueryProperties, i risultati vengono scritti in PrintWriter, nei file o in entrambi. |
void execute(String, PrintWriter, String, String, PrintWriter) Obsoleto. | Esegue una query basata sulle informazioni di QueryProperties, i risultati vengono scritti in PrintWriter, nei file o in entrambi. |
void execute(String, String, String, String) Obsoleto. | Esegue una query basata sulle informazioni di QueryProperties, i risultati vengono scritti nei file. |
void finalize() | Chiude la connessione, se creata da SQLToXML. |
Connection getConnection() | Restituisce una connessione al database. |
Document getCurrentDocument() | Restituisce il documento XML che rappresenta il risultato della chiamata più recente al metodo execute(). |
Document[] getCurrentDocuments() | Restituisce una matrice dei documenti XML che rappresenta il risultato della chiamata più recente al metodo execute(). |
String getDTDFile() | Restituisce il nome file DTD corrente da generare. |
String getNextAllQuery() | Restituisce una stringa di query valida. |
Vector getNextQueries() | Restituisce una sequenza di stringhe di query valide. |
String getParameters() | Restituisce i valori dei parametri per la proposizione where. |
String getXMLFile() | Restituisce il nome file XML corrente da generare. |
PrintWriter getXMLWriter() | Restituisce il PrintWriter corrente per l'output XML. |
String getXSDFile() | Restituisce il nome file dello schema XML corrente da generare. |
String getXSLFile() | Restituisce il nome file XSL corrente da generare. |
PrintWriter getXSLWriter() | Restituisce il PrintWriter corrente per l'output XSL. |
void setConnection(Connection) | Fornisce una connessione JDBC da utilizzare per la generazione dei file XML. |
void setDTDFile(String) | Imposta il nome file DTD da generare. |
void setGenDocType(Boolean) Obsoleto. | Controlla se generare o meno un file di schema DTD o XML per scopi di convalida. |
void setIndenting(Boolean) | Attiva e disattiva il rientro. |
void setMaxRows(int) | Imposta su max il limite per il numero massimo di righe da richiamare nel file XML generato. |
void setParameters(String) | Imposta i valori dei parametri per la proposizione where. |
void setQueryProperties(QueryProperties) | Sovrascrive il valore queryProperties corrente. |
void setXMLFile(String) | Imposta il nome file XML da generare. |
void setXMLWriter(String) | Imposta il PrintWriter a cui è indirizzato il file XML generato. |
void setXSDFile(String) | Imposta il nome file dello schema XML da generare. |
void setXSLFile(String) | Imposta il nome file XSL da generare. |
void setXSLWriter(String) | Imposta il PrintWriter a cui è indirizzato il file XSL generato. |
Metodi ereditati dalla classe java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public void execute() throws java.lang.Exception
Esegue una query basata sulle informazioni di QueryProperties fornite come argomento del costruttore. Le risorse che possono essere generate includono file XML, schema XML, file DTD e file XSL. Per generare risorse diverse da XML, prima di utilizzare questo metodo devono essere forniti nomi file o PrintWriter utilizzando accessor di insiemi rilevanti. Inoltre, l'output XML può essere ottenuto come documento DOM mediante la chiamata del metodo getCurrentDocument() o getCurrentDocuments().
Rimandi: java.lang.Exception - Restituisce un'eccezione quando l'esecuzione non riesce
public void execute(PrintWriter xml, String dtdfile, String xsdfile, PrintWriter xsl) throws Exception
Obsoleto. Esegue una query basata sulle informazioni di QueryProperties, i risultati vengono scritti in PrintWriter e/o nei file. Quando un argomento diverso da 'xml' è null, nessun risultato viene generato per quel particolare argomento. Inoltre, se vengono specificati i file dtdfile e xsdfile, viene generato solo il file xsdfile.
public void execute(String params, PrintWriter xml, String dtdfile, String xsdfile, PrintWriter xsl) throws Exception
Obsoleto. Esegue una query basata sulle informazioni di QueryProperties, i risultati vengono scritti in PrintWriter e/o nei file. Quando un argomento diverso da 'xml' è null, nessun risultato viene generato per quel particolare argomento. Inoltre, se vengono specificati i file dtdfile e xsdfile, viene generato solo il file xsdfile. Questo metodo viene utilizzato quando la query contiene una proposizione where e i vincoli sono forniti nell'argomento String 'params'. I parametri dei vincoli sono delimitati nell'argomento mediante una virgola (,).
public void execute(String xmlfile, String dtdfile, String xsdfile, String xslfile) throws Exception
Obsoleto. Esegue una query basata sulle informazioni di QueryProperties, i risultati vengono scritti nei file. Quando un argomento diverso da 'xml' è null, nessun risultato viene generato per quel particolare argomento. Inoltre, se vengono specificati i file dtdfile e xsdfile, viene generato solo il file xsdfile.
public void finalize()
Chiude la connessione, se creata da SQLToXML. Se la connessione è stata fornita esternamente (utilizzando setConnection()), non viene chiusa. Questo metodo viene richiamato da JVM quando SQLToXML è garbage-collected.
public Connection getConnection() throws Exception
Restituisce una connessione al database.Se non esiste alcuna connessione, questo metodo crea una nuova connessione utilizzando i valori di QueryProperties.
public Document getCurrentDocument()
Restituisce il documento XML che rappresenta il risultato della chiamata più recente al metodo execute(). Se viene utilizzato GENERATE_ID_AND_IDREF con l'opzione RECURSIVE, viene restituito il documento XML principale.
public Document[] getCurrentDocuments()
Restituisce una matrice dei documenti XML che rappresenta il risultato della chiamata più recente al metodo execute(). A meno che non venga utilizzato GENERATE_ID_AND_IDREF con l'opzione RECURSIVE, il risultato contiene un unico documento.
public java.lang.String getDTDFile()
Restituisce il nome file DTD corrente da generare.
public String getNextAllQuery()
Restituisce una stringa di query valida. Questo metodo restituisce una stringa di query valida solo nei seguenti casi
1) L'opzione del formato è ID_AND_IDREF 2) L'opzione di ricorsione è 'TRUE'Ad esempio, quando una colonna della query corrente è una chiave esterna rispetto alla colonna di chiavi primarie della tabella A, viene restituita la stringa 'select * from A'. Per un utilizzo tipico di questo metodo, fare riferimento al servlet di esempio XMLIntegratorServlet.java.
public Vector getNextQueries()
Restituisce una sequenza di stringhe di query valide. Questo metodo restituisce un Vector di stringhe di query valide solo nei seguenti casi
1) L'opzione del formato è ID_AND_IDREF 2) L'opzione di ricorsione è 'TRUE'Ad esempio, quando una colonna della query corrente è una chiave esterna rispetto all'ID della colonna di chiavi primarie (con valore 123) della tabella A, viene restituita la stringa 'select * from A where ID = 123'. Per un utilizzo tipico di questo metodo, fare riferimento al servlet di esempio XMLIntegratorServlet.java.
public java.lang.String getParameters()
Restituisce i valori dei parametri per la proposizione where.
public java.lang.String getXMLFile()
Restituisce il nome file XML corrente da generare.
public java.io.PrintWriter getXMLWriter()
Restituisce il PrintWriter corrente per l'output XML.
public java.lang.String getXSDFile()
Restituisce il nome file dello schema XML corrente da generare.
public java.lang.String getXSLFile()
Restituisce il nome file XSL corrente da generare.
public java.io.PrintWriter getXSLWriter()
Restituisce il PrintWriter corrente per l'output XSL.
public void setConnection(Connection jdbcConnection)
Fornisce una connessione JDBC da utilizzare per la generazione dei file XML. Questo metodo risulta utile quando in un programma applicativo si desidera utilizzare il meccanismo di gestione delle connessioni, ad esempio il pool di connessioni. Se questo metodo non viene richiamato prima di uno dei metodi execute(), SQLToXML crea la connessione utilizzando i valori di QueryProperties.
public void setDTDFile(java.lang.String filename) throws java.lang.Exception
Imposta il nome file DTD da generare. Questo metodo non può essere utilizzato insieme a setXSDFile(String).
public void setGenDocType(Boolean value)
Obsoleto. Controlla se generare o meno un file di schema DTD o XML per scopi di convalida. Per impostazione predefinita, il valore è impostato su true per il periodo di sviluppo e su false per il periodo di runtime. Se si imposta il valore su true per le applicazioni di runtime, ad esempio i servlet, possono verificarsi peggioramenti nelle prestazioni.
public void setIndenting(Boolean flag)
Attiva e disattiva il rientro. Per impostazione predefinita, il rientro è attivo.
public void setMaxRows(int max)
Imposta su max il limite per il numero massimo di righe da richiamare nel file XML generato. Per impostazione predefinita, non esiste alcun limite.
public void setParameters(java.lang.String parameters)
select * from EMPLOYEE where EMP_NO = :empnoNell'esempio in alto, il valore da sostituire per :empno viene fornito nell'argomento dei parametri. Se esistono più valori di vincoli, tali valori sono delimitati nei parametri mediante virgola (,), come nel seguente esempio.
String params = "87316,'Toronto'"; sqltoxml.setParameters(params);
public void setQueryProperties(QueryProperties qProperties)
Sovrascrive il valore queryProperties corrente.
public void setXMLFile(java.lang.String filename) throws java.lang.Exception
Imposta il nome file XML da generare. Questo metodo non può essere utilizzato insieme a setXMLWriter(PrintWriter).
public void setXMLWriter(java.io.PrintWriter writer) throws java.lang.Exception
Imposta il PrintWriter a cui è indirizzato il file XML generato. Questo metodo non può essere utilizzato insieme a setXMLFile(String).
public void setXSDFile(java.lang.String filename) throws java.lang.Exception
Imposta il nome file dello schema XML da generare. Questo metodo non può essere utilizzato insieme a setDTDFile(String).
public void setXSLFile(java.lang.String filename) throws java.lang.Exception
Imposta il nome file XSL da generare. Questo metodo non può essere utilizzato insieme a setXSLWriter(PrintWriter).
public void setXSLWriter(java.io.PrintWriter writer) throws java.lang.Exception
Imposta il PrintWriter a cui è indirizzato il file XSL generato. Questo metodo non può essere utilizzato insieme a setXSLFile(String).