X-Git-Url: https://gerrit.simantics.org/r/gitweb?a=blobdiff_plain;f=bundles%2Forg.simantics.fileimport%2Fsrc%2Forg%2Fsimantics%2Ffileimport%2FIGenericFileImport.java;h=a8bb132c98f8245013d250d5fd2f8c3f44e6e113;hb=55be1eddbfed0d3d9e9e95a7d2547e287fde84ca;hp=07c0edc467f594d90cebcdf5750344a7397d4d8c;hpb=b809a171b6dfb81ed9ef9e84870dcbcbc5912f0e;p=simantics%2Fplatform.git 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 07c0edc46..a8bb132c9 100644 --- a/bundles/org.simantics.fileimport/src/org/simantics/fileimport/IGenericFileImport.java +++ b/bundles/org.simantics.fileimport/src/org/simantics/fileimport/IGenericFileImport.java @@ -1,41 +1,45 @@ -package org.simantics.fileimport; - -import java.nio.file.Path; -import java.util.Map; -import java.util.Optional; - -/** - * 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 perform(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 allowed extensions this service can handle. Key is the extension e.g. .sharedLibrary and the value is the description of the extension - */ - Map allowedExtensionsWithFilters(); - -} +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 perform(Path file) throws Exception; + + Optional 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 allowed extensions this service can handle. Key is the extension e.g. .sharedLibrary and the value is the description of the extension + */ + Map allowedExtensionsWithFilters(); + +}