12
Package oracle.xml.async

This chapter describes package oracle.xml.async, which encapsulates the XML Parser for Java DOMParser class with a bean interface and extends its functionality to enable asynchronous parsing. It is part of Oracle XML Transviewer Beans that are provided as part of XDK for Java Beans. XML Transviewer Beans facilitate the addition of graphical or visual interfaces to your XML applications.

This chaper contains these sections:

• Package oracle.xml.async Description
• Package oracle.xml.async Summary

---

Package oracle.xml.async Description

Package oracle.xml.async implements a non-visual bean, DOMBuilder bean, which builds a DOM tree from an XML document.

The DOMBuilder bean encapsulates the XML Parser for Java DOMParser class with a bean interface and extends its functionality to enable asynchronous parsing. By registering a listener, Java applications can parse large documents or successive instances of documents and then allow control to return immediately to the caller.

It enables asynchronous DOM parsing in separate threads in the background. It utilizes the EventHandler interface to notify the calling class when the job is complete.

Information about developing applications using Oracle XML Transviewer Java Beans is available in Oracle9i XML Developer's Kits Guide - XDK.

---

Package oracle.xml.async Summary

Table 12-1  Class summary for oracle.xml.async

Class	Description
DOMBuilder	Encapsulates an eXtensible Markup Language (XML) 1.0 parser to parse an XML document and build a DOM tree.
DOMBuilderBeanInfo	Provides information about the DOMBuilder Bean.
DOMBuilderErrorEvent	Defines the error event which is sent when parse exception occurs.
DOMBuilderErrorListener	Implemented in order to receive notifications when error is found during parsing.
DOMBuilderEvent	Event object that DOMBuilder uses to notify all registered listeners about parse events.
DOMBuilderListener	Implemented in order to receive notifications about events during the asyncronous parsing.
ResourceManager	No description.
XSLTransformer	Applies XSL transformation in a background thread.
XSLTransformerBeanInfo	Provides information about the XSLTransformer Bean.
XSLTransformerErrorEvent	Error event object that XSLTransformer uses to notify all registered listeners about transformation error events.
XSLTransformerErrorListener	This interface must be implemented in order to receive notifications when an error is found during parsing.
XSLTransformerEvent	Provides information about the XSLTransformer Bean.
XSLTransformerListener	Implemented in order to receive notifications about events during the asynchronous transformation.

---

DOMBuilder

Syntax

public class DOMBuilder extends java.lang.Object implements 
java.io.Serializable, oracle.xml.async.DOMBuilderConstants, java.lang.Runnable
 
java.lang.Object
  |
  +--oracle.xml.async.DOMBuilder

All Implemented Interfaces

oracle.xml.async.DOMBuilderConstants, java.lang.Runnable, java.io.Serializable

Description

This class encapsulates an eXtensible Markup Language (XML) 1.0 parser to parse an XML document and build a DOM tree. The parsing is done in a separate thread and DOMBuilderListener interface must be used for notification when the tree is built.

---

Fields

inSource

protected org.xml.sax.InputSource inSource

InputSource containing XML data to parse

inStream

protected java.io.InputStream inStream

InputStream containing XML data to parse

inString

protected java.lang.String inString

String containing the URL to parse XML data from

methodToCall

protected int methodToCall

XML Parser method to call based on input types

reader

protected java.io.Reader reader

java.io.Reader containing XML data to be parsed

result

protected oracle.xml.async.XMLDocument result

XML Document being parsed

rootName

protected java.lang.String rootName

Name of the XML element to be treated as root

url

protected java.net.URL url

URL to parse XML data from

---

Constructors

DOMBuilder()

public  DOMBuilder()

Creates a new parser object.

DOMBuilder(int)

public  DOMBuilder(int id)

Creates a new parser object with a given id.

Parameters

id - The DOMBuilder id.

---

Methods

addDOMBuilderErrorListener(DOMBuilderErrorListener)

public void addDOMBuilderErrorListener(DOMBuilderErrorListener p0)

Adds DOMBuilderErrorListener

Parameters

p1 - The DOMBuilderErrorListener to add

addDOMBuilderListener(DOMBuilderListener)

public void addDOMBuilderListener(DOMBuilderListener p0)

Adds DOMBuilderListener

Parameters

p1 - The DOMBuilderListener to add

getDoctype()

public synchronized oracle.xml.async.DTD getDoctype()

Get the DTD

Returns

The DTD

getDocument()

public synchronized oracle.xml.async.XMLDocument getDocument()

Gets the document

Returns

The document being parsed

getId()

public int getId()

Returns the parser object id.

Returns

The DOMBuilder id

getReleaseVersion()

public synchronized java.lang.String getReleaseVersion()

Returns the release version of the Oracle XML Parser

Returns

the release version string

getResult()

public synchronized org.w3c.dom.Document getResult()

Gets the document

Returns

The document being parsed

getValidationMode()

public synchronized boolean getValidationMode()

Returns the validation mode

Returns

true if the XML parser is validating false if not

parse(InputSource)

public final synchronized void parse(org.xml.sax.InputSource in)

Parses the XML from given input source

Parameters

in - the org.xml.sax.InputSouce to parse

Throws

XMLParseException - if syntax or other error encountered.

SAXException - Any SAX exception, possibly wrapping another exception.

IOException - IO Error.

parse(InputStream)

public final synchronized void parse(java.io.InputStream in)

Parses the XML from given input stream. The base URL should be set for resolving external entities and DTD.

Parameters

in - the InputStream containing XML data to parse.

Throws

XMLParseException - if syntax or other error encountered.

SAXException - Any SAX exception, possibly wrapping another exception.

IOException - IO Error.

See Also

oracle.xml.parser.v2.XMLParser

parse(Reader)

public final synchronized void parse(java.io.Reader r)

Parses the XML from given input stream. The base URL should be set for resolving external entities and DTD.

Parameters

r - the Reader containing XML data to parse.

Throws

XMLParseException - if syntax or other error encountered.

SAXException - Any SAX exception, possibly wrapping another exception.

IOException - IO Error.

See Also

oracle.xml.parser.v2.XMLParser

parse(String)

public final synchronized void parse(java.lang.String in)

Parses the XML from the URL indicated

Parameters

in - the String containing the URL to parse from

Throws

XMLParseException - if syntax or other error encountered.

SAXException - Any SAX exception, possibly wrapping another exception.

IOException - IO Error.

parse(URL)

public final synchronized void parse(java.net.URL url)

Parses the XML document pointed to by the given URL and creates the corresponding XML document hierarchy.

Parameters

url - the url points to the XML document to parse.

Throws

XMLParseException - if syntax or other error encountered.

SAXException - Any SAX exception, possibly wrapping another exception.

IOException - IO Error.

parseDTD(InputSource, String)

public final synchronized void parseDTD(org.xml.sax.InputSource in, 
java.lang.String rootName)

Parses the XML External DTD from given input source

Parameters

in - the org.xml.sax.InputSouce to parse

rootName - the element to be used as root Element

Throws

XMLParseException - if syntax or other error encountered.

SAXException - Any SAX exception, possibly wrapping another exception.

IOException - IO Error.

parseDTD(InputStream, String)

public final synchronized void parseDTD(java.io.InputStream in, java.lang.String 
rootName)

Parses the XML External DTD from given input stream. The base URL should be set for resolving external entities and DTD.

Parameters

in - the InputStream containing XML data to parse.

rootName - the element to be used as root Element

Throws

XMLParseException - if syntax or other error encountered.

SAXException - Any SAX exception, possibly wrapping another exception.

IOException - IO Error.

See Also

oracle.xml.parser.v2.XMLParser

parseDTD(Reader, String)

public final synchronized void parseDTD(java.io.Reader r, java.lang.String 
rootName)

Parses the XML External DTD from given input stream. The base URL should be set for resolving external entities and DTD.

Parameters

r - the Reader containing XML data to parse.

rootName - the element to be used as root Element

