com.ptc.windchill.esi.rnd
Class VdbGroup

java.lang.Object
  com.ptc.windchill.esi.rnd.VdbGroup

All Implemented Interfaces:

Serializable

public final class VdbGroup

extends Object

implements Serializable

Manages a collection of VdbElements and renderers the contents as an Info*Engine Group.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private LinkedHashMap	elements
private String	name
private static String	RESOURCE

Constructor Summary

VdbGroup(String name)
Only constructor for the class.

Method Summary

void	addElement(Object key, VdbElement element) Adds a VdbElement to the collection at the location identified by key.
Group	asGroup() Renders the VdbGroup as an Info*engine Group.
VdbElement	getElement(Object key) Returns the element whose key is equal to the arrgument.
Collection	getElements() Returns the values of the elements collection.
String	getName() Gets the value of the attribute: name; The logical name of the VdbGroup.
void	removeElement(Object key) Removes an element from the elements collection if there is one with a key equal to the argument.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

name

private String name

elements

private LinkedHashMap elements

Constructor Detail

VdbGroup

public VdbGroup(String name)

Only constructor for the class. Ensures that the object is ready to process method calls.

Supported API: false

Parameters:

name -

Method Detail

getName

public String getName()

Gets the value of the attribute: name; The logical name of the VdbGroup.

Supported API: true

Returns:

String

getElement

public VdbElement getElement(Object key)

Returns the element whose key is equal to the arrgument. If no matching key, returns null.

Supported API: true

Parameters:

key - The identifier of the object in the collection

Returns:

VdbElement

getElements

public Collection getElements()

Returns the values of the elements collection.

Supported API: true

Returns:

Collection

addElement

public void addElement(Object key,
                       VdbElement element)

Adds a VdbElement to the collection at the location identified by key. If there is already an element at that location, it is replaced.

Supported API: true

Parameters:

key - The location to store the VdbElement.

element - The VdbElement that is to be added to the collection.

removeElement

public void removeElement(Object key)

Removes an element from the elements collection if there is one with a key equal to the argument.

Supported API: true

Parameters:

key - The key that identifies the element to be removed.

asGroup

public Group asGroup()

Renders the VdbGroup as an Info*engine Group.

Supported API: true

Returns:

Group