Oracle8i XML Reference Guide
Release 3 (8.1.7)

Part Number A83730-01

Library

Product

Contents

Index

Go to previous page Go to next page

4
Transviewer Beans

oracle.xml.async Package

Description

Class Summary 

 

Interfaces 

 

DOMBuilderErrorListener 

This interface must be implemented in order to receive notifications when error is found during parsing. 

DOMBuilderListener 

This interface must be implemented in order to receive notifications about events during the asyncronous parsing. 

XSLTransformerErrorListener 

This interface must be implemented in order to receive notifications about error events during the asyncronous transformation. 

XSLTransformerListener 

This interface must be implemented in order to receive notifications about events during the asyncronous transformation. 

Classes 

 

DOMBuilder 

This class implements an eXtensible Markup Language (XML) 1.0 parser according to the World Wide Web Consortium (W3C) recommendation. 

DOMBuilderBeanInfo 

 

DOMBuilderErrorEvent 

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

DOMBuilderEvent 

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

ResourceManager 

Simple semaphore that maintains access to fixed number of logical resources. 

XSLTransformer 

Applies XSL transformation in a background thread. 

XSLTransformerBeanInfo 

 

XSLTransformerErrorEvent 

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

XSLTransformerEvent  

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

oracle.xml.async


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 implements an eXtensible Markup Language (XML) 1.0 parser according to the World Wide Web Consortium (W3C) recommendation. to parse a 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.


Member Summary 

 

Constructors 

 

DOMBuilder() 

Creates a new parser object. 

Creates a new parser object. 

Creates a new parser object with a given id.  

Methods 

 

addDOMBuilderErrorListener(DOMBuilderErrorListener) 

Adds DOMBuilderErrorListener 

addDOMBuilderListener(DOMBuilderListener) 

Adds DOMBuilderListener 

 

Get the DTD 

getDocument() 

Gets the document 

getId() 

Returns the parser object id. 

getReleaseVersion() 

Returns the release version of the Oracle XML Parser 

 

Gets the document 

getValidationMode() 

Returns the validation mode 

parse(InputSource) 

Parses the XML from given input source 

 

Parses the XML from given input stream. 

parse(Reader) 

Parses the XML from given input stream. 

parse(String) 

Parses the XML from the URL indicated 

parse(URL) 

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

parseDTD(InputSource, String) 

Parses the XML External DTD from given input source 

parseDTD(InputStream, String) 

Parses the XML External DTD from given input stream. 

 

Parses the XML External DTD from given input stream. 

parseDTD(String, String) 

Parses the XML External DTD from the URL indicated 

parseDTD(URL, String) 

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

removeDOMBuilderErrorListener(DOMBuilderErrorListener) 

Remove DOMBuilderErrorListener 

removeDOMBuilderListener(DOMBuilderListener) 

Remove DOMBuilderListener 

run() 

This method runs in a thread 

setBaseURL(URL) 

Set the base URL for loading external enitites and DTDs. 

setDebugMode(boolean) 

Sets a flag to turn on debug information in the document 

setDoctype(DTD) 

Set the DTD 

setErrorStream(OutputStream) 

Creates an output stream for the output of errors and warnings. 

setErrorStream(OutputStream, String) 

Creates an output stream for the output of errors and warnings. 

setErrorStream(PrintWriter) 

Creates an output stream for the output of errors and warnings. 

setNodeFactory(NodeFactory) 

Set the node factory. 

setPreserveWhitespace(boolean) 

Set the white space preserving mode 

setValidationMode(boolean) 

Set the validation mode 

showWarnings(boolean) 

Switch to determine whether to print warnings 

Inherited Member Summary 

Fields inherited from interface oracle.xml.async.DOMBuilderConstants 

DOM_GEN_ENDED, DOM_GEN_ERROR, DOM_GEN_STARTED, DOM_METHOD1, DOM_METHOD10, DOM_METHOD2, DOM_METHOD3, DOM_METHOD4, DOM_METHOD5, DOM_METHOD6, DOM_METHOD7, DOM_METHOD8, DOM_METHOD9 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Constructors

DOMBuilder()

public  DOMBuilder()

Creates a new parser object.

DOMBuilder(int)

public  DOMBuilder(int id)

Creates a new parser object with a given 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.

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

oracle.xml.async

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

Member Summary 

 

Constructors 

 

DOMBuilderBeanInfo() 

 

Methods 

 

getIcon(int) 

 

getPropertyDescriptors() 

 

Inherited Member Summary 

Fields inherited from interface java.beans.BeanInfo 

ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32 

Methods inherited from class java.beans.SimpleBeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors, loadImage 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Methods inherited from interface java.beans.BeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors 

Constructors

DOMBuilderBeanInfo()

public  DOMBuilderBeanInfo()

Methods

getIcon(int)

public java.awt.Image getIcon(int iconKind)

Overrides:

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

getPropertyDescriptors()

public java.beans.PropertyDescriptor[] getPropertyDescriptors()

Overrides:

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

oracle.xml.async

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.

Member Summary 

 

Constructors 

 

DOMBuilderErrorEvent(Object, Exception) 

Constructor for DOMBuilderErrorEvent. 

Methods 

 

getException() 

Gets the Exception 

getMessage() 

Returns the error message generated by the parser 

Inherited Member Summary 

Methods inherited from class java.util.EventObject 

getSource, toString 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait 

Constructors

DOMBuilderErrorEvent(Object, Exception)

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

Constructor for DOMBuilderErrorEvent.

Parameters:

p0 - the Object that create this object

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

oracle.xml.async

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.

Member Summary 

 

Methods 

 

domBuilderErrorCalled(DOMBuilderErrorEvent) 

 

Methods

domBuilderErrorCalled(DOMBuilderErrorEvent)

public void domBuilderErrorCalled(DOMBuilderErrorEvent p0)

Parameters:

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

oracle.xml.async

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.

Member Summary 

 

Constructors 

 

DOMBuilderEvent(Object, int) 

 

Methods 

 

getID() 

Returns the DOMBuilder object unique id. 

Inherited Member Summary 

Methods inherited from class java.util.EventObject 

getSource, toString 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait 

Constructors

DOMBuilderEvent(Object, int)

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

Methods

getID()

public int getID()

Returns the DOMBuilder object unique id. Can be used to identify which instance of the DOMBuilder generated this event in case when multiple instances of DOMBuilder work in the background.

Returns:

The event id

oracle.xml.async

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.

Member Summary 

 

Methods 

 

domBuilderError(DOMBuilderEvent) 

This method is called when parse error occur. 

domBuilderOver(DOMBuilderEvent) 

This method is called when the parse is complete 

domBuilderStarted(DOMBuilderEvent) 

This method is called when parse starts 

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

oracle.xml.async

ResourceManager

Syntax

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

Description

Simple semaphore that maintains access to fixed number of logical resources.

Member Summary 

 

Constructors 

 

ResourceManager(int) 

The ResourceManager constructor 

Methods 

 

activeFound() 

Returns how many resources are avialable. 

getResource() 

If the number of resources avialable is nonzero, the method decreases the number of resources avialable by one and returns. 

releaseResource() 

Releases a resource. 

sleep(int) 

Let's you use Thread.sleep() without try/catch 

Inherited Member Summary 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Constructors

ResourceManager(int)

public  ResourceManager(int i)

The ResourceManager constructor

Parameters:

i - - the number of resources to manage

Methods

activeFound()

public boolean activeFound()

Returns how many resources are avialable.

getResource()

public synchronized void getResource()

If the number of resources avialable is nonzero, the method decreases the number of resources avialable by one and returns. Othervise, waits until resource is released.

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)

Let's you use Thread.sleep() without try/catch

oracle.xml.async

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.

Member Summary 

 

Constructors 

 

XSLTransformer() 

XSLTransformet constructor 

XSLTransformer(int) 

XSLTransformer constructor 

Methods 

 

addXSLTransformerErrorListener(XSLTransformerErrorListener) 

Adds an error event listener 

addXSLTransformerListener(XSLTransformerListener) 

Adds a listener 

 

Returns the unique XSLTransformer id 

getResult() 

Returns the document fragment for the resulting document. 

processXSL(XSLStylesheet, InputStream, URL) 

Initiate XSL Transformation in the background. 

processXSL(XSLStylesheet, Reader, URL) 

Initiate XSL Transformation in the background. 

processXSL(XSLStylesheet, URL, URL) 

Initiate XSL Transformation in the background. 

 

Initiate XSL Transformation in the background. 

processXSL(XSLStylesheet, XMLDocument, OutputStream) 

Initiate XSL Transformation in the background. 

removeDOMTransformerErrorListener(XSLTransformerErrorListener) 

Renmoves an error event listener 

removeXSLTransformerListener(XSLTransformerListener) 

Removes a listener 

run() 

 

 

Sets the error stream used by the XSL processor 

showWarnings(boolean) 

Sets the showWarnings flage used by the XSL processor 

Inherited Member Summary 

Fields inherited from interface oracle.xml.async.XSLTransformerConstants 

XSL_GEN_ENDED, XSL_GEN_ERROR, XSL_GEN_STARTED 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Constructors

XSLTransformer()

public  XSLTransformer()

XSLTransformet constructor

XSLTransformer(int)

public  XSLTransformer(int id)

XSLTransformer constructor

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 error event listener

Parameters:

p0 - - XSLTransformerErrorListener

addXSLTransformerListener(XSLTransformerListener)

public void addXSLTransformerListener(XSLTransformerListener p0)

Adds a listener

Parameters:

p0 - - XSLTransformerListener

getId()

public int getId()

Returns the unique XSLTransformer id

Returns:

The id

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 tre result is avialable.

processXSL(XSLStylesheet, InputStream, URL)

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

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

processXSL(XSLStylesheet, Reader, URL)

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

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

processXSL(XSLStylesheet, URL, URL)

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

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

processXSL(XSLStylesheet, XMLDocument)

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

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

processXSL(XSLStylesheet, XMLDocument, OutputStream)

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

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

removeDOMTransformerErrorListener(XSLTransformerErrorListener)

public synchronized void 
removeDOMTransformerErrorListener(XSLTransformerErrorListener p0)

Renmoves an error event listener

Parameters:

p0 - - XSLTransformerErrorListener

removeXSLTransformerListener(XSLTransformerListener)

public synchronized void removeXSLTransformerListener(XSLTransformerListener p0)

Removes a listener

Parameters:

p0 - - XSLTransformerListener

run()

public void run()

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

showWarnings(boolean)

public final void showWarnings(boolean yes)

Sets the showWarnings flage used by the XSL processor

oracle.xml.async

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

Member Summary 

 

Constructors 

 

XSLTransformerBeanInfo() 

 

Methods 

 

getIcon(int) 

 

getPropertyDescriptors() 

 

Inherited Member Summary 

Fields inherited from interface java.beans.BeanInfo 

ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32 

Methods inherited from class java.beans.SimpleBeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors, loadImage 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Methods inherited from interface java.beans.BeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors 

Constructors

XSLTransformerBeanInfo()

public  XSLTransformerBeanInfo()

Methods

getIcon(int)

public java.awt.Image getIcon(int iconKind)

Overrides:

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

getPropertyDescriptors()

public java.beans.PropertyDescriptor[] getPropertyDescriptors()

Overrides:

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

oracle.xml.async

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.

Member Summary 

 

Constructors 

 

XSLTransformerErrorEvent(Object, Exception) 

 

Methods 

 

getException() 

Returns the exception that XSLTransformer encountered object unique id. 

getMessage() 

Returns the error message that describes the error that XSLTransformer encountered 

Inherited Member Summary 

Methods inherited from class java.util.EventObject 

getSource, toString 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait 

Constructors

XSLTransformerErrorEvent(Object, Exception)

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

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

oracle.xml.async

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 asyncronous transformation. The class implementing this interface must be added to the XSLTransformet error event queue using addXSLTransformerListener method.

Member Summary 

 

Methods 

 

xslTransformerErrorCalled(XSLTransformerErrorEvent) 

This method is called when parse or transformation error occur. 

Methods

xslTransformerErrorCalled(XSLTransformerErrorEvent)

