eu.geclipse.core.model
Interface IGridElementCreator

All Known Subinterfaces:

IConfigurableElementCreator, IGridJobCreator

All Known Implementing Classes:

AbstractGridElementCreator, AbstractGridJobCreator, AbstractVoCreator, BatchConnectionInfoCreator, BatchQueueDescriptionCreator, FileSystemCreator, GenericVoCreator, GridJobCreator, GridWorkflowCreator, JSDLJobDescriptionCreator, RemoteFilesContainerCreator

public interface IGridElementCreator

Base interface for all classes that implement functionality for creating specific implementations of the IGridElement interface. Element creators and their capabilities to create elements from a source object are specified with the eu.geclipse.core.gridElementCreator extension point. Normally an element creator needs a source object from which it creates a corresponding grid model element. This source object has to be set with setSource(Object).

Method Summary

IGridElement	create(IGridContainer parent) Create an element and set it to be a child of the specified IGridContainer.
IGridElement	create(IGridContainer parent, java.lang.Object source) Shortcut method for creating an element from the specified source object.
java.lang.Object	getSource() Get the source object that was formerly specified with setSource(Object).
void	setSource(java.lang.Object source) Set the source object to be used by this creator to create a grid model element from.

Method Detail

create

IGridElement create(IGridContainer parent)
                    throws ProblemException

Create an element and set it to be a child of the specified IGridContainer. The element is created from the object that was specified in a former call to setSource(Object). If the creation fails a ProblemException will be thrown.

Parameters:

parent - The parent of the newly created element.

Returns:

The newly created element.

Throws:

ProblemException - If any problem occurs while the new element is created. For instance if a source object is needed to create the element but was not defined before.

create

IGridElement create(IGridContainer parent,
                    java.lang.Object source)
                    throws ProblemException

Shortcut method for creating an element from the specified source object.

Parameters:

parent - The parent of the newly created element.

source - The object from which to create the element.

Returns:

The newly created element.

Throws:

ProblemException - If any problem occurs while the new element is created.

getSource

java.lang.Object getSource()

Get the source object that was formerly specified with setSource(Object).

Returns:

Get the object from which this creator will try to create a grid model element if create(IGridContainer) is called.

setSource

void setSource(java.lang.Object source)

Set the source object to be used by this creator to create a grid model element from.

Parameters:

source - The object from which this creator will try to create a grid model element if create(IGridContainer) is called.