oracle.uddi.message.util
Class KeyedReference

java.lang.Object
  |
  +--oracle.uddi.message.UddiElement
        |
        +--oracle.uddi.message.util.KeyedReference

public class KeyedReference

extends UddiElement

General information:

This class represents an element within the UDDI API schema

Element description:

It maps to keyedReference element, which represents a namespace qualified name-value pair. It is used in different contexts, for example, CategoryBag.

Field Summary

static java.lang.String	ATTR_KEYNAME
static java.lang.String	ATTR_KEYVALUE
static java.lang.String	ATTR_TMODELKEY
static java.lang.String	UDDI_TAG

Constructor Summary

KeyedReference()
Deprecated. retained for backward compatibility. It will be removed in the next release.

KeyedReference(UddiElementFactory ueFactory)

Method Summary

java.lang.String	getKeyName()
java.lang.String	getKeyValue()
java.lang.String	getTagName() Returns the local name of the tag of the UDDI Element.
java.lang.String	getTModelKey()
void	init() This method is not intended for use by clients of the API.
boolean	isEmpty() Return true if the keyedReference is empty
void	setKeyName(java.lang.String keyName)
void	setKeyValue(java.lang.String keyValue)
void	setTModelKey(java.lang.String tModelKey)

Methods inherited from class oracle.uddi.message.UddiElement

getElementName, getElementPrefix, getGeneric, getNamespaceUri, getUddiElementFactory, getVersion, hasEmptyContent, isV1Compatible, isV2Compatible, marshall, unmarshall

Methods inherited from class java.lang.Object

equals, 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

ATTR_TMODELKEY

public static final java.lang.String ATTR_TMODELKEY

See Also:

Constant Field Values

ATTR_KEYNAME

public static final java.lang.String ATTR_KEYNAME

See Also:

Constant Field Values

ATTR_KEYVALUE

public static final java.lang.String ATTR_KEYVALUE

See Also:

Constant Field Values

Constructor Detail

KeyedReference

public KeyedReference()

Deprecated. retained for backward compatibility. It will be removed in the next release.

KeyedReference

public KeyedReference(UddiElementFactory ueFactory)

Method Detail

init

public void init()

Description copied from class: UddiElement

This method is not intended for use by clients of the API.

Initalizes the element. If the element has been initalized, it re-initalizes the element so that it is as if it is a new object. This method enables object reuse.

Note on re-initalization: Reinitalization is done such that the object will be in the state as if it is a new object. It implies that all sub-elements will be discarded. If the caller wants to re-use sub-elements, it is caller's responsibility to get the sub-elements prior to re-initalization and reassign the optional sub-elements after re-initalization.

For example, A tModel contains an optional sub-element identifierBag. Hence identifierBag will be discarded. If the caller wishes to re-use the identifierBag, the caller has to get the identifierBag, re-initalize it and assign it back as the tModel's identifierBag :

   ...
   IdentifierBag identifierBag = tModel.getIdentifierBag();
   tModel.init();
   identifierBag.init();
   tModel.setIdentifierBag(identifierBag);
   ...

Access to UddiElement and its sub-structure is not guaranteed to be thread-safe.

Every subclass of UddiElement MUST overwrite init(). In the implementation, it should always invoke super.init() and intialize/reinitialize subclass-specific members. The pattern is exactly the same as a Java constructor.

Overrides:

init in class UddiElement

getTagName

public java.lang.String getTagName()

Description copied from class: UddiElement

Returns the local name of the tag of the UDDI Element.

Specified by:

getTagName in class UddiElement

getTModelKey

public java.lang.String getTModelKey()

setTModelKey

public void setTModelKey(java.lang.String tModelKey)

getKeyName

public java.lang.String getKeyName()

setKeyName

public void setKeyName(java.lang.String keyName)

getKeyValue

public java.lang.String getKeyValue()

setKeyValue

public void setKeyValue(java.lang.String keyValue)

isEmpty

public boolean isEmpty()

Return true if the keyedReference is empty