created a simple plugin interface

This commit is contained in:
frosch95
2013-09-29 12:39:01 +02:00
parent 94441e06fa
commit ed708e836b
9 changed files with 241 additions and 10 deletions

View File

@@ -27,6 +27,8 @@ package de.frosch95.geofrogger.application;
import de.frosch95.geofrogger.gpx.GPXReader;
import de.frosch95.geofrogger.gpx.GroundspeakGPXReader;
import de.frosch95.geofrogger.plugins.PluginService;
import de.frosch95.geofrogger.plugins.PluginServiceImpl;
import de.frosch95.geofrogger.service.CacheService;
import de.frosch95.geofrogger.service.CacheServiceImpl;
import de.frosch95.geofrogger.sql.DatabaseService;
@@ -42,6 +44,7 @@ public class ServiceManager {
private GPXReader gpxReader;
private DatabaseService databaseService;
private CacheService cacheService;
private PluginService pluginService;
private ServiceManager() {
// private for singleton pattern
@@ -72,4 +75,11 @@ public class ServiceManager {
return cacheService;
}
public synchronized PluginService getPluginService() {
if (pluginService == null) {
pluginService = new PluginServiceImpl();
}
return pluginService;
}
}

View File

@@ -30,6 +30,8 @@ import de.frosch95.geofrogger.application.ServiceManager;
import de.frosch95.geofrogger.application.SessionContext;
import de.frosch95.geofrogger.gpx.GPXReader;
import de.frosch95.geofrogger.model.Cache;
import de.frosch95.geofrogger.plugins.Plugin;
import de.frosch95.geofrogger.plugins.PluginService;
import de.frosch95.geofrogger.service.CacheService;
import de.frosch95.geofrogger.service.CacheSortField;
import de.frosch95.geofrogger.service.SortDirection;
@@ -39,12 +41,10 @@ import javafx.beans.property.SimpleObjectProperty;
import javafx.concurrent.Service;
import javafx.concurrent.Task;
import javafx.event.ActionEvent;
import javafx.event.EventHandler;
import javafx.fxml.FXML;
import javafx.fxml.Initializable;
import javafx.scene.control.Label;
import javafx.scene.control.ProgressBar;
import javafx.scene.control.ProgressIndicator;
import javafx.scene.control.TextArea;
import javafx.scene.control.*;
import javafx.stage.FileChooser;
import org.controlsfx.dialog.Dialog;
@@ -106,6 +106,7 @@ public class GeofroggerController implements Initializable {
private final GPXReader gpxReader = ServiceManager.getInstance().getGPXReader();
private final CacheService cacheService = ServiceManager.getInstance().getCacheService();
private final PluginService pluginService = ServiceManager.getInstance().getPluginService();
@FXML
private Label leftStatus;
@@ -113,6 +114,9 @@ public class GeofroggerController implements Initializable {
@FXML
private ProgressBar progress;
@FXML
private Menu pluginsMenu;
/**
* Initializes the controller class.
*
@@ -121,14 +125,16 @@ public class GeofroggerController implements Initializable {
*/
@Override
public void initialize(URL url, ResourceBundle rb) {
gpxReader.addListener((ProgressEvent event) -> {
updateStatus(event.getMessage(), event.getProgress());
});
cacheService.addListener((ProgressEvent event) -> {
updateStatus(event.getMessage(), event.getProgress());
});
List<Plugin> plugins = pluginService.getAllPlugins();
for (Plugin plugin: plugins) {
MenuItem menuItem = new MenuItem(plugin.getName()+" ("+plugin.getVersion()+")");
menuItem.setOnAction(actionEvent -> pluginService.executePlugin(plugin));
pluginsMenu.getItems().add(menuItem);
}
gpxReader.addListener((ProgressEvent event) -> updateStatus(event.getMessage(), event.getProgress()));
cacheService.addListener((ProgressEvent event) -> updateStatus(event.getMessage(), event.getProgress()));
loadFromDBService.start();
}

View File

@@ -18,6 +18,7 @@
<MenuItem mnemonicParsing="false" onAction="#exit" text="%menu.title.quit"/>
</items>
</Menu>
<Menu fx:id="pluginsMenu" mnemonicParsing="false" text="%menu.title.plugins"/>
<Menu mnemonicParsing="false" text="%menu.title.help">
<items>
<MenuItem mnemonicParsing="false" onAction="#showAboutDialog" text="%menu.title.about"/>

View File

@@ -3,6 +3,7 @@ menu.title.file = Datei
menu.title.quit = Beenden
menu.title.help = Hilfe
menu.title.about = \u00dcber GeoFroggerFX
menu.title.plugins = Plugins
menu.title.sort = Sortieren
menu.title.filter = Filtern

View File

@@ -3,6 +3,7 @@ menu.title.file = File
menu.title.quit = Quit
menu.title.help = Help
menu.title.about = About GeoFroggerFX
menu.title.plugins = Plugins
menu.title.sort = Sort
menu.title.filter = Filter

View File

@@ -0,0 +1,30 @@
package de.frosch95.geofrogger.plugins;
import java.util.Map;
/**
* This interface defines the method a plugin has to provide to be called correctly
*
* @author abi
*/
public interface Plugin {
/**
* @return name
*/
String getName();
/**
* @return version
*/
String getVersion();
/**
* Run the main method of the plugin. All the logic is done in this method.
* Every run method will get a context map, with all the services inside,
* to use them.
* @param context services and data
*/
void run(Map context);
}

View File

@@ -0,0 +1,18 @@
package de.frosch95.geofrogger.plugins;
import java.util.List;
/**
* TODO: class description
*
* @author abi
*/
public interface PluginService {
List<Plugin> getAllPlugins();
void executePlugin(Plugin plugin);
}

View File

@@ -0,0 +1,61 @@
package de.frosch95.geofrogger.plugins;
import de.frosch95.geofrogger.application.ServiceManager;
import de.frosch95.geofrogger.application.SessionContext;
import groovy.lang.GroovyClassLoader;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* TODO: class description
*
* @author abi
*/
public class PluginServiceImpl implements PluginService {
private final GroovyClassLoader gcl = new GroovyClassLoader();
private final ServiceManager serviceManager = ServiceManager.getInstance();
@Override
public List<Plugin> getAllPlugins() {
List<Plugin> plugins = new ArrayList<>();
try {
File file = new File("./plugins");
if (!file.exists()) {
throw new IllegalArgumentException("plugins folder does not exit");
}
File[] pluginFiles = file.listFiles((dir, name) -> name.endsWith("Plugin.groovy"));
for (File pluginFile: pluginFiles) {
Class clazz = gcl.parseClass(pluginFile);
for (Class interf: clazz.getInterfaces()) {
if (interf.equals(Plugin.class)) {
plugins.add((Plugin)clazz.newInstance());
break;
}
}
}
} catch (IOException | InstantiationException | IllegalAccessException e) {
e.printStackTrace();
}
return plugins;
}
@Override
public void executePlugin(final Plugin plugin) {
Map<String, Object> context = new HashMap<>();
context.put("sessionContext", SessionContext.getInstance());
context.put("cacheService", serviceManager.getCacheService());
plugin.run(context);
}
}