org.pentaho.di.core.plugins
Class Plugin

java.lang.Object
  extended by org.pentaho.di.core.plugins.Plugin
All Implemented Interfaces:
PluginInterface

public class Plugin
extends Object
implements PluginInterface

This describes the plugin itself, the IDs it listens too, what libraries (jar files) it uses, the names, the i18n details, etc.

Author:
matt

Constructor Summary
Plugin(String[] ids, Class<? extends PluginTypeInterface> pluginType, Class<?> mainType, String category, String name, String description, String imageFile, boolean separateClassLoaderNeeded, boolean nativePlugin, Map<Class<?>,String> classMap, List<String> libraries, String errorHelpFile, URL pluginFolder)
           
 
Method Summary
 boolean equals(Object obj)
           
 String getCategory()
           
 Map<Class<?>,String> getClassMap()
           
 String getDescription()
           
 String getErrorHelpFile()
           
 String[] getIds()
           
 String getImageFile()
           
 List<String> getLibraries()
           
 Class<?> getMainType()
           
 String getName()
           
 URL getPluginDirectory()
           
 Class<? extends PluginTypeInterface> getPluginType()
           
 int hashCode()
           
 boolean isNativePlugin()
           
 boolean isSeparateClassLoaderNeeded()
           
 boolean matches(String id)
           
 void setCategory(String category)
           
 void setClassMap(Map<Class<?>,String> classMap)
           
 void setDescription(String description)
           
 void setErrorHelpFile(String errorHelpFile)
           
 void setIds(String[] ids)
           
 void setImageFile(String imageFile)
           
 void setLibraries(List<String> libraries)
           
 void setName(String name)
           
 void setNativePlugin(boolean nativePlugin)
           
 void setPluginType(Class<? extends PluginTypeInterface> pluginType)
           
 void setSaperateClassLoaderNeeded(boolean separateClassLoaderNeeded)
           
 String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Plugin

public Plugin(String[] ids,
              Class<? extends PluginTypeInterface> pluginType,
              Class<?> mainType,
              String category,
              String name,
              String description,
              String imageFile,
              boolean separateClassLoaderNeeded,
              boolean nativePlugin,
              Map<Class<?>,String> classMap,
              List<String> libraries,
              String errorHelpFile,
              URL pluginFolder)
Parameters:
ids -
pluginType -
category -
name -
description -
imageFile -
separateClassLoaderNeeded -
nativePlugin -
classMap -
libraries -
Method Detail

toString

public String toString()
Overrides:
toString in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

matches

public boolean matches(String id)
Specified by:
matches in interface PluginInterface
Parameters:
id - the plugin id to match
Returns:
true if one of the ids matches the given argument. Return false if it doesn't.

getCategory

public String getCategory()
Specified by:
getCategory in interface PluginInterface
Returns:
the category

setCategory

public void setCategory(String category)
Parameters:
category - the category to set

getName

public String getName()
Specified by:
getName in interface PluginInterface
Returns:
the name

setName

public void setName(String name)
Parameters:
name - the name to set

getDescription

public String getDescription()
Specified by:
getDescription in interface PluginInterface
Returns:
the description

setDescription

public void setDescription(String description)
Parameters:
description - the description to set

getIds

public String[] getIds()
Specified by:
getIds in interface PluginInterface
Returns:
the ids

setIds

public void setIds(String[] ids)
Parameters:
ids - the ids to set

getPluginType

public Class<? extends PluginTypeInterface> getPluginType()
Specified by:
getPluginType in interface PluginInterface
Returns:
the pluginType

setPluginType

public void setPluginType(Class<? extends PluginTypeInterface> pluginType)
Parameters:
pluginType - the pluginType to set

getImageFile

public String getImageFile()
Specified by:
getImageFile in interface PluginInterface
Returns:
the imageFile

setImageFile

public void setImageFile(String imageFile)
Parameters:
imageFile - the imageFile to set

isSeparateClassLoaderNeeded

public boolean isSeparateClassLoaderNeeded()
Specified by:
isSeparateClassLoaderNeeded in interface PluginInterface
Returns:
the separateClassLoaderNeeded

setSaperateClassLoaderNeeded

public void setSaperateClassLoaderNeeded(boolean separateClassLoaderNeeded)
Parameters:
separateClassLoaderNeeded - the separateClassLoaderNeeded to set

isNativePlugin

public boolean isNativePlugin()
Specified by:
isNativePlugin in interface PluginInterface
Returns:
the nativePlugin

setNativePlugin

public void setNativePlugin(boolean nativePlugin)
Parameters:
nativePlugin - the nativePlugin to set

getClassMap

public Map<Class<?>,String> getClassMap()
Specified by:
getClassMap in interface PluginInterface
Returns:
the classMap

setClassMap

public void setClassMap(Map<Class<?>,String> classMap)
Parameters:
classMap - the classMap to set

getLibraries

public List<String> getLibraries()
Specified by:
getLibraries in interface PluginInterface
Returns:
the libraries

setLibraries

public void setLibraries(List<String> libraries)
Parameters:
libraries - the libraries to set

getErrorHelpFile

public String getErrorHelpFile()
Specified by:
getErrorHelpFile in interface PluginInterface
Returns:
the errorHelpFile

setErrorHelpFile

public void setErrorHelpFile(String errorHelpFile)
Parameters:
errorHelpFile - the errorHelpFile to set

getMainType

public Class<?> getMainType()
Specified by:
getMainType in interface PluginInterface
Returns:
The main class assigned to this Plugin.

getPluginDirectory

public URL getPluginDirectory()
Specified by:
getPluginDirectory in interface PluginInterface