XML-SQL Utility (XSU) Specifications and Cheat Sheets, 4 of 5

XML-SQL Utility (XSU) for Java Cheat Sheets

Table G-2, Table G-3, and Table G-4 list the XML-SQL Utility (XSU) for Java cheat sheets for the top level classes.

Table G-2 OracleXMLSave()

Member Summary
Fields
DATE_FORMAT	date format for use in setDateFormat(String)
DEFAULT_BATCH_SIZE	default insert batch size is 17
Constructors
OracleXMLSave(Connection, String)	The public constructor for OracleXMLSave utility
Methods
close()	It closes/deallocates all the context associated with this object.
deleteXML(Document)	Deletes records from the db. object corresponding to the records in an XML doc.
deleteXML(InputStream)	Deletes records from the db. object corresponding to the records in an XML doc.
Deletes records from the db. object corresponding to the records in an XML doc.	Deletes records from the db. object corresponding to the records in an XML doc.
deleteXML(URL)	Deletes records from the db. object corresponding to the records in an XML doc.
insertXML(Document)	Inserts an XML document into a specified table. Returns the number of rows processed.
insertXML(InputStream)	Inserts an XML document into a specified table. Returns the number of rows processed.
insertXML(String)	Inserts an XML document into a specified table. Returns the number of rows processed.
insertXML(URL)	Inserts an XML document into a specified table. Returns the number of rows processed.
setBatchSize(int)	This call changes the batch size used during DML operations.
setCommitBatch(int)	Sets the commit batch size.
setDateFormat(String)	Sets the format of the date tags.
setIgnoreCase(boolean)	Used to tell XSU to ignores the case of the tag names when matching them with the column names of the table/view.
setKeyColumnList(String[])	Sets the list of columns to be used for identifying a particular row in the database table during update or delete.
setRowTag(String)	Names the tag used in the XML doc., to enclose the XML elements corresponding to each row value..
setUpdateColumnList(String[])	Set the column values to be updated.
updateXML(Document)	Updates the table given the XML document.
updateXML(InputStream)	Updates the table given the XML document.
updateXML(String)	Updates the table given the XML document.
updateXML(URL)	Updates the table given the XML document.

Table G-3 OracleXMLQuery()

