Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.ui.service.project
Interface ProjectService

All Known Implementing Classes:
AbstractProjectService, ProjectServiceImpl

public interface ProjectService

The ProjectService manages information on a HALE project, such as the loaded schemas, instances etc.

Author:
Thorsten Reitz, Simon Templer

Method Summary
 void addListener(ProjectServiceListener listener)
          Adds a project service listener
 void clean()
          Clean the project, reset all services.
 void executeAndRemember(IOConfiguration conf)
          Execute and remember the given I/O configuration.
 de.fhg.igd.osgi.util.configuration.IConfigurationService getConfigurationService()
          Get a project scoped configuration service
 ProjectInfo getProjectInfo()
          Get general information about the current project
 boolean isChanged()
          Get if the project content is changed
 void load(URI uri)
          Load a project from a given file.
 void open()
          Open a project.
 void rememberIO(String actionId, String providerId, IOProvider provider)
          Remember I/O operations after the execution of the corresponding I/O provider for storing it in the project.
 void removeListener(ProjectServiceListener listener)
          Removes a project service listener
 List<IOConfiguration> removeResources(String actionId)
          Remove all resources of the specified actionId from the project.
 void save()
          Save the project.
 void saveAs()
          Save the project to the given file
 void setChanged()
          Inform the service about a change in the project content.
 

Method Detail

addListener

void addListener(ProjectServiceListener listener)
Adds a project service listener

Parameters:
listener - the listener to add

removeListener

void removeListener(ProjectServiceListener listener)
Removes a project service listener

Parameters:
listener - the listener to remove

rememberIO

void rememberIO(String actionId,
                String providerId,
                IOProvider provider)
Remember I/O operations after the execution of the corresponding I/O provider for storing it in the project.

Parameters:
actionId - the I/O action identifier
providerId - the I/O provider identifier
provider - the I/O provider instance used for the I/O operation

executeAndRemember

void executeAndRemember(IOConfiguration conf)
Execute and remember the given I/O configuration.

Parameters:
conf - the I/O configuration

removeResources

List<IOConfiguration> removeResources(String actionId)
Remove all resources of the specified actionId from the project.

Parameters:
actionId - the I/O action identifier
Returns:
a list of removed io configurations
See Also:
rememberIO(String, String, IOProvider)

getConfigurationService

de.fhg.igd.osgi.util.configuration.IConfigurationService getConfigurationService()
Get a project scoped configuration service

Returns:
the configuration service

getProjectInfo

ProjectInfo getProjectInfo()
Get general information about the current project

Returns:
the project info

isChanged

boolean isChanged()
Get if the project content is changed

Returns:
if the project content is changed

setChanged

void setChanged()
Inform the service about a change in the project content.


clean

void clean()
Clean the project, reset all services.


load

void load(URI uri)
Load a project from a given file.

Parameters:
uri - the project file

open

void open()
Open a project.


save

void save()
Save the project. Calls saveAs() if needed.


saveAs

void saveAs()
Save the project to the given file


Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d