parametertype.html
来自「数据挖掘方面最新软件」· HTML 代码 · 共 779 行 · 第 1/2 页
HTML
779 行
<!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:49 CEST 2008 --><TITLE>ParameterType (RapidMiner Class Documentation)</TITLE><META NAME="keywords" CONTENT="com.rapidminer.parameter.ParameterType class"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ parent.document.title="ParameterType (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/ParameterType.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/parameter/Parameters.html" title="class in com.rapidminer.parameter"><B>PREV CLASS</B></A> <A HREF="../../../com/rapidminer/parameter/ParameterTypeAttributeFile.html" title="class in com.rapidminer.parameter"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../index.html?com/rapidminer/parameter/ParameterType.html" target="_top"><B>FRAMES</B></A> <A HREF="ParameterType.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 | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | <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.parameter</FONT><BR>Class ParameterType</H2><PRE>java.lang.Object <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.rapidminer.parameter.ParameterType</B></PRE><DL><DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.lang.Comparable</DD></DL><DL><DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../com/rapidminer/parameter/ParameterTypeConfiguration.html" title="class in com.rapidminer.parameter">ParameterTypeConfiguration</A>, <A HREF="../../../com/rapidminer/parameter/ParameterTypeList.html" title="class in com.rapidminer.parameter">ParameterTypeList</A>, <A HREF="../../../com/rapidminer/parameter/ParameterTypePreview.html" title="class in com.rapidminer.parameter">ParameterTypePreview</A>, <A HREF="../../../com/rapidminer/parameter/ParameterTypeSingle.html" title="class in com.rapidminer.parameter">ParameterTypeSingle</A></DD></DL><HR><DL><DT><PRE>public abstract class <B>ParameterType</B><DT>extends java.lang.Object<DT>implements java.lang.Comparable, java.io.Serializable</DL></PRE><P>A ParameterType holds information about type, range, and default value of a parameter. Lists of ParameterTypes are provided by operators.<P><P><DL><DT><B>Version:</B></DT> <DD>$Id: ParameterType.java,v 1.8 2008/07/11 09:42:40 ingomierswa Exp $</DD><DT><B>Author:</B></DT> <DD>Ingo Mierswa, Simon Fischer</DD><DT><B>See Also:</B><DD><A HREF="../../../com/rapidminer/operator/Operator.html#getParameterTypes()"><CODE>Operator.getParameterTypes()</CODE></A>, <A HREF="../../../serialized-form.html#com.rapidminer.parameter.ParameterType">Serialized Form</A></DL><HR><P><!-- ======== 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/parameter/ParameterType.html#ParameterType(java.lang.String, java.lang.String)">ParameterType</A></B>(java.lang.String key, java.lang.String description)</CODE><BR> Creates a new ParameterType.</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>abstract java.lang.Object</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/parameter/ParameterType.html#checkValue(java.lang.Object)">checkValue</A></B>(java.lang.Object value)</CODE><BR> For single parameters the value is a String and must be converted to an Integer, Double, Boolean or String.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/parameter/ParameterType.html#compareTo(java.lang.Object)">compareTo</A></B>(java.lang.Object o)</CODE><BR> ParameterTypes are compared by key.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>abstract java.lang.Object</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/parameter/ParameterType.html#copyValue(java.lang.Object)">copyValue</A></B>(java.lang.Object value)</CODE><BR> Copies the value.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>abstract java.lang.Object</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/parameter/ParameterType.html#getDefaultValue()">getDefaultValue</A></B>()</CODE><BR> Returns a value that can be used if the parameter is not set.</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/parameter/ParameterType.html#getDescription()">getDescription</A></B>()</CODE><BR> Returns a short description.</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/parameter/ParameterType.html#getKey()">getKey</A></B>()</CODE><BR> Returns the key.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>abstract java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/parameter/ParameterType.html#getRange()">getRange</A></B>()</CODE><BR> Returns a human readable description of the range.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>abstract java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/parameter/ParameterType.html#getXML(java.lang.String, java.lang.String, java.lang.Object, boolean)">getXML</A></B>(java.lang.String indent, java.lang.String key, java.lang.Object value, boolean hideDefault)</CODE><BR> Writes an xml representation of the given key-value pair.</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/parameter/ParameterType.html#illegalValue(java.lang.Object, java.lang.Object)">illegalValue</A></B>(java.lang.Object illegal, java.lang.Object corrected)</CODE><BR> Can be called in order to report an illegal parameter value which is encountered during <tt>checkValue()</tt>.</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/parameter/ParameterType.html#isExpert()">isExpert</A></B>()</CODE><BR> Returns true if this parameter can only be seen in expert mode.</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/parameter/ParameterType.html#isHidden()">isHidden</A></B>()</CODE><BR> Returns true if this parameter is hidden or not all dependency conditions are fullfilled.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>abstract boolean</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/parameter/ParameterType.html#isNumerical()">isNumerical</A></B>()</CODE><BR> Returns true if the values of this parameter type are numerical, i.e. might be parsed by <CODE>Double.parseDouble(String)</CODE>.</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/parameter/ParameterType.html#isOptional()">isOptional</A></B>()</CODE><BR> Returns true if this parameter is optional.</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/parameter/ParameterType.html#registerDependencyCondition(com.rapidminer.parameter.conditions.ParameterCondition)">registerDependencyCondition</A></B>(<A HREF="../../../com/rapidminer/parameter/conditions/ParameterCondition.html" title="interface in com.rapidminer.parameter.conditions">ParameterCondition</A> condition)</CODE><BR> Registers the given dependency condition.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>abstract void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/parameter/ParameterType.html#setDefaultValue(java.lang.Object)">setDefaultValue</A></B>(java.lang.Object defaultValue)</CODE><BR> Sets the default value.</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/parameter/ParameterType.html#setDescription(java.lang.String)">setDescription</A></B>(java.lang.String description)</CODE><BR> Sets the short description.</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/parameter/ParameterType.html#setExpert(boolean)">setExpert</A></B>(boolean expert)</CODE><BR> Sets if this parameter can be seen in expert mode (true) or beginner mode (false).</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/parameter/ParameterType.html#setHidden(boolean)">setHidden</A></B>(boolean hidden)</CODE><BR> Sets if this parameter is hidden (value true) and will not be shown in the GUI.</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/parameter/ParameterType.html#toString()">toString</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/parameter/ParameterType.html#toString(java.lang.Object)">toString</A></B>(java.lang.Object value)</CODE><BR> Returns a string representation of this value.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.Object</CODE></FONT></TD><TD><CODE><B><A HREF="../../../com/rapidminer/parameter/ParameterType.html#transformNewValue(java.lang.Object)">transformNewValue</A></B>(java.lang.Object value)</CODE><BR> This method will be invoked by the Parameters after a parameter was set.</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><!-- ========= CONSTRUCTOR DETAIL ======== --><A NAME="constructor_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>Constructor Detail</B></FONT></TH></TR></TABLE><A NAME="ParameterType(java.lang.String, java.lang.String)"><!-- --></A><H3>ParameterType</H3><PRE>public <B>ParameterType</B>(java.lang.String key, java.lang.String description)</PRE><DL><DD>Creates a new ParameterType.<P></DL><!-- ============ METHOD DETAIL ========== --><A NAME="method_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>Method Detail</B></FONT></TH></TR></TABLE><A NAME="getRange()"><!-- --></A><H3>getRange</H3><PRE>public abstract java.lang.String <B>getRange</B>()</PRE><DL><DD>Returns a human readable description of the range.<P><DD><DL></DL></DD><DD><DL></DL></DD></DL><HR><A NAME="checkValue(java.lang.Object)"><!-- --></A><H3>checkValue</H3><PRE>public abstract java.lang.Object <B>checkValue</B>(java.lang.Object value)</PRE><DL><DD>For single parameters the value is a String and must be converted to an Integer, Double, Boolean or String. For lists, value already is a list. If value is out of range, a corrected value must be returned.⌨️ 快捷键说明
复制代码Ctrl + C
搜索代码Ctrl + F
全屏模式F11
增大字号Ctrl + =
减小字号Ctrl + -
显示快捷键?