org.eclipse.emf.ecp.ide.spi.util

Class ViewModelHelper.ViewLoader

java.lang.Object

org.eclipse.emf.ecp.ide.spi.util.ViewModelHelper.ViewLoader

Enclosing class:

ViewModelHelper

public static class ViewModelHelper.ViewLoader
extends Object

Helper class for encapsulating view loading functionality.

Constructor Summary

Constructors

Constructor and Description
ViewLoader()

Method Summary

Modifier and Type	Method and Description
protected boolean	ecoreExistsInWorkspace(String ecorePath) Indicates whether the Ecore denoted by the path exists in the workspace.
protected String	getPath(org.eclipse.core.resources.IFile file) Returns the path string of the given file.
protected ReportService	getReportService() Returns the service used for error reporting.
protected Optional<String>	getViewName(VView view) Determines a name for the given view.
protected String	getViewNameAndLocation(VView view, String viewLocation) Returns a string representation of the view and its location.
VView	loadView(org.eclipse.core.resources.IFile file, Collection<String> registeredEcores) Loads the view denoted by the given file.
protected VView	loadView(String path) Loads the view denoted by the given path.
protected void	registerEcore(String ecorePath) Try to register the Ecore denoted by the path.
protected void	registerReferencedEcores(VView view, String viewLocation, Collection<String> registeredEcores) Registers the referenced Ecores of the given view.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ViewLoader

public ViewLoader()

Method Detail

loadView

public VView loadView(org.eclipse.core.resources.IFile file,
                      Collection<String> registeredEcores)
               throws IOException

Loads the view denoted by the given file. Also tries to register referenced Ecores.

Parameters:

file - the view to load

registeredEcores - a collection to which all Ecores which are successfully registered are added.

Returns:

the VView denoted by the given file.

Throws:

IOException - if something goes wrong during loading or registering

getPath

protected String getPath(org.eclipse.core.resources.IFile file)

Returns the path string of the given file.

Parameters:

file - the IFile for which the path string shall be determined.

Returns:

The determined string path.

loadView

protected VView loadView(String path)

Loads the view denoted by the given path.

Parameters:

path - the path denoting the VView

Returns:

the loaded VView

registerReferencedEcores

protected void registerReferencedEcores(VView view,
                                        String viewLocation,
                                        Collection<String> registeredEcores)
                                 throws IOException

Registers the referenced Ecores of the given view.

Parameters:

view - the VView which possibly references Ecores.

viewLocation - the location of the given view. Used for error reporting.

registeredEcores - a collection to which all Ecores which are successfully registered are added.

Throws:

IOException - if something goes wrong during loading or registering

getViewNameAndLocation

protected String getViewNameAndLocation(VView view,
                                        String viewLocation)

Returns a string representation of the view and its location.

Parameters:

view - the VView.

viewLocation - the location.

Returns:

a string representation of the view and its location

getViewName

protected Optional<String> getViewName(VView view)

Determines a name for the given view.

Parameters:

view - the [@link VView}.

Returns:

an optional possibly containing a determined name, empty otherwise.

ecoreExistsInWorkspace

protected boolean ecoreExistsInWorkspace(String ecorePath)

Indicates whether the Ecore denoted by the path exists in the workspace.

Parameters:

ecorePath - the potential path to an Ecore

Returns:

true if an Ecore exists at the path in the workspace, false otherwise.

getReportService

protected ReportService getReportService()

Returns the service used for error reporting.

Returns:

the ReportService

registerEcore

protected void registerEcore(String ecorePath)
                      throws IOException

Try to register the Ecore denoted by the path.

Parameters:

ecorePath - the path to the Ecore in the workspace which shall be registered.

Throws:

IOException - if something goes wrong during registering.