org.cristalise.kernel.collection

Class DependencyMember

java.lang.Object

org.cristalise.kernel.collection.DependencyMember

All Implemented Interfaces:

CollectionMember

public class DependencyMember
extends Object
implements CollectionMember

Constructor Summary

Constructors

Constructor and Description
DependencyMember()

Method Summary

Modifier and Type	Method and Description
void	assignItem(ItemPath itemPath, TransactionKey transactionKey) Assign the given item to the slot, if it fits
void	clearItem() De-assign the slot, leaving it empty.
boolean	convertToItemPropertyByScript(PropertyArrayList props, TransactionKey transactionKey) Executes Script if it was defined in the Member properties
protected Object	evaluateScript(TransactionKey transactionKey)
Object	getBuiltInProperty(BuiltInVertexProperties prop)
String	getChildUUID() Returns the UUID of the currently assigned Item
String	getClassProps() Gets the class properties, which specify type information in child Items.
int	getID() Get the integer slot ID, as generated by the parent Collection
ItemPath	getItemPath() Returns the current assigned ItemPath
KeyValuePair[]	getKeyValuePairs()
CastorHashMap	getProperties() Gets the member properties.
ItemProxy	resolveItem(TransactionKey transactionKey) Resolve the Item currently assigned
void	setBuiltInProperty(BuiltInVertexProperties prop, Object val)
void	setChildUUID(String uuid)
void	setClassProps(String props)
void	setID(int id)
void	setKeyValuePairs(KeyValuePair[] pairs)
void	setProperties(CastorHashMap props)
void	updatePropertieFromDescription(CastorHashMap propDesc, DependencyMember newMember)
void	updateProperties(CastorHashMap newProps) Only update existing properties otherwise throw an exception

Methods inherited from class java.lang.Object

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

Constructor Detail

DependencyMember

public DependencyMember()

Method Detail

getItemPath

public ItemPath getItemPath()

Description copied from interface: CollectionMember

Returns the current assigned ItemPath

Specified by:

getItemPath in interface CollectionMember

Returns:

the ItemPath, null if empty

setProperties

public void setProperties(CastorHashMap props)

getProperties

public CastorHashMap getProperties()

Description copied from interface: CollectionMember

Gets the member properties.

Specified by:

getProperties in interface CollectionMember

Returns:

CastorHashMap

getKeyValuePairs

public KeyValuePair[] getKeyValuePairs()

setKeyValuePairs

public void setKeyValuePairs(KeyValuePair[] pairs)

getID

public int getID()

Description copied from interface: CollectionMember

Get the integer slot ID, as generated by the parent Collection

Specified by:

getID in interface CollectionMember

Returns:

ID

setID

public void setID(int id)

setClassProps

public void setClassProps(String props)

getClassProps

public String getClassProps()

Description copied from interface: CollectionMember

Gets the class properties, which specify type information in child Items. On instantiation from a CollectionDescription, the ClassProps are generated from the PropertyDescriptions which have the isClassIdentifier boolean set to true.

Specified by:

getClassProps in interface CollectionMember

Returns:

Comma-separated list of property names that relate to Item type

assignItem

public void assignItem(ItemPath itemPath,
                       TransactionKey transactionKey)
                throws InvalidCollectionModification

Description copied from interface: CollectionMember

Assign the given item to the slot, if it fits

Specified by:

assignItem in interface CollectionMember

Parameters:

itemPath - The item to assign

Throws:

InvalidCollectionModification - When the Item Properties don't match the typing specification in ClassProps and Properties

clearItem

public void clearItem()

Description copied from interface: CollectionMember

De-assign the slot, leaving it empty.

Specified by:

clearItem in interface CollectionMember

resolveItem

public ItemProxy resolveItem(TransactionKey transactionKey)
                      throws ObjectNotFoundException

Description copied from interface: CollectionMember

Resolve the Item currently assigned

Specified by:

resolveItem in interface CollectionMember

Returns:

the ItemProxy of the assigned Item

Throws:

ObjectNotFoundException - When empty

setChildUUID

public void setChildUUID(String uuid)
                  throws InvalidCollectionModification,
                         InvalidItemPathException

Throws:

InvalidCollectionModification

InvalidItemPathException

getChildUUID

public String getChildUUID()

Description copied from interface: CollectionMember

Returns the UUID of the currently assigned Item

Specified by:

getChildUUID in interface CollectionMember

Returns:

UUID

getBuiltInProperty

public Object getBuiltInProperty(BuiltInVertexProperties prop)

setBuiltInProperty

public void setBuiltInProperty(BuiltInVertexProperties prop,
                               Object val)

evaluateScript

protected Object evaluateScript(TransactionKey transactionKey)
                         throws InvalidDataException,
                                ObjectNotFoundException

Returns:

either PropertyArrayList or CastorHashMap

Throws:

InvalidDataException

ObjectNotFoundException

updatePropertieFromDescription

public void updatePropertieFromDescription(CastorHashMap propDesc,
                                           DependencyMember newMember)
                                    throws ObjectNotFoundException,
                                           InvalidCollectionModification

Parameters:

propDesc -

newMember -

Throws:

ObjectNotFoundException

InvalidCollectionModification

updateProperties

public void updateProperties(CastorHashMap newProps)
                      throws ObjectNotFoundException,
                             InvalidCollectionModification

Only update existing properties otherwise throw an exception

Parameters:

newProps - the new properties

Throws:

ObjectNotFoundException - property does not exists for member

InvalidCollectionModification - cannot update class properties

convertToItemPropertyByScript

public boolean convertToItemPropertyByScript(PropertyArrayList props,
                                             TransactionKey transactionKey)
                                      throws InvalidDataException,
                                             ObjectNotFoundException

Executes Script if it was defined in the Member properties

Parameters:

props - the current list of ItemProperties

member - the current DependencyMember

Returns:

true when Script was executed

Throws:

InvalidDataException

ObjectNotFoundException