Package com.powsybl.afs.storage

Class ForwardingAppStorage

java.lang.Object

com.powsybl.afs.storage.ForwardingAppStorage

All Implemented Interfaces:

AppStorage, AutoCloseable

public class ForwardingAppStorage
extends Object
implements AppStorage

A storage implementation which simply delegates calls to another underlying AppStorage implementation.

Author:

Geoffroy Jamgotchian

Constructor Summary

Constructors

Constructor	Description
ForwardingAppStorage(AppStorage storage)

Method Summary

Modifier and Type	Method	Description
void	addDependency(String nodeId, String name, String toNodeId)	Adds a dependency from node with ID nodeId to node with ID toNodeId.
void	addDoubleTimeSeriesData(String nodeId, int version, String timeSeriesName, List<com.powsybl.timeseries.DoubleDataChunk> chunks)	Adds data (double) to the time series with names timeSeriesNames associated with node with ID nodeId.
void	addStringTimeSeriesData(String nodeId, int version, String timeSeriesName, List<com.powsybl.timeseries.StringDataChunk> chunks)	Adds data (string) to the time series with names timeSeriesNames associated with node with ID nodeId.
List<FileSystemCheckIssue>	checkFileSystem(FileSystemCheckOptions options)	Check file system for consistency issues.
void	clearTimeSeries(String nodeId)	Deletes time series associated with node with ID nodeId
void	close()	Closes any resource associated with this storage.
NodeInfo	createNode(String parentNodeId, String name, String nodePseudoClass, String description, int version, NodeGenericMetadata genericMetadata)	Creates a new node in the tree under a parent node.
NodeInfo	createRootNodeIfNotExists(String name, String nodePseudoClass)	Returns the root node of the tree, creating it if it does not exist.
void	createTimeSeries(String nodeId, com.powsybl.timeseries.TimeSeriesMetadata metadata)	Creates a time series associated with node with ID nodeId.
boolean	dataExists(String nodeId, String name)	Returns true if data named name associated with the node with ID nodeId exists.
String	deleteNode(String nodeId)	Deletes the node with ID nodeId.
void	flush()	Flush any changes to underlying storage.
Set<NodeInfo>	getBackwardDependencies(String nodeId)	Gets NodeInfo objects of nodes which depend on the node with ID nodeId.
Optional<NodeInfo>	getChildNode(String nodeId, String name)	Gets NodeInfo for child node with name name of the node with ID nodeId, empty if such a node does not exist or node is inconsistent.
List<NodeInfo>	getChildNodes(String nodeId)	Gets NodeInfo for consistent child nodes of the node with ID nodeId.
Set<String>	getDataNames(String nodeId)	Returns the lists of names of data associated to the node with ID nodeId.
Set<NodeDependency>	getDependencies(String nodeId)	Gets all dependencies (NodeDependency objects) of node with ID nodeId.
Set<NodeInfo>	getDependencies(String nodeId, String name)	Gets NodeInfo objects for dependencies of node with ID nodeId, and associated to the dependency name name.
Map<String,List<com.powsybl.timeseries.DoubleDataChunk>>	getDoubleTimeSeriesData(String nodeId, Set<String> timeSeriesNames, int version)	Gets data (double) for the time series with names timeSeriesNames associated with node with ID nodeId.
EventsBus	getEventsBus()	Get the events store.
String	getFileSystemName()
List<NodeInfo>	getInconsistentNodes()	Gets NodeInfo for all inconsistent nodes.
NodeInfo	getNodeInfo(String nodeId)	Gets NodeInfo object for the node with ID nodeId.
Optional<NodeInfo>	getParentNode(String nodeId)	Gets NodeInfo for parent node of the node with ID nodeId, empty if such a node does not exist or inconsistent.
Map<String,List<com.powsybl.timeseries.StringDataChunk>>	getStringTimeSeriesData(String nodeId, Set<String> timeSeriesNames, int version)	Gets data (string) for the time series with names timeSeriesNames associated with node with ID nodeId.
List<String>	getSupportedFileSystemChecks()	The list of supported file system checks.
Set<Integer>	getTimeSeriesDataVersions(String nodeId)	Gets versions of time series data associated with node with ID nodeId.
Set<Integer>	getTimeSeriesDataVersions(String nodeId, String timeSeriesName)	Gets versions of data for the time series with name timeSeriesName associated with node with ID nodeId.
List<com.powsybl.timeseries.TimeSeriesMetadata>	getTimeSeriesMetadata(String nodeId, Set<String> timeSeriesNames)	Returns metadata of time series associated with node with ID nodeId and with name in timeSeriesNames.
Set<String>	getTimeSeriesNames(String nodeId)	Returns names of all time series associated with node with ID nodeId.
boolean	isClosed()	Check if storage is closed.
boolean	isConsistent(String nodeId)	Return true if the node with ID nodeId is consistent, otherwise it returns false .
boolean	isRemote()
boolean	isWritable(String nodeId)
Optional<InputStream>	readBinaryData(String nodeId, String name)	Reads data associated to the node with ID nodeId.
boolean	removeData(String nodeId, String name)	Removes the data blob named name associated with the node with ID nodeId.
void	removeDependency(String nodeId, String name, String toNodeId)	Removes a dependency named name from node with ID nodeId to node with ID toNodeId.
void	renameNode(String nodeId, String name)	Rename the node with ID nodeId
void	setConsistent(String nodeId)	mark the node with ID nodeId as consistent node.
void	setDescription(String nodeId, String description)
void	setMetadata(String nodeId, NodeGenericMetadata genericMetadata)	Update a node metadata
void	setParentNode(String nodeId, String newParentNodeId)	Sets new parent node for the node with ID nodeId.
boolean	timeSeriesExists(String nodeId, String timeSeriesName)	Returns true if a time series named timeSeriesName associated with the node with ID nodeId exists.
void	updateModificationTime(String nodeId)
OutputStream	writeBinaryData(String nodeId, String name)	Returns an OutputStream to write data associated to the node with ID nodeId.

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardingAppStorage

public ForwardingAppStorage(AppStorage storage)

Method Detail

getFileSystemName

public String getFileSystemName()

Specified by:

getFileSystemName in interface AppStorage

isRemote

public boolean isRemote()

Specified by:

isRemote in interface AppStorage

createRootNodeIfNotExists

public NodeInfo createRootNodeIfNotExists(String name,
                                          String nodePseudoClass)

Description copied from interface: AppStorage

Returns the root node of the tree, creating it if it does not exist.

Specified by:

createRootNodeIfNotExists in interface AppStorage

createNode

public NodeInfo createNode(String parentNodeId,
                           String name,
                           String nodePseudoClass,
                           String description,
                           int version,
                           NodeGenericMetadata genericMetadata)

Description copied from interface: AppStorage

Creates a new node in the tree under a parent node. Returns NodeInfo corresponding to the newly created node. The new node is by default inconsistent, AppStorage.setConsistent(String nodeId) method should explicitly be called to set it consistent.

Specified by:

createNode in interface AppStorage

setMetadata

public void setMetadata(String nodeId,
                        NodeGenericMetadata genericMetadata)

Description copied from interface: AppStorage

Update a node metadata

Specified by:

setMetadata in interface AppStorage

Parameters:

nodeId - id of the node

genericMetadata - new metadata that will override previous ones

isWritable

public boolean isWritable(String nodeId)

Specified by:

isWritable in interface AppStorage

getNodeInfo

public NodeInfo getNodeInfo(String nodeId)

Description copied from interface: AppStorage

Gets NodeInfo object for the node with ID nodeId.

Specified by:

getNodeInfo in interface AppStorage

setDescription

public void setDescription(String nodeId,
                           String description)

Specified by:

setDescription in interface AppStorage

setConsistent

public void setConsistent(String nodeId)

Description copied from interface: AppStorage

mark the node with ID nodeId as consistent node.

Specified by:

setConsistent in interface AppStorage

isConsistent

public boolean isConsistent(String nodeId)

Description copied from interface: AppStorage

Return true if the node with ID nodeId is consistent, otherwise it returns false .

Specified by:

isConsistent in interface AppStorage

updateModificationTime

public void updateModificationTime(String nodeId)

Specified by:

updateModificationTime in interface AppStorage

getChildNodes

public List<NodeInfo> getChildNodes(String nodeId)

Description copied from interface: AppStorage

Gets NodeInfo for consistent child nodes of the node with ID nodeId.

Specified by:

getChildNodes in interface AppStorage

getInconsistentNodes

public List<NodeInfo> getInconsistentNodes()

Description copied from interface: AppStorage

Gets NodeInfo for all inconsistent nodes.

Specified by:

getInconsistentNodes in interface AppStorage

getChildNode

public Optional<NodeInfo> getChildNode(String nodeId,
                                       String name)

Description copied from interface: AppStorage

Gets NodeInfo for child node with name name of the node with ID nodeId, empty if such a node does not exist or node is inconsistent.

Specified by:

getChildNode in interface AppStorage

getParentNode

public Optional<NodeInfo> getParentNode(String nodeId)

Description copied from interface: AppStorage

Gets NodeInfo for parent node of the node with ID nodeId, empty if such a node does not exist or inconsistent.

Specified by:

getParentNode in interface AppStorage

setParentNode

public void setParentNode(String nodeId,
                          String newParentNodeId)

Description copied from interface: AppStorage

Sets new parent node for the node with ID nodeId.

Specified by:

setParentNode in interface AppStorage

deleteNode

public String deleteNode(String nodeId)

Description copied from interface: AppStorage

Deletes the node with ID nodeId.

Specified by:

deleteNode in interface AppStorage

renameNode

public void renameNode(String nodeId,
                       String name)

Description copied from interface: AppStorage

Rename the node with ID nodeId

Specified by:

renameNode in interface AppStorage

readBinaryData

public Optional<InputStream> readBinaryData(String nodeId,
                                            String name)

Description copied from interface: AppStorage

Reads data associated to the node with ID nodeId. A node may have several data blobs associated to it, with different names. The parameters name specifies which of those data is requested.

Specified by:

readBinaryData in interface AppStorage

writeBinaryData

public OutputStream writeBinaryData(String nodeId,
                                    String name)

Description copied from interface: AppStorage

Returns an OutputStream to write data associated to the node with ID nodeId. A node may have several data blobs associated to it, with different names.

Specified by:

writeBinaryData in interface AppStorage

dataExists

public boolean dataExists(String nodeId,
                          String name)

Description copied from interface: AppStorage

Returns true if data named name associated with the node with ID nodeId exists.

Specified by:

dataExists in interface AppStorage

getDataNames

public Set<String> getDataNames(String nodeId)

Description copied from interface: AppStorage

Returns the lists of names of data associated to the node with ID nodeId.

Specified by:

getDataNames in interface AppStorage

removeData

public boolean removeData(String nodeId,
                          String name)

Description copied from interface: AppStorage

Removes the data blob named name associated with the node with ID nodeId.

Specified by:

removeData in interface AppStorage

createTimeSeries

public void createTimeSeries(String nodeId,
                             com.powsybl.timeseries.TimeSeriesMetadata metadata)

Description copied from interface: AppStorage

Creates a time series associated with node with ID nodeId.

Specified by:

createTimeSeries in interface AppStorage

getTimeSeriesNames

public Set<String> getTimeSeriesNames(String nodeId)

Description copied from interface: AppStorage

Returns names of all time series associated with node with ID nodeId.

Specified by:

getTimeSeriesNames in interface AppStorage

timeSeriesExists

public boolean timeSeriesExists(String nodeId,
                                String timeSeriesName)

Description copied from interface: AppStorage

Returns true if a time series named timeSeriesName associated with the node with ID nodeId exists.

Specified by:

timeSeriesExists in interface AppStorage

getTimeSeriesMetadata

public List<com.powsybl.timeseries.TimeSeriesMetadata> getTimeSeriesMetadata(String nodeId,
                                                                             Set<String> timeSeriesNames)

Description copied from interface: AppStorage

Returns metadata of time series associated with node with ID nodeId and with name in timeSeriesNames.

Specified by:

getTimeSeriesMetadata in interface AppStorage

getTimeSeriesDataVersions

public Set<Integer> getTimeSeriesDataVersions(String nodeId)

Description copied from interface: AppStorage

Gets versions of time series data associated with node with ID nodeId.

Specified by:

getTimeSeriesDataVersions in interface AppStorage

getTimeSeriesDataVersions

public Set<Integer> getTimeSeriesDataVersions(String nodeId,
                                              String timeSeriesName)

Description copied from interface: AppStorage

Gets versions of data for the time series with name timeSeriesName associated with node with ID nodeId.

Specified by:

