Package net.sf.tweety.plugin
Class AbstractTweetyPlugin
- java.lang.Object
-
- net.sf.tweety.plugin.AbstractTweetyPlugin
-
- All Implemented Interfaces:
TweetyPlugin
,net.xeoh.plugins.base.Plugin
- Direct Known Subclasses:
FirstOrderLogicPlugin
,PlPlugin
,PreferencesPlugin
,RPCLPlugin
public abstract class AbstractTweetyPlugin extends java.lang.Object implements TweetyPlugin
This abstract class implements the TweetyPlugin interface and provides a base for plugin implementations in each project- Author:
- Bastian Wolf
-
-
Constructor Summary
Constructors Constructor Description AbstractTweetyPlugin()
-
Method Summary
Modifier and Type Method Description void
addParameter(CommandParameter cmdParameter)
adds new command parameter to this pluginabstract PluginOutput
execute(java.io.File[] input, CommandParameter[] params)
executes the given inputabstract java.lang.String
getCommand()
returns the command this plugin is called withjava.util.List<CommandParameter>
getParameters()
returns all possible parametersCommandParameter
validateParameter(java.lang.String s)
checks, whether each command parameter given with the plugin call is valid within is this pluginjava.util.ArrayList<CommandParameter>
validateParameter(java.util.ArrayList<java.lang.String> s)
This method handels instantiations with array-lists instead of a simple string (e.g.
-
-
-
Method Detail
-
getCommand
public abstract java.lang.String getCommand()
returns the command this plugin is called with- Specified by:
getCommand
in interfaceTweetyPlugin
- Returns:
- the keyword used in the cli to call this plugin
-
execute
public abstract PluginOutput execute(java.io.File[] input, CommandParameter[] params)
executes the given input- Specified by:
execute
in interfaceTweetyPlugin
- Parameters:
input
- files to be used within the pluginparams
- parameter handled in the plugin (e.g. desired output file, iterations...)- Returns:
- the output resulted after the execution
-
addParameter
public void addParameter(CommandParameter cmdParameter)
adds new command parameter to this plugin- Parameters:
cmdParameter
- the command parameter to be added
-
getParameters
public java.util.List<CommandParameter> getParameters()
returns all possible parameters- Specified by:
getParameters
in interfaceTweetyPlugin
- Returns:
- parameters allowed with plugin calls
-
validateParameter
public CommandParameter validateParameter(java.lang.String s) throws java.lang.CloneNotSupportedException
checks, whether each command parameter given with the plugin call is valid within is this plugin- Parameters:
s
- the given parameter string- Returns:
- a newly instantiated command parameter with the given value
- Throws:
java.lang.CloneNotSupportedException
- if cloning is not supported
-
validateParameter
public java.util.ArrayList<CommandParameter> validateParameter(java.util.ArrayList<java.lang.String> s) throws java.lang.CloneNotSupportedException
This method handels instantiations with array-lists instead of a simple string (e.g. for multi-argument parameter)- Parameters:
s
- the ArrayList<String> containing the input parameter- Returns:
- the newly instantiated command parameter with the given value
- Throws:
java.lang.CloneNotSupportedException
- if cloning is not supported
-
-