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

Class StandaloneProjectDescriptor

java.lang.Object

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

All Implemented Interfaces:

IProjectDescriptor

public class StandaloneProjectDescriptor
extends java.lang.Object
implements IProjectDescriptor

Implements a descriptor for the source and target VIL project locations. The second constructor allows to specify a different target location.

Author:

Holger Eichelberger

Nested Class Summary

Nested classes/interfaces inherited from interface net.ssehub.easy.instantiation.core.model.vilTypes.IProjectDescriptor

IProjectDescriptor.ModelKind

Field Summary

Fields

Modifier and Type	Field	Description
private java.io.File	base
private IProjectDescriptor	parent
private Script	vilScript

Constructor Summary

Constructors

Constructor	Description
StandaloneProjectDescriptor(ModelInfo<Script> vilInfo, java.io.File base)	Creates a standalone project descriptor.
StandaloneProjectDescriptor(Script vilScript, java.io.File base)	Creates a standalone project descriptor.
StandaloneProjectDescriptor(IProjectDescriptor parent, java.io.File base)	Allows to instantiate into a given location.

Method Summary

Modifier and Type	Method	Description
ProgressObserver	createObserver()	Creates a progress observer on demand, e.g., when predecessors are accessed the first time.
java.io.File	getBase()	The base folder of the project (typically the project location).
Script	getMainVilScript()	Returns the main VIL script of the project.
java.lang.String	getModelFolder(IProjectDescriptor.ModelKind kind)	Returns the path to the respective models relative to IProjectDescriptor.getBase().
IProjectDescriptor	getPredecessor(int index)	Returns a specific predecessor descriptor.
int	getPredecessorCount()	The number of predecessor projects.

Methods inherited from class java.lang.Object

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

Field Detail

parent

private IProjectDescriptor parent

base

private java.io.File base

vilScript

private Script vilScript

Constructor Detail

StandaloneProjectDescriptor

public StandaloneProjectDescriptor(ModelInfo<Script> vilInfo,
                                   java.io.File base)
                            throws ModelManagementException

Creates a standalone project descriptor.

Parameters:

vilInfo - the model information instance for the VIL script to run

base - the folder to instantiate into

Throws:

ModelManagementException - in case that resolving the model, obtaining information etc failed.

StandaloneProjectDescriptor

public StandaloneProjectDescriptor(Script vilScript,
                                   java.io.File base)
                            throws ModelManagementException

Creates a standalone project descriptor.

Parameters:

vilScript - the VIL script to run

base - the folder to instantiate into

Throws:

ModelManagementException - in case that resolving the model, obtaining information etc failed.

StandaloneProjectDescriptor

public StandaloneProjectDescriptor(IProjectDescriptor parent,
                                   java.io.File base)

Allows to instantiate into a given location.

Parameters:

parent - the parent descriptor (also representing the source, to be obtained via #ProjectDescriptor())

base - the folder to instantiate into

Method Detail

getBase

public java.io.File getBase()

Description copied from interface: IProjectDescriptor

The base folder of the project (typically the project location).

Specified by:

getBase in interface IProjectDescriptor

Returns:

the base folder

getPredecessorCount

public int getPredecessorCount()

Description copied from interface: IProjectDescriptor

The number of predecessor projects.

Specified by:

getPredecessorCount in interface IProjectDescriptor

Returns:

the number of predecessor projects

getPredecessor

public IProjectDescriptor getPredecessor(int index)

Description copied from interface: IProjectDescriptor

Returns a specific predecessor descriptor.

Specified by:

getPredecessor in interface IProjectDescriptor

Parameters:

index - the index of the predecessor to be returned

Returns:

the predecessor

getMainVilScript

public Script getMainVilScript()

Description copied from interface: IProjectDescriptor

Returns the main VIL script of the project.

Specified by:

getMainVilScript in interface IProjectDescriptor

Returns:

the main VIL script

createObserver

public ProgressObserver createObserver()

Description copied from interface: IProjectDescriptor

Creates a progress observer on demand, e.g., when predecessors are accessed the first time. [factory method]

Specified by:

createObserver in interface IProjectDescriptor

Returns:

the progress observer to be used

getModelFolder

public java.lang.String getModelFolder(IProjectDescriptor.ModelKind kind)

Description copied from interface: IProjectDescriptor

Returns the path to the respective models relative to IProjectDescriptor.getBase().

Specified by:

getModelFolder in interface IProjectDescriptor

Parameters:

kind - the model kind to return the folder for

Returns:

the relative path to the model folder