org.apache.juddi.datatype
Class OverviewDoc

java.lang.Object
  org.apache.juddi.datatype.OverviewDoc

All Implemented Interfaces:

java.io.Serializable, RegistryObject

public class OverviewDoc
extends java.lang.Object
implements RegistryObject

Optional structure in InstanceDetails used for overview information about a particular TModel use within a BindingTemplate.

Author:

Steve Viens (sviens@apache.org)

See Also:

Serialized Form

Constructor Summary

OverviewDoc()
Construct a new emtpy overviewDoc instance.

OverviewDoc(OverviewURL url)
Construct a new overviewDoc with a given overviewURL.

OverviewDoc(java.lang.String url)
Construct a new overviewDoc with a given overviewURL.

Method Summary

void	addDescription(Description desc) Adds the given description.
java.util.Vector	getDescriptionVector() Returns the descriptions.
OverviewURL	getOverviewURL() Returns the overviewURL of this overviewDoc.
java.lang.String	getOverviewURLString() Returns the overviewURL of this overviewDoc.
void	setDescriptionVector(java.util.Vector descs) Sets the description list to the current one.
void	setOverviewURL(OverviewURL url) Sets the overviewURL to the String value of the given URL.
void	setOverviewURL(java.lang.String url) Sets the overviewURL to the given URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

OverviewDoc

public OverviewDoc()

Construct a new emtpy overviewDoc instance.

OverviewDoc

public OverviewDoc(java.lang.String url)

Construct a new overviewDoc with a given overviewURL.

Parameters:

url - The overviewURL of this overviewDoc

OverviewDoc

public OverviewDoc(OverviewURL url)

Construct a new overviewDoc with a given overviewURL.

Parameters:

url - The overviewURL of this overviewDoc

Method Detail

addDescription

public void addDescription(Description desc)

Adds the given description. If there was already a description with the same language-code as the new description, an exception will be thrown.

Parameters:

desc - The description to add.

setDescriptionVector

public void setDescriptionVector(java.util.Vector descs)

Sets the description list to the current one. Ignores any object in the collection that is not an "instanceof" the Description class.

Parameters:

descs - Descriptions of Description objects to set

getDescriptionVector

public java.util.Vector getDescriptionVector()

Returns the descriptions.

Returns:

the descriptions instance.

setOverviewURL

public void setOverviewURL(OverviewURL url)

Sets the overviewURL to the String value of the given URL.

Parameters:

url - The new overviewURL.

setOverviewURL

public void setOverviewURL(java.lang.String url)

Sets the overviewURL to the given URL.

Parameters:

url - The new overviewURL.

getOverviewURL

public OverviewURL getOverviewURL()

Returns the overviewURL of this overviewDoc.

Returns:

The overviewURL of this overviewDoc, or null if there is no overviewURL.

getOverviewURLString

public java.lang.String getOverviewURLString()

Returns the overviewURL of this overviewDoc.

Returns:

The overviewURL of this overviewDoc as a String, or null if there is no overviewURL.