Some fileimport enhancements - Add support for Excel import

[simantics/platform.git] / bundles / org.simantics.fileimport / src / org / simantics / fileimport / IGenericFileImport.java

diff --git a/bundles/org.simantics.fileimport/src/org/simantics/fileimport/IGenericFileImport.java b/bundles/org.simantics.fileimport/src/org/simantics/fileimport/IGenericFileImport.java
index 2de1cc7427dd5f03367b9ea310731011a7e701a8..a8bb132c98f8245013d250d5fd2f8c3f44e6e113 100644 (file)
--- a/bundles/org.simantics.fileimport/src/org/simantics/fileimport/IGenericFileImport.java
+++ b/bundles/org.simantics.fileimport/src/org/simantics/fileimport/IGenericFileImport.java
@@ -1,33 +1,45 @@
-package org.simantics.fileimport;\r
-\r
-import java.nio.file.Path;\r
-import java.util.Map;\r
-import java.util.Optional;\r
-\r
-/**\r
- * @author Jani Simomaa\r
- *\r
- */\r
-public interface IGenericFileImport {\r
-\r
-    /**\r
-     * Performs the import procedure for the given file\r
-     * \r
-     * @param file\r
-     *            file to import\r
-     */\r
-    Optional<String> perform(Path file) throws Exception;\r
-\r
-    /**\r
-     * @param resource\r
-     */\r
-    void remove(String resource) throws Exception;\r
-    \r
-    /**\r
-     * Returns a key-value map for file extensions this importer can handle\r
-     * \r
-     * @return\r
-     */\r
-    Map<String, String> allowedExtensionsWithFilters();\r
-\r
-}\r
+package org.simantics.fileimport;
+
+import java.nio.file.Path;
+import java.util.Map;
+import java.util.Optional;
+
+import org.simantics.db.Resource;
+
+/**
+ * Base interface for performing file imports. 
+ * 
+ * Usually with Simantics products every file that will be imported will become 
+ * a resource in the Simantics database. For these cases see {@link SimanticsResourceFileImport}
+ * 
+ * @author Jani Simomaa
+ *
+ */
+public interface IGenericFileImport {
+
+    /**
+     * Performs the import for the given file
+     * 
+     * @param file Path to file to import
+     * @return Optional string which will be the identifier of the imported file which can later be used for removing the imported entity
+     * @throws Exception
+     */
+    Optional<String> perform(Path file) throws Exception;
+
+    Optional<Resource> perform(Resource parent, Path file) throws Exception;
+    
+    /**
+     * Remove the entity
+     * 
+     * @param identifier String identifier which can be used to remove the imported entity
+     */
+    void remove(String identifier) throws Exception;
+    
+    /**
+     * Returns a key-value map for file extensions this importer can handle
+     * 
+     * @return Map<String, String> allowed extensions this service can handle. Key is the extension e.g. <code>.sharedLibrary</code> and the value is the description of the extension
+     */
+    Map<String, String> allowedExtensionsWithFilters();
+
+}