Member Summary	Description
Fields
DTD	The DTD is used to specified that the DTD is to be generated
ERROR_TAG	The ERROR_TAG specifies the default tag name for the ERROR document
MAXROWS_ALL	The MAXROWS_NONE specifies that all rows be included in the result
NONE	The NONE is used to specified that no DTD is to be generated
ROW_TAG	The ROW_TAG specifies the default tag name for the ROW elements
ROWIDATTR_TAG	The ROWIDATTR_TAG specifies the default tag name for the ROW elements
ROWSET_TAG	The ROWSET_TAG specifies the default tag name for the document
SKIPROWS_ALL	The SKIPROWS_ALL specifies that all rows be skipped in the result.
Constructors
OracleXMLQuery(Connection, ResultSet)	Constructor for the OracleXMLQueryObject.
OracleXMLQuery(Connection, String)	Constructor for the OracleXMLQueryObject.
OracleXMLQuery(OracleXMLDataSet)	Constructor for the OracleXMLQueryObject.
Methods
close()	Close any open resource.
getXMLDOM()	getXMLDOM returns a DOM representation of the XML document using the OracleXMLDocGenDOM class to generate the DOM tree
getXMLDOM(Node)	The root node is also passed in.
getXMLDOM(Node, int)	This method returns a Document object containing the XML doc.
getXMLMetaData(int, boolean)	This functions returns the DTD for the XML document which would have been generated by a getXML call.
getXMLString()	getXMLString returns a string representation of the XML document using the OracleXMLDocGenString class to create the string; generates no DTD.
getXMLString(int)	getXMLString returns a string representation of the XML document using the OracleXMLDocGenString class to create the string.
getXMLString(Node)	All the children created are appended to this root node.
getXMLString(Node, int)	This method returns a String object containing the XML doc.
keepObjectOpen(boolean)	The default behavior for all the getXML functions which DO NOT TAKE in a ResultSet object is to close the ResultSet object and Statement objects at the end of the call; this method allows for change of this behaviour. This is very useful when retreiving few records at a time because it preserves all the metadata.
setCollIdAttrName(String)
setDataHeader(Reader, String)	Sets the XML data header.
setDateFormat(String)	Sets the format of the generated dates in the XML doc.
setEncoding(String)	Sets the encoding PI (processing instruction) in the XML doc.
setErrorTag(String)	setErrorTag sets the name of the error tag (default "ERROR") in case an error is raised.
setException(Exception)	Allows the user to pass in an exception, and have the XSU handle it.
setMaxRows(int)	This sets the maximum number of rows to be retreived from the query result after "skipRows" number of rows are skipped You can use one of MAXROWS_NONE, MAXROWS_ALL, MAXROWS_DEFAULT
setMetaHeader(Reader)	Sets the XML meta header.
setRaiseException(boolean)	setRaiseException function when called with the value true, will raise exceptions such as no-data found, instead of returning a NULL row out.
setRaiseNoRowsException(boolean)	Tells the XSU to throw or not to throw an OracleXMLNoRowsException in the case when for one reason or another, the XML doc generated is empty.
setRowIdAttrName(String)	Sets the name of the id attribute of the row enclosing tag.
setRowIdAttrValue(String)	Specifies the scalar column whose value is to be assigned to the id attribute of the row enclosing tag.
setRowsetTag(String)	Sets the tag to be used to enclose the xml dataset.
setRowTag(String)	Sets the tag to be used to enclose the xml element corresponding to a db.
setSkipRows(int)	Sets the number of rows to skip.
setStylesheetHeader(String)	Sets the stylesheet header (i.e. stylesheet processing instructions) in the generated XML doc.
setStylesheetHeader(String, String)	Sets the stylesheet header (i.e. stylesheet processing instructions) in the generated XML doc.
setXSLT(Reader, String)	Sets the stylesheet to be applied during XML generation.
setXSLT(String, String)	Sets the stylesheet to be applied during XML generation.
useLowerCaseTagNames()	This will set the case to be lower for all tag names.
useNullAttributeIndicator(boolean)	Specified weather to use an XML attribute to indicate NULLness; or to do it by omitting the inclusion of the particular entity in the XML document.
useUpperCaseTagNames()	This will set the case to be upper for all tag names.

Member Summary Description

Constructors

OracleXMLSQLException(Exception)

OracleXMLSQLException(Exception, String)

OracleXMLSQLException(String)

OracleXMLSQLException(String, Exception)

OracleXMLSQLException(String, Exception, String)

OracleXMLSQLException(String, int)

OracleXMLSQLException(String, int, String)

OracleXMLSQLException(String, String)

Methods

getErrorCode()

getParentException()

returns the original exception, if there was one; otherwise, it returns null

getXMLErrorString()

prints the XML error string with the given error tag name

getXMLSQLErrorString()

prints the SQL parameters as well in the error message

setErrorTag(String)

Sets the error tag name which is then used by getXMLErrorString and getXMLSQLErrorString, to generate xml error reports

Member Summary	Description
Constructors
OracleXMLSQLException(Exception)
OracleXMLSQLException(Exception, String)
OracleXMLSQLException(String)
OracleXMLSQLException(String, Exception)
OracleXMLSQLException(String, Exception, String)
OracleXMLSQLException(String, int)
OracleXMLSQLException(String, int, String)
OracleXMLSQLException(String, String)
Methods
getErrorCode()
getParentException()	returns the original exception, if there was one; otherwise, it returns null
getXMLErrorString()	prints the XML error string with the given error tag name
getXMLSQLErrorString()	prints the SQL parameters as well in the error message
setErrorTag(String)	Sets the error tag name which is then used by getXMLErrorString and getXMLSQLErrorString, to generate xml error reports