📄 plugin.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!--NewPage--><HTML><HEAD><!-- Generated by javadoc (build 1.5.0_13) on Mon Jul 14 01:36:53 CEST 2008 --><TITLE>Plugin (RapidMiner Class Documentation)</TITLE><META NAME="keywords" CONTENT="com.rapidminer.tools.plugin.Plugin class"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ parent.document.title="Plugin (RapidMiner Class Documentation)";}</SCRIPT><NOSCRIPT></NOSCRIPT></HEAD><BODY BGCOLOR="white" onload="windowTitle();"><!-- ========= START OF TOP NAVBAR ======= --><A NAME="navbar_top"><!-- --></A><A HREF="#skip-navbar_top" title="Skip navigation links"></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""><TR><TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"><A NAME="navbar_top_firstrow"><!-- --></A><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Plugin.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR></TABLE></TD><TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM></EM></TD></TR><TR><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../com/rapidminer/tools/plugin/Dependency.html" title="class in com.rapidminer.tools.plugin"><B>PREV CLASS</B></A> <A HREF="../../../../com/rapidminer/tools/plugin/PluginClassLoader.html" title="class in com.rapidminer.tools.plugin"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?com/rapidminer/tools/plugin/Plugin.html" target="_top"><B>FRAMES</B></A> <A HREF="Plugin.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--></SCRIPT><NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A></NOSCRIPT></FONT></TD></TR><TR><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD></TR></TABLE><A NAME="skip-navbar_top"></A><!-- ========= END OF TOP NAVBAR ========= --><HR><!-- ======== START OF CLASS DATA ======== --><H2><FONT SIZE="-1">com.rapidminer.tools.plugin</FONT><BR>Class Plugin</H2><PRE>java.lang.Object <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.rapidminer.tools.plugin.Plugin</B></PRE><HR><DL><DT><PRE>public class <B>Plugin</B><DT>extends java.lang.Object</DL></PRE><P><p> The class for RapidMiner plugins. This class is used to encapsulate the .jar file which must be in the <code>lib/plugins</code> subdirectory of RapidMiner. Provides methods for plugin checks, operator registering, and getting information about the plugin. </p> <p> Plugin dependencies must be defined in the form <br /> plugin_name1 (plugin_version1) # ... # plugin_nameM (plugin_versionM) < /br> of the manifest parameter <code>Plugin-Dependencies</code>. You must define both the name and the version of the desired plugins and separate them with "#". </p><P><P><DL><DT><B>Version:</B></DT> <DD>$Id: Plugin.java,v 1.12 2008/07/12 17:46:46 ingomierswa Exp $</DD><DT><B>Author:</B></DT> <DD>Simon Fischer, Ingo Mierswa</DD></DL><HR><P><!-- =========== FIELD SUMMARY =========== --><A NAME="field_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Field Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#RAPIDMINER_TYPE">RAPIDMINER_TYPE</A></B></CODE><BR> The name for the manifest entry RapidMiner-Type which can be used to indicate that a jar file is a RapidMiner plugin.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#RAPIDMINER_TYPE_PLUGIN">RAPIDMINER_TYPE_PLUGIN</A></B></CODE><BR> The value for the manifest entry RapidMiner-Type which indicates that a jar file is a RapidMiner plugin.</TD></TR></TABLE> <!-- ======== CONSTRUCTOR SUMMARY ======== --><A NAME="constructor_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Constructor Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#Plugin(java.io.File)">Plugin</A></B>(java.io.File file)</CODE><BR> Creates a new pluging based on the plugin .jar file.</TD></TR></TABLE> <!-- ========== METHOD SUMMARY =========== --><A NAME="method_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"><B>Method Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="../../../../com/rapidminer/gui/tools/AboutBox.html" title="class in com.rapidminer.gui.tools">AboutBox</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#createAboutBox(java.awt.Frame, java.awt.Image)">createAboutBox</A></B>(java.awt.Frame owner, java.awt.Image productLogo)</CODE><BR> Creates the about box for this plugin.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#findPlugins(java.io.File, boolean)">findPlugins</A></B>(java.io.File pluginDir, boolean showWarningForNonPluginJars)</CODE><BR> Returns a list of Plugins found in the plugins directory.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static java.util.List<<A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html" title="class in com.rapidminer.tools.plugin">Plugin</A>></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#getAllPlugins()">getAllPlugins</A></B>()</CODE><BR> Returns the collection of all plugins.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.util.List<<A HREF="../../../../com/rapidminer/gui/templates/BuildingBlock.html" title="class in com.rapidminer.gui.templates">BuildingBlock</A>></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#getBuildingBlocks()">getBuildingBlocks</A></B>()</CODE><BR> Returns a list of building blocks.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.ClassLoader</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#getClassLoader()">getClassLoader</A></B>()</CODE><BR> Returns the class loader of this plugin.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static java.lang.ClassLoader</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#getMajorClassLoader()">getMajorClassLoader</A></B>()</CODE><BR> Returns a class loader which is able to load all classes (core _and_ all plugins).</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#getName()">getName</A></B>()</CODE><BR> Returns the name of the plugin.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#getNecessaryRapidMinerVersion()">getNecessaryRapidMinerVersion</A></B>()</CODE><BR> Returns the necessary RapidMiner version.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static <A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html" title="class in com.rapidminer.tools.plugin">Plugin</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#getPlugin(java.lang.String)">getPlugin</A></B>(java.lang.String name)</CODE><BR> Returns the desired plugin.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.util.List</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#getPluginDependencies()">getPluginDependencies</A></B>()</CODE><BR> Returns the plugin dependencies of this plugin.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#getVersion()">getVersion</A></B>()</CODE><BR> Returns the version of this plugin.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#initAboutTexts(java.util.Properties)">initAboutTexts</A></B>(java.util.Properties properties)</CODE><BR> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#initFinalChecks()">initFinalChecks</A></B>()</CODE><BR> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#initPluginGuis(com.rapidminer.gui.MainFrame)">initPluginGuis</A></B>(<A HREF="../../../../com/rapidminer/gui/MainFrame.html" title="class in com.rapidminer.gui">MainFrame</A> mainframe)</CODE><BR> This method will try to invoke the method void initGui(MainFrame) of PluginInit class of every plugin.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#initPluginSplashTexts()">initPluginSplashTexts</A></B>()</CODE><BR> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#initPluginUpdateManager()">initPluginUpdateManager</A></B>()</CODE><BR> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#mergeClassLoader(com.rapidminer.tools.plugin.Plugin)">mergeClassLoader</A></B>(<A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html" title="class in com.rapidminer.tools.plugin">Plugin</A> other)</CODE><BR> Adds the URLs of the given Plugin to class loader of this one.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#register()">register</A></B>()</CODE><BR> Register the operators of this plugin in RapidMiner.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#registerAllPlugins(java.io.File, boolean)">registerAllPlugins</A></B>(java.io.File pluginDirectory, boolean showWarningForNonPluginJars)</CODE><BR> Returns a list of Plugins found in the given plugins directory.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> boolean</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#showAboutBox()">showAboutBox</A></B>()</CODE><BR> </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../com/rapidminer/tools/plugin/Plugin.html#toString()">toString</A></B>()</CODE><BR> </TD></TR></TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"><TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD></TR></TABLE> <P><!-- ============ FIELD DETAIL =========== --><A NAME="field_detail"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"><B>Field Detail</B></FONT></TH></TR></TABLE><A NAME="RAPIDMINER_TYPE"><!-- --></A><H3>RAPIDMINER_TYPE</H3><PRE>public static final java.lang.String <B>RAPIDMINER_TYPE</B></PRE><DL><DD>The name for the manifest entry RapidMiner-Type which can be used to indicate that a jar file is a RapidMiner plugin.<P><DL><DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.rapidminer.tools.plugin.Plugin.RAPIDMINER_TYPE">Constant Field Values</A></DL></DL><HR>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -