org.cristalise.kernel.collection

Class AggregationInstance

java.lang.Object

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

org.cristalise.kernel.collection.Aggregation

org.cristalise.kernel.collection.AggregationInstance

All Implemented Interfaces:

C2KLocalObject

public class AggregationInstance
extends Aggregation

Field Summary

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

mLayout

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

mMembers, mName, mVersion

Constructor Summary

Constructors

Constructor and Description
AggregationInstance()
AggregationInstance(String name)
AggregationInstance(String name, Integer version)

Method Summary

Modifier and Type	Method and Description
AggregationMember	addMember(ItemPath itemPath, CastorHashMap props, String classProps, GraphPoint location, int w, int h, TransactionKey transactionKey)
AggregationMember	addMember(ItemPath itemPath, CastorHashMap props, String classProps, TransactionKey transactionKey) 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.

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

addMember, addSlot, addSlot, exists, getIsComposite, getLayout, getMemberPair, getVertexTypeNameAndConstructionInfo, removeMember, setLayout

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cristalise.kernel.entity.C2KLocalObject

enforceValidName

Constructor Detail

AggregationInstance

public AggregationInstance()

AggregationInstance

public AggregationInstance(String name)

AggregationInstance

public AggregationInstance(String name,
                           Integer version)

Method Detail

addMember

public AggregationMember addMember(ItemPath itemPath,
                                   CastorHashMap props,
                                   String classProps,
                                   TransactionKey transactionKey)
                            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.

Overrides:

addMember in class Aggregation

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

addMember

public AggregationMember addMember(ItemPath itemPath,
                                   CastorHashMap props,
                                   String classProps,
                                   GraphPoint location,
                                   int w,
                                   int h,
                                   TransactionKey transactionKey)
                            throws InvalidCollectionModification,
                                   ObjectAlreadyExistsException

Overrides:

addMember in class Aggregation

Throws:

InvalidCollectionModification

ObjectAlreadyExistsException