Package net.ssehub.easy.producer.core.persistence.standard

Class ProjectCreationResult

java.lang.Object

net.ssehub.easy.producer.core.persistence.standard.ProjectCreationResult

All Implemented Interfaces:

IProjectCreationResult

Direct Known Subclasses:

EclipseProjectCreationResult

public class ProjectCreationResult
extends java.lang.Object
implements IProjectCreationResult

Result of Persistencer.createProject(String, File, String, boolean).

Author:

El-Sharkawy

Field Summary

Fields

Modifier and Type	Field	Description
private Script	mainBuildScript
private java.io.File	projectFolder
private java.lang.String	projectID
private Project	varModel
private java.io.File	varModelProjectLocation

Constructor Summary

Constructors

Constructor	Description
ProjectCreationResult(java.io.File projectFolder, java.lang.String projectID, java.io.File varModelProjectLocation, Project varModel, Script mainBuildScript)	Sole constructor for this class.

Method Summary

Modifier and Type	Method	Description
Script	getBuildScript()	Returns the main build script for instantiating the whole project.
java.io.File	getConfigFolder()	Returns the location of configuration files for the newly created project.
java.io.File	getProjectFolder()	Returns the top level location of the newly created project.
java.lang.String	getProjectID()	Returns the projectID of the newly created project.
Project	getVarModel()	Returns the variability model of the newly created project.
java.io.File	getVarModelProjectPath()	Returns the absolute path of the newly created VarModel project (ivml project).
protected void	setVarModelProjectPath(java.io.File varModelProjectLocation)	Setter for the varModelProjectLocation.

Methods inherited from class java.lang.Object

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

Field Detail

projectFolder

private java.io.File projectFolder

projectID

private java.lang.String projectID

varModelProjectLocation

private java.io.File varModelProjectLocation

varModel

private Project varModel

mainBuildScript

private Script mainBuildScript

Constructor Detail

ProjectCreationResult

public ProjectCreationResult(java.io.File projectFolder,
                             java.lang.String projectID,
                             java.io.File varModelProjectLocation,
                             Project varModel,
                             Script mainBuildScript)

Sole constructor for this class.

Parameters:

projectFolder - The location of the newly created project.

projectID - The ID of the newly created project.

varModelProjectLocation - The location of the (ivml) project file.

varModel - The variability model of the newly created project.

mainBuildScript - The main build script decriping how to instanciate the whole project.

Method Detail

getProjectFolder

public final java.io.File getProjectFolder()

Description copied from interface: IProjectCreationResult

Returns the top level location of the newly created project.

Specified by:

getProjectFolder in interface IProjectCreationResult

Returns:

The top level location of the newly created project.

getProjectID

public final java.lang.String getProjectID()

Description copied from interface: IProjectCreationResult

Returns the projectID of the newly created project.

Specified by:

getProjectID in interface IProjectCreationResult

Returns:

The projectID of the newly created project.

getVarModelProjectPath

public final java.io.File getVarModelProjectPath()

Description copied from interface: IProjectCreationResult

Returns the absolute path of the newly created VarModel project (ivml project).

Specified by:

getVarModelProjectPath in interface IProjectCreationResult

Returns:

The absolute path of the newly created VarModel project.

setVarModelProjectPath

protected void setVarModelProjectPath(java.io.File varModelProjectLocation)

Setter for the varModelProjectLocation. This method should only be used by sub classes.

Parameters:

varModelProjectLocation - The new location of the varModel.

getVarModel

public Project getVarModel()

Description copied from interface: IProjectCreationResult

Returns the variability model of the newly created project.

Specified by:

getVarModel in interface IProjectCreationResult

Returns:

The variability model of the newly created project.

getConfigFolder

public java.io.File getConfigFolder()

Description copied from interface: IProjectCreationResult

Returns the location of configuration files for the newly created project.

Specified by:

getConfigFolder in interface IProjectCreationResult

Returns:

The location of configuration files for the newly created project.

getBuildScript

public Script getBuildScript()

Description copied from interface: IProjectCreationResult

Returns the main build script for instantiating the whole project.

Specified by:

getBuildScript in interface IProjectCreationResult

Returns:

The starting point of the complete instantiation of the current project.