Package com.powsybl.afs
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 AppStorage interface.
The entry point of AFS is the AppData object. It contains a list of AppFileSystems.
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 FileExtension and ProjectFileExtension.
-
Interface Summary Interface Description AppFileSystemProvider AppLogger FileExtension<T extends File> Interface to add a new type of file to the application file system.FolderBase<N extends AbstractNodeBase<F>,F extends FolderBase<N,F>> ProjectFileBuilder<F extends ProjectFile> ProjectFileExtension<T extends ProjectFile,U extends ProjectFileBuilder<T>> Interface to add a new type of project file to the application file system.ProjectFileListener ProjectFolderListener SecurityTokenProvider ServiceExtension<U> Registers a new implementation for service of type <U>, to be retrieved withAppData.findService(java.lang.Class<U>, boolean)
.TaskListener TaskMonitor -
Class Summary Class Description AbstractNodeBase<F> Base class for all node objects stored in an AFS tree.AppData An instance of AppData is the root of an application file system.AppFileSystem An AppFileSystem instance is a tree ofNode
objects, starting with its root folder.AppFileSystemProviderContext AppFileSystemTool DefaultProjectFileListener DependencyCache<T extends ProjectNode> Allows to request and cache dependencies of a project file to one or several other project nodes.File A file in anAppFileSystem
object.FileCreationContext Folder A folder in anAppFileSystem
tree.LocalTaskMonitor Node NodePath OrderedDependencyManager PowsyblAfsVersion Project A project is a special type of file in the file system, which represents workspace to carry out a study or computations.ProjectDependency<T extends ProjectNode> ProjectFile ProjectFileBuildContext ProjectFileContext ProjectFileCreationContext ProjectFolder A folder in aProject
tree.ProjectNode ServiceCreationContext ServiceExtension.ServiceKey<U> SoutAppLogger SoutTaskListener StartTaskEvent StopTaskEvent TaskCancellableStatusChangeEvent TaskEvent TaskMonitor.Snapshot TaskMonitor.Task TaskMonitorLogger UnknownFile Represents a file object of an unknown type (for instance when trying to read a file of type unknown to your instance of AFS).UnknownProjectFile Represents a project file object of an unknown type (for instance when trying to read a file of type unknown to your instance of AFS).UpdateTaskMessageEvent -
Exception Summary Exception Description AfsCircularDependencyException AfsException TaskMonitor.NotACancellableTaskMonitor