1. Documentation
2. 10.1 (Latest)10.09.109.99.89.79.69.59.49.39.29.19.08.28.18.07.6
3. Developers
4. Extensions
5. Bundle sample data

Bundle sample data with your extension

This article will guide you through:

• Assembling sample data
• Preparing the extension resources
• Adding data to the extension resources
• Registering a sample repository

Assembling sample data in your repository

First, create a new folder in your local repository, e.g.,//Local Repository/Myextension Samples. Now add your data into this folder. You can add data via the wizard behind theAdd databutton, or use a process with a圣oreoperator, or copy an existing repository entry. For our example, we choose the second option.

Drag and drop aGenerate Dataoperator onto the process panel add a圣oreoperator and connections.

Configure the圣oreoperator to store the data set in the new folder, e.g., as//Local Repository/Myextension Samples/Custom data, and run the process.

Add a subfolder, in our example called "Subfolder", to theMyextension Samplesfolder, copy theCustom datainto it and rename it toCustom data 2. Your repository should now look like this:

Now that we have assembled the data we want to ship, we need to prepare a package in the extension, where the data will be copied to.

Preparing the extension resources

If you have no experience with writing extensions yet, please refer to our guideCreate your own extension. Sections 1-3 cover all you need to know to build an extension that can be used to distribute sample repositories.

By convention build tools such as Maven and Gradle look for resources in thesrc/main/resourcesdirectory. We recommend using this structure for RapidMiner extensions as well.

让我们假设你选择org.myorg.myextensionas group id. Then your resources should be located undersrc/main/resources/org/myorg/myextension. Thus, you could choose the folder…/org/myorg/myextension/myextension_samplesas location for your sample data:

my_extension ├── README.md ├── build.gradle ├── … ├── src │ └── main │ ├── java │ │ └── … │ └── resources │ ├── org │ │ └── myorg │ │ └── myextension │ │ └── myextension_samples │ └── … └── …

Note that the last part of the directory name, in our casemyextension_samples, must be unique. If another extension uses the same name then your data might get substituted by the data from the other extension. In particular, the name cannot besamplesas this name is already in use by RapidMiner Studio itself.

RapidMiner will not search for resources in that directory unless you register the location as resource source. This can be easily done in the initialization code of your extension. All you need to do is to add the following line to theinitPlugin()method:

/** * This method will be called directly after the extension is initialized. This is the first * hook during start up. No initialization of the operators or renderers has taken place when * this is called. */ public static void initPlugin() { // register extension resources Tools.addResourceSource(new ResourceSource(PluginInitMyExtension.class.getClassLoader(), "org/myorg/myextension/")); }

Adding data to the extension resources

Now, we copy the data assembled in the first step into the resources foldermyextension_samplesin the extension. For that, alternative-click on theMyextension Samplesfolder in the repository and chooseOpen in file browser. Copy its content and paste it into the resources foldermyextension_samples:

… └── myextension_samples ├── Subfolder │ ├── Custom data 2.ioo │ ├── Custom data 2.md │ └── Custom data 2.properties ├── Custom data.ioo ├── Custom data.md ├── Custom data.properties └── Subfolder.properties

In order for the content to get loaded there needs to be an additionalCONTENTSfile describing the file structure in every folder. The foldermyextension_samplescontains one folder and one file, so we add a file called "CONTENTS" with the following lines:

FOLDER Subfolder ENTRY Custom data.ioo

Analogously, to the folderSubfolderwe add a file called "CONTENTS" with the line:

ENTRY Custom data 2.ioo

The resulting file structure looks like this:

… └── myextension_samples ├── Subfolder │ ├── CONTENTS │ ├── Custom data 2.ioo │ ├── Custom data 2.md │ └── Custom data 2.properties ├── CONTENTS ├── Custom data.ioo ├── Custom data.md ├── Custom data.properties └── Subfolder.properties

Registering a sample repository

To register the data added in the previous step, you need to add two more lines to the plugin initialization code:

public static void initPlugin() { // register extension resources Tools.addResourceSource(new ResourceSource(PluginInitMyExtension.class.getClassLoader(), "org/myorg/myextension/")); // create a new repository pointing to the resource folder Repository repository = new ResourceRepository("MyExtension Samples", "myextension_samples", false, false); // register the repository RepositoryManager.getInstance(null).addRepository(repository); }

Please note that the second parameter of

new ResourceRepository("MyExtension Samples", "myextension_samples", false, false)

must the name of folder containing your data while the first parameter is the display name of your new repository. The last two parameters should be set tofalseto prevent your repository from containing a copy of theTemplatesandTutorialssubfolders that are already contained in theSamples库在RapidMiner Studio。

Testing the sample repository

There are no further special steps involved in testing the bundled repository. All you need to do is to build a new version of your extension, e.g., via the commandgradle clean installExtension.

After a restart of RapidMiner Studio your repository should look like this: