Data store implementation

commons/src/main/java/com/powsybl/commons/datasource/ObservableInputStream.java

@@ -14,13 +14,13 @@
 /**
  * @author Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>
  */
-class ObservableInputStream extends ForwardingInputStream<InputStream> {
+public class ObservableInputStream extends ForwardingInputStream<InputStream> {
 
     private final String streamName;
 
     private final DataSourceObserver observer;
 
-    ObservableInputStream(InputStream is, String streamName, DataSourceObserver observer) {
+    public ObservableInputStream(InputStream is, String streamName, DataSourceObserver observer) {
         super(is);
         this.streamName = streamName;
         this.observer = observer;

commons/src/main/java/com/powsybl/commons/datastore/AbstractDataResolver.java

@@ -0,0 +1,66 @@
+/**
+ * Copyright (c) 2020, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.commons.datastore;
+
+import java.io.IOException;
+import java.util.List;
+import java.util.Objects;
+import java.util.Optional;
+import java.util.Properties;
+import java.util.stream.Collectors;
+
+import com.google.common.io.Files;
+
+/**
+ * @author Giovanni Ferrari <giovanni.ferrari at techrain.eu>
+ */
+public abstract class AbstractDataResolver implements DataResolver {
+
+    @Override
+    public Optional<DataPack> resolve(ReadOnlyDataStore store, String mainFileName, Properties parameters)
+            throws IOException, NonUniqueResultException {
+        Objects.requireNonNull(store);
+
+        DataPack dp = null;
+        if (mainFileName != null) {
+            if (store.exists(mainFileName) && checkFileExtension(mainFileName)) {
+                dp = buildDataPack(store, mainFileName);
+            }
+        } else {
+            List<String> candidates = store.getEntryNames().stream().filter(a -> checkFileExtension(a)).collect(Collectors.toList());
+            if (candidates.size() > 1) {
+                throw new NonUniqueResultException();
+            } else if (candidates.size() == 1) {
+                String entryName = candidates.get(0);
+                dp = buildDataPack(store, entryName);
+            }
+        }
+        return Optional.ofNullable(dp);
+    }
+
+    @Override
+    public boolean validate(DataPack pack, Properties properties) {
+        Optional<DataEntry> main = pack.getMainEntry();
+        return pack.getDataFormatId().equals(getDataFormatId()) && main.isPresent() && checkFileExtension(main.get().getName());
+    }
+
+    public boolean checkFileExtension(String filename) {
+        return getExtensions().contains(Files.getFileExtension(filename));
+    }
+
+    private DataPack buildDataPack(ReadOnlyDataStore store, String mainFileName) {
+        DataPack dp = new DataPack(store, getDataFormatId());
+        DataEntry entry = new DataEntry(mainFileName, DataPack.MAIN_ENTRY_TAG);
+        dp.addEntry(entry);
+        return dp;
+    }
+
+    public abstract String getDataFormatId();
+
+    public abstract List<String> getExtensions();
+
+}

commons/src/main/java/com/powsybl/commons/datastore/Bzip2FileDataStore.java

@@ -0,0 +1,59 @@
+/**
+ * Copyright (c) 2020, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.commons.datastore;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Collections;
+import java.util.List;
+import java.util.Objects;
+
+import org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream;
+import org.apache.commons.compress.compressors.bzip2.BZip2CompressorOutputStream;
+
+import com.powsybl.commons.datasource.DataSourceUtil;
+
+/**
+ * @author Giovanni Ferrari <giovanni.ferrari at techrain.eu>
+ */
+public class Bzip2FileDataStore implements DataStore {
+
+    private final Path path;
+
+    public Bzip2FileDataStore(Path path) {
+        Objects.requireNonNull(path);
+        this.path = path;
+    }
+
+    @Override
+    public List<String> getEntryNames() throws IOException {
+        return Collections.singletonList(getEntryName());
+    }
+
+    @Override
+    public boolean exists(String entryName) {
+        return getEntryName().equals(entryName);
+    }
+
+    @Override
+    public InputStream newInputStream(String entryName) throws IOException {
+        return new BZip2CompressorInputStream(Files.newInputStream(path));
+    }
+
+    @Override
+    public OutputStream newOutputStream(String entryName, boolean append) throws IOException {
+        return new BZip2CompressorOutputStream(Files.newOutputStream(path, DataSourceUtil.getOpenOptions(append)));
+    }
+
+    private String getEntryName() {
+        String fileName = path.getFileName().toString();
+        return fileName.substring(0, fileName.lastIndexOf(".bz2"));
+    }
+}

commons/src/main/java/com/powsybl/commons/datastore/DataEntry.java

@@ -0,0 +1,38 @@
+/**
+ * Copyright (c) 2020, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.commons.datastore;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Objects;
+
+/**
+ * @author Giovanni Ferrari <giovanni.ferrari at techrain.eu>
+ */
+public class DataEntry {
+
+    private String name;
+
+    private final List<String> tags = new ArrayList<>();
+
+    public DataEntry(String name, String... tags) {
+        this.name = Objects.requireNonNull(name);
+        if (tags != null)  {
+            this.tags.addAll(Arrays.asList(tags));
+        }
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public List<String> getTags() {
+        return tags;
+    }
+
+}

commons/src/main/java/com/powsybl/commons/datastore/DataFormat.java

@@ -0,0 +1,20 @@
+/**
+ * Copyright (c) 2020, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.commons.datastore;
+
+/**
+ * @author Giovanni Ferrari <giovanni.ferrari at techrain.eu>
+ */
+public interface DataFormat {
+
+    public String getId();
+
+    public String getDescription();
+
+    public DataResolver getDataResolver();
+
+}

commons/src/main/java/com/powsybl/commons/datastore/DataPack.java

@@ -0,0 +1,76 @@
+/**
+ * Copyright (c) 2020, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.commons.datastore;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Objects;
+import java.util.Optional;
+
+import com.google.common.io.ByteStreams;
+
+/**
+ * @author Giovanni Ferrari <giovanni.ferrari at techrain.eu>
+ */
+public class DataPack {
+
+    public static final String MAIN_ENTRY_TAG = "MAIN_ENTRY";
+
+    private final String dataFormatId;
+
+    private final ReadOnlyDataStore source;
+
+    private final List<DataEntry> entries;
+
+    public DataPack(ReadOnlyDataStore source, String formatId) {
+        this.source = Objects.requireNonNull(source);
+        this.dataFormatId = Objects.requireNonNull(formatId);
+        this.entries = new ArrayList<>();
+    }
+
+    public List<DataEntry> getEntries() {
+        return entries;
+    }
+
+    public void addEntry(DataEntry entry) {
+        entries.add(entry);
+    }
+
+    public Optional<DataEntry> getEntry(String entryName) {
+        Objects.requireNonNull(entryName);
+        return entries.stream().filter(e -> e.getName().equals(entryName)).findFirst();
+    }
+
+    public Optional<DataEntry> getMainEntry() {
+        return entries.stream().filter(e -> e.getTags().contains(MAIN_ENTRY_TAG)).findFirst();
+    }
+
+    public ReadOnlyDataStore getSource() {
+        return source;
+    }
+
+    public DataPack copyTo(DataStore target) throws IOException {
+        Objects.requireNonNull(target);
+        DataPack copy = new DataPack(target, dataFormatId);
+        for (DataEntry e : entries) {
+            try (InputStream in = source.newInputStream(e.getName()); OutputStream out = target.newOutputStream(e.getName(), false)) {
+                ByteStreams.copy(in, out);
+            }
+            copy.addEntry(e);
+        }
+
+        return copy;
+    }
+
+    public String getDataFormatId() {
+        return dataFormatId;
+    }
+
+}

commons/src/main/java/com/powsybl/commons/datastore/DataResolver.java

@@ -0,0 +1,23 @@
+/**
+ * Copyright (c) 2020, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.commons.datastore;
+
+import java.io.IOException;
+import java.util.Optional;
+import java.util.Properties;
+
+import javax.annotation.Nullable;
+
+/**
+ * @author Giovanni Ferrari <giovanni.ferrari at techrain.eu>
+ */
+public interface DataResolver {
+
+    public Optional<DataPack> resolve(ReadOnlyDataStore store, @Nullable String mainFileName, @Nullable Properties parameters) throws IOException, NonUniqueResultException;
+
+    public boolean validate(DataPack pack, @Nullable Properties parameters);
+}

commons/src/main/java/com/powsybl/commons/datastore/DataStore.java

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) 2020, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.commons.datastore;
+
+import java.io.IOException;
+import java.io.OutputStream;
+
+/**
+ * @author Giovanni Ferrari <giovanni.ferrari at techrain.eu>
+ */
+public interface DataStore extends ReadOnlyDataStore {
+
+    public OutputStream newOutputStream(String entryName, boolean append) throws IOException;
+
+}

commons/src/main/java/com/powsybl/commons/datastore/DataStoreUtil.java

@@ -0,0 +1,53 @@
+/**
+ * Copyright (c) 2020, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package com.powsybl.commons.datastore;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.NotDirectoryException;
+import java.nio.file.Path;
+import java.util.Objects;
+
+/**
+ * @author Giovanni Ferrari <giovanni.ferrari at techrain.eu>
+ */
+public interface DataStoreUtil {
+
+    static DataStore createDataStore(Path fileName) throws IOException {
+        Objects.requireNonNull(fileName);
+        DataStore ds = null;
+        if (Files.isDirectory(fileName)) {
+            ds = new DirectoryDataStore(fileName);
+        } else {
+            String extension = getExtension(fileName.getFileName().toString());
+            if (extension.equals("zip")) {
+                ds = new ZipFileDataStore(fileName);
+            } else if (extension.equals("gz")) {
+                ds = new GzipFileDataStore(fileName);
+            } else if (extension.equals("bz2")) {
+                ds = new Bzip2FileDataStore(fileName);
+            } else {
+                Path parent = fileName.toAbsolutePath().getParent();
+                if (parent == null) {
+                    throw new NotDirectoryException("null");
+                }
+                ds = new DirectoryDataStore(parent);
+            }
+        }
+        return ds;
+    }
+
+    static String getExtension(String filename) {
+        int dotIndex = filename.lastIndexOf(".");
+        return dotIndex < 0 ? "" : filename.substring(dotIndex + 1);
+    }
+
+    static String getBasename(String filename) {
+        int dotIndex = filename.lastIndexOf(".");
+        return dotIndex < 0 ? filename : filename.substring(0, dotIndex);
+    }
+}