Throws

XMLParseException - if syntax or other error encountered.

SAXException - Any SAX exception, possibly wrapping another exception.

IOException - IO Error.

See Also

oracle.xml.parser.v2.XMLParser

parseDTD(String, String)

public final synchronized void parseDTD(java.lang.String in, java.lang.String 
rootName)

Parses the XML External DTD from the URL indicated

Parameters

in - the String containing the URL to parse from

rootName - the element to be used as root Element

Throws

XMLParseException - if syntax or other error encountered.

SAXException - Any SAX exception, possibly wrapping another exception.

IOException - IO Error.

parseDTD(URL, String)

public final synchronized void parseDTD(java.net.URL url, java.lang.String 
rootName)

Parses the XML External DTD document pointed to by the given URL and creates the corresponding XML document hierarchy.

Parameters

url - the url points to the XML document to parse.

rootName - the element to be used as root Element

Throws

XMLParseException - if syntax or other error encountered.

SAXException - Any SAX exception, possibly wrapping another exception.

IOException - IO Error.

removeDOMBuilderErrorListener(DOMBuilderErrorListener)

public synchronized void removeDOMBuilderErrorListener(DOMBuilderErrorListener 
p0)

Remove DOMBuilderErrorListener

Parameters

p1 - The DOMBuilderErrorListener to remove

removeDOMBuilderListener(DOMBuilderListener)

public synchronized void removeDOMBuilderListener(DOMBuilderListener p0)

Remove DOMBuilderListener

Parameters

p1 - The DOMBuilderListener to remove

run()

public void run()

This method runs in a thread

Specified By

java.lang.Runnable.run() in interface java.lang.Runnable

setBaseURL(URL)

public synchronized void setBaseURL(java.net.URL url)

Set the base URL for loading external enitites and DTDs. This method should to be called if the parse(InputStream) is used to parse the XML Document

Parameters

url - The base URL

setDebugMode(boolean)

public void setDebugMode(boolean flag)

Sets a flag to turn on debug information in the document

Parameters

flag - determines whether debug info is stored

setDoctype(DTD)

public synchronized void setDoctype(oracle.xml.async.DTD dtd)

Set the DTD

Parameters

dtd - DTD to set and used while parsing

setErrorStream(OutputStream)

public final synchronized void setErrorStream(java.io.OutputStream out)

Creates an output stream for the output of errors and warnings. If an output stream for errors is not specified, the parser will use the standard error output stream System.err for outputting errors and warnings.

Parameters

out - The output stream to use for errors and warnings

setErrorStream(OutputStream, String)

public final synchronized void setErrorStream(java.io.OutputStream out, 
java.lang.String enc)

Creates an output stream for the output of errors and warnings. If an output stream for errors is not specified, the parser will use the standard error output stream System.err for outputting errors and warnings. Additionally, an .exception is thrown if the encoding specified is unsupported.

Parameters

out - The output stream to use for errors and warnings

enc - the encoding to use

Throws

IOException - if an unsupported encoding is specified

setErrorStream(PrintWriter)

public final synchronized void setErrorStream(java.io.PrintWriter out)

Creates an output stream for the output of errors and warnings. If an output stream for errors is not specified, the parser will use the standard error output stream System.err for outputting errors and warnings.

Parameters

out - The PrintWriter to use for errors and warnings

setNodeFactory(NodeFactory)

public synchronized void setNodeFactory(oracle.xml.async.NodeFactory factory)

Set the node factory. Applications can extend the NodeFactory and register it through this method. The parser will then use the user supplied NodeFactory to create nodes of the DOM tree.

Parameters

factory - The NodeFactory to set

Throws

XMLParseException - if an invalid factory is set

See Also

NodeFactory

setPreserveWhitespace(boolean)

public synchronized void setPreserveWhitespace(boolean flag)

Set the white space preserving mode

Parameters

flag - preserving mode

setValidationMode(boolean)

public synchronized void setValidationMode(boolean yes)

Set the validation mode

Parameters

