oracle.xml.xmlcomp
Class XMLCompress

java.lang.Object
  |
  +--oracle.xml.xmlcomp.XMLCompress

All Implemented Interfaces:

java.io.Serializable

public class XMLCompress

extends java.lang.Object

implements java.io.Serializable

This bean class is a simple encapsulation of the XML Compression functionality. The functionalities that are supported in this class are essentially Compression of the internal DOM tree obtained via a DOMParser, Compression of the SAX events thrown by the SAX Parser, Uncompression of the serialized XML data, returning an XMLDocument object. The input for compression can be from an InputStream, a java String, a database CLOB object, an XMLType object. In all cases the outputStream has to be set before hand so that the compressed data is written to it. The case where input data is unparsed the parsing for it is done with no validation.To use different parsing options parse the document before inputting and then pass the XMLDocument object to the compressor bean. The compression factor is a rough value based on the file size of the input XML file and the compressed file. The limitation of the compression factor method is it can only be used when the compression is done using the "java.io.File" objects as parameters.

See Also:

Serialized Form

XMLCompress

public XMLCompress()

Constructs this object by setting the various parameter

setBinOutputStream

public void setBinOutputStream(java.io.OutputStream binstr)

Sets the Binary outputstream to write the compressed data

Returns:

none

setBinInputStream

public void setBinInputStream(java.io.InputStream binstr)

Sets the Binary inputstream to write the compressed data

Returns:

none

setXmlTextOutputStream

public void setXmlTextOutputStream(java.io.OutputStream txtstr)

Sets the Text outputstream to write the XML data

Returns:

none

setXmlTextInputStream

public void setXmlTextInputStream(java.io.InputStream txtstr)

Sets the Text Inputstream to compress the data

Returns:

none

getXMLDocument

public XMLDocument getXMLDocument()

Returns the XMLDocument object obtained from compressed data

Returns:

XMLDocument object

setXMLDocument

public void setXMLDocument(XMLDocument setDoc)

Sets the XMLDocument object that needs to be Compressed

Returns:

none

DOMCompress

public void DOMCompress()
                 throws XMLParseException,
SAXException,
                        java.io.IOException

Compress the XML Data set in the Text InputStream of this object and writes the compressed data into the binary outputstream

Returns:

none

Throws:

XMLParseException, - SAXException, IOException

XMLParseException

SAXException

java.io.IOException

DOMCompress

public void DOMCompress(java.io.InputStream is)
                 throws XMLParseException,
SAXException,
                        java.io.IOException

Compress the XML Data set in the Text InputStream and writes the compressed data into the binary outputstream

Returns:

none

Throws:

XMLParseException, - SAXException, IOException

XMLParseException

SAXException

java.io.IOException

DOMCompress

public void DOMCompress(XMLDocument xmldoc)
                 throws java.io.IOException

Compress the XMLDocument object and writes the compressed data into the binary outputstream of this object

Returns:

none

Throws:

java.io.IOException

DOMCompress

public void DOMCompress(java.lang.String xmldoc)
                 throws XMLParseException,
SAXException,
                        java.io.IOException

Compress the xml data contained in the java String and writes the compressed data into the binary outputstream of this object

Returns:

none

Throws:

java.io.IOException

XMLParseException

SAXException

DOMCompress

public void DOMCompress(oracle.sql.CLOB clob)
                 throws XMLParseException,
SAXException,
                        java.io.IOException,
                        java.sql.SQLException

Compress the xml data contained in the CLOB object and writes the compressed data into the binary outputstream of this object

Returns:

none

Throws:

java.io.IOException

XMLParseException

SAXException

java.sql.SQLException

DOMCompress

public void DOMCompress(XMLType xmldoc)
                 throws java.io.IOException,
XMLParseException,
SAXException,
                        java.sql.SQLException

Compress the xml data contained in the database XMLType object and writes the compressed data into the binary outputstream of this object

Returns:

none

Throws:

IOException,XMLParseException,SAXException,SQLException

java.io.IOException

XMLParseException

SAXException

java.sql.SQLException

DOMCompress

public void DOMCompress(java.io.File inpTxtfile,
                        java.io.File outpBinfile)
                 throws java.io.IOException,
XMLParseException,
SAXException,
                        java.sql.SQLException

Compress the xml data contained in the inpTxtfile and writes the compressed ouput to outpBinfile

Returns:

none

Throws:

IOException,XMLParseException,SAXException,SQLException

java.io.IOException

XMLParseException

SAXException

java.sql.SQLException

DOMExpand

public void DOMExpand()
               throws java.io.IOException,
                      java.io.EOFException,
                      java.lang.ClassNotFoundException

Uncompresses the binary inputstream and populates the XMLDocument of this object.

Returns:

none

Throws:

IOException,EOFException,ClassNotFoundException

java.io.IOException

java.io.EOFException

java.lang.ClassNotFoundException

DOMExpand

public void DOMExpand(java.io.InputStream inpstr)
               throws java.io.IOException,
                      java.io.EOFException,
                      java.lang.ClassNotFoundException

Uncompresses the binary inputstream parameter and populates the XMLDocument of this object.

Returns:

none

Throws:

IOException,EOFException,ClassNotFoundException

java.io.IOException

java.io.EOFException

java.lang.ClassNotFoundException

DOMExpand

public void DOMExpand(oracle.sql.BLOB blob)
               throws java.sql.SQLException,
                      java.io.IOException,
                      java.io.EOFException,
                      java.lang.ClassNotFoundException

Uncompresses the BLOB parameter and populates the XMLDocument of this object.

Returns:

none

Throws:

SQLException,IOException,EOFException,ClassNotFoundException

java.sql.SQLException

java.io.IOException

java.io.EOFException

java.lang.ClassNotFoundException

DOMExpand

public void DOMExpand(java.io.File inpBinfile,
                      java.io.File outpTxtfile)
               throws java.io.IOException,
XMLParseException,
                      java.sql.SQLException,
                      java.lang.ClassNotFoundException

UnCompress the data contained in the inpBinfile and writes the compressed ouput to outpTxtfile

Returns:

none

Throws:

IOException,XMLParseException,SAXException,SQLException

java.io.IOException

XMLParseException

java.sql.SQLException

java.lang.ClassNotFoundException

SAXCompress

public void SAXCompress(java.io.InputStream xmltext)
                 throws SAXException,
XMLParseException,
                        java.io.IOException

Compress the XML data in the Inputstream to a binary stream which contains the SAX events

Returns:

none

Throws:

SAXException,XMLParseException,IOException

SAXException

XMLParseException

java.io.IOException

SAXCompress

public void SAXCompress(java.io.File inpTxtfile,
                        java.io.File outpBinfile)
                 throws java.io.IOException,
XMLParseException,
SAXException

Compress the xml data contained in the inpTxtfile and writes the compressed ouput to outpBinfile

Returns:

none

Throws:

IOException,XMLParseException,SAXException,SQLException

java.io.IOException

XMLParseException

SAXException

SAXCompress

public void SAXCompress(java.lang.String xmltext)
                 throws SAXException,
XMLParseException,
                        java.io.IOException

Compress the XML data in the String to a binary stream which contains the SAX events

Returns:

none

Throws:

SAXException,XMLParseException,IOException

SAXException

XMLParseException

java.io.IOException

getCompPercent

public float getCompPercent()

Return the compression factor. This can be used only when the compression is done using Java File objects as Inputs

Returns:

float , compression factor