eu.geclipse.core.model
Interface IGridElement

All Known Subinterfaces:

IConnectionManager, IDefaultGridElementManager, IExtendedGridInfoService, IGridApplication, IGridApplicationManager, IGridBatchQueueDescription, IGridComputing, IGridConnection, IGridConnectionElement, IGridContainer, IGridElementManager, IGridInfoService, IGridJob, IGridJobDescription, IGridJobManager, IGridJobService, IGridProject, IGridResource, IGridResourceContainer, IGridRoot, IGridService, IGridSiteConfig, IGridStorage, IGridVisualisation, IGridWorkflowDescription, IManageable, IMountable, IServiceJob, IServiceJobManager, IStorableElement, IStorableElementManager, IVirtualOrganization, IVoManager, IWrappedElement

All Known Implementing Classes:

AbstractApplicationManager, AbstractGridContainer, AbstractGridElement, AbstractGridInfoService, AbstractGridVisualisationResource, AbstractServiceJob, AbstractSubmittableServiceJob, AbstractVirtualOrganization, BatchConnectionInfo, BatchQueueDescription, ContainerMarker, GenericVirtualOrganization, GenericVoProperties, GridAccessServiceJob, GridApplication, GridGlueComputing, GridGlueElement, GridGlueService, GridGlueServiceApplication, GridGlueServiceComputing, GridGlueSite, GridGlueStorage, GridJob, GridWorkflow, JSDLJobDescription, JSDLJobDescriptionModel, ParametricJobService, RemoteFilesContainer, ResourceGridContainer, ResourceGridElement

public interface IGridElement

This is the base interface of all interfaces and classes that are members of a Grid model. Elements may have associated IResources. In that case they are called non-virtual. If they have no corresponding resource the element is called virtual. If the element represents a resource or at least any item that is local, i.e. contained somewhere on the local machine, the element itself is called to be local.

Method Summary

void	dispose() Clean up all resources that this element uses internally.
IFileStore	getFileStore() Get the file store that this element is associated with.
java.lang.String	getName() Get the name of this element.
IGridContainer	getParent() Get the parent element of this element.
IPath	getPath() Get the path of this element relative to the grid root element.
IGridProject	getProject() Get the IGridProject this element belongs to.
IResource	getResource() Get the corresponding resource of this element.
boolean	isHidden() Determines if this element is hidden.
boolean	isLocal() Determines if this element is local.
boolean	isVirtual() Determines if this element is virtual.

Method Detail

dispose

void dispose()

Clean up all resources that this element uses internally.

getFileStore

IFileStore getFileStore()

Get the file store that this element is associated with. May return null if there is no such associated file store. If this element is not virtual the filestore corresponds to the file store of the corresponding resource.

Returns:

The corresponding file store.

getName

java.lang.String getName()

Get the name of this element. The names of all children of a container have to be unique within this container. If this element is not virtual the name is the name of the corresponding resource.

Returns:

The name of this element.

getParent

IGridContainer getParent()

Get the parent element of this element. The parent can only be an IGridContainer. This method may not return null since the only element that is allowed to return null is the IGridRoot which is a singleton and is internally defined within the model.

Returns:

The parent container of this element.

getPath

IPath getPath()

Get the path of this element relative to the grid root element. If this element is not virtual this has to be the path of the corresponding @IResource.

Returns:

The path of this element relative to the grid root.

getProject

IGridProject getProject()

Get the IGridProject this element belongs to. This method may return null if the element is not contained in a project like for example an element manager and its children.

Returns:

The IGridProject this element belongs to.

getResource

IResource getResource()

Get the corresponding resource of this element. This may be null if - and only if - this element is virtual.

Returns:

The corresponding resource or null if this element is virtual.

isHidden

boolean isHidden()

Determines if this element is hidden. Hidden elements are not shown in the Grid model views.

Returns:

True if this is a hidden element, false otherwise.

isLocal

boolean isLocal()

Determines if this element is local. A local element has to be any related item (not necessarily an IResource) that is local in the means that it is located on the local machine.

Returns:

True if this element is local.

isVirtual

boolean isVirtual()

Determines if this element is virtual. Virtual elements have no corresponding resources. If this method returns false the getResource() method returns null. If this method returns true the getResource() has to return a valid IResource that is related to this element.

Returns:

True if this element is virtual, i.e. has no corresponding resource.