getTimeSeriesDataVersions in interface AppStorage

getDoubleTimeSeriesData

public Map<String,List<com.powsybl.timeseries.DoubleDataChunk>> getDoubleTimeSeriesData(String nodeId,
                                                                                              Set<String> timeSeriesNames,
                                                                                              int version)

Description copied from interface: AppStorage

Gets data (double) for the time series with names timeSeriesNames associated with node with ID nodeId.

Specified by:

getDoubleTimeSeriesData in interface AppStorage

addDoubleTimeSeriesData

public void addDoubleTimeSeriesData(String nodeId,
                                    int version,
                                    String timeSeriesName,
                                    List<com.powsybl.timeseries.DoubleDataChunk> chunks)

Description copied from interface: AppStorage

Adds data (double) to the time series with names timeSeriesNames associated with node with ID nodeId.

Specified by:

addDoubleTimeSeriesData in interface AppStorage

getStringTimeSeriesData

public Map<String,List<com.powsybl.timeseries.StringDataChunk>> getStringTimeSeriesData(String nodeId,
                                                                                              Set<String> timeSeriesNames,
                                                                                              int version)

Description copied from interface: AppStorage

Gets data (string) for the time series with names timeSeriesNames associated with node with ID nodeId.

Specified by:

getStringTimeSeriesData in interface AppStorage

addStringTimeSeriesData

public void addStringTimeSeriesData(String nodeId,
                                    int version,
                                    String timeSeriesName,
                                    List<com.powsybl.timeseries.StringDataChunk> chunks)

Description copied from interface: AppStorage

Adds data (string) to the time series with names timeSeriesNames associated with node with ID nodeId.

Specified by:

addStringTimeSeriesData in interface AppStorage

clearTimeSeries

public void clearTimeSeries(String nodeId)

Description copied from interface: AppStorage

Deletes time series associated with node with ID nodeId

Specified by:

clearTimeSeries in interface AppStorage

addDependency

public void addDependency(String nodeId,
                          String name,
                          String toNodeId)

Description copied from interface: AppStorage

Adds a dependency from node with ID nodeId to node with ID toNodeId. The dependency will be associated with the specified name.

Specified by:

addDependency in interface AppStorage

getDependencies

public Set<NodeInfo> getDependencies(String nodeId,
                                     String name)

Description copied from interface: AppStorage

Gets NodeInfo objects for dependencies of node with ID nodeId, and associated to the dependency name name.

Specified by:

getDependencies in interface AppStorage

getDependencies

public Set<NodeDependency> getDependencies(String nodeId)

Description copied from interface: AppStorage

Gets all dependencies (NodeDependency objects) of node with ID nodeId.

Specified by:

getDependencies in interface AppStorage

getBackwardDependencies

public Set<NodeInfo> getBackwardDependencies(String nodeId)

Description copied from interface: AppStorage

Gets NodeInfo objects of nodes which depend on the node with ID nodeId.

Specified by:

getBackwardDependencies in interface AppStorage

removeDependency

public void removeDependency(String nodeId,
                             String name,
                             String toNodeId)

Description copied from interface: AppStorage

Removes a dependency named name from node with ID nodeId to node with ID toNodeId.

Specified by:

removeDependency in interface AppStorage

flush

public void flush()

Description copied from interface: AppStorage

Flush any changes to underlying storage.

Specified by:

flush in interface AppStorage

isClosed

public boolean isClosed()

Description copied from interface: AppStorage

Check if storage is closed.

Specified by:

isClosed in interface AppStorage

close

public void close()

Description copied from interface: AppStorage

Closes any resource associated with this storage.

Specified by:

close in interface AppStorage

Specified by:

close in interface AutoCloseable

getEventsBus

public EventsBus getEventsBus()

Description copied from interface: AppStorage

Get the events store.

Specified by:

getEventsBus in interface AppStorage

checkFileSystem

public List<FileSystemCheckIssue> checkFileSystem(FileSystemCheckOptions options)

Description copied from interface: AppStorage

Check file system for consistency issues.

Specified by:

checkFileSystem in interface AppStorage

getSupportedFileSystemChecks

public List<String> getSupportedFileSystemChecks()

Description copied from interface: AppStorage

The list of supported file system checks.

Specified by:

getSupportedFileSystemChecks in interface AppStorage