IProjectDescriptor (EASy-Producer Documentation API)

All Known Implementing Classes:

ProjectDescriptor, StandaloneProjectDescriptor
```
public interface IProjectDescriptor
```
Describes a Project for creation of a project object. This interface helps separating VIL from upper level parts of EASy.

Author:

Holger Eichelberger

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class IProjectDescriptor.ModelKind
Defines different model kinds.

Method Summary

All Methods Instance Methods Abstract Methods
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 `getBase()`.
`IProjectDescriptor`	`getPredecessor(int index)`	Returns a specific predecessor descriptor.
`int`	`getPredecessorCount()`	The number of predecessor projects.

- Method Detail
  - getBase
```
java.io.File getBase()
```
    The base folder of the project (typically the project location).
    
    Returns:
    
    the base folder
  - getPredecessorCount
```
int getPredecessorCount()
```
    The number of predecessor projects.
    
    Returns:
    
    the number of predecessor projects
  - getPredecessor
```
IProjectDescriptor getPredecessor(int index)
```
    Returns a specific predecessor descriptor.
    
    Parameters:
    
    index - the index of the predecessor to be returned
    
    Returns:
    
    the predecessor
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - in case that index < 0 || index >= getPredecessorCount()
  - getMainVilScript
```
Script getMainVilScript()
```
    Returns the main VIL script of the project.
    
    Returns:
    
    the main VIL script
  - createObserver
```
ProgressObserver createObserver()
```
    Creates a progress observer on demand, e.g., when predecessors are accessed the first time. [factory method]
    
    Returns:
    
    the progress observer to be used
  - getModelFolder
```
java.lang.String getModelFolder(IProjectDescriptor.ModelKind kind)
```
    Returns the path to the respective models relative to getBase().
    
    Parameters:
    
    kind - the model kind to return the folder for
    
    Returns:
    
    the relative path to the model folder