public void xslTransformerErrorCalled(XSLTransformerErrorEvent p0)

This method is called when parse or transformation error occur.

Parameters:

p0 - - The XSLTransformerErrorEvent object produced by the XSLTransformer

oracle.xml.async

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

Description

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

Member Summary 

 

Constructors 

 

XSLTransformerEvent(Object, int) 

 

Methods 

 

getID() 

Returns the XSLTransformer object unique id. 

Inherited Member Summary 

Methods inherited from class java.util.EventObject 

getSource, toString 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait 

Constructors

XSLTransformerEvent(Object, int)

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

Methods

getID()

public int getID()

Returns the XSLTransformer object unique id. Can be used to identify which instance of the XSLTransformer generated this event in case when multiple instances of XSLTransformer work in the background.

Returns:

The event id

oracle.xml.async

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 asyncronous transformation. The class implementing this interface must be added to the XSLTransformet event queue using addXSLTransformerListener method.

Member Summary 

 

Methods 

 

xslTransformerError(XSLTransformerEvent) 

This method is called when parse or transformation error occur. 

xslTransformerOver(XSLTransformerEvent) 

This method is called when the transformation is complete 

xslTransformerStarted(XSLTransformerEvent) 

This method is called when the transformation starts 

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


oracle.xml.srcviewer Package


Description

Class Summary 

 

Classes 

 

oracle.xml.srcviewer.XMLSourceView 

Shows an XML document. 

XMLSourceViewBeanInfo 

 

oracle.xml.srcviewer.XMLSourceView

Syntax

public class XMLSourceView extends javax.swing.JPanel implements 
java.io.Serializable
 
java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.xml.srcviewer.XMLSourceView

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, 
java.awt.MenuContainer, java.io.Serializable

Description

Shows an XML document. Recognizes the following XML token types: Tag, Attribute Name, Attribute Value, Comment, CDATA, PCDATA, PI Data, PI Name and NOTATION Symbol. Each token type has a foreground color and font. The default color/font settings can be changed by the user. Takes as input an org.w3c.dom.Document object.

Member Summary 

 

Constructors 

 

XMLSourceView() 

The class constructor. 

Methods 

 

fontGet(AttributeSet) 

Extracts and returns the font from a given attributeset. 

fontSet(MutableAttributeSet, Font) 

Sets the mutableattributeset font. 

getAttributeNameFont() 

Returns the Attribute Value font. 

getAttributeNameForeground() 

Returns the Attribute Name foreground color. 

getAttributeValueFont() 

Returns the Attribute Value font. 

getAttributeValueForeground() 

Returns the Attribute Value foreground color. 

getBackground() 

Returns the background color. 

getCDATAFont() 

Returns the CDATA font. 

getCDATAForeground() 

Returns the CDATA foreground color. 

getCommentDataFont() 

Returns the Comment Data font. 

getCommentDataForeground() 

Returns the Comment Data foreground color. 

getEditedText() 

Returns the edited text. 

getJTextPane() 

Returns the viewer JTextPane component. 

getMinimumSize() 

Returns the XMLSourceView minimal size. 

getNodeAtOffset(int) 

Returns the XML node at a given offset. 

getPCDATAFont() 

Returns the PCDATA font. 

getPCDATAForeground() 

Returns the PCDATA foreground color. 

getPIDataFont() 

Returns the PI Data font. 

getPIDataForeground() 

Returns the PI Data foreground color. 

getPINameFont() 

Returns the PI Name font. 

getPINameForeground() 

Returns the PI Data foreground color. 

getSymbolFont() 

Returns the NOTATION Symbol font. 

getSymbolForeground() 

Returns the NOTATION Symbol foreground color. 

getTagFont() 

Returns the Tag font. 

getTagForeground() 

Returns the Tag foreground color. 

getText() 

Returns the XML document as a String. 

isEditable() 

Returns boolean to indicate whether this object is editable. 

selectNodeAt(int) 

Moves the cursor to XML Node at offset i. 

setAttributeNameFont(Font) 

Sets the Attribute Name font. 

setAttributeNameForeground(Color) 

Sets the Attribute Name foreground color. 

setAttributeValueFont(Font) 

Sets the Attribute Value font. 

setAttributeValueForeground(Color) 

Sets the Attribute Value foreground color. 

setBackground(Color) 

Sets the background color. 

setCDATAFont(Font) 

Sets the CDATA font. 

setCDATAForeground(Color) 

Sets the CDATA foreground color. 

setCommentDataFont(Font) 

Sets the Comment font. 

setCommentDataForeground(Color) 

Sets the Comment foreground color. 

setEditable(boolean) 

Sets the specified boolean to indicate whether this object should be editable. 

setPCDATAFont(Font) 

Sets the PCDATA font. 

setPCDATAForeground(Color) 

Sets the PCDATA foreground color. 

setPIDataFont(Font) 

Sets the PI Data font. 

setPIDataForeground(Color) 

Sets the PI Data foreground color. 

setPINameFont(Font) 

Sets the PI Name font. 

setPINameForeground(Color) 

Sets the PI Name foreground color. 

setSelectedNode(Node) 

Sets the cursor position at the selected XML node. 

setSymbolFont(Font) 

Sets the NOTATION Symbol font. 

setSymbolForeground(Color) 

Sets the NOTATION Symbol foreground color. 

setTagFont(Font) 

Sets the Tag font. 

setTagForeground(Color) 

Sets the Tag foreground color. 

setXMLDocument(Document) 

Associates the XMLviewer with a XML document. 

Inherited Member Summary 

Inner classes inherited from class javax.swing.JComponent 

javax.swing.JComponent.AccessibleJComponent 

Fields inherited from class javax.swing.JComponent 

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW 

Fields inherited from class java.awt.Component 

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT 

Fields inherited from interface java.awt.image.ImageObserver 

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH 

Methods inherited from class javax.swing.JPanel 

getAccessibleContext, getUIClassID, updateUI 

Methods inherited from class javax.swing.JComponent 

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVisible, unregisterKeyboardAction, update 

Methods inherited from class java.awt.Container 

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, remove, removeAll, removeContainerListener, setCursor, setLayout, validate 

Methods inherited from class java.awt.Component 

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, contains, createImage, createImage, disable, dispatchEvent, enable, enable, enableInputMethods, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait 

Methods inherited from interface javax.accessibility.Accessible 

getAccessibleContext 

Methods inherited from interface java.awt.image.ImageObserver 

imageUpdate 

Methods inherited from interface java.awt.MenuContainer 

getFont, postEvent, remove 

Constructors

XMLSourceView()

public  XMLSourceView()

The class constructor. Creates an object of type XMLSourceView.

Methods

fontGet(AttributeSet)

public static java.awt.Font fontGet(javax.swing.text.AttributeSet attributeset)

Extracts and returns the font from a given attributeset.

Parameters:

attributeset - The source Attributeset.

Returns:

The extracted Font.

fontSet(MutableAttributeSet, Font)

public static void fontSet(javax.swing.text.MutableAttributeSet 
mutableattributeset, java.awt.Font font)

Sets the mutableattributeset font.

Parameters:

mutableattributeset - The mutableattributeset to update.

font - The new Font for the mutableattributeset.

getAttributeNameFont()

public java.awt.Font getAttributeNameFont()

Returns the Attribute Value font.

Returns:

The Font object.

getAttributeNameForeground()

public java.awt.Color getAttributeNameForeground()

Returns the Attribute Name foreground color.

Returns:

The Color object.

getAttributeValueFont()

public java.awt.Font getAttributeValueFont()

Returns the Attribute Value font.

Returns:

The Font object.

getAttributeValueForeground()

public java.awt.Color getAttributeValueForeground()

Returns the Attribute Value foreground color.

Returns:

The Color object.

getBackground()

public java.awt.Color getBackground()

Returns the background color.

Overrides:

java.awt.Component.getBackground() in class java.awt.Component

Returns:

The Color object.

getCDATAFont()

public java.awt.Font getCDATAFont()

Returns the CDATA font.

Returns:

The Font object.

getCDATAForeground()

public java.awt.Color getCDATAForeground()

Returns the CDATA foreground color.

Returns:

The Color object.

getCommentDataFont()

public java.awt.Font getCommentDataFont()

Returns the Comment Data font.

Returns:

The Font object.

getCommentDataForeground()

public java.awt.Color getCommentDataForeground()

Returns the Comment Data foreground color.

Returns:

The Color object.

getEditedText()

public java.lang.String getEditedText()

Returns the edited text.

Returns:

The String object containing the edited text.

getJTextPane()

public javax.swing.JTextPane getJTextPane()

Returns the viewer JTextPane component.

Returns:

The JTextPane object used by XMLSourceViewer

getMinimumSize()

public java.awt.Dimension getMinimumSize()

Returns the XMLSourceView minimal size.

Overrides:

javax.swing.JComponent.getMinimumSize() in class javax.swing.JComponent

Returns:

The Dimension object containing the XMLSourceView minimum size.

getNodeAtOffset(int)

public org.w3c.dom.Node getNodeAtOffset(int i)

Returns the XML node at a given offset.

Parameters:

i - The node offset.

Returns:

The Node object from offset i.

getPCDATAFont()

public java.awt.Font getPCDATAFont()

Returns the PCDATA font.

Returns:

The Font object.

getPCDATAForeground()

public java.awt.Color getPCDATAForeground()

Returns the PCDATA foreground color.

Returns:

The Color object.

getPIDataFont()

public java.awt.Font getPIDataFont()

Returns the PI Data font.

Returns:

The Font object

getPIDataForeground()

public java.awt.Color getPIDataForeground()

Returns the PI Data foreground color.

Returns:

The Color object.

getPINameFont()

public java.awt.Font getPINameFont()

Returns the PI Name font.

Returns:

The Font object.

getPINameForeground()

public java.awt.Color getPINameForeground()

Returns the PI Data foreground color.

Returns:

The Color object.

getSymbolFont()

public java.awt.Font getSymbolFont()

Returns the NOTATION Symbol font.

Returns:

The Font object.

getSymbolForeground()

public java.awt.Color getSymbolForeground()

Returns the NOTATION Symbol foreground color.

Returns:

The Color object.

getTagFont()

public java.awt.Font getTagFont()

Returns the Tag font.

Returns:

The Font object.

getTagForeground()

public java.awt.Color getTagForeground()

Returns the Tag foreground color.

Returns:

The Color object.

getText()

public java.lang.String getText()

Returns the XML document as a String.

Returns:

The String object containing the XML document.

isEditable()

public boolean isEditable()

Returns boolean to indicate whether this object is editable.

selectNodeAt(int)

public void selectNodeAt(int i)

Moves the cursor to XML Node at offset i.

Parameters:

i - The node offset.

setAttributeNameFont(Font)

public void setAttributeNameFont(java.awt.Font font)

Sets the Attribute Name font.

Parameters:

font - The new Font for Attribute Name.

setAttributeNameForeground(Color)

public void setAttributeNameForeground(java.awt.Color color)

Sets the Attribute Name foreground color.

Parameters:

color - The new Color for Attribute Name.

setAttributeValueFont(Font)

public void setAttributeValueFont(java.awt.Font font)

Sets the Attribute Value font.

Parameters:

font - The new Font for Attribute Value.

setAttributeValueForeground(Color)

public void setAttributeValueForeground(java.awt.Color color)

Sets the Attribute Value foreground color.

Parameters:

color - The new Color for Attribute Value.

setBackground(Color)

public void setBackground(java.awt.Color color)

Sets the background color.

Overrides:

javax.swing.JComponent.setBackground(java.awt.Color) in class javax.swing.JComponent

Parameters:

color - The new background Color.

setCDATAFont(Font)

public void setCDATAFont(java.awt.Font font)

Sets the CDATA font.

Parameters:

font - The new Font for CDATA.

setCDATAForeground(Color)

public void setCDATAForeground(java.awt.Color color)

Sets the CDATA foreground color.

Parameters:

color - The new Color for CDATA.

setCommentDataFont(Font)

public void setCommentDataFont(java.awt.Font font)

Sets the Comment font.

Parameters:

font - The new Font for the XML Comments.

setCommentDataForeground(Color)

public void setCommentDataForeground(java.awt.Color color)

Sets the Comment foreground color.

Parameters:

color - The new Color for Comment.

setEditable(boolean)

public void setEditable(boolean edit)

Sets the specified boolean to indicate whether this object should be editable.

Parameters:

doc - The new boolean value.

setPCDATAFont(Font)

public void setPCDATAFont(java.awt.Font font)

Sets the PCDATA font.

Parameters:

font - The new Font for PCDATA.

setPCDATAForeground(Color)

public void setPCDATAForeground(java.awt.Color color)

Sets the PCDATA foreground color.

Parameters:

color - The new Color for PCDATA.

setPIDataFont(Font)

public void setPIDataFont(java.awt.Font font)

Sets the PI Data font.

Parameters:

font - The new Font for PI Data.

setPIDataForeground(Color)

public void setPIDataForeground(java.awt.Color color)

Sets the PI Data foreground color.

Parameters:

color - The new Color for PI Data.

setPINameFont(Font)

public void setPINameFont(java.awt.Font font)

Sets the PI Name font.

Parameters:

font - The new Font for the PI Names.

setPINameForeground(Color)

public void setPINameForeground(java.awt.Color color)

Sets the PI Name foreground color.

Parameters:

color - The new Color for PI Name.

setSelectedNode(Node)

public void setSelectedNode(org.w3c.dom.Node node)

Sets the cursor position at the selected XML node.

Parameters:

node - The selected node.

setSymbolFont(Font)

public void setSymbolFont(java.awt.Font font)

Sets the NOTATION Symbol font.

Parameters:

color - The new Font for NOTATION Symbol.

setSymbolForeground(Color)

public void setSymbolForeground(java.awt.Color color)

Sets the NOTATION Symbol foreground color.

Parameters:

color - The new Color for NOTATION Symbol.

setTagFont(Font)

public void setTagFont(java.awt.Font font)

Sets the Tag font.

Parameters:

font - The new Font for the XML Tags.

setTagForeground(Color)

public void setTagForeground(java.awt.Color color)

Sets the Tag foreground color.

Parameters:

color - The new Color for the XML Tags.

setXMLDocument(Document)

public void setXMLDocument(org.w3c.dom.Document document)

Associates the XMLviewer with a XML document.

Parameters:

doc - The Document document to display.

See Also:

getText()

oracle.xml.srcviewer

XMLSourceViewBeanInfo

Syntax

public class XMLSourceViewBeanInfo extends java.beans.SimpleBeanInfo
 
java.lang.Object
  |
  +--java.beans.SimpleBeanInfo
        |
        +--oracle.xml.srcviewer.XMLSourceViewBeanInfo

All Implemented Interfaces:

java.beans.BeanInfo

Description

Member Summary 

 

Constructors 

 

XMLSourceViewBeanInfo() 

 

Methods 

 

getIcon(int) 

 

getPropertyDescriptors() 

 

Inherited Member Summary 

Fields inherited from interface java.beans.BeanInfo 

ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32 

Methods inherited from class java.beans.SimpleBeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors, loadImage 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Methods inherited from interface java.beans.BeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors 

Constructors

XMLSourceViewBeanInfo()

public  XMLSourceViewBeanInfo()

Methods

getIcon(int)

public java.awt.Image getIcon(int iconKind)

Overrides:

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

getPropertyDescriptors()

public java.beans.PropertyDescriptor[] getPropertyDescriptors()

Overrides:

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


oracle.xml.async Package


Description

Class Summary 

 

Interfaces 

 

DOMBuilderErrorListener 

This interface must be implemented in order to receive notifications when error is found during parsing. 

DOMBuilderListener 

This interface must be implemented in order to receive notifications about events during the asyncronous parsing. 

XSLTransformerErrorListener 

This interface must be implemented in order to receive notifications about error events during the asyncronous transformation. 

XSLTransformerListener 

This interface must be implemented in order to receive notifications about events during the asyncronous transformation. 

Classes 

 

DOMBuilder 

This class implements an eXtensible Markup Language (XML) 1.0 parser according to the World Wide Web Consortium (W3C) recommendation. 

DOMBuilderBeanInfo 

 

DOMBuilderErrorEvent 

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

DOMBuilderEvent 

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

ResourceManager 

Simple semaphore that maintains access to fixed number of logical resources. 

XSLTransformer 

Applies XSL transformation in a background thread. 

XSLTransformerBeanInfo 

 

XSLTransformerErrorEvent 

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

XSLTransformerEvent 

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

oracle.xml.async


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 implements an eXtensible Markup Language (XML) 1.0 parser according to the World Wide Web Consortium (W3C) recommendation. to parse a 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.

Member Summary 

 

Constructors 

 

DOMBuilder() 

Creates a new parser object. 

Creates a new parser object. 

Creates a new parser object with a given id. 

Methods 

 

addDOMBuilderErrorListener(DOMBuilderErrorListener) 

Adds DOMBuilderErrorListener 

addDOMBuilderListener(DOMBuilderListener) 

Adds DOMBuilderListener 

 

Get the DTD 

getDocument() 

Gets the document 

getId() 

Returns the parser object id. 

getReleaseVersion() 

Returns the release version of the Oracle XML Parser 

 

Gets the document 

getValidationMode() 

Returns the validation mode 

parse(InputSource) 

Parses the XML from given input source 

 

Parses the XML from given input stream. 

parse(Reader) 

Parses the XML from given input stream. 

parse(String) 

Parses the XML from the URL indicated 

parse(URL) 

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

parseDTD(InputSource, String) 

Parses the XML External DTD from given input source 

parseDTD(InputStream, String) 

Parses the XML External DTD from given input stream. 

 

Parses the XML External DTD from given input stream. 

parseDTD(String, String) 

Parses the XML External DTD from the URL indicated 

parseDTD(URL, String) 

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

removeDOMBuilderErrorListener(DOMBuilderErrorListener) 

Remove DOMBuilderErrorListener 

removeDOMBuilderListener(DOMBuilderListener) 

Remove DOMBuilderListener 

run() 

This method runs in a thread 

setBaseURL(URL) 

Set the base URL for loading external enitites and DTDs. 

setDebugMode(boolean) 

Sets a flag to turn on debug information in the document 

setDoctype(DTD) 

Set the DTD 

setErrorStream(OutputStream) 

Creates an output stream for the output of errors and warnings. 

setErrorStream(OutputStream, String) 

Creates an output stream for the output of errors and warnings. 

setErrorStream(PrintWriter) 

Creates an output stream for the output of errors and warnings. 

setNodeFactory(NodeFactory) 

Set the node factory. 

setPreserveWhitespace(boolean) 

Set the white space preserving mode 

setValidationMode(boolean) 

Set the validation mode 

showWarnings(boolean) 

Switch to determine whether to print warnings 

Inherited Member Summary 

Fields inherited from interface oracle.xml.async.DOMBuilderConstants 

DOM_GEN_ENDED, DOM_GEN_ERROR, DOM_GEN_STARTED, DOM_METHOD1, DOM_METHOD10, DOM_METHOD2, DOM_METHOD3, DOM_METHOD4, DOM_METHOD5, DOM_METHOD6, DOM_METHOD7, DOM_METHOD8, DOM_METHOD9 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Constructors

DOMBuilder()

public  DOMBuilder()

Creates a new parser object.

DOMBuilder(int)

public  DOMBuilder(int id)

Creates a new parser object with a given 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.

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

oracle.xml.async

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

Member Summary 

 

Constructors 

 

DOMBuilderBeanInfo() 

 

Methods 

 

getIcon(int) 

 

getPropertyDescriptors() 

 

Inherited Member Summary 

Fields inherited from interface java.beans.BeanInfo 

ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32 

Methods inherited from class java.beans.SimpleBeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors, loadImage 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Methods inherited from interface java.beans.BeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors 

Constructors

DOMBuilderBeanInfo()

public  DOMBuilderBeanInfo()

Methods

getIcon(int)

public java.awt.Image getIcon(int iconKind)

Overrides:

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

getPropertyDescriptors()

public java.beans.PropertyDescriptor[] getPropertyDescriptors()

Overrides:

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

oracle.xml.async

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.

Member Summary 

 

Constructors 

 

DOMBuilderErrorEvent(Object, Exception) 

Constructor for DOMBuilderErrorEvent. 

Methods 

 

getException() 

Gets the Exception 

getMessage() 

Returns the error message generated by the parser 

Inherited Member Summary 

Methods inherited from class java.util.EventObject 

getSource, toString 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait 

Constructors

DOMBuilderErrorEvent(Object, Exception)

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

Constructor for DOMBuilderErrorEvent.

Parameters:

p0 - the Object that create this object

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

oracle.xml.async

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.

Member Summary 

 

Methods 

 

domBuilderErrorCalled(DOMBuilderErrorEvent) 

 

Methods

domBuilderErrorCalled(DOMBuilderErrorEvent)

public void domBuilderErrorCalled(DOMBuilderErrorEvent p0)

Parameters:

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

oracle.xml.async

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.

Member Summary 

 

Constructors 

 

DOMBuilderEvent(Object, int) 

 

Methods 

 

getID() 

Returns the DOMBuilder object unique id. 

Inherited Member Summary 

Methods inherited from class java.util.EventObject 

getSource, toString 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait 

Constructors

DOMBuilderEvent(Object, int)

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

Methods

getID()

public int getID()

Returns the DOMBuilder object unique id. Can be used to identify which instance of the DOMBuilder generated this event in case when multiple instances of DOMBuilder work in the background.

Returns:

The event id

oracle.xml.async

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.

Member Summary 

 

Methods 

 

domBuilderError(DOMBuilderEvent) 

This method is called when parse error occur. 

domBuilderOver(DOMBuilderEvent) 

This method is called when the parse is complete 

domBuilderStarted(DOMBuilderEvent) 

This method is called when parse starts 

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

oracle.xml.async

ResourceManager

Syntax

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

Description

Simple semaphore that maintains access to fixed number of logical resources.

Member Summary 

 

Constructors 

 

ResourceManager(int) 

The ResourceManager constructor 

Methods 

 

activeFound() 

Returns how many resources are avialable. 

getResource() 

If the number of resources avialable is nonzero, the method decreases the number of resources avialable by one and returns. 

releaseResource() 

Releases a resource. 

sleep(int) 

Let's you use Thread.sleep() without try/catch 

Inherited Member Summary 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Constructors

ResourceManager(int)

public  ResourceManager(int i)

The ResourceManager constructor

Parameters:

i - - the number of resources to manage

Methods

activeFound()

public boolean activeFound()

Returns how many resources are avialable.

getResource()

public synchronized void getResource()

If the number of resources avialable is nonzero, the method decreases the number of resources avialable by one and returns. Othervise, waits until resource is released.

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)

Let's you use Thread.sleep() without try/catch

oracle.xml.async

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.

Member Summary 

 

Constructors 

 

XSLTransformer() 

XSLTransformet constructor 

XSLTransformer(int) 

XSLTransformer constructor 

Methods 

 

addXSLTransformerErrorListener(XSLTransformerErrorListener) 

Adds an error event listener 

addXSLTransformerListener(XSLTransformerListener) 

Adds a listener 

 

Returns the unique XSLTransformer id 

getResult() 

Returns the document fragment for the resulting document. 

processXSL(XSLStylesheet, InputStream, URL) 

Initiate XSL Transformation in the background. 

processXSL(XSLStylesheet, Reader, URL) 

Initiate XSL Transformation in the background. 

processXSL(XSLStylesheet, URL, URL) 

Initiate XSL Transformation in the background. 

 

Initiate XSL Transformation in the background. 

processXSL(XSLStylesheet, XMLDocument, OutputStream) 

Initiate XSL Transformation in the background. 

removeDOMTransformerErrorListener(XSLTransformerErrorListener) 

Renmoves an error event listener 

removeXSLTransformerListener(XSLTransformerListener) 

Removes a listener 

run() 

 

 

Sets the error stream used by the XSL processor 

showWarnings(boolean) 

Sets the showWarnings flage used by the XSL processor 

Inherited Member Summary 

Fields inherited from interface oracle.xml.async.XSLTransformerConstants 

XSL_GEN_ENDED, XSL_GEN_ERROR, XSL_GEN_STARTED 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Constructors

XSLTransformer()

public  XSLTransformer()

XSLTransformet constructor

XSLTransformer(int)

public  XSLTransformer(int id)

XSLTransformer constructor

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 error event listener

Parameters:

p0 - - XSLTransformerErrorListener

addXSLTransformerListener(XSLTransformerListener)

public void addXSLTransformerListener(XSLTransformerListener p0)

Adds a listener

Parameters:

p0 - - XSLTransformerListener

getId()

public int getId()

Returns the unique XSLTransformer id

Returns:

The id

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 tre result is avialable.

processXSL(XSLStylesheet, InputStream, URL)

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

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

processXSL(XSLStylesheet, Reader, URL)

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

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

processXSL(XSLStylesheet, URL, URL)

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

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

processXSL(XSLStylesheet, XMLDocument)

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

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

processXSL(XSLStylesheet, XMLDocument, OutputStream)

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

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

removeDOMTransformerErrorListener(XSLTransformerErrorListener)

public synchronized void 
removeDOMTransformerErrorListener(XSLTransformerErrorListener p0)

Renmoves an error event listener

Parameters:

p0 - - XSLTransformerErrorListener

removeXSLTransformerListener(XSLTransformerListener)

public synchronized void removeXSLTransformerListener(XSLTransformerListener p0)

Removes a listener

Parameters:

p0 - - XSLTransformerListener

run()

public void run()

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

showWarnings(boolean)

public final void showWarnings(boolean yes)

Sets the showWarnings flage used by the XSL processor

oracle.xml.async

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

Member Summary 

 

Constructors 

 

XSLTransformerBeanInfo() 

 

Methods 

 

getIcon(int) 

 

getPropertyDescriptors() 

 

Inherited Member Summary 

Fields inherited from interface java.beans.BeanInfo 

ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32 

Methods inherited from class java.beans.SimpleBeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors, loadImage 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Methods inherited from interface java.beans.BeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors 

Constructors

XSLTransformerBeanInfo()

public  XSLTransformerBeanInfo()

Methods

getIcon(int)

public java.awt.Image getIcon(int iconKind)

Overrides:

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

getPropertyDescriptors()

public java.beans.PropertyDescriptor[] getPropertyDescriptors()

Overrides:

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

oracle.xml.async

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.

Member Summary 

 

Constructors 

 

XSLTransformerErrorEvent(Object, Exception) 

 

Methods 

 

getException() 

Returns the exception that XSLTransformer encountered object unique id. 

getMessage() 

Returns the error message that describes the error that XSLTransformer encountered 

Inherited Member Summary 

Methods inherited from class java.util.EventObject 

getSource, toString 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait 

Constructors

XSLTransformerErrorEvent(Object, Exception)

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

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

oracle.xml.async

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 asyncronous transformation. The class implementing this interface must be added to the XSLTransformet error event queue using addXSLTransformerListener method.

Member Summary 

 

Methods 

 

xslTransformerErrorCalled(XSLTransformerErrorEvent) 

This method is called when parse or transformation error occur. 

Methods

xslTransformerErrorCalled(XSLTransformerErrorEvent)

public void xslTransformerErrorCalled(XSLTransformerErrorEvent p0)

This method is called when parse or transformation error occur.

Parameters:

p0 - - The XSLTransformerErrorEvent object produced by the XSLTransformer

oracle.xml.async

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

Description

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

Member Summary 

 

Constructors 

 

XSLTransformerEvent(Object, int) 

 

Methods 

 

getID() 

Returns the XSLTransformer object unique id. 

Inherited Member Summary 

Methods inherited from class java.util.EventObject 

getSource, toString 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait 

Constructors

XSLTransformerEvent(Object, int)

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

Methods

getID()

public int getID()

Returns the XSLTransformer object unique id. Can be used to identify which instance of the XSLTransformer generated this event in case when multiple instances of XSLTransformer work in the background.

Returns:

The event id

oracle.xml.async

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 asyncronous transformation. The class implementing this interface must be added to the XSLTransformet event queue using addXSLTransformerListener method.

Member Summary 

 

Methods 

 

xslTransformerError(XSLTransformerEvent) 

This method is called when parse or transformation error occur. 

xslTransformerOver(XSLTransformerEvent) 

This method is called when the transformation is complete 

xslTransformerStarted(XSLTransformerEvent) 

This method is called when the transformation starts 

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


oracle.xml.transviewer Package


Description

Class Summary 

 

Classes 

 

DBAccess 

Maintains CLOB tables that can hold multiple XML and text documents. 

XMLTransformPanel 

XMLTransformPanel visual bean. 

XMLTransformPanelBeanInfo 

 

XMLTransViewer 

Simple application that uses XMLTransformPanel. 

oracle.xml.transviewer


DBAccess

Syntax

public class DBAccess extends java.lang.Object
 
java.lang.Object
  |
  +--oracle.xml.transviewer.DBAccess

Description

Maintains CLOB tables that can hold multiple XML and text documents. Each table is created using the statement: CREATE TABLE tablename FILENAME CHAR( 16) UNIQUE, FILEDATA CLOB) LOB(FILEDATA) STORE AS (DISABLE STORAGE IN ROW). Each XML (or text) document is stored as a row in the table and the FILENAME field holds a unique string that is used as a key to retrieve, update or delete the row. The document text is stored in the FILEDATA field that is a CLOB object. This CLOB tables are automatically maintained by the transviewer bean. The CLOB tables maintained by this class can be later used by the transviewer bean. The class creates and deletes CLOB tables, list a CLOB table content and also add, replace or delete text documents in this CLOB tables.

Member Summary 

 

Constructors 

 

DBAccess() 

 

Methods 

 

createXMLTable(Connection, String) 

Create XML table 

deleteXMLName(Connection, String, String) 

Delete text file from XML table 

dropXMLTable(Connection, String) 

Delete XML table 

getNameSize() 

Returns the size of the field where the filename is kept. 

getXMLData(Connection, String, String) 

Retrieve text file from XML table 

getXMLNames(Connection, String) 

Returns all file names in XML table 

getXMLTableNames(Connection, String) 

Gets all XML tables with names starting with a given string 

insertXMLData(Connection, String, String, String) 

Inserts text file as a row in XML table 

isXMLTable(Connection, String) 

Check if the table is XML table. 

replaceXMLData(Connection, String, String, String) 

Replace text file as a row in XML table 

xmlTableExists(Connection, String) 

Checks if the XML table exists 

Inherited Member Summary 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Constructors

DBAccess()

public  DBAccess()

Methods

createXMLTable(Connection, String)

public boolean createXMLTable(java.sql.Connection con, java.lang.String 
tablename)

Create XML table

Parameters:

con - - the Connection object

tablename - - the table name

Returns:

true if successfull

deleteXMLName(Connection, String, String)

public boolean deleteXMLName(java.sql.Connection con, java.lang.String 
tablename, java.lang.String xmlname)

Delete text file from XML table

Parameters:

con - - the Connection object

tablename - - the table name

xmlname - - the file name

Returns:

true if successfull

dropXMLTable(Connection, String)

public boolean dropXMLTable(java.sql.Connection con, java.lang.String tablename)

Delete XML table

Parameters:

con - - the Connection object

tablename - - the table name

Returns:

true if successfull

getNameSize()

public int getNameSize()

Returns the size of the field where the filename is kept.

Returns:

filename size

getXMLData(Connection, String, String)

public java.lang.String getXMLData(java.sql.Connection con, java.lang.String 
tablename, java.lang.String xmlname)

Retrieve text file from XML table

Parameters:

con - - the Connection object

tablename - - the table name

xmlname - - the file name

Returns:

file as a string

getXMLNames(Connection, String)

public java.lang.String[] getXMLNames(java.sql.Connection con, java.lang.String 
tablename)

Returns all file names in XML table

Parameters:

con - - the Connection object

tablename - - the table name

Returns:

String array with all file names in this table

getXMLTableNames(Connection, String)

public java.lang.String[] getXMLTableNames(java.sql.Connection con, 
java.lang.String tablePrefix)

Gets all XML tables with names starting with a given string

Parameters:

con - - the Connection object

tablePrefix - - table prefix string

Returns:

array of all XML tables that begin with tablePrefix

insertXMLData(Connection, String, String, String)

public boolean insertXMLData(java.sql.Connection con, java.lang.String 
tablename, java.lang.String xmlname, java.lang.String xmldata)

Inserts text file as a row in XML table

Parameters:

con - - the Connection object

tablename - - the table name

xmlname - - the file name

xmldata - - string with the file data

Returns:

true if successfull

isXMLTable(Connection, String)

public boolean isXMLTable(java.sql.Connection con, java.lang.String tablename)

Check if the table is XML table.

Parameters:

con - - the Connection object

tableName - - the table name to test

Returns:

true if this is XML table

replaceXMLData(Connection, String, String, String)

public boolean replaceXMLData(java.sql.Connection con, java.lang.String 
tablename, java.lang.String xmlname, java.lang.String xmldata)

Replace text file as a row in XML table

Parameters:

con - - the Connection object

tablename - - the table name

xmlname - - the file name

xmldata - - string with the file data

Returns:

true if successfull

xmlTableExists(Connection, String)

public boolean xmlTableExists(java.sql.Connection con, java.lang.String 
tablename)

Checks if the XML table exists

Parameters:

con - - the Connection object

tablename - - the table name

Returns:

true if the table exists

oracle.xml.transviewer

XMLTransformPanel

Syntax

public class XMLTransformPanel extends javax.swing.JPanel
 
java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.xml.transviewer.XMLTransformPanel

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, 
java.awt.MenuContainer, java.io.Serializable

Description

XMLTransformPanel visual bean. Applies XSL transformations on XML documents. Visualizes the result. Allows editing of input XML and XSL documents/files.

Member Summary 

 

Constructors 

 

XMLTransformPanel() 

The class constructor. 

Inherited Member Summary 

Inner classes inherited from class javax.swing.JComponent 

javax.swing.JComponent.AccessibleJComponent 

Fields inherited from class javax.swing.JComponent 

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW 

Fields inherited from class java.awt.Component 

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT 

Fields inherited from interface java.awt.image.ImageObserver 

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH 

Methods inherited from class javax.swing.JPanel 

getAccessibleContext, getUIClassID, updateUI 

Methods inherited from class javax.swing.JComponent 

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVisible, unregisterKeyboardAction, update 

Methods inherited from class java.awt.Container 

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, remove, removeAll, removeContainerListener, setCursor, setLayout, validate 

Methods inherited from class java.awt.Component 

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, contains, createImage, createImage, disable, dispatchEvent, enable, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait 

Methods inherited from interface javax.accessibility.Accessible 

getAccessibleContext 

Methods inherited from interface java.awt.image.ImageObserver 

imageUpdate 

Methods inherited from interface java.awt.MenuContainer 

getFont, postEvent, remove 

Constructors

XMLTransformPanel()

public  XMLTransformPanel()

The class constructor. Creates an object of type XMLTransformPanel.

oracle.xml.transviewer

XMLTransformPanelBeanInfo

Syntax

public class XMLTransformPanelBeanInfo extends java.beans.SimpleBeanInfo
 
java.lang.Object
  |
  +--java.beans.SimpleBeanInfo
        |
        +--oracle.xml.transviewer.XMLTransformPanelBeanInfo

All Implemented Interfaces:

java.beans.BeanInfo

Description

Member Summary 

 

Constructors 

 

XMLTransformPanelBeanInfo() 

 

Methods 

 

getIcon(int) 

 

getPropertyDescriptors() 

 

Inherited Member Summary 

Fields inherited from interface java.beans.BeanInfo 

ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32 

Methods inherited from class java.beans.SimpleBeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors, loadImage 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Methods inherited from interface java.beans.BeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors 

Constructors

XMLTransformPanelBeanInfo()

public  XMLTransformPanelBeanInfo()

Methods

getIcon(int)

public java.awt.Image getIcon(int iconKind)

Overrides:

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

