org.uddi4j.util

Class KeyedReference

java.lang.Object

org.uddi4j.UDDIElement

org.uddi4j.util.KeyedReference

All Implemented Interfaces:

java.io.Serializable

public class KeyedReference
extends UDDIElement

Represents the keyedReference element within the UDDI version 2.0 schema. This class contains the following types of methods:

• A constructor that passes the required fields.
• A Constructor that will instantiate the object from an appropriate XML DOM element.
• Get/set methods for each attribute that this element can contain.
• A get/setVector method is provided for sets of attributes.
• A SaveToXML method that serializes this class within a passed in element.

Typically, this class is used to construct parameters for, or interpret responses from, methods in the UDDIProxy class.

Element description:

Service element. Represents a namespace qualified name-value pair. Depending upon the context in which it is used, this structure can be utilized within different convention frameworks.

Author:

David Melgar (dmelgar@us.ibm.com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.w3c.dom.Element	base
static java.lang.String	UDDI_TAG

Fields inherited from class org.uddi4j.UDDIElement

GENERIC, SOAPNS, XMLNS, XMLNS_PREFIX

Constructor Summary

Constructors

Constructor and Description
KeyedReference() Default constructor.
KeyedReference(org.w3c.dom.Element base) Construct the object from a DOM tree.
KeyedReference(java.lang.String keyName, java.lang.String keyValue) Construct the object with required fields.
KeyedReference(java.lang.String keyName, java.lang.String keyValue, java.lang.String tModelKey)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getKeyName()
java.lang.String	getKeyValue()
java.lang.String	getTModelKey()
void	saveToXML(org.w3c.dom.Element parent) Save an object to the DOM tree.
void	setKeyName(java.lang.String s)
void	setKeyValue(java.lang.String s)
void	setTModelKey(java.lang.String s)

Methods inherited from class org.uddi4j.UDDIElement

getChildElementsByTagName, getText

Methods inherited from class java.lang.Object

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

Field Detail

UDDI_TAG

public static final java.lang.String UDDI_TAG

See Also:

Constant Field Values

base

protected org.w3c.dom.Element base

Constructor Detail

KeyedReference

public KeyedReference()

Default constructor. Avoid using the default constructor for validation. It does not validate required fields. Instead, use the required fields constructor to perform validation.

KeyedReference

public KeyedReference(java.lang.String keyName,
                      java.lang.String keyValue)

Construct the object with required fields.

Parameters:

keyName - String

keyValue - String

KeyedReference

public KeyedReference(java.lang.String keyName,
                      java.lang.String keyValue,
                      java.lang.String tModelKey)

KeyedReference

public KeyedReference(org.w3c.dom.Element base)
               throws UDDIException

Construct the object from a DOM tree. Used by UDDIProxy to construct an object from a received UDDI message.

Parameters:

base - Element with the name appropriate for this class.

Throws:

UDDIException - Thrown if DOM tree contains a SOAP fault or a disposition report indicating a UDDI error.

Method Detail

setTModelKey

public void setTModelKey(java.lang.String s)

setKeyName

public void setKeyName(java.lang.String s)

setKeyValue

public void setKeyValue(java.lang.String s)

getTModelKey

public java.lang.String getTModelKey()

getKeyName

public java.lang.String getKeyName()

getKeyValue

public java.lang.String getKeyValue()

saveToXML

public void saveToXML(org.w3c.dom.Element parent)

Save an object to the DOM tree. Used to serialize an object to a DOM tree, usually to send a UDDI message.
Used by UDDIProxy.

Specified by:

saveToXML in class UDDIElement

Parameters:

parent - Object will serialize as a child element under the passed in parent element.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object