org.pfsw.tools.cda.base.model

Class ComponentModel

java.lang.Object

org.pfsw.tools.cda.base.model.ComponentModel

All Implemented Interfaces:

IComponentHolder

public class ComponentModel
extends java.lang.Object
implements IComponentHolder

An envelope around a set of components an their dependencies.

Constructor Summary

Constructors

Constructor and Description
ComponentModel(java.lang.String modelName, Workset aWorkset) Initialize the new instance with a name and a workset.
ComponentModel(Workset aWorkset) Initialize the new instance with a workset.

Method Summary

Modifier and Type	Method and Description
void	addComponent(SoftwareComponent component) Add the given component
protected void	clearPackageAssignmentOfAllComponents()
protected CollectionUtil	coll()
SoftwareComponent[]	getComponents() Returns all containers that are hold by this object
java.lang.String	getDescription()
protected java.util.List<SoftwareComponent>	getIncludedComponents()
java.lang.String	getName()
IComponentHolder	getParentComponentHolder() Returns the parent holder that contains this object.
Workset	getWorkset()
java.util.List<ClassPackage>	initializePackages() Scans the given workset for all packages that match a pattern of one of the components in the component model.
boolean	processSoftwareComponents(java.util.Collection<SoftwareComponent> collection, ISoftwareComponentProcessor processor) Calls the given processor for each contained component object and adds all component objects that the processor wants to the given collection.
void	removeComponent(SoftwareComponent component) Remove the given component
void	setDescription(java.lang.String newValue)
protected void	setIncludedComponents(java.util.List<SoftwareComponent> newValue)
protected void	setName(java.lang.String newValue)
protected void	setWorkset(Workset newValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentModel

public ComponentModel(Workset aWorkset)

Initialize the new instance with a workset.

ComponentModel

public ComponentModel(java.lang.String modelName,
                      Workset aWorkset)

Initialize the new instance with a name and a workset.

Method Detail

getName

public java.lang.String getName()

setName

protected void setName(java.lang.String newValue)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String newValue)

getIncludedComponents

protected java.util.List<SoftwareComponent> getIncludedComponents()

setIncludedComponents

protected void setIncludedComponents(java.util.List<SoftwareComponent> newValue)

getWorkset

public Workset getWorkset()

setWorkset

protected void setWorkset(Workset newValue)

getComponents

public SoftwareComponent[] getComponents()

Description copied from interface: IComponentHolder

Returns all containers that are hold by this object

Specified by:

getComponents in interface IComponentHolder

getParentComponentHolder

public IComponentHolder getParentComponentHolder()

Description copied from interface: IComponentHolder

Returns the parent holder that contains this object. If this object has no parent null will be returned.

Specified by:

getParentComponentHolder in interface IComponentHolder

addComponent

public void addComponent(SoftwareComponent component)

Description copied from interface: IComponentHolder

Add the given component

Specified by:

addComponent in interface IComponentHolder

removeComponent

public void removeComponent(SoftwareComponent component)

Remove the given component

Specified by:

removeComponent in interface IComponentHolder

processSoftwareComponents

public boolean processSoftwareComponents(java.util.Collection<SoftwareComponent> collection,
                                         ISoftwareComponentProcessor processor)

Calls the given processor for each contained component object and adds all component objects that the processor wants to the given collection.

Parameters:

collection - The collection to which the matching objects will be added (might be null)

processor - The processor that decides whether or not an object must be added (must not be null)

Returns:

true if processing should continue, otherwise false

initializePackages

public java.util.List<ClassPackage> initializePackages()

Scans the given workset for all packages that match a pattern of one of the components in the component model. Returns a list of all those packages that are not yet associated with a component.

clearPackageAssignmentOfAllComponents

protected void clearPackageAssignmentOfAllComponents()

coll

protected CollectionUtil coll()