com.tensegrity.composite
Interface BaseCompositeContainer

All Known Subinterfaces:

CompositeGroup, CompositeSwimLane, CompositeSwimLanePool, CompositeView, VisualGraphView, VisualSubgraphComposite

public interface BaseCompositeContainer

The BaseCompositeContainer interface is a collection container specification for objects which implement the BaseComposite interface. Such objects can be added to and removed from any instance of a class which implements this interface.

The methods that deal with the contained composites are:

• getCompositeCount()
• addComposite(com.tensegrity.composite.BaseComposite) / removeComposite(com.tensegrity.composite.BaseComposite)
• addComposites(java.util.List) / removeComposites(java.util.List)
• setComposites(java.util.List)
• removeAllComposites()
• getCompositeIterator()

Version:

$Id: BaseCompositeContainer.java,v 1.8 2005/06/16 16:13:43 AndreasEbbert Exp $

Author:

MichaelKegel

Method Summary

void	addComposite(BaseComposite bcomposite) Adds the given BaseComposite to this BaseCompositeContainer.
void	addComposites(java.util.List bcomposites) Adds the BaseComposites contained in the given list to this BaseCompositeContainer.
int	getCompositeCount() Returns the number of BaseComposite actually added to the BaseCompositeContainer.
BaseCompositeIterator	getCompositeIterator() Returns a BaseCompositeIterator that can be used to iterate over the BaseCompositeContainers list of BaseComposites.
void	removeAllComposites() Removes all BaseComposites from the list of BaseComposite of the BaseCompositeContainer.
void	removeComposite(BaseComposite bcomposite) Removes the given BaseComposite from this BaseCompositeContainer.
void	removeComposites(java.util.List bcomposites) Removes the BaseComposites contained in the given list from this BaseCompositeContainer.
void	setComposites(java.util.List bcomposites) Add the BaseComposites contained in the given List to this BaseCompositeContainer.

Method Detail

getCompositeCount

public int getCompositeCount()

Returns the number of BaseComposite actually added to the BaseCompositeContainer.

Returns:

int the actual number of BaseComposites in the CompositeGroup

Find more information in the class documentation

addComposite

public void addComposite(BaseComposite bcomposite)

Adds the given BaseComposite to this BaseCompositeContainer.

Parameters:

bcomposite - the BaseComposite to add

Find more information in the class documentation

removeComposite

public void removeComposite(BaseComposite bcomposite)

Removes the given BaseComposite from this BaseCompositeContainer.

Parameters:

bcomposite - the BaseComposite to remove

Find more information in the class documentation

addComposites

public void addComposites(java.util.List bcomposites)

Adds the BaseComposites contained in the given list to this BaseCompositeContainer.

Parameters:

bcomposites - the list of BaseComposites to add

Find more information in the class documentation

removeComposites

public void removeComposites(java.util.List bcomposites)

Removes the BaseComposites contained in the given list from this BaseCompositeContainer.

Parameters:

bcomposites - the list of BaseComposite to remove

Find more information in the class documentation

setComposites

public void setComposites(java.util.List bcomposites)

Add the BaseComposites contained in the given List to this BaseCompositeContainer. All the BaseComposites that are part of the list of BaseComposite of the BaseCompositeContainer but not part of the List given by bcomposites will be removed from the list of BaseComposite of the BaseCompositeContainer.

Parameters:

bcomposites - the list of BaseComposites to set as elements of the BaseCompositeContainer

Find more information in the class documentation

removeAllComposites

public void removeAllComposites()

Removes all BaseComposites from the list of BaseComposite of the BaseCompositeContainer.

Find more information in the class documentation

getCompositeIterator

public BaseCompositeIterator getCompositeIterator()

Returns a BaseCompositeIterator that can be used to iterate over the BaseCompositeContainers list of BaseComposites.

Returns:

BaseCompositeIterator to walk through the BaseCompositeContainers list of BaseComposites

Find more information in the class documentation