Package net.sf.tweety.plugin

Class AbstractTweetyPlugin

java.lang.Object

net.sf.tweety.plugin.AbstractTweetyPlugin

All Implemented Interfaces:

TweetyPlugin, net.xeoh.plugins.base.Plugin

public abstract class AbstractTweetyPlugin
extends Object
implements TweetyPlugin

This abstract class implements the TweetyPlugin interface and provides a base for plugin implementations in each project

Author:

Bastian Wolf

Field Summary

Fields

Modifier and Type	Field	Description
protected List<CommandParameter>	parameters	valid parameters for this plugin

Constructor Summary

Constructors

Constructor	Description
AbstractTweetyPlugin()

Method Summary

Modifier and Type	Method	Description
void	addParameter(CommandParameter cmdParameter)	adds new command parameter to this plugin
abstract PluginOutput	execute(File[] input, CommandParameter[] params)	executes the given input
abstract String	getCommand()	returns the command this plugin is called with
List<CommandParameter>	getParameters()	returns all possible parameters
CommandParameter	validateParameter(String s)	checks, whether each command parameter given with the plugin call is valid within is this plugin
ArrayList<CommandParameter>	validateParameter(ArrayList<String> s)	This method handels instantiations with array-lists instead of a simple string (e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

parameters

protected List<CommandParameter> parameters

valid parameters for this plugin

Constructor Detail

AbstractTweetyPlugin

public AbstractTweetyPlugin()

Method Detail

getCommand

public abstract String getCommand()

returns the command this plugin is called with

Specified by:

getCommand in interface TweetyPlugin

Returns:

the keyword used in the cli to call this plugin

execute

public abstract PluginOutput execute(File[] input,
                                     CommandParameter[] params)

executes the given input

Specified by:

execute in interface TweetyPlugin

Parameters:

input - files to be used within the plugin

params - 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 List<CommandParameter> getParameters()

returns all possible parameters

Specified by:

getParameters in interface TweetyPlugin

Returns:

parameters allowed with plugin calls

validateParameter

public CommandParameter validateParameter(String s)
                                   throws 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:

CloneNotSupportedException - if cloning is not supported

validateParameter

public ArrayList<CommandParameter> validateParameter(ArrayList<String> s)
                                              throws 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:

CloneNotSupportedException - if cloning is not supported