com.powsybl.afs.package-info Maven / Gradle / Ivy
/**
*
* AFS stands for Application FileSystem.
*
* This package contains bases classes which define the concept of AFS.
* An AFS is meant to be used to organize your business data and store them,
* like a file system does for file.
*
*
* The way data is actually stored is implementation-dependent,
* and is defined through the implementation of the {@linkplain com.powsybl.afs.storage.AppStorage AppStorage} interface.
*
*
* The entry point of AFS is the {@linkplain com.powsybl.afs.AppData AppData} object.
* It contains a list of {@linkplain com.powsybl.afs.AppFileSystem AppFileSystem}s.
*
*
* The structure of an AFS looks like:
*
*
* AppData
* |
* +-- FileSystem1
* | +-- File1
* | +-- File2
* | +-- Project1
* | | +-- RootFolder
* | | +-- ProjectFile1
* | | +-- ProjectFolder1
* | | | +-- ProjectFile2
* | | +-- ProjectFolder2
* | | +-- ProjectFile3
* | +-- Project2
* | ...
* |
* +-- FileSystem2
* ...
*
*
*
*
*
* You may add your own types of files and project files through and extension mechanism, see {@linkplain com.powsybl.afs.FileExtension FileExtension}
* and {@linkplain com.powsybl.afs.ProjectFileExtension ProjectFileExtension}.
*
*
* @auhor Sylvain Leclerc
*
*/
package com.powsybl.afs;