import java.util.Optional;\r
\r
/**\r
+ * Base interface for performing file imports. \r
+ * \r
+ * Usually with Simantics products every file that will be imported will become \r
+ * a resource in the Simantics database. For these cases see {@link SimanticsResourceFileImport}\r
+ * \r
* @author Jani Simomaa\r
*\r
*/\r
public interface IGenericFileImport {\r
\r
/**\r
- * Performs the import procedure for the given file\r
+ * Performs the import for the given file\r
* \r
- * @param file\r
- * file to import\r
+ * @param file Path to file to import\r
+ * @return Optional string which will be the identifier of the imported file which can later be used for removing the imported entity\r
+ * @throws Exception\r
*/\r
Optional<String> perform(Path file) throws Exception;\r
\r
/**\r
- * @param resource\r
+ * Remove the entity\r
+ * \r
+ * @param identifier String identifier which can be used to remove the imported entity\r
*/\r
- void remove(String resource) throws Exception;\r
+ void remove(String identifier) throws Exception;\r
\r
/**\r
* Returns a key-value map for file extensions this importer can handle\r
* \r
- * @return\r
+ * @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\r
*/\r
Map<String, String> allowedExtensionsWithFilters();\r
\r