org.cristalise.kernel.entity.proxy

Class ItemProxy

java.lang.Object

org.cristalise.kernel.entity.proxy.ItemProxy

Direct Known Subclasses:

AgentProxy

public class ItemProxy
extends Object

It is a wrapper for the connection and communication with Item. It caches data loaded from the Item to reduce communication

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	mIOR
protected Item	mItem
protected ItemPath	mItemPath

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ItemProxy(Object ior, ItemPath itemPath)

Method Summary

Modifier and Type	Method and Description
boolean	checkContent(String path, String name) Check if the data of the Item located by the ClusterStorage path is exist
boolean	checkOutcome(Schema schema, int eventId) Check if the given Outcome exists
boolean	checkOutcome(String schemaName, int schemaVersion, int eventId) Check if the given Outcome exists
boolean	checkViewpoint(String schemaName, String viewName) Check if the given Viewvpoint exists
void	dumpSubscriptions(int logLevel)
String	executeQuery(Query query) Executes the Query in the target database.
protected void	finalize() If this is reaped, clear out the cache for it too.
Collection<?>	getCollection(BuiltInCollections collection) Gets the current version of the named Collection
Collection<?>	getCollection(BuiltInCollections collection, Integer version) Gets a numbered version (snapshot) of a collection
Collection<?>	getCollection(String collName) Gets the last version of the named collection
Collection<?>	getCollection(String collName, Integer version) Gets a numbered version (snapshot) of a collection
String[]	getContents(ClusterType type) List the root content of the given ClusterType
String[]	getContents(String path) List the content of the cluster located by the cluster path
protected Item	getItem() Returns the CORBA Item this proxy is linked with
Job	getJobByName(String actName, AgentProxy agent) Finds the first finishing job with the given name for the given Agent in the workflow.
Job	getJobByTransitionName(String actName, String transName, AgentPath agentPath) Finds the Job with the given Activity and Transition name for the Agent in the Items Workflow
Job	getJobByTransitionName(String actName, String transName, AgentProxy agent) Finds the Job with the given Activity and Transition name for the Agent in the Items Workflow
ArrayList<Job>	getJobList(AgentProxy agent) Get the list of Job if the Item that can be executed by the Agent
String	getName() Get the name of the Item from its Property called Name
C2KLocalObject	getObject(ClusterType type) Retrieve the C2KLocalObject for the ClusterType
C2KLocalObject	getObject(String path) Retrieve the C2KLocalObject for the Cluster path
Outcome	getOutcome(Schema schema, int eventId) Gets the selected Outcome
Outcome	getOutcome(String schemaName, int schemaVersion, int eventId) Gets the selected Outcome
ItemPath	getPath() Return the ItemPath object of the Item this proxy is linked with
String	getProperty(BuiltInItemProperties prop) Retrieves the values of a BuiltInItemProperty
String	getProperty(String name) Retrieves the values of a named property
String	getProperty(String name, String defaultValue) Retrieves the values of a named property or returns the defaulValue if no Property was found
String	getType() Get the type of the Item from its Property called Type
Viewpoint	getViewpoint(String schemaName, String viewName) Gets the named Viewpoint
String[]	getViewpoints(String schemaName) Reads the list of existing Viewpoint names for the given schema
Workflow	getWorkflow() Gets the Workflow object of this Item
void	initialise(AgentPath agentId, PropertyArrayList itemProps, CompositeActivity workflow, CollectionArrayList colls) Initialise the new Item with instance data which is normally is created from descriptions
Item	narrow() Narrows the CORBA Item this proxy is linked with
void	notify(ProxyMessage message)
String	queryData(String path) Query data of the Item located by the ClusterStorage path
String	requestAction(Job thisJob) Executes the given Job
void	setProperty(AgentProxy agent, String name, String value) Sets the vlaue of the given Property
void	subscribe(MemberSubscription<?> newSub)
void	unsubscribe(ProxyObserver<?> observer)

Methods inherited from class java.lang.Object

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

Field Detail

mItem

protected Item mItem

mItemPath

protected ItemPath mItemPath

mIOR

protected Object mIOR

Constructor Detail

ItemProxy

protected ItemProxy(Object ior,
                    ItemPath itemPath)

Parameters:

ior -

itemPath -

Method Detail

getPath

public ItemPath getPath()

Return the ItemPath object of the Item this proxy is linked with

Returns:

the ItemPath of the Item this proxy is linked with

getItem

protected Item getItem()
                throws ObjectNotFoundException

Returns the CORBA Item this proxy is linked with

Returns:

the CORBA Item this proxy is linked with

Throws:

ObjectNotFoundException - there was a problem connecting with the Item

narrow

public Item narrow()
            throws ObjectNotFoundException

Narrows the CORBA Item this proxy is linked with

Returns:

the CORBA Item this proxy is linked with

Throws:

ObjectNotFoundException - there was a problem connecting with the Item

initialise

public void initialise(AgentPath agentId,
                       PropertyArrayList itemProps,
                       CompositeActivity workflow,
                       CollectionArrayList colls)
                throws AccessRightsException,
                       InvalidDataException,
                       PersistencyException,
                       ObjectNotFoundException,
                       org.exolab.castor.xml.MarshalException,
                       org.exolab.castor.xml.ValidationException,
                       IOException,
                       org.exolab.castor.mapping.MappingException,
                       InvalidCollectionModification

Initialise the new Item with instance data which is normally is created from descriptions

Parameters:

agentId - the Agent who is creating the Item

itemProps - initial list of Properties of the Item

workflow - new Lifecycle of the Item

colls - the initial state of the Item's collections

Throws:

AccessRightsException - Agent does not the rights to create an Item

InvalidDataException - data was invalid

PersistencyException - there was a database probles during Item initialisation

ObjectNotFoundException - Object not found

org.exolab.castor.xml.MarshalException - there was a problem converting those objects to XML

org.exolab.castor.xml.ValidationException - XML was not valid

IOException - IO errors

org.exolab.castor.mapping.MappingException - errors in XML marshall/unmarshall mapping

InvalidCollectionModification - invalid Collection

setProperty

public void setProperty(AgentProxy agent,
                        String name,
                        String value)
                 throws AccessRightsException,
                        PersistencyException,
                        InvalidDataException

Sets the vlaue of the given Property

Parameters:

agent - the Agent who is setting the Property

name - the name of the Property

value - the value of the Property

Throws:

AccessRightsException - Agent does not the rights to execute this operation

PersistencyException - there was a database problems during this operations

InvalidDataException - data was invalid

requestAction

public String requestAction(Job thisJob)
                     throws AccessRightsException,
                            InvalidTransitionException,
                            ObjectNotFoundException,
                            InvalidDataException,
                            PersistencyException,
                            ObjectAlreadyExistsException,
                            InvalidCollectionModification

Executes the given Job

Parameters:

thisJob - the Job to be executed

Returns:

the result of the execution

Throws:

AccessRightsException - Agent does not the rights to execute this operation

PersistencyException - there was a database problems during this operations

InvalidDataException - data was invalid

InvalidTransitionException - the Transition cannot be executed

ObjectNotFoundException - Object not found

ObjectAlreadyExistsException - Object already exists

InvalidCollectionModification - Invalid collection

getJobList

public ArrayList<Job> getJobList(AgentProxy agent)
                          throws AccessRightsException,
                                 ObjectNotFoundException,
                                 PersistencyException

Get the list of Job if the Item that can be executed by the Agent

Parameters:

agent - the Agent requesting the job

Returns:

list of Jobs

Throws:

AccessRightsException - Agent does not the rights to execute this operation

PersistencyException - there was a database problems during this operations

ObjectNotFoundException - data was invalid

getCollection

public Collection<?> getCollection(BuiltInCollections collection)
                            throws ObjectNotFoundException

Gets the current version of the named Collection

Parameters:

collection - The built-in collection

Returns:

the Collection object

Throws:

ObjectNotFoundException - objects were not found

getCollection

public Collection<?> getCollection(BuiltInCollections collection,
                                   Integer version)
                            throws ObjectNotFoundException

Gets a numbered version (snapshot) of a collection

Parameters:

collection - The built-in Collection

version - The collection number. Use null to get the 'last' version.

Returns:

the Collection object

Throws:

ObjectNotFoundException - objects were not found

getCollection

public Collection<?> getCollection(String collName)
                            throws ObjectNotFoundException

Gets the last version of the named collection

Parameters:

collName - The collection name

Returns:

the Collection object

Throws:

ObjectNotFoundException - objects were not found

getCollection

public Collection<?> getCollection(String collName,
                                   Integer version)
                            throws ObjectNotFoundException

Gets a numbered version (snapshot) of a collection

Parameters:

collName - The collection name

version - The collection number. Use null to get the 'last' version.

Returns:

the Collection object

Throws:

ObjectNotFoundException - objects were not found

getWorkflow

public Workflow getWorkflow()
                     throws ObjectNotFoundException

Gets the Workflow object of this Item

Returns:

the Item's Workflow object

Throws:

ObjectNotFoundException - objects were not found

checkViewpoint

public boolean checkViewpoint(String schemaName,
                              String viewName)
                       throws ObjectNotFoundException

Check if the given Viewvpoint exists

Parameters:

schemaName - the name of the Schema associated with the Viewpoint

viewName - the name of the View

Returns:

true if the ViewPoint exist false otherwise

Throws:

ObjectNotFoundException - Object not found

getViewpoints

public String[] getViewpoints(String schemaName)
                       throws ObjectNotFoundException

Reads the list of existing Viewpoint names for the given schema

Parameters:

schemaName - the name of the schema

Returns:

array of strings containing the Viewpoint names

Throws:

ObjectNotFoundException - Object not found

getViewpoint

public Viewpoint getViewpoint(String schemaName,
                              String viewName)
                       throws ObjectNotFoundException

Gets the named Viewpoint

Parameters:

schemaName - the name of the Schema associated with the Viewpoint

viewName - name if the View

Returns:

a Viewpoint object

Throws:

ObjectNotFoundException - objects were not found

checkOutcome

public boolean checkOutcome(String schemaName,
                            int schemaVersion,
                            int eventId)
                     throws ObjectNotFoundException

Check if the given Outcome exists

Parameters:

schemaName - the name of the Schema used to create the Outcome

schemaVersion - the version of the Schema used to create the Outcome

eventId - the id of the Event created when the Outcome was stored

Returns:

true if the Outcome exist false otherwise

Throws:

ObjectNotFoundException - Object not found

checkOutcome

public boolean checkOutcome(Schema schema,
                            int eventId)
                     throws ObjectNotFoundException

Check if the given Outcome exists

Parameters:

schema - the Schema used to create the Outcome

eventId - the id of the Event created when the Outcome was stored

Returns:

true if the Outcome exist false otherwise

Throws:

ObjectNotFoundException - Object not found

getOutcome

public Outcome getOutcome(String schemaName,
                          int schemaVersion,
                          int eventId)
                   throws ObjectNotFoundException

Gets the selected Outcome

Parameters:

schemaName - the name of the Schema of the Outcome

schemaVersion - the version of the Schema of the Outcome

eventId - the event id

Returns:

the Outcome object

Throws:

ObjectNotFoundException - object was not found

getOutcome

public Outcome getOutcome(Schema schema,
                          int eventId)
                   throws ObjectNotFoundException

Gets the selected Outcome

Parameters:

schema - the Schema used to create the Outcome

eventId - the id of the Event created when the Outcome was stored

Returns:

the Outcome object

Throws:

ObjectNotFoundException - object was not found

getJobByName

public Job getJobByName(String actName,
                        AgentProxy agent)
                 throws AccessRightsException,
                        ObjectNotFoundException,
                        PersistencyException

Finds the first finishing job with the given name for the given Agent in the workflow.

Parameters:

actName - the name of the Activity to look for

agent - The agent to fetch jobs for

Returns:

the JOB object or null if nothing was found

Throws:

AccessRightsException - Agent has not rights

ObjectNotFoundException - objects were not found

PersistencyException - Error loading the relevant objects

getJobByTransitionName

public Job getJobByTransitionName(String actName,
                                  String transName,
                                  AgentProxy agent)
                           throws AccessRightsException,
                                  ObjectNotFoundException,
                                  PersistencyException

Finds the Job with the given Activity and Transition name for the Agent in the Items Workflow

Parameters:

actName - the name of the Activity to look for

transName - the name of the Transition to look for

agent - The AgentProxy to fetch jobs for

Returns:

the JOB object or null if nothing was found

Throws:

AccessRightsException - Agent has not rights

ObjectNotFoundException - objects were not found

PersistencyException - Error loading the relevant objects

getJobByTransitionName

public Job getJobByTransitionName(String actName,
                                  String transName,
                                  AgentPath agentPath)
                           throws AccessRightsException,
                                  ObjectNotFoundException,
                                  PersistencyException

Finds the Job with the given Activity and Transition name for the Agent in the Items Workflow

Parameters:

actName - the name of the Activity to look for

transName - the name of the Transition to look for

agentPath - The agent to fetch jobs for

Returns:

the JOB object or null if nothing was found

Throws:

AccessRightsException - Agent has not rights

ObjectNotFoundException - objects were not found

PersistencyException - Error loading the relevant objects

finalize

protected void finalize()
                 throws Throwable

If this is reaped, clear out the cache for it too.

Overrides:

finalize in class Object

Throws:

Throwable

queryData

public String queryData(String path)
                 throws ObjectNotFoundException

Query data of the Item located by the ClusterStorage path

Parameters:

path - the ClusterStorage path

Returns:

the data in XML form

Throws:

ObjectNotFoundException - path was not correct

checkContent

public boolean checkContent(String path,
                            String name)
                     throws ObjectNotFoundException

Check if the data of the Item located by the ClusterStorage path is exist

Parameters:

path - the ClusterStorage path

name - the name of the content to be checked

Returns:

true if there is content false otherwise

Throws:

ObjectNotFoundException - path was not correct

getContents

public String[] getContents(ClusterType type)
                     throws ObjectNotFoundException

List the root content of the given ClusterType

Parameters:

type - the type of the cluster

Returns:

list of String of the cluster content

Throws:

ObjectNotFoundException - Object nt found

getContents

public String[] getContents(String path)
                     throws ObjectNotFoundException

List the content of the cluster located by the cluster path

Parameters:

path - the ClusterStorage path

Returns:

list of String of the cluster content

Throws:

ObjectNotFoundException - Object not found

executeQuery

public String executeQuery(Query query)
                    throws PersistencyException

Executes the Query in the target database. The query can be any of these type: SQL/OQL/XQuery/XPath/etc.

Parameters:

query - the query to be executed

Returns:

the xml result of the query

Throws:

PersistencyException - there was a fundamental DB issue

getObject

public C2KLocalObject getObject(ClusterType type)
                         throws ObjectNotFoundException

Retrieve the C2KLocalObject for the ClusterType

Parameters:

type - the ClusterTyoe

Returns:

the C2KLocalObject

Throws:

ObjectNotFoundException - the type did not result in a C2KLocalObject

getObject

public C2KLocalObject getObject(String path)
                         throws ObjectNotFoundException

Retrieve the C2KLocalObject for the Cluster path

Parameters:

path - the path to the cluster content

Returns:

the C2KLocalObject

Throws:

ObjectNotFoundException - the path did not result in a C2KLocalObject

getProperty

public String getProperty(BuiltInItemProperties prop)
                   throws ObjectNotFoundException

Retrieves the values of a BuiltInItemProperty

Parameters:

prop - one of the Built-In Item Property

Returns:

the value of the property

Throws:

ObjectNotFoundException - property was not found

getProperty

public String getProperty(String name,
                          String defaultValue)

Retrieves the values of a named property or returns the defaulValue if no Property was found

Parameters:

name - of the Item Property

defaultValue - the value to be used if no Property was found

Returns:

the value or the defaultValue

getProperty

public String getProperty(String name)
                   throws ObjectNotFoundException

Retrieves the values of a named property

Parameters:

name - of the Item Property

Returns:

the value of the property

Throws:

ObjectNotFoundException - property was not found

getName

public String getName()

Get the name of the Item from its Property called Name

Returns:

the name of the Item or null of no Name Property

getType

public String getType()

Get the type of the Item from its Property called Type

Returns:

the type of the Item or null of no Type Property

subscribe

public void subscribe(MemberSubscription<?> newSub)

unsubscribe

public void unsubscribe(ProxyObserver<?> observer)

dumpSubscriptions

public void dumpSubscriptions(int logLevel)

notify

public void notify(ProxyMessage message)