getPropertyDescriptors()

public java.beans.PropertyDescriptor[] getPropertyDescriptors()

Overrides:

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

oracle.xml.transviewer

XMLTransViewer

Syntax

public class XMLTransViewer extends java.lang.Object
 
java.lang.Object
  |
  +--oracle.xml.transviewer.XMLTransViewer

Description

Simple application that uses XMLTransformPanel. Can be used from the command line to edit and parse XML files, edit and apply XSL transformations and retrieve and save XML, XSL and result files in the file system or in the Oracle 8i database

Member Summary 

 

Constructors 

 

XMLTransViewer() 

 

Methods 

 

main(String) 

 

Inherited Member Summary 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Constructors

XMLTransViewer()

public  XMLTransViewer()

Methods

main(String)

public static void main(java.lang.String[] args)


oracle.xml.treeviewer Package


Description

Class Summary 

 

Classes 

 

XMLTreeView 

Shows an XML document as a tree. 

XMLTreeViewBeanInfo 

 

oracle.xml.treeviewer


XMLTreeView

Syntax

public class XMLTreeView extends javax.swing.JPanel
 
java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.xml.treeviewer.XMLTreeView

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, 
java.awt.MenuContainer, java.io.Serializable

Description

Shows an XML document as a tree. Recognizes the following XML DOM nodes: Tag, Attribute Name, Attribute Value, Comment, CDATA, PCDATA, PI Data, PI Name and NOTATION Symbol. Takes as input an org.w3c.dom.Document object.

Member Summary 

 

Constructors 

 

XMLTreeView() 

The class constructor. 

Methods 

 

getPreferredSize() 

Returns the XMLTreeView preffered size. 

setXMLDocument(Document) 

Associates the XMLTreeViewer with a XML document. 

updateUI() 

Forces the XMLTreeView to update/refresh UI. 

Inherited Member Summary 

Inner classes inherited from class javax.swing.JComponent 

javax.swing.JComponent.AccessibleJComponent 

Fields inherited from class javax.swing.JComponent 

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW 

Fields inherited from class java.awt.Component 

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT 

Fields inherited from interface java.awt.image.ImageObserver 

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH 

Methods inherited from class javax.swing.JPanel 

getAccessibleContext, getUIClassID 

Methods inherited from class javax.swing.JComponent 

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVisible, unregisterKeyboardAction, update 

Methods inherited from class java.awt.Container 

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, remove, removeAll, removeContainerListener, setCursor, setLayout, validate 

Methods inherited from class java.awt.Component 

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, contains, createImage, createImage, disable, dispatchEvent, enable, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait 

Methods inherited from interface javax.accessibility.Accessible 

getAccessibleContext 

Methods inherited from interface java.awt.image.ImageObserver 

imageUpdate 

Methods inherited from interface java.awt.MenuContainer 

getFont, postEvent, remove 

Constructors

XMLTreeView()

public  XMLTreeView()

The class constructor. Creates an object of type XMLTreeView.

Methods

getPreferredSize()

public java.awt.Dimension getPreferredSize()

Returns the XMLTreeView preffered size.

Overrides:

javax.swing.JComponent.getPreferredSize() in class javax.swing.JComponent

Returns:

The Dimension object containing the XMLTreeView prefered size.

setXMLDocument(Document)

public void setXMLDocument(org.w3c.dom.Document document)

Associates the XMLTreeViewer with a XML document.

Parameters:

doc - The Document document to display.

updateUI()

public void updateUI()

Forces the XMLTreeView to update/refresh UI.

Overrides:

javax.swing.JPanel.updateUI() in class javax.swing.JPanel

oracle.xml.treeviewer

XMLTreeViewBeanInfo

Syntax

public class XMLTreeViewBeanInfo extends java.beans.SimpleBeanInfo
 
java.lang.Object
  |
  +--java.beans.SimpleBeanInfo
        |
        +--oracle.xml.treeviewer.XMLTreeViewBeanInfo

All Implemented Interfaces:

java.beans.BeanInfo

Description

Member Summary 

 

Constructors 

 

XMLTreeViewBeanInfo() 

 

Methods 

 

getIcon(int) 

 

getPropertyDescriptors() 

 

Inherited Member Summary 

Fields inherited from interface java.beans.BeanInfo 

ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32 

Methods inherited from class java.beans.SimpleBeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors, loadImage 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Methods inherited from interface java.beans.BeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors 

Constructors

XMLTreeViewBeanInfo()

public  XMLTreeViewBeanInfo()

Methods

getIcon(int)

public java.awt.Image getIcon(int iconKind)

Overrides:

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

getPropertyDescriptors()

public java.beans.PropertyDescriptor[] getPropertyDescriptors()

Overrides:

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


oracle.xml.srcviewer Package


Description

Class Summary 

 

Classes 

 

oracle.xml.srcviewer.XMLSourceView 

Shows an XML document. 

XMLSourceViewBeanInfo 

 

oracle.xml.srcviewer.XMLSourceView

Syntax

public class XMLSourceView extends javax.swing.JPanel implements 
java.io.Serializable
 
java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.xml.srcviewer.XMLSourceView

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, 
java.awt.MenuContainer, java.io.Serializable

Description

Shows an XML document. Recognizes the following XML token types: Tag, Attribute Name, Attribute Value, Comment, CDATA, PCDATA, PI Data, PI Name and NOTATION Symbol. Each token type has a foreground color and font. The default color/font settings can be changed by the user. Takes as input an org.w3c.dom.Document object.

Member Summary 

 

Constructors 

 

XMLSourceView() 

The class constructor. 

Methods 

 

fontGet(AttributeSet) 

Extracts and returns the font from a given attributeset. 

fontSet(MutableAttributeSet, Font) 

Sets the mutableattributeset font. 

getAttributeNameFont() 

Returns the Attribute Value font. 

getAttributeNameForeground() 

Returns the Attribute Name foreground color. 

getAttributeValueFont() 

Returns the Attribute Value font. 

getAttributeValueForeground() 

Returns the Attribute Value foreground color. 

getBackground() 

Returns the background color. 

getCDATAFont() 

Returns the CDATA font. 

getCDATAForeground() 

Returns the CDATA foreground color. 

getCommentDataFont() 

Returns the Comment Data font. 

getCommentDataForeground() 

Returns the Comment Data foreground color. 

getEditedText() 

Returns the edited text. 

getJTextPane() 

Returns the viewer JTextPane component. 

getMinimumSize() 

Returns the XMLSourceView minimal size. 

getNodeAtOffset(int) 

Returns the XML node at a given offset. 

getPCDATAFont() 

Returns the PCDATA font. 

getPCDATAForeground() 

Returns the PCDATA foreground color. 

getPIDataFont() 

Returns the PI Data font. 

getPIDataForeground() 

Returns the PI Data foreground color. 

getPINameFont() 

Returns the PI Name font. 

getPINameForeground() 

Returns the PI Data foreground color. 

getSymbolFont() 

Returns the NOTATION Symbol font. 

getSymbolForeground() 

Returns the NOTATION Symbol foreground color. 

getTagFont() 

Returns the Tag font. 

getTagForeground() 

Returns the Tag foreground color. 

getText() 

Returns the XML document as a String. 

isEditable() 

Returns boolean to indicate whether this object is editable. 

selectNodeAt(int) 

Moves the cursor to XML Node at offset i

setAttributeNameFont(Font) 

Sets the Attribute Name font. 

setAttributeNameForeground(Color) 

Sets the Attribute Name foreground color. 

setAttributeValueFont(Font) 

Sets the Attribute Value font. 

setAttributeValueForeground(Color) 

Sets the Attribute Value foreground color. 

setBackground(Color) 

Sets the background color. 

setCDATAFont(Font) 

Sets the CDATA font. 

setCDATAForeground(Color) 

Sets the CDATA foreground color. 

setCommentDataFont(Font) 

Sets the Comment font. 

setCommentDataForeground(Color) 

Sets the Comment foreground color. 

setEditable(boolean) 

Sets the specified boolean to indicate whether this object should be editable. 

setPCDATAFont(Font) 

Sets the PCDATA font. 

setPCDATAForeground(Color) 

Sets the PCDATA foreground color. 

setPIDataFont(Font) 

Sets the PI Data font. 

setPIDataForeground(Color) 

Sets the PI Data foreground color. 

setPINameFont(Font) 

Sets the PI Name font. 

setPINameForeground(Color) 

Sets the PI Name foreground color. 

setSelectedNode(Node) 

Sets the cursor position at the selected XML node. 

setSymbolFont(Font) 

Sets the NOTATION Symbol font. 

setSymbolForeground(Color) 

Sets the NOTATION Symbol foreground color. 

setTagFont(Font) 

Sets the Tag font. 

setTagForeground(Color) 

Sets the Tag foreground color. 

setXMLDocument(Document) 

Associates the XMLviewer with a XML document. 

Inherited Member Summary 

Inner classes inherited from class javax.swing.JComponent 

javax.swing.JComponent.AccessibleJComponent 

Fields inherited from class javax.swing.JComponent 

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW 

Fields inherited from class java.awt.Component 

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT 

Fields inherited from interface java.awt.image.ImageObserver 

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH 

Methods inherited from class javax.swing.JPanel 

getAccessibleContext, getUIClassID, updateUI 

Methods inherited from class javax.swing.JComponent 

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVisible, unregisterKeyboardAction, update 

Methods inherited from class java.awt.Container 

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, remove, removeAll, removeContainerListener, setCursor, setLayout, validate 

Methods inherited from class java.awt.Component 

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, contains, createImage, createImage, disable, dispatchEvent, enable, enable, enableInputMethods, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait 

Methods inherited from interface javax.accessibility.Accessible 

getAccessibleContext 

Methods inherited from interface java.awt.image.ImageObserver 

imageUpdate 

Methods inherited from interface java.awt.MenuContainer 

getFont, postEvent, remove 

Constructors

XMLSourceView()

public  XMLSourceView()

The class constructor. Creates an object of type XMLSourceView.

Methods

fontGet(AttributeSet)

public static java.awt.Font fontGet(javax.swing.text.AttributeSet attributeset)

Extracts and returns the font from a given attributeset.

Parameters:

attributeset - The source Attributeset.

Returns:

The extracted Font.

fontSet(MutableAttributeSet, Font)

public static void fontSet(javax.swing.text.MutableAttributeSet 
mutableattributeset, java.awt.Font font)

Sets the mutableattributeset font.

Parameters:

mutableattributeset - The mutableattributeset to update.

font - The new Font for the mutableattributeset.

getAttributeNameFont()

public java.awt.Font getAttributeNameFont()

Returns the Attribute Value font.

Returns:

The Font object.

getAttributeNameForeground()

public java.awt.Color getAttributeNameForeground()

Returns the Attribute Name foreground color.

Returns:

The Color object.

getAttributeValueFont()

public java.awt.Font getAttributeValueFont()

Returns the Attribute Value font.

Returns:

The Font object.

getAttributeValueForeground()

public java.awt.Color getAttributeValueForeground()

Returns the Attribute Value foreground color.

Returns:

The Color object.

getBackground()

public java.awt.Color getBackground()

Returns the background color.

Overrides:

java.awt.Component.getBackground() in class java.awt.Component

Returns:

The Color object.

getCDATAFont()

public java.awt.Font getCDATAFont()

Returns the CDATA font.

Returns:

The Font object.

getCDATAForeground()

public java.awt.Color getCDATAForeground()

Returns the CDATA foreground color.

Returns:

The Color object.

getCommentDataFont()

public java.awt.Font getCommentDataFont()

Returns the Comment Data font.

Returns:

The Font object.

getCommentDataForeground()

public java.awt.Color getCommentDataForeground()

Returns the Comment Data foreground color.

Returns:

The Color object.

getEditedText()

public java.lang.String getEditedText()

Returns the edited text.

Returns:

The String object containing the edited text.

getJTextPane()

public javax.swing.JTextPane getJTextPane()

Returns the viewer JTextPane component.

Returns:

The JTextPane object used by XMLSourceViewer

getMinimumSize()

public java.awt.Dimension getMinimumSize()

