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)
boolean	checkViewpoint(String schemaName, String viewName)
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(String path)
protected Item	getItem()
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)
String	getName()
C2KLocalObject	getObject(String xpath)
ItemPath	getPath()
String	getProperty(BuiltInItemProperties prop) Retrieves the values of a BuiltInItemProperty
String	getProperty(String name) Retrieves the values of a named property
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)
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:

AccessRightsException

InvalidTransitionException

ObjectNotFoundException

InvalidDataException

PersistencyException

ObjectAlreadyExistsException

InvalidCollectionModification

getJobList

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

Throws:

AccessRightsException

ObjectNotFoundException

PersistencyException

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

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 - objects were 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

Throws:

ObjectNotFoundException

checkContent

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

Throws:

ObjectNotFoundException

getContents

public String[] getContents(String path)
                     throws ObjectNotFoundException

Throws:

ObjectNotFoundException

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(String xpath)
                         throws ObjectNotFoundException

Throws:

ObjectNotFoundException

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

subscribe

public void subscribe(MemberSubscription<?> newSub)

unsubscribe

public void unsubscribe(ProxyObserver<?> observer)

dumpSubscriptions

public void dumpSubscriptions(int logLevel)

notify

public void notify(ProxyMessage message)