yes - determines whether the XML parser should be validating

showWarnings(boolean)

public synchronized void showWarnings(boolean yes)

Switch to determine whether to print warnings

Parameters

yes - determines whether warnings should be shown

---

DOMBuilderBeanInfo

Syntax

public class DOMBuilderBeanInfo extends java.beans.SimpleBeanInfo
 
java.lang.Object
  |
  +--java.beans.SimpleBeanInfo
        |
        +--oracle.xml.async.DOMBuilderBeanInfo

All Implemented Interfaces

java.beans.BeanInfo

Description

This class provides information about the DOMBuilder Bean.

---

Constructors

DOMBuilderBeanInfo()

public  DOMBuilderBeanInfo()

The default Constructor

---

Methods

getIcon(int)

public java.awt.Image getIcon(int iconKind)

Gets an image object that can be used to represent DOMBuilder bean in toolbars, toolboxes, etc.

Overrides:

java.beans.SimpleBeanInfo.getIcon(int) in class java.beans.SimpleBeanInfo

Parameters

iconKind - The kind of icon requested.

Returns

An image object representing the requested icon type for DOMBuilder bean.

getPropertyDescriptors()

public java.beans.PropertyDescriptor[] getPropertyDescriptors()

Gets the DOMBuilder bean's PropertyDescriptors

Overrides:

java.beans.SimpleBeanInfo.getPropertyDescriptors() in class java.beans.SimpleBeanInfo

Returns

An array of PropertyDescriptors describing the editable properties supported by DOMBuilder bean.

---

DOMBuilderErrorEvent

Syntax

public class DOMBuilderErrorEvent extends java.util.EventObject
 
java.lang.Object
  |
  +--java.util.EventObject
        |
        +--oracle.xml.async.DOMBuilderErrorEvent

All Implemented Interfaces

java.io.Serializable

Description

This class defines the error event which is sent when parse exception occurs.

Fields

protected java.lang.Exception e

The exception being raised.

---

Constructors

DOMBuilderErrorEvent(Object, Exception)

public  DOMBuilderErrorEvent(java.lang.Object p0, java.lang.Exception e)

Constructor for DOMBuilderErrorEvent.

Parameters

p0 - The Object that created this event.

e - The Exception raised.

---

Methods

getException()

public java.lang.Exception getException()

Gets the Exception

Returns

The Exception beind raised

getMessage()

public java.lang.String getMessage()

Returns the error message generated by the parser

Returns

The error message string

---

DOMBuilderErrorListener

Syntax

public interface DOMBuilderErrorListener extends java.util.EventListener

All Superinterfaces

java.util.EventListener

Description

This interface must be implemented in order to receive notifications when error is found during parsing. The class implementing this interface must be added to the DOMBuilder using addDOMBuilderErrorListener method.

---

Methods

domBuilderErrorCalled(DOMBuilderErrorEvent)

public void domBuilderErrorCalled(DOMBuilderErrorEvent p0)

This method is called when a parse error occurs.

Parameters

p0 - The DOMBuilderErrorEvent object produced by the DOMBuilder as result of parsing error

---

DOMBuilderEvent

Syntax

public class DOMBuilderEvent extends java.util.EventObject
 
java.lang.Object
  |
  +--java.util.EventObject
        |
        +--oracle.xml.async.DOMBuilderEvent

All Implemented Interfaces

java.io.Serializable

Description

The event object that DOMBuilder uses to notify all registered listeners about parse events.

Fields

id

protected int id

ID of the source DOMBuilder object

---

Constructors

DOMBuilderEvent(Object, int)

public  DOMBuilderEvent(java.lang.Object p0, int p1)

Creates a new DOMBuilderEvent

Parameters

p0 - The Object creating this event.

p1 - Id of the DOMBuilder creating this event.

---

Methods

getID()

public int getID()

Returns unique id of the DOMBuilder object which can be used to identify which instance of the DOMBuilder generated this event in cases where multiple instances of DOMBuilder may be working in background.

Returns

The unique id of the source DOMBuilder for this event.

---

DOMBuilderListener

Syntax

public interface DOMBuilderListener extends java.util.EventListener

All Superinterfaces

java.util.EventListener

Description

This interface must be implemented in order to receive notifications about events during the asyncronous parsing. The class implementing this interface must be added to the DOMBuilder using addDOMBuilderListener method.

---

Methods

domBuilderError(DOMBuilderEvent)

public void domBuilderError(DOMBuilderEvent p0)

This method is called when parse error occur.

Parameters

p0 - - The DOMBuilderEvent object produced by the DOMBuilder

domBuilderOver(DOMBuilderEvent)

public void domBuilderOver(DOMBuilderEvent p0)

This method is called when the parse is complete

Parameters

p0 - - The DOMBuilderEvent object produced by the DOMBuilder

domBuilderStarted(DOMBuilderEvent)

public void domBuilderStarted(DOMBuilderEvent p0)

This method is called when parse starts

Parameters

p0 - - The DOMBuilderEvent object produced by the DOMBuilder

---

ResourceManager

Syntax

public class ResourceManager extends java.lang.Object
 
java.lang.Object
  |
  +--oracle.xml.async.ResourceManager

---

Constructors

ResourceManager(int)

public  ResourceManager(int i)

The ResourceManager constructor

Parameters

i - - the number of resources to manage

---

Methods

activeFound()

public boolean activeFound()

Checks if any of the logical resources being managed are in active use

Returns

true - if one or more resource is in use false - if none of the resources are in use

getResource()

public synchronized void getResource()

If the number of resources available for use is nonzero, the method decreases the number of resources by one. Otherwise, it waits until a resource is released & it becomes available for use.

releaseResource()

public void releaseResource()

Releases a resource. When this method is called, the number of resources avialable is increased by one.

sleep(int)

public void sleep(int i)

Allows usage of Thread.sleep() without try/catch

---

XSLTransformer

Syntax

public class XSLTransformer extends java.lang.Object implements 
java.io.Serializable, oracle.xml.async.XSLTransformerConstants, 
java.lang.Runnable
 
java.lang.Object
  |
  +--oracle.xml.async.XSLTransformer

All Implemented Interfaces

java.lang.Runnable, java.io.Serializable, 
oracle.xml.async.XSLTransformerConstants

Description

Applies XSL transformation in a background thread.

Fields

methodToCall

protected int methodToCall

The XSL transformation method to call based on input types.

result

protected oracle.xml.async.DocumentFragment result

Transformation result document.

---

Constructors

XSLTransformer()

public  XSLTransformer()

XSLTransformer constructor

XSLTransformer(int)

public  XSLTransformer(int id)

XSLTransformer constructor accepting an identifier

Parameters

id - - A unique integer that can be used to identify the XSLTransformer instance during event processing

---

Methods

addXSLTransformerErrorListener(XSLTransformerErrorListener)

public void addXSLTransformerErrorListener(XSLTransformerErrorListener p0)

Adds an XSLTransformer error event listener

Parameters

p0 - XSLTransformerErrorListener to be added

addXSLTransformerListener(XSLTransformerListener)

public void addXSLTransformerListener(XSLTransformerListener p0)

Adds a XSLTransformer listener

Parameters

p0 - XSLTransformerListener to be added

getId()

public int getId()

Returns the unique XSLTransformer id

Returns

The id of this XSLTransformer.

getResult()

public synchronized oracle.xml.async.DocumentFragment getResult()

Returns the document fragment for the resulting document. Call this method only after receiving notification that the transformation is complete. Since the transformation occurs in background and asyncronously, calling this method immediately after processXSL will result in holding the control until the result is avialable.

Returns

The resulting document fragment of the XSL transformation.

processXSL(XSLStylesheet, InputStream, URL)

public void processXSL(oracle.xml.async.XSLStylesheet xsl, java.io.InputStream 
xml, java.net.URL ref)

Initiates XSL Transformation in the background. The control is returned immediately.

Parameters

xsl - The stylesheet to be used for XSL transformation

