java.lang.Object com.ibm.etools.sqltoxml.SQLToXML
public class SQLToXML extends java.lang.Object
這個類別提供了一些方法,供應用程式(如「SQL 至 XML」精靈)用來執行資料庫查詢。 取得的查詢結果採用 XML 格式。它也可以選擇性地產生結果的對應 DTD、XML 綱目和 XSL 檔。
建構子 | 說明 |
---|---|
SQLToXML(QueryProperties) | 這是唯一建構子。 |
方法 | 說明 |
---|---|
void execute() | 根據提供作為建構子引數的 QueryProperties 所提供的資訊來執行查詢。 |
void execute(PrintWriter, , String, PrintWriter) 已棄用。 | 根據 QueryProperties 所提供的資訊來執行查詢,且結果會寫入 PrintWriters 和/或檔案中。 |
void execute (String, PrintWriter, String, String, PrintWriter) 已棄用。 | 根據 QueryProperties 所提供的資訊來執行查詢,且結果會寫入 PrintWriters 和/或檔案中。 |
void execute (String, String, String, String) 已棄用。 | 根據 QueryProperties 所提供的資訊來執行查詢,且結果會寫入檔案中。 |
void finalize() | 如果這是 SQLToXML 所建立的,就關閉連線。 |
Connection getConnection() | 傳回資料庫連線。 |
Document getCurrentDocument() | 傳回最後一次呼叫 execute() 方法之結果的 XML 文件。 |
Document[] getCurrentDocuments() | 傳回最後一次呼叫 execute() 方法之結果的 XML 文件陣列。 |
String getDTDFile() | 傳回要產生的現行 DTD 檔案名稱。 |
String getNextAllQuery() | 傳回有效的查詢字串。 |
Vector getNextQueries() | 傳回一列有效的查詢字串。 |
String getParameters() | 傳回 where 子句的參數值。 |
String getXMLFile() | 傳回要產生的現行 XML 檔案名稱。 |
PrintWriter getXMLWriter() | 傳回用於 XML 輸出的現行 PrintWriter。 |
String getXSDFile() | 傳回要產生的現行 XML 綱目檔名稱。 |
String getXSLFile() | 傳回要產生的現行 XSL 檔案名稱。 |
PrintWriter getXSLWriter() | 傳回用於 XSL 輸出的現行 PrintWriter。 |
void setConnection(Connection) | 提供要用來產生 XML 檔的 JDBC 連線。 |
void setDTDFile(String) | 設定要產生的 DTD 檔案名稱。 |
void setGenDocType(Boolean) 已棄用。 | 控制是否要產生 DTD 或 XML 綱目檔,供驗證之用。 |
void setIndenting(Boolean) | 設定開啟或關閉內縮。 |
void setMaxRows(int) | 將產生之 XML 中要擷取之最大列數的限制設為最大值。 |
void setParameters(String) | 設定 where 子句的參數值。 |
void setQueryProperties(QueryProperties) | 置換現行 queryProperties。 |
void setXMLFile(String) | 設定要產生的 XML 檔案名稱。 |
void setXMLWriter(String) | 設定產生之 XML 要導入的 PrintWriter。 |
void setXSDFile(String) | 設定要產生的 XML 綱目檔名稱。 |
void setXSLFile(String) | 設定要產生的 XSL 檔案名稱。 |
void setXSLWriter(String) | 設定產生之 XSL 要導入的 PrintWriter。 |
繼承自 java.lang.Object 類別的方法 |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
public void execute() throws java.lang.Exception
根據提供作為建構子引數的 QueryProperties 所提供的資訊來執行查詢。 可以產生的成品包括 XML、XML 綱目、DTD 和 XSL 檔。如果要產生 XML 以外的成品,在使用這個方法之前,您必須先利用相關的設定存取元提供檔案名稱或 PrintWriter。此外,XML 輸出也可以透過 getCurrentDocument() 或 getCurrentDocuments() 方法呼叫取得,作為 DOM 文件。
擲出:java.lang.Exception - 在執行失敗時擲出
public void execute(PrintWriter xml, String dtdfile, String xsdfile, PrintWriter xsl) throws Exception
已棄用。根據 QueryProperties 所提供的資訊來執行查詢,且結果會寫入 PrintWriters 和/或檔案中。當 'xml' 以外的任何引數是空值時,都不會產生這個特定引數的結果。另外,如果同時指定了 dtdfile 和 xsdfile,就只會產生 xsdfile。
public void execute(String params, PrintWriter xml, String dtdfile, String xsdfile, PrintWriter xsl) throws Exception
已棄用。根據 QueryProperties 所提供的資訊來執行查詢,且結果會寫入 PrintWriters 和/或檔案中。當 'xml' 以外的任何引數是空值時,都不會產生這個特定引數的結果。另外,如果指定了 dtdfile 和 xsdfile 兩者,就只會產生 xsdfile。 當查詢含有 where 子句且其限制是由 'params' 字串引數提供時,便會使用這個方法。這些限制參數在引數中會以逗點 (,) 區隔。
public void execute(String xmlfile, String dtdfile, String xsdfile, String xslfile) throws Exception
已棄用。根據 QueryProperties 所提供的資訊來執行查詢,且結果會寫入檔案中。當 'xml' 以外的任何引數是空值時,都不會產生這個特定引數的結果。另外,如果同時指定了 dtdfile 和 xsdfile,就只會產生 xsdfile。
public void finalize()
如果這是 SQLToXML 所建立的,就關閉連線。 如果是外部提供的連線(使用 setConnection()),就不會關閉連線。 這個方法是在執行 SQLToXML 的記憶體回收時,由 JVM 來呼叫的。
public Connection getConnection() throws Exception
傳回資料庫連線。如果沒有連線存在,這個方法會利用來自 QueryProperties 的值建立新連線。
public Document getCurrentDocument()
傳回最後一次呼叫 execute() 方法之結果的 XML 文件。如果您使用 GENERATE_ID_AND_IDREF 時帶有 RECURSIVE 選項,則會傳回主要的 XML 文件。
public Document[] getCurrentDocuments()
傳回最後一次呼叫 execute() 方法之結果的 XML 文件陣列。除非您使用 GENERATE_ID_AND_IDREF 時帶有 RECURSIVE 選項,否則結果僅會包含一個文件。
public java.lang.String getDTDFile()
傳回要產生的現行 DTD 檔案名稱。
public String getNextAllQuery()
傳回有效的查詢字串。這個方法只會在下列情況中傳回有效的查詢字串:
1) 格式選項是 ID_AND_IDREF;以及 2) 遞迴選項是 'TRUE'比方說,當現行查詢的直欄是 A 表格主鍵直欄的外來鍵時,這會傳回 'select * from A' 字串。 請參閱範例 Servlet XMLIntegratorServlet.java,以取得這個方法的典型用法。
public Vector getNextQueries()
傳回一列有效的查詢字串。這個方法只會在下列情況傳回有效查詢字串的 Vector:
1) 格式選項是 ID_AND_IDREF;以及 2) 遞迴選項是 'TRUE'比方說,當現行查詢的某直欄是表格 A 主鍵直欄 ID(值為 123)的外來鍵時,這會傳回字串 'select * from A where ID = 123'。 請參閱範例 Servlet XMLIntegratorServlet.java,以取得這個方法的典型用法。
public java.lang.String getParameters()
傳回 where 子句的參數值。
public java.lang.String getXMLFile()
傳回要產生的現行 XML 檔案名稱。
public java.io.PrintWriter getXMLWriter()
傳回用於 XML 輸出的現行 PrintWriter。
public java.lang.String getXSDFile()
傳回要產生的現行 XML 綱目檔名稱。
public java.lang.String getXSLFile()
傳回要產生的現行 XSL 檔案名稱。
public java.io.PrintWriter getXSLWriter()
傳回用於 XSL 輸出的現行 PrintWriter。
public void setConnection(Connection jdbcConnection)
提供要用來產生 XML 檔的 JDBC 連線。當應用程式要使用自己的連線管理機制(如連線儲存區)時,這個方法會很有用。如果這個方法未在任何 execute() 方法之前被呼叫,SQLToXML 會利用來自 QueryProperties 的值建立自己的連線。
public void setDTDFile(java.lang.String filename) throws java.lang.Exception
設定要產生的 DTD 檔案名稱。這個方法不可和 setXSDFile(String) 組合使用。
public void setGenDocType(Boolean value)
已棄用。控制是否要產生 DTD 或 XML 綱目檔來進行驗證。依預設,開發時期的值會設為 true,執行時期會設為 false。如果這個值對執行時期應用程式(如 Servlet)設為 true,將會降低部分效能。
public void setIndenting(Boolean flag)
設定開啟或關閉內縮。預設值為開啟內縮。
public void setMaxRows(int max)
將產生之 XML 中要擷取之最大列數的限制設為最大值。預設值是沒有限制。
public void setParameters(java.lang.String parameters)
select * from EMPLOYEE where EMP_NO = :empno在上述範例中,:empno 的取代值由參數引數提供。 如果有多個限制值,這些值在參數中會以逗號 (,) 區隔,如下列範例所示。
String params = "87316,'Toronto'"; sqltoxml.setParameters(params);
public void setQueryProperties(QueryProperties qProperties)
置換現行 queryProperties。
public void setXMLFile(java.lang.String filename) throws java.lang.Exception
設定要產生的 XML 檔案名稱。這個方法不可和 setXMLWriter(PrintWriter) 組合使用。
public void setXMLWriter(java.io.PrintWriter writer) throws java.lang.Exception
設定產生之 XML 要導入的 PrintWriter。這個方法不可和 setXMLFile(String) 組合使用。
public void setXSDFile(java.lang.String filename) throws java.lang.Exception
設定要產生的 XML 綱目檔名稱。這個方法不可和 setDTDFile(String) 組合使用。
public void setXSLFile(java.lang.String filename) throws java.lang.Exception
設定要產生的 XSL 檔案名稱。這個方法不可和 setXSLWriter(PrintWriter) 組合使用。
public void setXSLWriter(java.io.PrintWriter writer) throws java.lang.Exception
設定產生之 XSL 要導入的 PrintWriter。這個方法不可和 setXSLFile(String) 組合使用。