net.refractions.udig.project
Interface IProject


public interface IProject

A Project contains Maps and Pages.

Provides event notification when something changes. The ProjectRegistry is used to obtain references to Projects.

Responsibilities:

Example Use:


 Project project = registry.getProject(new URL("file://home/user/project.udig"));
 project.getElements();
 

Since:
0.1
Author:
Jesse

Method Summary
 java.util.List<IProjectElement> getElements()
          Returns a List with all elements in the project
<E> java.util.List<E>
getElements(java.lang.Class<E> type)
          Returns an unmodifiable list of the type requested.
 URI getID()
          The id of the Project.
 java.lang.String getName()
           
 void sendASync(Command command)
          Executes the command asynchronously.
 void sendSync(Command command)
          Executes the command synchronously and blocks.
 

Method Detail

getElements

<E> java.util.List<E> getElements(java.lang.Class<E> type)
Returns an unmodifiable list of the type requested.

Some currently valid options are IMap and Page


getElements

java.util.List<IProjectElement> getElements()
Returns a List with all elements in the project

This is an immutable list

Returns:
a list with all in the project

getName

java.lang.String getName()
Returns:
the name of the project

sendASync

void sendASync(Command command)
Executes the command asynchronously. The commands are not placed in a commandstack so they can not be undone. This allows developers to execute commands such as map creation. NOTICE: this should only be used if IMap#sendCommand(MapCommand)

Parameters:
command -

sendSync

void sendSync(Command command)
Executes the command synchronously and blocks. The commands are not placed in a commandstack so they can not be undone. This allows developers to execute commands such as map creation. NOTICE: this should only be used if IMap#sendCommand(MapCommand)

Parameters:
command -

getID

URI getID()
The id of the Project.