Package net.ssehub.easy.producer.examples

Class ExamplesInstaller

java.lang.Object

net.ssehub.easy.producer.examples.ExamplesInstaller

public class ExamplesInstaller
extends Object

Methods for installing selected examples into the workspace.

Author:

El-Sharkawy

Field Summary

Fields

Modifier and Type	Field	Description
private Set<String>	importedProjects
private Map<String,Boolean>	projects	Stores whether a given project may be imported into workspace (true) or already exist in workspace.
private AvailableExamples.ExampleDescriptor[]	selectedExamples
private Set<String>	skippedProjects

Constructor Summary

Constructors

Constructor	Description
ExamplesInstaller(AvailableExamples.ExampleDescriptor[] selectedExamples)	Sole constructor for this class.

Method Summary

Modifier and Type	Method	Description
private boolean	addProject(String projectName)	Returns whether a given project name may be used for creating a new project inside the workspace.
static String	determineProjectName(String entryName)	Calculates the project name for a given entry of a Zip archive.
Set<String>	installExamples()	Imports the examples into workspace.
private void	unzip(File zipLocation)	Unzipps the contents of the given zip archive.

Methods inherited from class java.lang.Object

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

Field Details

projects

private Map<String,Boolean> projects

Stores whether a given project may be imported into workspace (true) or already exist in workspace.

selectedExamples

private AvailableExamples.ExampleDescriptor[] selectedExamples

importedProjects

private Set<String> importedProjects

skippedProjects

private Set<String> skippedProjects

Constructor Details

ExamplesInstaller

public ExamplesInstaller(AvailableExamples.ExampleDescriptor[] selectedExamples)

Sole constructor for this class.

Parameters:

selectedExamples - The list of examples, which shall be installed into workspace. Must not be null.

Method Details

installExamples

public Set<String> installExamples()
                            throws ExampleInstallationException

Imports the examples into workspace.

Returns:

the List of successfully imported projects.

Throws:

ExampleInstallationException - If at least one of the examples could not be installed into the workspace.

unzip

private void unzip(File zipLocation)

Unzipps the contents of the given zip archive.

Parameters:

zipLocation - The location of the zip archive to unpack. Should be located inside this bundle.

See Also:

• http://www.mkyong.com/java/how-to-decompress-files-from-a-zip-file/

addProject

private boolean addProject(String projectName)

Returns whether a given project name may be used for creating a new project inside the workspace.

Parameters:

projectName - The name of the project to be created in workspace.

Returns:

true if the project and the destination location do not exist, false otherwise.

determineProjectName

public static String determineProjectName(String entryName)

Calculates the project name for a given entry of a Zip archive.

Parameters:

entryName - The current entry for which the destination project should be calculated. Should not be null.

Returns:

The name of the project, may be null if destination project could not be calculated.