org.eclipse.ocl.examples.modelregistry.environment
Interface ProjectHandle

All Superinterfaces:

FileHandle, org.eclipse.core.runtime.IAdaptable

All Known Implementing Classes:

EclipseProjectHandle, JavaProjectHandle

public interface ProjectHandle
extends FileHandle

The ProjectHandle denotes a special location with respect to which all other file handles belonging to a project are resolved. There is no fundamental need for this location to exist or to be a parent of the other resources, although in normal practice the project handle will denote the hierarchical root of the project. Derived JavaProjectHandle and EclipseProjectHandle specialise the behaviour using a java.io.File to define the location of a project for standalone usage, or a org.eclipse.core.resources.IProject for use with an active Eclipse Workspace.

Field Summary

static java.lang.String	DEFAULT_MODEL_REGISTRY_NAME
static java.lang.String	DEFAULT_MODEL_REGISTRY_NAME2
static java.lang.String	DEFAULT_MODEL_REGISTRY_PATH
static java.lang.String	DEFAULT_MODEL_REGISTRY_PATH2

Method Summary

FileHandle	getFileHandle(java.lang.String name) Return the FileHandle for the model located at name relative to the project, if the name does not start with a /, or with respect to the root if it does.
java.lang.String	getRegistryName() Get the name of the registry model with respect to the project.
org.eclipse.emf.common.util.URI	getRegistryURI() Get the preferred URI of the registry model.
java.util.List<org.eclipse.emf.common.util.URI>	getRegistryURIs() Get all possible URIs of the registry model.
void	refreshRegistry() Respond to a notification that the registry has changed.
void	setRegistryName(java.lang.String name) Define the name of the registry model with respect to the project.

Methods inherited from interface org.eclipse.ocl.examples.modelregistry.environment.FileHandle

exists, getAbsoluteName, getContents, getName, getParentFileHandle, getProjectHandle, getProjectRelativeName, getURI, isFile, isFolder, isProject

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Field Detail

DEFAULT_MODEL_REGISTRY_NAME

static final java.lang.String DEFAULT_MODEL_REGISTRY_NAME

See Also:

Constant Field Values

DEFAULT_MODEL_REGISTRY_NAME2

static final java.lang.String DEFAULT_MODEL_REGISTRY_NAME2

See Also:

Constant Field Values

DEFAULT_MODEL_REGISTRY_PATH

static final java.lang.String DEFAULT_MODEL_REGISTRY_PATH

See Also:

Constant Field Values

DEFAULT_MODEL_REGISTRY_PATH2

static final java.lang.String DEFAULT_MODEL_REGISTRY_PATH2

See Also:

Constant Field Values

Method Detail

getFileHandle

FileHandle getFileHandle(java.lang.String name)
                         throws java.io.IOException

Return the FileHandle for the model located at name relative to the project, if the name does not start with a /, or with respect to the root if it does.

Parameters:

name -

Returns:

the Handle

Throws:

java.io.IOException

getRegistryURI

org.eclipse.emf.common.util.URI getRegistryURI()

Get the preferred URI of the registry model.

Returns:

the registry URI

getRegistryURIs

java.util.List<org.eclipse.emf.common.util.URI> getRegistryURIs()

Get all possible URIs of the registry model.

Returns:

the registry URIs

getRegistryName

java.lang.String getRegistryName()

Get the name of the registry model with respect to the project. The default value is DEFAULT_MODEL_REGISTRY_NAME.

Returns:

registry name

refreshRegistry

void refreshRegistry()

Respond to a notification that the registry has changed.

setRegistryName

void setRegistryName(java.lang.String name)

Define the name of the registry model with respect to the project.

Parameters:

name - registry name