org.modelio.api.module.context.project

Interface IProjectStructure

public interface IProjectStructure

This interface describes the Modelio project itself: ie its name, path, type...

Also describes the installed fragments and modules.

Since:

3.5

Method Summary

Modifier and Type	Method and Description
java.util.List<IFragmentStructure>	getFragments() Get the list of all model fragments in the project.
java.util.List<IModuleStructure>	getModules() Get the list of all modules in the project.
java.lang.String	getName() Get the project's name.
java.nio.file.Path	getPath() Get the project directory i.e.
java.lang.String	getRemoteLocation() Get the project remote location.
java.lang.String	getType() Get the project type, either LOCAL or HTTP.

Method Detail

getName

java.lang.String getName()

Get the project's name.

Returns:

the project's name.

getType

java.lang.String getType()

Get the project type, either LOCAL or HTTP.

Returns:

the project type.

getPath

java.nio.file.Path getPath()

Get the project directory i.e. the project.conf location.

Returns:

the directory containing the project.conf.

getRemoteLocation

java.lang.String getRemoteLocation()

Get the project remote location.

Returns null for LOCAL projects.

Returns:

the project remote location.

See Also:

getType()

getFragments

java.util.List<IFragmentStructure> getFragments()

Get the list of all model fragments in the project.

The returned list is not modifiable.

Returns:

all model fragments.

getModules

java.util.List<IModuleStructure> getModules()

Get the list of all modules in the project.

The returned list is not modifiable.

Returns:

all model fragments.