com.finwin.util
Class WDDXDocument

java.lang.Object
  |
  +--com.finwin.util.WDDXDocument

public class WDDXDocument

extends java.lang.Object

implements java.io.Serializable

Represents a WDDX XML Message. This object is provided to manage the resultant data from a WDDX Message. It is the entry point in to managing this data. This object expects to be constructed from or to receive via setDocument(Document) a org.w3c.dom.Document. From this Document object the methods in this object and the other WDDXObject based objects one may retreive the data in the result message from a FinWin data request.

See Also:

Serialized Form

Constructor Summary

WDDXDocument()
Default constructor called when this object is accessed as a bean.

WDDXDocument(org.w3c.dom.Document doc)
Constructs the WDDXDocument from a org.w3c.dom.Document.

Method Summary

WDDXObject	getData() Obtains the Data object of the WDDX document.
static org.w3c.dom.Node	getFirstInstance(org.w3c.dom.Node base, java.lang.String nodePath) Obtains the first instance of the node named by nodePath
void	setDocument(org.w3c.dom.Document doc) Sets the document for the object.
java.lang.String	toString() Provides the descriptive string output

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WDDXDocument

public WDDXDocument()

Default constructor called when this object is accessed as a bean.

WDDXDocument

public WDDXDocument(org.w3c.dom.Document doc)

Constructs the WDDXDocument from a org.w3c.dom.Document. The object will then use this object to retreive the data.

Parameters:

doc - The WDDX Document to obtain data from

Method Detail

setDocument

public void setDocument(org.w3c.dom.Document doc)

Sets the document for the object. Do not call in conjunction with WDDXDocument(Document). Also do not call this method twice. Doing either will result an IllegalArgumentException.

Parameters:

doc - The WDDX Document to obtain data from

Throws:

IllegalArugmentException - if this method or WDDXDocument(Document) has been called.

getFirstInstance

public static org.w3c.dom.Node getFirstInstance(org.w3c.dom.Node base,
                                                java.lang.String nodePath)

Obtains the first instance of the node named by nodePath

Parameters:

nodePath - A path string (element names separated by "/" characters) defining the path in the XML document to the node to be fetched

Returns:

The Node named or null if not found.

getData

public WDDXObject getData()

Obtains the Data object of the WDDX document. This data object will be an implementor of WDDXObject.

See Also:

WDDXObject for a listing of implementors., WDDXStruct, WDDXRecordset, WDDXVar

toString

public java.lang.String toString()

Provides the descriptive string output

Overrides:

toString in class java.lang.Object