Package org.cristalise.kernel.property

Class PropertyUtility

java.lang.Object

org.cristalise.kernel.property.PropertyUtility

public class PropertyUtility
extends Object

Utility class to handle operations of ItemProperties and their description

Constructor Summary

Constructors

Constructor	Description
PropertyUtility()

Method Summary

Modifier and Type	Method	Description
static boolean	checkProperty(ItemPath item, String name, TransactionKey transactionKey)
static boolean	checkProperty(ItemPath item, BuiltInItemProperties prop, TransactionKey transactionKey)
static CastorHashMap	convertTransitiveProperties(PropertyDescriptionList pdList)	Converts transitive PropertyDescriptions to VertexProprties (CastorHashMap).
static String	getClassIdNames(ArrayList<PropertyDescription> pdlist)
static String	getDefaultValue(List<PropertyDescription> pdlist, String name)	Reads the default value of the Property
static String	getNames(ArrayList<PropertyDescription> pdlist)
static Property	getProperty(ItemPath itemPath, String propName, TransactionKey transactionKey)
static Property	getProperty(ItemPath itemPath, BuiltInItemProperties prop, TransactionKey transactionKey)
static PropertyDescriptionList	getPropertyDescriptionOutcome(ItemPath itemPath, String descVer, TransactionKey transactionKey)	Reads the PropertyDescriptionList either from a built-in type of Item using LocalObjectLoader or from the 'last' Viewpoint of the 'PropertyDescription' Outcome in the Item (very likely a Factory Item).
static String	getPropertyValue(ItemPath item, String name, String defaultValue, TransactionKey transactionKey)
static String	getPropertyValue(ItemPath item, BuiltInItemProperties prop, String defaultValue, TransactionKey transactionKey)
static String	getValue(ArrayList<PropertyDescription> pdlist, String name)	Deprecated. Badly named method, use getDefaultValue() instead
static boolean	propertyExists(ItemPath itemPath, String propName, TransactionKey transactionKey)
static void	writeProperty(ItemPath item, String name, String value, TransactionKey transactionKey)	Updates (writes) the value of an existing Property
static void	writeProperty(ItemPath item, BuiltInItemProperties prop, String value, TransactionKey transactionKey)	Updates (writes) the value of an existing Property

Methods inherited from class java.lang.Object

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

Constructor Details

PropertyUtility

public PropertyUtility()

Method Details

getValue

public static String getValue(ArrayList<PropertyDescription> pdlist,
 String name)

Deprecated.

Badly named method, use getDefaultValue() instead

Reads the default value of the Property

Parameters:

pdlist - the list of Properties to search

name - name of the Property to search for

Returns:

the defeult value of the property. Can be null.

getDefaultValue

public static String getDefaultValue(List<PropertyDescription> pdlist,
 String name)

Reads the default value of the Property

Parameters:

pdlist - the list of Properties to search

name - name of the Property to search for

Returns:

the defeult value of the property. Can be null.

propertyExists

public static boolean propertyExists(ItemPath itemPath,
 String propName,
 TransactionKey transactionKey)

Parameters:

itemPath -

propName -

transactionKey -

Returns:

getProperty

public static Property getProperty(ItemPath itemPath,
 BuiltInItemProperties prop,
 TransactionKey transactionKey)
                            throws ObjectNotFoundException

Parameters:

itemPath -

prop -

transactionKey -

Returns:

Throws:

ObjectNotFoundException

getProperty

public static Property getProperty(ItemPath itemPath,
 String propName,
 TransactionKey transactionKey)
                            throws ObjectNotFoundException

Parameters:

itemPath -

propName -

transactionKey -

Returns:

Throws:

ObjectNotFoundException

getNames

public static String getNames(ArrayList<PropertyDescription> pdlist)

Parameters:

pdlist -

Returns:

getClassIdNames

public static String getClassIdNames(ArrayList<PropertyDescription> pdlist)

Parameters:

pdlist -

Returns:

getPropertyDescriptionOutcome

public static PropertyDescriptionList getPropertyDescriptionOutcome(ItemPath itemPath,
 String descVer,
 TransactionKey transactionKey)
                                                             throws ObjectNotFoundException

Reads the PropertyDescriptionList either from a built-in type of Item using LocalObjectLoader or from the 'last' Viewpoint of the 'PropertyDescription' Outcome in the Item (very likely a Factory Item).

Parameters:

itemPath - the Item containing the PropertyDescriptionList

descVer - the version of the PropertyDescriptionList

transactionKey - transaction key

Returns:

the PropertyDescriptionList

Throws:

ObjectNotFoundException - PropertyDescriptionList cannot be retrieved

convertTransitiveProperties

public static CastorHashMap convertTransitiveProperties(PropertyDescriptionList pdList)

Converts transitive PropertyDescriptions to VertexProprties (CastorHashMap). ClassIdentifiers are transitive by default.

Parameters:

pdList - the PropertyDescriptions to be used

Returns:

the initialised CastorHashMap

writeProperty

public static void writeProperty(ItemPath item,
 BuiltInItemProperties prop,
 String value,
 TransactionKey transactionKey)
                          throws PersistencyException,
ObjectCannotBeUpdated,
ObjectNotFoundException

Updates (writes) the value of an existing Property

Parameters:

item - the Path (UUID) of actual Item

prop - the BuiltIn ItemProperty to write

value - the value of the Property

transactionKey - transaction key

Throws:

PersistencyException - something went wrong updating the database

ObjectCannotBeUpdated - the Property is immutable

ObjectNotFoundException - there is no Property with the given name

writeProperty

public static void writeProperty(ItemPath item,
 String name,
 String value,
 TransactionKey transactionKey)
                          throws PersistencyException,
ObjectCannotBeUpdated,
ObjectNotFoundException

Updates (writes) the value of an existing Property

Parameters:

item - the Path (UUID) of actual Item

name - the name of the Property to write

value - the value of the Property

transactionKey - transaction key

Throws:

PersistencyException - something went wrong updating the database

ObjectCannotBeUpdated - the Property is immutable

ObjectNotFoundException - there is no Property with the given name

checkProperty

public static boolean checkProperty(ItemPath item,
 BuiltInItemProperties prop,
 TransactionKey transactionKey)

Parameters:

item -

prop -

transactionKey -

Returns:

checkProperty

public static boolean checkProperty(ItemPath item,
 String name,
 TransactionKey transactionKey)

Parameters:

item -

name -

transactionKey -

Returns:

getPropertyValue

public static String getPropertyValue(ItemPath item,
 BuiltInItemProperties prop,
 String defaultValue,
 TransactionKey transactionKey)

Parameters:

item -

prop -

defaultValue -

transactionKey -

Returns:

getPropertyValue

public static String getPropertyValue(ItemPath item,
 String name,
 String defaultValue,
 TransactionKey transactionKey)

Parameters:

item -

name -

defaultValue -

transactionKey -

Returns: