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

Version:

$Revision: 1.25 $ $Date: 2005/05/10 11:40:09 $

Author:

$Author: abranson $

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

Methods

Modifier and Type	Method and Description
void	dumpSubscriptions(int logLevel)
protected void	finalize() If this is reaped, clear out the cache for it too.
Collection<?>	getCollection(String collName) Gets the current version of the named collection
Collection<?>	getCollection(String collName, Integer version) Gets a numbered version (snapshot) of a collection
String[]	getContents(String path)
protected Item	getItem()
Job	getJobByName(String actName, AgentProxy agent) Tries to find a job with the given name for the given Agent in the workflow.
ArrayList<Job>	getJobList(AgentProxy agent)
String	getName()
C2KLocalObject	getObject(String xpath)
ItemPath	getPath()
String	getProperty(String name)
Viewpoint	getViewpoint(String schemaName, String viewName) Gets the named viewpoint
Workflow	getWorkflow() Gets the Workflow object of this Item
void	initialise(AgentPath agentId, PropertyArrayList itemProps, CompositeActivity workflow, CollectionArrayList colls)
Item	narrow()
void	notify(ProxyMessage message)
String	queryData(String path)
String	requestAction(Job thisJob)
void	setProperty(AgentProxy agent, String name, String value)
void	subscribe(MemberSubscription<?> newSub) Subscription methods
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)

Method Detail

getPath

public ItemPath getPath()

getItem

protected Item getItem()
                throws ObjectNotFoundException

Throws:

ObjectNotFoundException

narrow

public Item narrow()
            throws ObjectNotFoundException

Throws:

ObjectNotFoundException

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

Throws:

AccessRightsException

InvalidDataException

PersistencyException

ObjectNotFoundException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

IOException

org.exolab.castor.mapping.MappingException

InvalidCollectionModification

setProperty

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

Throws:

AccessRightsException

PersistencyException

InvalidDataException

requestAction

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

Throws:

InvalidCollectionModification

AccessRightsException

InvalidTransitionException

ObjectNotFoundException

InvalidDataException

PersistencyException

ObjectAlreadyExistsException

getJobList

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

Throws:

AccessRightsException

ObjectNotFoundException

PersistencyException

getCollection

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

Gets the current version of the named collection

Parameters:

collName - The collection name

Returns:

the Collection object

Throws:

ObjectNotFoundException

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 (null for the current version)

Returns:

Throws:

ObjectNotFoundException

getWorkflow

public Workflow getWorkflow()
                     throws ObjectNotFoundException

Gets the Workflow object of this Item

Returns:

the Item's Workflow object

Throws:

ObjectNotFoundException

getViewpoint

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

Gets the named viewpoint

Parameters:

schemaName - Outcome schema name

viewName - Viewpoint name

Returns:

a Viewpoint object

Throws:

ObjectNotFoundException

getJobByName

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

Tries to find a job with the given name for the given Agent in the workflow.

Parameters:

actName - The activity name to look for

agent - The agent to fetch jobs for

Returns:

Throws:

AccessRightsException

ObjectNotFoundException

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

Throws:

ObjectNotFoundException

getContents

public String[] getContents(String path)
                     throws ObjectNotFoundException

Throws:

ObjectNotFoundException

getObject

public C2KLocalObject getObject(String xpath)
                         throws ObjectNotFoundException

Throws:

ObjectNotFoundException

getProperty

public String getProperty(String name)
                   throws ObjectNotFoundException

Throws:

ObjectNotFoundException

getName

public String getName()

subscribe

public void subscribe(MemberSubscription<?> newSub)

Subscription methods

unsubscribe

public void unsubscribe(ProxyObserver<?> observer)

dumpSubscriptions

public void dumpSubscriptions(int logLevel)

notify

public void notify(ProxyMessage message)