org.cristalise.kernel.process.resource

Class DefaultResourceImportHandler

java.lang.Object

org.cristalise.kernel.process.resource.DefaultResourceImportHandler

All Implemented Interfaces:

ResourceImportHandler

public class DefaultResourceImportHandler
extends Object
implements ResourceImportHandler

Constructor Summary

Constructors

Constructor and Description
DefaultResourceImportHandler(BuiltInResources resType)
DefaultResourceImportHandler(String resType) Deprecated.

Method Summary

Modifier and Type	Method and Description
CollectionArrayList	getCollections(String name, Integer version, Outcome outcome) Returns any collections that this Resource Item stored in the outcome should contain.
CollectionArrayList	getCollections(String name, String ns, String location, Integer version) Returns any collections that this Resource Item should contain.
String	getName() The name of the imported resource managed by the handler
DomainPath	getPath(String name, String ns) Returns the DomainPath for a specific resource
PropertyDescriptionList	getPropDesc() Should return all of the Properties the resource Item will have on creation.
Set<Outcome>	getResourceOutcomes(String name, String ns, String location, Integer version) Generates the outcomes that the resource should contain.
DomainPath	getTypeRoot() The directory context to search for existing resources.
String	getWorkflowName() Gives the CompActDef name to instantiate to provide the workflow for this type of resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultResourceImportHandler

public DefaultResourceImportHandler(BuiltInResources resType)
                             throws Exception

Throws:

Exception

DefaultResourceImportHandler

@Deprecated
public DefaultResourceImportHandler(String resType)
                                         throws Exception

Deprecated.

Throws:

Exception

Method Detail

getCollections

public CollectionArrayList getCollections(String name,
                                          String ns,
                                          String location,
                                          Integer version)
                                   throws Exception

Description copied from interface: ResourceImportHandler

Returns any collections that this Resource Item should contain.

Specified by:

getCollections in interface ResourceImportHandler

Parameters:

name - the name of the Resource Item

ns - the namaspace of the module declaring the Resource Item

location - the location of the XML file on the boot directory

version - the version of the Resource Item

Returns:

CollectionArrayList

Throws:

Exception - something went wrong

getCollections

public CollectionArrayList getCollections(String name,
                                          Integer version,
                                          Outcome outcome)
                                   throws Exception

Description copied from interface: ResourceImportHandler

Returns any collections that this Resource Item stored in the outcome should contain.

Specified by:

getCollections in interface ResourceImportHandler

Parameters:

name - the name of the Resource Item

version - the version of the Resource Item

outcome - Outcome containing the XML representing the Resource Item

Returns:

CollectionArrayList

Throws:

Exception - something went wrong

getTypeRoot

public DomainPath getTypeRoot()

Description copied from interface: ResourceImportHandler

The directory context to search for existing resources. The name of the resource must be unique below this point.

Specified by:

getTypeRoot in interface ResourceImportHandler

Returns:

Root DomainPath

getName

public String getName()

Description copied from interface: ResourceImportHandler

The name of the imported resource managed by the handler

Specified by:

getName in interface ResourceImportHandler

Returns:

The name of the imported resource managed by the handler

getPath

public DomainPath getPath(String name,
                          String ns)
                   throws Exception

Description copied from interface: ResourceImportHandler

Returns the DomainPath for a specific resource

Specified by:

getPath in interface ResourceImportHandler

Parameters:

name - - resource name

ns - - module namespace

Returns:

DomainPath initialised

Throws:

Exception

getResourceOutcomes

public Set<Outcome> getResourceOutcomes(String name,
                                        String ns,
                                        String location,
                                        Integer version)
                                 throws Exception

Description copied from interface: ResourceImportHandler

Generates the outcomes that the resource should contain.

Specified by:

getResourceOutcomes in interface ResourceImportHandler

Parameters:

name - the name of the resource

ns - the namespace defined in the module

location - the location of the resource file

version - the specified version

Returns:

a set of outcomes to be synced with the resource item.

Throws:

Exception - - if the supplied resources are not valid

getPropDesc

public PropertyDescriptionList getPropDesc()
                                    throws Exception

Description copied from interface: ResourceImportHandler

Should return all of the Properties the resource Item will have on creation. The Property 'Name' will be created and populated automatically, even if not declared.

Specified by:

getPropDesc in interface ResourceImportHandler

Returns:

a PropertyDescriptionList - an arraylist of PropertyDescriptions

Throws:

Exception

getWorkflowName

public String getWorkflowName()
                       throws Exception

Description copied from interface: ResourceImportHandler

Gives the CompActDef name to instantiate to provide the workflow for this type of resource. Should be found in the CA typeroot (/desc/ActivityDesc/)

Specified by:

getWorkflowName in interface ResourceImportHandler

Returns:

String workflow name

Throws:

Exception