org.cristalise.kernel.collection

Class Dependency

java.lang.Object

org.cristalise.kernel.collection.Collection<DependencyMember>

org.cristalise.kernel.collection.Dependency

All Implemented Interfaces:

C2KLocalObject

Direct Known Subclasses:

DependencyDescription

public class Dependency
extends Collection<DependencyMember>

A Collection implementation that contains a variable number of members of the same type, like a variable-length array. CollectionMembers are created and destroyed as needed. A Dependency never contains empty slots, nor duplicated members.

ClassProps are stored at the collection level and duplicated in each slot. Slots may still have their own individual properties annotating their link. Predefined steps managing Dependencies:

Field Summary

Fields

Modifier and Type	Field and Description
protected String	mClassProps
protected CastorHashMap	mProperties

Fields inherited from class org.cristalise.kernel.collection.Collection

EMPTY, mMembers, mName, mVersion

Constructor Summary

Constructors

Constructor and Description
Dependency()
Dependency(String name)

Method Summary

Methods

Modifier and Type	Method and Description
DependencyMember	addMember(ItemPath itemPath)
DependencyMember	addMember(ItemPath itemPath, CastorHashMap props, String classProps) Add a member to this collection, with the given property and class properties and optionally an Item to assign, which may be null if the collection allows empty slots.
List<ItemPath>	compare(Dependency other) Returns all ItemPaths that are members of the other collection but not members of this one.
String	getClassProps()
KeyValuePair[]	getKeyValuePairs()
CastorHashMap	getProperties()
void	removeMember(int memberId) Removes the slot with the given ID from the collection.
void	setClassProps(String classProps)
void	setKeyValuePairs(KeyValuePair[] pairs)
void	setProperties(CastorHashMap props)

Methods inherited from class org.cristalise.kernel.collection.Collection

contains, equals, getClusterType, getCounter, getDescVer, getMember, getMembers, getName, getVersion, getVersionName, hashCode, isFull, setMembers, setName, setVersion, size

Methods inherited from class java.lang.Object

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

Field Detail

mProperties

protected CastorHashMap mProperties

mClassProps

protected String mClassProps

Constructor Detail

Dependency

public Dependency()

Dependency

public Dependency(String name)

Method Detail

getProperties

public CastorHashMap getProperties()

setProperties

public void setProperties(CastorHashMap props)

getKeyValuePairs

public KeyValuePair[] getKeyValuePairs()

setKeyValuePairs

public void setKeyValuePairs(KeyValuePair[] pairs)

setClassProps

public void setClassProps(String classProps)

getClassProps

public String getClassProps()

addMember

public DependencyMember addMember(ItemPath itemPath)
                           throws InvalidCollectionModification,
                                  ObjectAlreadyExistsException

Throws:

InvalidCollectionModification

ObjectAlreadyExistsException

compare

public List<ItemPath> compare(Dependency other)

Returns all ItemPaths that are members of the other collection but not members of this one.

Parameters:

other - - The collection to compare

Returns:

List of ItemPaths

addMember

public DependencyMember addMember(ItemPath itemPath,
                         CastorHashMap props,
                         String classProps)
                           throws InvalidCollectionModification,
                                  ObjectAlreadyExistsException

Description copied from class: Collection

Add a member to this collection, with the given property and class properties and optionally an Item to assign, which may be null if the collection allows empty slots.

Specified by:

addMember in class Collection<DependencyMember>

Parameters:

itemPath - the Item to assign to the new slot. Optional for collections that allow empty slots

props - the Properties of the new member

classProps - the names of the properties that dictate the type of assigned Items.

Returns:

the new CollectionMember instance

Throws:

InvalidCollectionModification - when the assignment was invalid because of collection constraints, such as global type constraints, or not allowing empty slots.

ObjectAlreadyExistsException - some collections don't allow multiple slots assigned to the same Item, and throw this Exception if it is attempted

removeMember

public void removeMember(int memberId)
                  throws ObjectNotFoundException

Description copied from class: Collection

Removes the slot with the given ID from the collection.

Specified by:

removeMember in class Collection<DependencyMember>

Parameters:

memberId - to remove

Throws:

ObjectNotFoundException - when there was no slot with this ID found.