Package 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.

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 String	mClassProps
protected CastorHashMap	mProperties

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

mMembers, mName, mVersion

Constructor Summary

Constructors

Constructor	Description
Dependency()
Dependency(String name)
Dependency(String name, Integer version)
Dependency(BuiltInCollections collection)
Dependency(BuiltInCollections collection, Integer version)

Method Summary

Modifier and Type	Method	Description
void	addMember(DependencyMember depMember)
DependencyMember	addMember(ItemPath itemPath, TransactionKey transactionKey)	Add a member to the Dependency
DependencyMember	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.
void	addToItemProperties(PropertyArrayList props, TransactionKey transactionKey)	Add Dependency specific values to ItemProperties.
void	addToVertexProperties(CastorHashMap props, TransactionKey transactionKey)	Add Dependency specific values to VertexProperties (CastorHashMap).
List<DependencyMember>	compare(Dependency other)	Returns all DependencyMember that are members of the other collection but not members of this one.
boolean	containsBuiltInProperty(BuiltInVertexProperties prop)	Method of convenience to check if property exists
DependencyMember	createMember(ItemPath itemPath, TransactionKey transactionKey)
DependencyMember	createMember(ItemPath itemPath, CastorHashMap props, TransactionKey transactionKey)
protected Object	evaluateScript(TransactionKey transactionKey)
Object	getBuiltInProperty(BuiltInVertexProperties prop)	Method of convenience to get property value using BuiltInVertexProperties
Object	getBuiltInProperty(BuiltInVertexProperties prop, Object defValue)	Method of convenience to get property value using BuiltInVertexProperties
Collection.Cardinality	getCardinality()
Property[]	getClassProperties()
String	getClassProps()
KeyValuePair[]	getKeyValuePairs()
CastorHashMap	getProperties()
String	getToDependencyName(ItemPath referencedItem, TransactionKey transactionKey)	Reads the DependencyTo property to retrieve the name of the dependency.
Collection.Type	getType()
void	setClassProps(String classProps)
void	setKeyValuePairs(KeyValuePair[] pairs)
void	setProperties(CastorHashMap props)
String	toString()
void	updateMember(ItemPath childPath, int memberID, CastorHashMap memberNewProps)
void	updateMember(ItemPath childPath, CastorHashMap memberNewProps)

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

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

Methods inherited from class java.lang.Object

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

Field Details

mProperties

protected CastorHashMap mProperties

mClassProps

protected String mClassProps

Constructor Details

Dependency

public Dependency()

Dependency

public Dependency(String name)

Dependency

public Dependency(String name,
 Integer version)

Dependency

public Dependency(BuiltInCollections collection)

Dependency

public Dependency(BuiltInCollections collection,
 Integer version)

Method Details

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()

getClassProperties

public Property[] getClassProperties()

Returns:

array of Property instances fully initialised from classProps (comma separated values)

updateMember

public void updateMember(ItemPath childPath,
 CastorHashMap memberNewProps)
                  throws ObjectNotFoundException,
InvalidDataException,
InvalidCollectionModification

Parameters:

childPath -

memberNewProps -

Throws:

ObjectNotFoundException

InvalidDataException

InvalidCollectionModification

updateMember

public void updateMember(ItemPath childPath,
 int memberID,
 CastorHashMap memberNewProps)
                  throws ObjectNotFoundException,
InvalidDataException,
InvalidCollectionModification

Parameters:

childPath -

memberID -

memberNewProps -

Throws:

ObjectNotFoundException

InvalidDataException

InvalidCollectionModification

addMember

public DependencyMember addMember(ItemPath itemPath,
 TransactionKey transactionKey)
                           throws InvalidCollectionModification,
ObjectAlreadyExistsException

Add a member to the Dependency

Parameters:

itemPath - the Item to be added as a Member

Returns:

DependencyMember the newly created DependencyMember

Throws:

InvalidCollectionModification - if Item is null or the Properties of the Item (e.g. Type) does not match the Collection's

ObjectAlreadyExistsException - Item is already a member

addMember

public void addMember(DependencyMember depMember)
               throws InvalidCollectionModification,
ObjectAlreadyExistsException

Parameters:

depMember -

Throws:

InvalidCollectionModification

ObjectAlreadyExistsException

createMember

public DependencyMember createMember(ItemPath itemPath,
 TransactionKey transactionKey)
                              throws InvalidCollectionModification,
ObjectAlreadyExistsException

Parameters:

itemPath -

Returns:

Throws:

InvalidCollectionModification

ObjectAlreadyExistsException

compare

public List<DependencyMember> compare(Dependency other)

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

Parameters:

other - - The collection to compare

Returns:

List of Members

addMember

public DependencyMember 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<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

createMember

public DependencyMember createMember(ItemPath itemPath,
 CastorHashMap props,
 TransactionKey transactionKey)
                              throws InvalidCollectionModification,
ObjectAlreadyExistsException

Parameters:

itemPath -

props -

Returns:

Throws:

InvalidCollectionModification

ObjectAlreadyExistsException

addToItemProperties

public void addToItemProperties(PropertyArrayList props,
 TransactionKey transactionKey)
                         throws InvalidDataException,
ObjectNotFoundException

Add Dependency specific values to ItemProperties. First checks if there is a Script to be executed, if no Script defined it will use the default conversion implemented for BuiltInCollections

Parameters:

props - the current list of ItemProperties

transactionKey - the key of the transaction

Throws:

InvalidDataException

ObjectNotFoundException

addToVertexProperties

public void addToVertexProperties(CastorHashMap props,
 TransactionKey transactionKey)
                           throws InvalidDataException,
ObjectNotFoundException

Add Dependency specific values to VertexProperties (CastorHashMap). First checks if there is a Script to be executed, if no Script defined it will use the default conversion implemented for BuiltInCollections

Parameters:

props - the current list of VertexProperties

Throws:

InvalidDataException - inconsistent data was provided

ObjectNotFoundException - objects were not found while reading the properties

getBuiltInProperty

public Object getBuiltInProperty(BuiltInVertexProperties prop)

Method of convenience to get property value using BuiltInVertexProperties

Parameters:

prop - the property to read

Returns:

the value, can be null

getBuiltInProperty

public Object getBuiltInProperty(BuiltInVertexProperties prop,
 Object defValue)

Method of convenience to get property value using BuiltInVertexProperties

Parameters:

prop - the property to read

defValue - default value

Returns:

the value, can be null

containsBuiltInProperty

public boolean containsBuiltInProperty(BuiltInVertexProperties prop)

Method of convenience to check if property exists

Parameters:

prop - the property to check

Returns:

true if property exist, false otherwise

evaluateScript

protected Object evaluateScript(TransactionKey transactionKey)
                         throws InvalidDataException,
ObjectNotFoundException

Returns:

either PropertyArrayList or CastorHashMap

Throws:

InvalidDataException

ObjectNotFoundException

getType

public Collection.Type getType()

getCardinality

public Collection.Cardinality getCardinality()

getToDependencyName

public String getToDependencyName(ItemPath referencedItem,
 TransactionKey transactionKey)
                           throws InvalidDataException

Reads the DependencyTo property to retrieve the name of the dependency. The property may contain a single Dependency name or a mapping of ItemType to a Dependency e.g.: 'Employee:Employees, Guest:Guests'

Parameters:

referencedItem -

transactionKey -

Returns:

Throws:

InvalidDataException

toString

public String toString()

Overrides:

toString in class Object