Returns the XMLSourceView minimal size.

Overrides:

javax.swing.JComponent.getMinimumSize() in class javax.swing.JComponent

Returns:

The Dimension object containing the XMLSourceView minimum size.

getNodeAtOffset(int)

public org.w3c.dom.Node getNodeAtOffset(int i)

Returns the XML node at a given offset.

Parameters:

i - The node offset.

Returns:

The Node object from offset i.

getPCDATAFont()

public java.awt.Font getPCDATAFont()

Returns the PCDATA font.

Returns:

The Font object.

getPCDATAForeground()

public java.awt.Color getPCDATAForeground()

Returns the PCDATA foreground color.

Returns:

The Color object.

getPIDataFont()

public java.awt.Font getPIDataFont()

Returns the PI Data font.

Returns:

The Font object

getPIDataForeground()

public java.awt.Color getPIDataForeground()

Returns the PI Data foreground color.

Returns:

The Color object.

getPINameFont()

public java.awt.Font getPINameFont()

Returns the PI Name font.

Returns:

The Font object.

getPINameForeground()

public java.awt.Color getPINameForeground()

Returns the PI Data foreground color.

Returns:

The Color object.

getSymbolFont()

public java.awt.Font getSymbolFont()

Returns the NOTATION Symbol font.

Returns:

The Font object.

getSymbolForeground()

public java.awt.Color getSymbolForeground()

Returns the NOTATION Symbol foreground color.

Returns:

The Color object.

getTagFont()

public java.awt.Font getTagFont()

Returns the Tag font.

Returns:

The Font object.

getTagForeground()

public java.awt.Color getTagForeground()

Returns the Tag foreground color.

Returns:

The Color object.

getText()

public java.lang.String getText()

Returns the XML document as a String.

Returns:

The String object containing the XML document.

isEditable()

public boolean isEditable()

Returns boolean to indicate whether this object is editable.

selectNodeAt(int)

public void selectNodeAt(int i)

Moves the cursor to XML Node at offset i.

Parameters:

i - The node offset.

setAttributeNameFont(Font)

public void setAttributeNameFont(java.awt.Font font)

Sets the Attribute Name font.

Parameters:

font - The new Font for Attribute Name.

setAttributeNameForeground(Color)

public void setAttributeNameForeground(java.awt.Color color)

Sets the Attribute Name foreground color.

Parameters:

color - The new Color for Attribute Name.

setAttributeValueFont(Font)

public void setAttributeValueFont(java.awt.Font font)

Sets the Attribute Value font.

Parameters:

font - The new Font for Attribute Value.

setAttributeValueForeground(Color)

public void setAttributeValueForeground(java.awt.Color color)

Sets the Attribute Value foreground color.

Parameters:

color - The new Color for Attribute Value.

setBackground(Color)

public void setBackground(java.awt.Color color)

Sets the background color.

Overrides:

javax.swing.JComponent.setBackground(java.awt.Color) in class javax.swing.JComponent

Parameters:

color - The new background Color.

setCDATAFont(Font)

public void setCDATAFont(java.awt.Font font)

Sets the CDATA font.

Parameters:

font - The new Font for CDATA.

setCDATAForeground(Color)

public void setCDATAForeground(java.awt.Color color)

Sets the CDATA foreground color.

Parameters:

color - The new Color for CDATA.

setCommentDataFont(Font)

public void setCommentDataFont(java.awt.Font font)

Sets the Comment font.

Parameters:

font - The new Font for the XML Comments.

setCommentDataForeground(Color)

public void setCommentDataForeground(java.awt.Color color)

Sets the Comment foreground color.

Parameters:

color - The new Color for Comment.

setEditable(boolean)

public void setEditable(boolean edit)

Sets the specified boolean to indicate whether this object should be editable.

Parameters:

doc - The new boolean value.

setPCDATAFont(Font)

public void setPCDATAFont(java.awt.Font font)

Sets the PCDATA font.

Parameters:

font - The new Font for PCDATA.

setPCDATAForeground(Color)

public void setPCDATAForeground(java.awt.Color color)

Sets the PCDATA foreground color.

Parameters:

color - The new Color for PCDATA.

setPIDataFont(Font)

public void setPIDataFont(java.awt.Font font)

Sets the PI Data font.

Parameters:

font - The new Font for PI Data.

setPIDataForeground(Color)

public void setPIDataForeground(java.awt.Color color)

Sets the PI Data foreground color.

Parameters:

color - The new Color for PI Data.

setPINameFont(Font)

public void setPINameFont(java.awt.Font font)

Sets the PI Name font.

Parameters:

font - The new Font for the PI Names.

setPINameForeground(Color)

public void setPINameForeground(java.awt.Color color)

Sets the PI Name foreground color.

Parameters:

color - The new Color for PI Name.

setSelectedNode(Node)

public void setSelectedNode(org.w3c.dom.Node node)

Sets the cursor position at the selected XML node.

Parameters:

node - The selected node.

setSymbolFont(Font)

public void setSymbolFont(java.awt.Font font)

Sets the NOTATION Symbol font.

Parameters:

color - The new Font for NOTATION Symbol.

setSymbolForeground(Color)

public void setSymbolForeground(java.awt.Color color)

Sets the NOTATION Symbol foreground color.

Parameters:

color - The new Color for NOTATION Symbol.

setTagFont(Font)

public void setTagFont(java.awt.Font font)

Sets the Tag font.

Parameters:

font - The new Font for the XML Tags.

setTagForeground(Color)

public void setTagForeground(java.awt.Color color)

Sets the Tag foreground color.

Parameters:

color - The new Color for the XML Tags.

setXMLDocument(Document)

public void setXMLDocument(org.w3c.dom.Document document)

Associates the XMLviewer with a XML document.

Parameters:

doc - The Document document to display.

See Also:

getText()

oracle.xml.srcviewer

XMLSourceViewBeanInfo

Syntax

public class XMLSourceViewBeanInfo extends java.beans.SimpleBeanInfo
 
java.lang.Object
  |
  +--java.beans.SimpleBeanInfo
        |
        +--oracle.xml.srcviewer.XMLSourceViewBeanInfo

All Implemented Interfaces:

java.beans.BeanInfo

Description


Member Summary 

 

Constructors 

 

XMLSourceViewBeanInfo() 

 

Methods 

 

getIcon(int) 

 

getPropertyDescriptors() 

 


Inherited Member Summary 

Fields inherited from interface java.beans.BeanInfo 

ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32 

Methods inherited from class java.beans.SimpleBeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors, loadImage 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Methods inherited from interface java.beans.BeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors 

Constructors

XMLSourceViewBeanInfo()

public  XMLSourceViewBeanInfo()

Methods

getIcon(int)

public java.awt.Image getIcon(int iconKind)

Overrides:

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

getPropertyDescriptors()

public java.beans.PropertyDescriptor[] getPropertyDescriptors()

Overrides:

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


oracle.xml.async Package


Description


Class Summary 

 

Interfaces 

 

DOMBuilderErrorListener 

This interface must be implemented in order to receive notifications when error is found during parsing. 

DOMBuilderListener 

This interface must be implemented in order to receive notifications about events during the asyncronous parsing. 

XSLTransformerErrorListener 

This interface must be implemented in order to receive notifications about error events during the asyncronous transformation. 

XSLTransformerListener 

This interface must be implemented in order to receive notifications about events during the asyncronous transformation. 

Classes 

 

DOMBuilder 

This class implements an eXtensible Markup Language (XML) 1.0 parser according to the World Wide Web Consortium (W3C) recommendation. 

DOMBuilderBeanInfo 

 

DOMBuilderErrorEvent 

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

DOMBuilderEvent 

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

ResourceManager 

Simple semaphore that maintains access to fixed number of logical resources. 

XSLTransformer 

Applies XSL transformation in a background thread. 

XSLTransformerBeanInfo 

 

XSLTransformerErrorEvent 

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

XSLTransformerEvent 

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

oracle.xml.async


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 implements an eXtensible Markup Language (XML) 1.0 parser according to the World Wide Web Consortium (W3C) recommendation. to parse a 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.

Member Summary 

 

Constructors 

 

DOMBuilder() 

Creates a new parser object. 

Creates a new parser object. 

Creates a new parser object with a given id. 

Methods 

 

addDOMBuilderErrorListener(DOMBuilderErrorListener) 

Adds DOMBuilderErrorListener 

addDOMBuilderListener(DOMBuilderListener) 

Adds DOMBuilderListener 

 

Get the DTD 

getDocument() 

Gets the document 

getId() 

Returns the parser object id. 

getReleaseVersion() 

Returns the release version of the Oracle XML Parser 

 

Gets the document 

getValidationMode() 

Returns the validation mode 

parse(InputSource) 

Parses the XML from given input source 

 

Parses the XML from given input stream. 

parse(Reader) 

Parses the XML from given input stream. 

parse(String) 

Parses the XML from the URL indicated 

parse(URL) 

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

parseDTD(InputSource, String) 

Parses the XML External DTD from given input source 

parseDTD(InputStream, String) 

Parses the XML External DTD from given input stream. 

 

Parses the XML External DTD from given input stream. 

parseDTD(String, String) 

Parses the XML External DTD from the URL indicated 

parseDTD(URL, String) 

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

removeDOMBuilderErrorListener(DOMBuilderErrorListener) 

Remove DOMBuilderErrorListener 

removeDOMBuilderListener(DOMBuilderListener) 

Remove DOMBuilderListener 

run() 

This method runs in a thread 

setBaseURL(URL) 

Set the base URL for loading external enitites and DTDs. 

setDebugMode(boolean) 

Sets a flag to turn on debug information in the document 

setDoctype(DTD) 

Set the DTD 

setErrorStream(OutputStream) 

Creates an output stream for the output of errors and warnings. 

setErrorStream(OutputStream, String) 

Creates an output stream for the output of errors and warnings. 

setErrorStream(PrintWriter) 

Creates an output stream for the output of errors and warnings. 

setNodeFactory(NodeFactory) 

Set the node factory. 

setPreserveWhitespace(boolean) 

Set the white space preserving mode 

setValidationMode(boolean) 

Set the validation mode 

showWarnings(boolean) 

Switch to determine whether to print warnings 

Inherited Member Summary 

Fields inherited from interface oracle.xml.async.DOMBuilderConstants 

DOM_GEN_ENDED, DOM_GEN_ERROR, DOM_GEN_STARTED, DOM_METHOD1, DOM_METHOD10, DOM_METHOD2, DOM_METHOD3, DOM_METHOD4, DOM_METHOD5, DOM_METHOD6, DOM_METHOD7, DOM_METHOD8, DOM_METHOD9 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Constructors

DOMBuilder()

public  DOMBuilder()

Creates a new parser object.

DOMBuilder(int)

public  DOMBuilder(int id)

Creates a new parser object with a given 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.

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

oracle.xml.async

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

Member Summary 

 

Constructors 

 

DOMBuilderBeanInfo() 

 

Methods 

 

getIcon(int) 

 

getPropertyDescriptors() 

 

Inherited Member Summary 

Fields inherited from interface java.beans.BeanInfo 

ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32 

Methods inherited from class java.beans.SimpleBeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors, loadImage 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Methods inherited from interface java.beans.BeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors 

Constructors

DOMBuilderBeanInfo()

public  DOMBuilderBeanInfo()

Methods

getIcon(int)

public java.awt.Image getIcon(int iconKind)

Overrides:

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

getPropertyDescriptors()

public java.beans.PropertyDescriptor[] getPropertyDescriptors()

Overrides:

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

oracle.xml.async

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.

Member Summary 

 

Constructors 

 

DOMBuilderErrorEvent(Object, Exception) 

Constructor for DOMBuilderErrorEvent. 

Methods 

 

getException() 

Gets the Exception 

getMessage() 

Returns the error message generated by the parser 

Inherited Member Summary 

Methods inherited from class java.util.EventObject 

getSource, toString 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait 

Constructors

DOMBuilderErrorEvent(Object, Exception)

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

Constructor for DOMBuilderErrorEvent.

Parameters:

p0 - the Object that create this object

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

oracle.xml.async

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.

Member Summary 

 

