Package org.cristalise.kernel.collection

Class Aggregation

java.lang.Object

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

org.cristalise.kernel.collection.Aggregation

All Implemented Interfaces:

C2KLocalObject

Direct Known Subclasses:

AggregationDescription, AggregationInstance

public abstract class Aggregation
extends Collection<AggregationMember>

A Collection with a graph layout

Nested Class Summary

Nested classes/interfaces inherited from class org.cristalise.kernel.collection.Collection

Collection.Cardinality, Collection.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected GraphModel	mLayout

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

mMembers, mName, mVersion

Constructor Summary

Constructors

Constructor	Description
Aggregation()
Aggregation(String name)
Aggregation(String name, Integer version)

Method Summary

Modifier and Type	Method	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.
AggregationMember	addMember(CastorHashMap props, String classProps, GraphPoint location, int w, int h, TransactionKey transactionKey)
AggregationMember	addSlot(CastorHashMap props, String classProps)
AggregationMember	addSlot(CastorHashMap props, String classProps, GraphPoint location, int w, int h)
boolean	exists(ItemPath itemPath)
static boolean	getIsComposite(ItemPath itemPath, String name, TransactionKey transactionKey)
GraphModel	getLayout()
AggregationMember	getMemberPair(int vertexID)
TypeNameAndConstructionInfo[]	getVertexTypeNameAndConstructionInfo()
AggregationMember	removeMember(int memberId)	Removes the slot with the given ID from the collection.
void	setLayout(GraphModel layout)

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

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

Methods inherited from class java.lang.Object

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

Field Details

mLayout

protected GraphModel mLayout

Constructor Details

Aggregation

public Aggregation()

Aggregation

public Aggregation(String name)

Aggregation

public Aggregation(String name,
 Integer version)

Method Details

getLayout

public GraphModel getLayout()

setLayout

public void setLayout(GraphModel layout)

getVertexTypeNameAndConstructionInfo

public TypeNameAndConstructionInfo[] getVertexTypeNameAndConstructionInfo()

exists

public boolean exists(ItemPath itemPath)

getMemberPair

public AggregationMember getMemberPair(int vertexID)

addSlot

public AggregationMember addSlot(CastorHashMap props,
 String classProps,
 GraphPoint location,
 int w,
 int h)

addMember

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

Throws:

InvalidCollectionModification

ObjectAlreadyExistsException

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.

Specified by:

addMember in class Collection<AggregationMember>

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(CastorHashMap props,
 String classProps,
 GraphPoint location,
 int w,
 int h,
 TransactionKey transactionKey)
                            throws InvalidCollectionModification

Throws:

InvalidCollectionModification

addSlot

public AggregationMember addSlot(CastorHashMap props,
 String classProps)

removeMember

public AggregationMember removeMember(int memberId)
                               throws ObjectNotFoundException

Description copied from class: Collection

Removes the slot with the given ID from the collection.

Overrides:

removeMember in class Collection<AggregationMember>

Parameters:

memberId - to remove

Returns:

removed member instance

Throws:

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

getIsComposite

public static boolean getIsComposite(ItemPath itemPath,
 String name,
 TransactionKey transactionKey)