Jani Simomaa at 11:29, 14 September 2016

2016-09-14T11:29:11Z

← Older revision		Revision as of 11:29, 14 September 2016
Line 54:		Line 54:

	}		}
			</pre>

			It is important to create the component for defining declarative service. To do this right click the same plugin where the implmentation is and click New -> Other -> Plug-in Development -> Component Definition.

			Give the name for the XML file and and browse to the implementing class You just created.

			An example of XML-file is:

			<pre>
			<?xml version="1.0" encoding="UTF-8"?>
			<scr:component xmlns:scr="http://www.osgi.org/xmlns/scr/v1.1.0" name="org.simantics.fmi.studio.fileimport">
			<implementation class="org.simantics.fmi.studio.fileimport.FMIFileImport"/>
			<service>
			<provide interface="org.simantics.fileimport.IGenericFileImport"/>
			</service>
			</scr:component>
	</pre>		</pre>

Jani Simomaa: Created page with "Simantics Generic File Import is a utility service that enables [http://help.eclipse.org/mars/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Freference%2Fmisc%2Fp2_dropins_f..."

2016-09-13T11:18:51Z

Created page with "Simantics Generic File Import is a utility service that enables [http://help.eclipse.org/mars/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Freference%2Fmisc%2Fp2_dropins_f..."

New page

Simantics Generic File Import is a utility service that enables [http://help.eclipse.org/mars/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Freference%2Fmisc%2Fp2_dropins_format.html Eclipse's Dropins]-like functionality. The directory resides inside <code>~/workspace/.metadata/plugins/org.simantics.fileimport/dropins</code> and it is not watched by default. There are two ways to start the watchservice:

# Call directly in Java <code>FileImportDropins.watchDropinsFolder()</code>
# Use SCL function <code>watchDropinsFolder</code> from <code>"Dropins/Core"</code>

== Creating own File importer ==

To create own File importer it is usually enough to extend the abstract class <code>SimanticsResourceFileImport</code> and implement the two methods:

<pre>
/**
* 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();

/**
* Performs the import for the given file
*
* @param parent Resource parent of the imported entity in Simantics database
* @param file Path file location of file
* @return Optional Resource of the imported entity in Simantics database
* @throws Exception
*/
public abstract Optional<Resource> perform(Resource parent, Path file) throws Exception;

</pre>

An example of such a class for importing FMU-files to Simantics workbench would be following:

<pre>
public class FMIFileImport extends SimanticsResourceFileImport {

private static final Map<String, String> EXTENSIONS_FILTERS = Collections.singletonMap("*.fmu",
"Functional Mock-up Unit (*.fmu)");

@Override
public Optional<Resource> perform(Resource parent, Path file) throws IOException{
try {
Resource model = FMIStudioSCL.createFMIModel(parent, file);
return Optional.of(model);
} catch (FMILException | DatabaseException e) {
e.printStackTrace();
return Optional.empty();
}
}

@Override
public Map<String, String> allowedExtensionsWithFilters() {
return EXTENSIONS_FILTERS;
}

}
</pre>

== FileImportService utility class ==

The class <code>org.simantics.fileimport.FileImportService</code> contains utility methods for e.g. listing all current services and performing file imports:

<pre>
/**
* Lists all supported file extensions which have a registered service for handling the import
*
* @return Map containing the extension and the description of the extension in that order
*/
public static Map<String, String> supportedExtensionsWithFilters();

/**
* Method that performs the import of the given file. This method is called when e.g. {@link FileImportDropins} watcher detects {@link java.nio.file.StandardWatchEventKinds.ENTRY_CREATE} operation
*
* @param file Path file to be imported
* @param callback Optional callback which can be used to catch Throwables thrown in the import process
*/
public static void performFileImport(Path file, Optional<Consumer<Throwable>> callback);
</pre>

Simantics Generic File Import - Revision history

Jani Simomaa at 11:29, 14 September 2016

Jani Simomaa: Created page with "Simantics Generic File Import is a utility service that enables [http://help.eclipse.org/mars/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Freference%2Fmisc%2Fp2_dropins_f..."