Methods 

 

domBuilderErrorCalled(DOMBuilderErrorEvent) 

 

Methods

domBuilderErrorCalled(DOMBuilderErrorEvent)

public void domBuilderErrorCalled(DOMBuilderErrorEvent p0)

Parameters:

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

oracle.xml.async

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.

Member Summary 

 

Constructors 

 

DOMBuilderEvent(Object, int) 

 

Methods 

 

getID() 

Returns the DOMBuilder object unique id. 

Inherited Member Summary 

Methods inherited from class java.util.EventObject 

getSource, toString 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait 

Constructors

DOMBuilderEvent(Object, int)

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

Methods

getID()

public int getID()

Returns the DOMBuilder object unique id. Can be used to identify which instance of the DOMBuilder generated this event in case when multiple instances of DOMBuilder work in the background.

Returns:

The event id

oracle.xml.async

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.

Member Summary 

 

Methods 

 

domBuilderError(DOMBuilderEvent) 

This method is called when parse error occur. 

domBuilderOver(DOMBuilderEvent) 

This method is called when the parse is complete 

domBuilderStarted(DOMBuilderEvent) 

This method is called when parse starts 

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

oracle.xml.async

ResourceManager

Syntax

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

Description

Simple semaphore that maintains access to fixed number of logical resources.

Member Summary 

 

Constructors 

 

ResourceManager(int) 

The ResourceManager constructor 

Methods 

 

activeFound() 

Returns how many resources are avialable. 

getResource() 

If the number of resources avialable is nonzero, the method decreases the number of resources avialable by one and returns. 

releaseResource() 

Releases a resource. 

sleep(int) 

Let's you use Thread.sleep() without try/catch 

Inherited Member Summary 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Constructors

ResourceManager(int)

public  ResourceManager(int i)

The ResourceManager constructor

Parameters:

i - - the number of resources to manage

Methods

activeFound()

public boolean activeFound()

Returns how many resources are avialable.

getResource()

public synchronized void getResource()

If the number of resources avialable is nonzero, the method decreases the number of resources avialable by one and returns. Othervise, waits until resource is released.

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)

Let's you use Thread.sleep() without try/catch

oracle.xml.async

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.

Member Summary 

 

Constructors 

 

XSLTransformer() 

XSLTransformet constructor 

XSLTransformer(int) 

XSLTransformer constructor 

Methods 

 

addXSLTransformerErrorListener(XSLTransformerErrorListener) 

Adds an error event listener 

addXSLTransformerListener(XSLTransformerListener) 

Adds a listener 

 

Returns the unique XSLTransformer id 

getResult() 

Returns the document fragment for the resulting document. 

processXSL(XSLStylesheet, InputStream, URL) 

Initiate XSL Transformation in the background. 

processXSL(XSLStylesheet, Reader, URL) 

Initiate XSL Transformation in the background. 

processXSL(XSLStylesheet, URL, URL) 

Initiate XSL Transformation in the background. 

 

Initiate XSL Transformation in the background. 

processXSL(XSLStylesheet, XMLDocument, OutputStream) 

Initiate XSL Transformation in the background. 

removeDOMTransformerErrorListener(XSLTransformerErrorListener) 

Renmoves an error event listener 

removeXSLTransformerListener(XSLTransformerListener) 

Removes a listener 

run() 

 

 

Sets the error stream used by the XSL processor 

showWarnings(boolean) 

Sets the showWarnings flage used by the XSL processor 

Inherited Member Summary 

Fields inherited from interface oracle.xml.async.XSLTransformerConstants 

XSL_GEN_ENDED, XSL_GEN_ERROR, XSL_GEN_STARTED 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Constructors

XSLTransformer()

public  XSLTransformer()

XSLTransformet constructor

XSLTransformer(int)

public  XSLTransformer(int id)

XSLTransformer constructor

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 error event listener

Parameters:

p0 - - XSLTransformerErrorListener

addXSLTransformerListener(XSLTransformerListener)

public void addXSLTransformerListener(XSLTransformerListener p0)

Adds a listener

Parameters:

p0 - - XSLTransformerListener

getId()

public int getId()

Returns the unique XSLTransformer id

Returns:

The id

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 tre result is avialable.

processXSL(XSLStylesheet, InputStream, URL)

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

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

processXSL(XSLStylesheet, Reader, URL)

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

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

processXSL(XSLStylesheet, URL, URL)

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

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

processXSL(XSLStylesheet, XMLDocument)

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

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

processXSL(XSLStylesheet, XMLDocument, OutputStream)

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

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

removeDOMTransformerErrorListener(XSLTransformerErrorListener)

public synchronized void 
removeDOMTransformerErrorListener(XSLTransformerErrorListener p0)

Renmoves an error event listener

Parameters:

p0 - - XSLTransformerErrorListener

removeXSLTransformerListener(XSLTransformerListener)

public synchronized void removeXSLTransformerListener(XSLTransformerListener p0)

Removes a listener

Parameters:

p0 - - XSLTransformerListener

run()

public void run()

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

showWarnings(boolean)

public final void showWarnings(boolean yes)

Sets the showWarnings flage used by the XSL processor

oracle.xml.async

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

Member Summary 

 

Constructors 

 

XSLTransformerBeanInfo() 

 

Methods 

 

getIcon(int) 

 

getPropertyDescriptors() 

 

Inherited Member Summary 

Fields inherited from interface java.beans.BeanInfo 

ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32 

Methods inherited from class java.beans.SimpleBeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors, loadImage 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Methods inherited from interface java.beans.BeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors 

Constructors

XSLTransformerBeanInfo()

public  XSLTransformerBeanInfo()

Methods

getIcon(int)

public java.awt.Image getIcon(int iconKind)

Overrides:

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

getPropertyDescriptors()

public java.beans.PropertyDescriptor[] getPropertyDescriptors()

Overrides:

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

oracle.xml.async

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.

Member Summary 

 

Constructors 

 

XSLTransformerErrorEvent(Object, Exception) 

 

Methods 

 

getException() 

Returns the exception that XSLTransformer encountered object unique id. 

getMessage() 

Returns the error message that describes the error that XSLTransformer encountered 

Inherited Member Summary 

Methods inherited from class java.util.EventObject 

getSource, toString 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait 

Constructors

XSLTransformerErrorEvent(Object, Exception)

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

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

oracle.xml.async

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 asyncronous transformation. The class implementing this interface must be added to the XSLTransformet error event queue using addXSLTransformerListener method.

Member Summary 

 

Methods 

 

xslTransformerErrorCalled(XSLTransformerErrorEvent) 

This method is called when parse or transformation error occur. 

Methods

xslTransformerErrorCalled(XSLTransformerErrorEvent)

public void xslTransformerErrorCalled(XSLTransformerErrorEvent p0)

This method is called when parse or transformation error occur.

Parameters:

p0 - - The XSLTransformerErrorEvent object produced by the XSLTransformer

oracle.xml.async

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

Description

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

Member Summary 

 

Constructors 

 

XSLTransformerEvent(Object, int) 

 

Methods 

 

getID() 

Returns the XSLTransformer object unique id. 

Inherited Member Summary 

Methods inherited from class java.util.EventObject 

getSource, toString 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait 

Constructors

XSLTransformerEvent(Object, int)

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

Methods

getID()

public int getID()

Returns the XSLTransformer object unique id. Can be used to identify which instance of the XSLTransformer generated this event in case when multiple instances of XSLTransformer work in the background.

Returns:

The event id

oracle.xml.async

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 asyncronous transformation. The class implementing this interface must be added to the XSLTransformet event queue using addXSLTransformerListener method.

Member Summary 

 

Methods 

 

xslTransformerError(XSLTransformerEvent) 

This method is called when parse or transformation error occur. 

xslTransformerOver(XSLTransformerEvent) 

This method is called when the transformation is complete 

xslTransformerStarted(XSLTransformerEvent) 

This method is called when the transformation starts 

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


oracle.xml.transviewer Package


Description

Class Summary 

 

Classes 

 

DBAccess 

Maintains CLOB tables that can hold multiple XML and text documents. 

XMLTransformPanel 

XMLTransformPanel visual bean. 

XMLTransformPanelBeanInfo 

 

XMLTransViewer 

Simple application that uses XMLTransformPanel. 

oracle.xml.transviewer

DBAccess

Syntax

public class DBAccess extends java.lang.Object
 
java.lang.Object
  |
  +--oracle.xml.transviewer.DBAccess

Description

Maintains CLOB tables that can hold multiple XML and text documents. Each table is created using the statement: CREATE TABLE tablename FILENAME CHAR( 16) UNIQUE, FILEDATA CLOB) LOB(FILEDATA) STORE AS (DISABLE STORAGE IN ROW). Each XML (or text) document is stored as a row in the table and the FILENAME field holds a unique string that is used as a key to retrieve, update or delete the row. The document text is stored in the FILEDATA field that is a CLOB object. This CLOB tables are automatically maintained by the transviewer bean. The CLOB tables maintained by this class can be later used by the transviewer bean. The class creates and deletes CLOB tables, list a CLOB table content and also add, replace or delete text documents in this CLOB tables.

Member Summary 

 

Constructors 

 

DBAccess() 

 

Methods 

 

createXMLTable(Connection, String) 

Create XML table 

deleteXMLName(Connection, String, String) 

Delete text file from XML table 

dropXMLTable(Connection, String) 

Delete XML table 

getNameSize() 

Returns the size of the field where the filename is kept. 

getXMLData(Connection, String, String) 

Retrieve text file from XML table 

getXMLNames(Connection, String) 

Returns all file names in XML table 

getXMLTableNames(Connection, String) 

Gets all XML tables with names starting with a given string 

insertXMLData(Connection, String, String, String) 

Inserts text file as a row in XML table 

isXMLTable(Connection, String) 

Check if the table is XML table. 

replaceXMLData(Connection, String, String, String) 

Replace text file as a row in XML table 

xmlTableExists(Connection, String) 

Checks if the XML table exists 

Inherited Member Summary 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Constructors

DBAccess()

public  DBAccess()

Methods

createXMLTable(Connection, String)

public boolean createXMLTable(java.sql.Connection con, java.lang.String 
tablename)

Create XML table

Parameters:

con - - the Connection object

tablename - - the table name

Returns:

true if successfull

deleteXMLName(Connection, String, String)

public boolean deleteXMLName(java.sql.Connection con, java.lang.String 
tablename, java.lang.String xmlname)

Delete text file from XML table

Parameters:

con - - the Connection object

tablename - - the table name

xmlname - - the file name

Returns:

true if successfull

dropXMLTable(Connection, String)

public boolean dropXMLTable(java.sql.Connection con, java.lang.String tablename)

Delete XML table

Parameters:

con - - the Connection object

tablename - - the table name

Returns:

true if successfull

getNameSize()

public int getNameSize()

Returns the size of the field where the filename is kept.

Returns:

filename size

getXMLData(Connection, String, String)

public java.lang.String getXMLData(java.sql.Connection con, java.lang.String 
tablename, java.lang.String xmlname)

Retrieve text file from XML table

Parameters:

con - - the Connection object

tablename - - the table name

xmlname - - the file name

Returns:

file as a string

getXMLNames(Connection, String)

public java.lang.String[] getXMLNames(java.sql.Connection con, java.lang.String 
tablename)

Returns all file names in XML table

Parameters:

con - - the Connection object

tablename - - the table name

Returns:

String array with all file names in this table

getXMLTableNames(Connection, String)

public java.lang.String[] getXMLTableNames(java.sql.Connection con, 
java.lang.String tablePrefix)

Gets all XML tables with names starting with a given string

Parameters:

con - - the Connection object

tablePrefix - - table prefix string

Returns:

array of all XML tables that begin with tablePrefix

insertXMLData(Connection, String, String, String)

public boolean insertXMLData(java.sql.Connection con, java.lang.String 
tablename, java.lang.String xmlname, java.lang.String xmldata)

Inserts text file as a row in XML table

Parameters:

con - - the Connection object

tablename - - the table name

xmlname - - the file name

xmldata - - string with the file data

Returns:

true if successfull

isXMLTable(Connection, String)

public boolean isXMLTable(java.sql.Connection con, java.lang.String tablename)

Check if the table is XML table.

Parameters:

con - - the Connection object

tableName - - the table name to test

Returns:

true if this is XML table

replaceXMLData(Connection, String, String, String)

public boolean replaceXMLData(java.sql.Connection con, java.lang.String 
tablename, java.lang.String xmlname, java.lang.String xmldata)

Replace text file as a row in XML table

Parameters:

con - - the Connection object

tablename - - the table name

xmlname - - the file name

xmldata - - string with the file data

Returns:

true if successfull

xmlTableExists(Connection, String)

public boolean xmlTableExists(java.sql.Connection con, java.lang.String 
tablename)

Checks if the XML table exists

Parameters:

con - - the Connection object

tablename - - the table name

Returns:

true if the table exists

oracle.xml.transviewer

XMLTransformPanel

Syntax

public class XMLTransformPanel extends javax.swing.JPanel
 
java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.xml.transviewer.XMLTransformPanel

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, 
java.awt.MenuContainer, java.io.Serializable

Description

XMLTransformPanel visual bean. Applies XSL transformations on XML documents. Visualizes the result. Allows editing of input XML and XSL documents/files.

Member Summary 

 

Constructors 

 

XMLTransformPanel() 

The class constructor. 

Inherited Member Summary 

Inner classes inherited from class javax.swing.JComponent 

javax.swing.JComponent.AccessibleJComponent 

Fields inherited from class javax.swing.JComponent 

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW 

Fields inherited from class java.awt.Component 

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT 

Fields inherited from interface java.awt.image.ImageObserver 

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH 

Methods inherited from class javax.swing.JPanel 

getAccessibleContext, getUIClassID, updateUI 

Methods inherited from class javax.swing.JComponent 

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVisible, unregisterKeyboardAction, update 

Methods inherited from class java.awt.Container 

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, remove, removeAll, removeContainerListener, setCursor, setLayout, validate 

Methods inherited from class java.awt.Component 

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, contains, createImage, createImage, disable, dispatchEvent, enable, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait 

Methods inherited from interface javax.accessibility.Accessible 

getAccessibleContext 

Methods inherited from interface java.awt.image.ImageObserver 

imageUpdate 

Methods inherited from interface java.awt.MenuContainer 

getFont, postEvent, remove 

Constructors

XMLTransformPanel()

public  XMLTransformPanel()

The class constructor. Creates an object of type XMLTransformPanel.

oracle.xml.transviewer

XMLTransformPanelBeanInfo

Syntax

public class XMLTransformPanelBeanInfo extends java.beans.SimpleBeanInfo
 
java.lang.Object
  |
  +--java.beans.SimpleBeanInfo
        |
        +--oracle.xml.transviewer.XMLTransformPanelBeanInfo

All Implemented Interfaces:

java.beans.BeanInfo

Description

Member Summary 

 

Constructors 

 

XMLTransformPanelBeanInfo() 

 

Methods 

 

getIcon(int) 

 

getPropertyDescriptors() 

 

Inherited Member Summary 

Fields inherited from interface java.beans.BeanInfo 

ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32 

Methods inherited from class java.beans.SimpleBeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors, loadImage 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Methods inherited from interface java.beans.BeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors 

Constructors

XMLTransformPanelBeanInfo()

public  XMLTransformPanelBeanInfo()

Methods

getIcon(int)

public java.awt.Image getIcon(int iconKind)

Overrides:

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

getPropertyDescriptors()

public java.beans.PropertyDescriptor[] getPropertyDescriptors()

Overrides:

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

oracle.xml.transviewer

XMLTransViewer

Syntax

public class XMLTransViewer extends java.lang.Object
 
java.lang.Object
  |
  +--oracle.xml.transviewer.XMLTransViewer

Description

Simple application that uses XMLTransformPanel. Can be used from the command line to edit and parse XML files, edit and apply XSL transformations and retrieve and save XML, XSL and result files in the file system or in the Oracle 8i database

Member Summary 

 

Constructors 

 

XMLTransViewer() 

 

Methods 

 

main(String) 

 

Inherited Member Summary 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Constructors

XMLTransViewer()

public  XMLTransViewer()

Methods

main(String[])

public static void main(java.lang.String[] args)


oracle.xml.treeviewer Package


Description

Class Summary 

 

Classes 

 

XMLTreeView 

Shows an XML document as a tree. 

XMLTreeViewBeanInfo 

 

oracle.xml.treeviewer

XMLTreeView

Syntax

public class XMLTreeView extends javax.swing.JPanel
 
java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.xml.treeviewer.XMLTreeView

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, 
java.awt.MenuContainer, java.io.Serializable

Description

Shows an XML document as a tree. Recognizes the following XML DOM nodes: Tag, Attribute Name, Attribute Value, Comment, CDATA, PCDATA, PI Data, PI Name and NOTATION Symbol. Takes as input an org.w3c.dom.Document object.

Member Summary 

 

Constructors 

 

XMLTreeView() 

The class constructor. 

Methods 

 

getPreferredSize() 

Returns the XMLTreeView preffered size. 

setXMLDocument(Document) 

Associates the XMLTreeViewer with a XML document. 

updateUI() 

Forces the XMLTreeView to update/refresh UI. 

Inherited Member Summary 

Inner classes inherited from class javax.swing.JComponent 

javax.swing.JComponent.AccessibleJComponent 

Fields inherited from class javax.swing.JComponent 

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW 

Fields inherited from class java.awt.Component 

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT 

Fields inherited from interface java.awt.image.ImageObserver 

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH 

Methods inherited from class javax.swing.JPanel 

getAccessibleContext, getUIClassID 

Methods inherited from class javax.swing.JComponent 

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVisible, unregisterKeyboardAction, update 

Methods inherited from class java.awt.Container 

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, remove, removeAll, removeContainerListener, setCursor, setLayout, validate 

Methods inherited from class java.awt.Component 

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, contains, createImage, createImage, disable, dispatchEvent, enable, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait 

Methods inherited from interface javax.accessibility.Accessible 

getAccessibleContext 

Methods inherited from interface java.awt.image.ImageObserver 

imageUpdate 

Methods inherited from interface java.awt.MenuContainer 

getFont, postEvent, remove 

Constructors

XMLTreeView()

public  XMLTreeView()

The class constructor. Creates an object of type XMLTreeView.

Methods

getPreferredSize()

public java.awt.Dimension getPreferredSize()

Returns the XMLTreeView preffered size.

Overrides:

javax.swing.JComponent.getPreferredSize() in class javax.swing.JComponent

Returns:

The Dimension object containing the XMLTreeView prefered size.

setXMLDocument(Document)

public void setXMLDocument(org.w3c.dom.Document document)

Associates the XMLTreeViewer with a XML document.

Parameters:

doc - The Document document to display.

updateUI()

public void updateUI()

Forces the XMLTreeView to update/refresh UI.

Overrides:

javax.swing.JPanel.updateUI() in class javax.swing.JPanel

oracle.xml.treeviewer

XMLTreeViewBeanInfo

Syntax

public class XMLTreeViewBeanInfo extends java.beans.SimpleBeanInfo
 
java.lang.Object
  |
  +--java.beans.SimpleBeanInfo
        |
        +--oracle.xml.treeviewer.XMLTreeViewBeanInfo

All Implemented Interfaces:

java.beans.BeanInfo

Description

Member Summary 

 

Constructors 

 

XMLTreeViewBeanInfo() 

 

Methods 

 

getIcon(int) 

 

getPropertyDescriptors() 

 

Inherited Member Summary 

Fields inherited from interface java.beans.BeanInfo 

ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32 

Methods inherited from class java.beans.SimpleBeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors, loadImage 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Methods inherited from interface java.beans.BeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors 

Constructors

XMLTreeViewBeanInfo()

public  XMLTreeViewBeanInfo()

Methods

getIcon(int)

public java.awt.Image getIcon(int iconKind)

Overrides:

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

getPropertyDescriptors()

public java.beans.PropertyDescriptor[] getPropertyDescriptors()

Overrides:

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

oracle.xml.treeviewer Package


Description

Class Summary 

 

Classes 

 

XMLTreeView 

Shows an XML document as a tree. 

XMLTreeViewBeanInfo 

 

oracle.xml.treeviewer


XMLTreeView

Syntax

public class XMLTreeView extends javax.swing.JPanel
 
java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.xml.treeviewer.XMLTreeView

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, 
java.awt.MenuContainer, java.io.Serializable

Description

Shows an XML document as a tree. Recognizes the following XML DOM nodes: Tag, Attribute Name, Attribute Value, Comment, CDATA, PCDATA, PI Data, PI Name and NOTATION Symbol. Takes as input an org.w3c.dom.Document object.

Member Summary 

 

Constructors 

 

XMLTreeView() 

The class constructor. 

Methods 

 

getPreferredSize() 

Returns the XMLTreeView preffered size. 

setXMLDocument(Document) 

Associates the XMLTreeViewer with a XML document. 

updateUI() 

Forces the XMLTreeView to update/refresh UI. 

Inherited Member Summary 

Inner classes inherited from class javax.swing.JComponent 

javax.swing.JComponent.AccessibleJComponent 

Fields inherited from class javax.swing.JComponent 

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW 

Fields inherited from class java.awt.Component 

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT 

Fields inherited from interface java.awt.image.ImageObserver 

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH 

Methods inherited from class javax.swing.JPanel 

getAccessibleContext, getUIClassID 

Methods inherited from class javax.swing.JComponent 

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVisible, unregisterKeyboardAction, update 

Methods inherited from class java.awt.Container 

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, remove, removeAll, removeContainerListener, setCursor, setLayout, validate 

Methods inherited from class java.awt.Component 

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, contains, createImage, createImage, disable, dispatchEvent, enable, enable, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait 

Methods inherited from interface javax.accessibility.Accessible 

getAccessibleContext 

Methods inherited from interface java.awt.image.ImageObserver 

imageUpdate 

Methods inherited from interface java.awt.MenuContainer 

getFont, postEvent, remove 

Constructors

XMLTreeView()

public  XMLTreeView()

The class constructor. Creates an object of type XMLTreeView.

Methods

getPreferredSize()

public java.awt.Dimension getPreferredSize()

Returns the XMLTreeView preffered size.

Overrides:

javax.swing.JComponent.getPreferredSize() in class javax.swing.JComponent

Returns:

The Dimension object containing the XMLTreeView prefered size.

setXMLDocument(Document)

public void setXMLDocument(org.w3c.dom.Document document)

Associates the XMLTreeViewer with a XML document.

Parameters:

doc - The Document document to display.

updateUI()

public void updateUI()

Forces the XMLTreeView to update/refresh UI.

Overrides:

javax.swing.JPanel.updateUI() in class javax.swing.JPanel

oracle.xml.treeviewer

XMLTreeViewBeanInfo

Syntax

public class XMLTreeViewBeanInfo extends java.beans.SimpleBeanInfo
 
java.lang.Object
  |
  +--java.beans.SimpleBeanInfo
        |
        +--oracle.xml.treeviewer.XMLTreeViewBeanInfo

All Implemented Interfaces:

java.beans.BeanInfo

Description

Member Summary 

 

Constructors 

 

XMLTreeViewBeanInfo() 

 

Methods 

 

getIcon(int) 

 

getPropertyDescriptors() 

 

Inherited Member Summary 

Fields inherited from interface java.beans.BeanInfo 

ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32 

Methods inherited from class java.beans.SimpleBeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors, loadImage 

Methods inherited from class java.lang.Object 

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait 

Methods inherited from interface java.beans.BeanInfo 

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getMethodDescriptors 

Constructors

XMLTreeViewBeanInfo()

public  XMLTreeViewBeanInfo()

Methods

getIcon(int)

public java.awt.Image getIcon(int iconKind)

Overrides:

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

getPropertyDescriptors()

public java.beans.PropertyDescriptor[] getPropertyDescriptors()

Overrides:

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


Go to previous page Go to next page
Oracle
Copyright © 1996-2000, Oracle Corporation.

All Rights Reserved.

Library

Product

Contents

Index