Oracle Application Server Web Services UDDI Client API Reference
10g (9.0.4)

Part No. B10396-01

oracle.uddi.message.util
Class Description

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

public class Description
extends UddiElement

General information:

This class represents an element within the UDDI API schema

Element description:

It maps to description element, which is used in various UDDI base data types.


Field Summary
static java.lang.String ATTR_LANG
           
static java.lang.String UDDI_TAG
           

 

Constructor Summary
Description(UddiElementFactory ueFactory)
           

 

Method Summary
static java.util.List createOneDescriptionList(java.lang.String szDescription, java.lang.String szLang, UddiElementFactory ueFactory)
          Creates a list of description with one description
 java.lang.String getContent()
           
static java.lang.String getDefaultOrFirstDescription(java.util.List listDescription)
          Return the default description (the one without language attribute).
static java.lang.String getFirstDescription(java.util.List listDescription)
          Return the first description Return null if there is no description
static Description getFirstDescriptionAsDescription(java.util.List listDescription)
          Return the first description Return null if there is no description
 java.lang.String getLang()
           
 java.lang.String getTagName()
          Returns the local name of the tag of the UDDI Element.
 void init()
          This method is not intended for use by clients of the API.
 void setContent(java.lang.String content)
           
static void setDefaultDescription(java.util.List listDescription, java.lang.String defaultDesc, UddiElementFactory ueFactory)
          Set the default description, i.e., the description without any language qualifier.
 void setLang(java.lang.String lang)
           

 

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_LANG

public static final java.lang.String ATTR_LANG
See Also:
Constant Field Values
Constructor Detail

Description

public Description(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

getContent

public java.lang.String getContent()

setContent

public void setContent(java.lang.String content)

getLang

public java.lang.String getLang()

setLang

public void setLang(java.lang.String lang)

setDefaultDescription

public static void setDefaultDescription(java.util.List listDescription,
                                         java.lang.String defaultDesc,
UddiElementFactory ueFactory)
Set the default description, i.e., the description without any language qualifier.
Parameters:
listDescription - the vector of descriptions. Existing default description, if present, will be replaced.
defaultDesc - the default description to be set.

createOneDescriptionList

public static java.util.List createOneDescriptionList(java.lang.String szDescription,
                                                      java.lang.String szLang,
UddiElementFactory ueFactory)
Creates a list of description with one description

getFirstDescription

public static java.lang.String getFirstDescription(java.util.List listDescription)
Return the first description Return null if there is no description
Parameters:
listDescription - the vector of descriptions.

getFirstDescriptionAsDescription

public static Description getFirstDescriptionAsDescription(java.util.List listDescription)
Return the first description Return null if there is no description
Parameters:
listDescription - the vector of descriptions.

getDefaultOrFirstDescription

public static java.lang.String getDefaultOrFirstDescription(java.util.List listDescription)
Return the default description (the one without language attribute). If there is no default, then returns the first description.
Parameters:
listDescription - the vector of descriptions.

Oracle Application Server Web Services UDDI Client API Reference
10g (9.0.4)

Part No. B10396-01

Copyright © 2001, 2003, Oracle. All rights reserved.