xml - The XML document to be used (as a java.io.InputStream)

ref - Reference URL to resolve external entities in input XML

Throws

XSLException - if an error occurs during XSL transformation

processXSL(XSLStylesheet, Reader, URL)

public void processXSL(oracle.xml.async.XSLStylesheet xsl, java.io.Reader xml, 
java.net.URL ref)

Initiates XSL Transformation in the background. The control is returned immediately.

Parameters

xsl - The stylesheet to be used for XSL transformation

xml - The XML document to be used (as a java.io.Reader)

ref - Reference URL to resolve external entities in input XML

Throws

XSLException - if an error occurs during XSL transformation

processXSL(XSLStylesheet, URL, URL)

public void processXSL(oracle.xml.async.XSLStylesheet xsl, java.net.URL xml, 
java.net.URL ref)

Initiates XSL Transformation in the background. The control is returned immediately.

Parameters

xsl - The stylesheet to be used for XSL transformation

xml - The XML document to be used (as a java.net.URL)

ref - Reference URL to resolve external entities in input XML

Throws

XSLException - if an error occurs during XSL transformation

processXSL(XSLStylesheet, XMLDocument)

public void processXSL(oracle.xml.async.XSLStylesheet xsl, 
oracle.xml.async.XMLDocument xml)

Initiates XSL Transformation in the background. The control is returned immediately.

Parameters

xsl - The stylesheet to be used for XSL transformation

xml - The XML document to be used (as a DOM Tree)

Throws

XSLException - if an error occurs during XSL transformation

processXSL(XSLStylesheet, XMLDocument, OutputStream)

public void processXSL(oracle.xml.async.XSLStylesheet xsl, 
oracle.xml.async.XMLDocument xml, java.io.OutputStream os)

Initiates XSL Transformation in the background. The control is returned immediately.

Parameters

xsl - The stylesheet to be used for XSL transformation

xml - The XML document to be used (as a DOM Tree)

os - Outputstream to which the XSL transformation result is written

Throws

XSLException - if an error occurs during XSL transformation

removeDOMTransformerErrorListener(XSLTransformerErrorListener)

public synchronized void 
removeDOMTransformerErrorListener(XSLTransformerErrorListener p0)

Removes an XSLTransformer error event listener

Parameters

p0 - XSLTransformerErrorListener to be removed

removeXSLTransformerListener(XSLTransformerListener)

public synchronized void removeXSLTransformerListener(XSLTransformerListener p0)

Removes a XSLTransformer listener

Parameters

p0 - XSLTransformerListener to be removed

run()

public void run()

Starts a separate thread to do the XSL Transformation.

Specified By

java.lang.Runnable.run() in interface java.lang.Runnable

setErrorStream(OutputStream)

public final void setErrorStream(java.io.OutputStream out)

Sets the error stream used by the XSL processor

Parameters

out - The error output stream for the XSL processor

showWarnings(boolean)

public final void showWarnings(boolean yes)

Sets the showWarnings flag used by the XSL processor

Parameters

yes - Boolean indicating if XSL processor warnings to be shown or not.

---

XSLTransformerBeanInfo

Syntax

public class XSLTransformerBeanInfo extends java.beans.SimpleBeanInfo
 
java.lang.Object
  |
  +--java.beans.SimpleBeanInfo
        |
        +--oracle.xml.async.XSLTransformerBeanInfo

All Implemented Interfaces

java.beans.BeanInfo

Description

This class provides information about the XSLTransformer Bean.

---

Constructors

XSLTransformerBeanInfo()

public  XSLTransformerBeanInfo()

The default Constructor

---

Methods

getIcon(int)

public java.awt.Image getIcon(int iconKind)

Gets an image object that can be used to represent XSLTransformer bean in toolbars, toolboxes, etc.

Overrides:

java.beans.SimpleBeanInfo.getIcon(int) in class java.beans.SimpleBeanInfo

Parameters

iconKind - The kind of icon requested.

Returns

An image object representing the requested icon type for XSLTransformer bean.

getPropertyDescriptors()

public java.beans.PropertyDescriptor[] getPropertyDescriptors()

Gets the XSLTransformer bean's PropertyDescriptors

Overrides:

java.beans.SimpleBeanInfo.getPropertyDescriptors() in class java.beans.SimpleBeanInfo

Returns

An array of PropertyDescriptors describing the editable properties supported by XSLTransformer bean.

---

XSLTransformerErrorEvent

Syntax

public class XSLTransformerErrorEvent extends java.util.EventObject
 
java.lang.Object
  |
  +--java.util.EventObject
        |
        +--oracle.xml.async.XSLTransformerErrorEvent

All Implemented Interfaces

java.io.Serializable

Description

The error event object that XSLTransformer uses to notify all registered listeners about transformation error events.

Fields

protected java.lang.Exception e

The exception being raised.

---

Constructors

XSLTransformerErrorEvent(Object, Exception)

public  XSLTransformerErrorEvent(java.lang.Object p0, java.lang.Exception e)

Constructor for XSLTransformerErrorEvent.

Parameters

p0 - The Object that created this event

e - The Exception raised.

---

Methods

getException()

public java.lang.Exception getException()

Returns the exception that XSLTransformer encountered object unique id. Can be used to

Returns

The transformation exception

getMessage()

public java.lang.String getMessage()

Returns the error message that describes the error that XSLTransformer encountered

Returns

The error message

---

XSLTransformerErrorListener

Syntax

public interface XSLTransformerErrorListener extends java.util.EventListener

All Superinterfaces

java.util.EventListener

Description

This interface must be implemented in order to receive notifications about error events during the asynchronous transformation. The class implementing this interface must be added to the XSLTransformer using addXSLTransformerListener method.

---

Methods

xslTransformerErrorCalled(XSLTransformerErrorEvent)

public void xslTransformerErrorCalled(XSLTransformerErrorEvent p0)

This method is called when parse or transformation error occurs.

Parameters

p0 - - The XSLTransformerErrorEvent object produced by the XSLTransformer

---

XSLTransformerEvent

Syntax

public class XSLTransformerEvent extends java.util.EventObject
 
java.lang.Object
  |
  +--java.util.EventObject
        |
        +--oracle.xml.async.XSLTransformerEvent

All Implemented Interfaces

java.io.Serializable

Fields

id

protected int id

ID of the source XSLTransformer object

---

Constructors

XSLTransformerEvent(Object, int)

public  XSLTransformerEvent(java.lang.Object p0, int p1)

Constructs the XSLTransformerEvent object using the XSLTransformer source object and its unique id.

Parameters

p0 - The source XSLTransformer object that will fire the events

p1 - Unique id identifying the source object

---

Methods

getID()

public int getID()

Returns unique id of the XSLTransformer object which can be used to identify which instance of the XSLTransformer generated this event in cases where multiple instances of XSLTransformer may be working in background.

Returns

The unique id of the source XSLTransformer object for this event object.

---

XSLTransformerListener

Syntax

public interface XSLTransformerListener extends java.util.EventListener

All Superinterfaces

java.util.EventListener

Description

This interface must be implemented in order to receive notifications about events during the asynchronous transformation. The class implementing this interface must be added to the XSLTransformer using addXSLTransformerListener method.

---

Methods

xslTransformerError(XSLTransformerEvent)

public void xslTransformerError(XSLTransformerEvent p0)

This method is called when parse or transformation error occur.

Parameters

p0 - - The XSLTransformerEvent object produced by the XSLTransformer

xslTransformerOver(XSLTransformerEvent)

public void xslTransformerOver(XSLTransformerEvent p0)

This method is called when the transformation is complete

Parameters

p0 - - The XSLTransformerEvent object produced by the XSLTransformer

xslTransformerStarted(XSLTransformerEvent)

public void xslTransformerStarted(XSLTransformerEvent p0)

This method is called when the transformation starts

Parameters

p0 - - The XSLTransformerEvent object produced by the XSLTransformer.