floatparameter.html

Geotools是一个开源的Java GIS工具包,可利用它来开发符合标准的地理信息系统。Geotools提供了OGC(Open Geospatial Consortium)规范的一个实现来作为他们的

<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/geotools/parameter/FloatParameter.html#setValue(double[], javax.units.Unit)">setValue</A></B>(double[]&nbsp;values,
         <A HREF="http://jsr-108.sourceforge.net/javadoc/javax/units/Unit.html" title="class or interface in javax.units">Unit</A>&nbsp;unit)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Always throws an exception, since this parameter is not an array.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/geotools/parameter/FloatParameter.html#setValue(double, javax.units.Unit)">setValue</A></B>(double&nbsp;value,
         <A HREF="http://jsr-108.sourceforge.net/javadoc/javax/units/Unit.html" title="class or interface in javax.units">Unit</A>&nbsp;unit)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the parameter value as a floating point and its associated unit.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/geotools/parameter/FloatParameter.html#setValue(int)">setValue</A></B>(int&nbsp;value)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the parameter value as an integer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/geotools/parameter/FloatParameter.html#setValue(java.lang.Object)">setValue</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>&nbsp;value)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the parameter value as a <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Double.html" title="class or interface in java.lang"><CODE>Double</CODE></A> object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/geotools/parameter/FloatParameter.html#stringValue()">stringValue</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the string representation of the value.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/net/URI.html" title="class or interface in java.net">URI</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/geotools/parameter/FloatParameter.html#valueFile()">valueFile</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Always throws an exception, since this parameter is not an URI.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_AbstractParameter"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class <A HREF="../../../org/geotools/parameter/AbstractParameter.html" title="class in org.geotools.parameter">AbstractParameter</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../org/geotools/parameter/AbstractParameter.html#clone()">clone</A>, <A HREF="../../../org/geotools/parameter/AbstractParameter.html#formatWKT(org.geotools.referencing.wkt.Formatter)">formatWKT</A>, <A HREF="../../../org/geotools/parameter/AbstractParameter.html#getDescriptor()">getDescriptor</A>, <A HREF="../../../org/geotools/parameter/AbstractParameter.html#toString()">toString</A>, <A HREF="../../../org/geotools/parameter/AbstractParameter.html#write(org.geotools.io.TableWriter)">write</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_Formattable"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class <A HREF="../../../org/geotools/referencing/wkt/Formattable.html" title="class in org.geotools.referencing.wkt">Formattable</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../org/geotools/referencing/wkt/Formattable.html#toWKT()">toWKT</A>, <A HREF="../../../org/geotools/referencing/wkt/Formattable.html#toWKT(org.opengis.metadata.citation.Citation, int)">toWKT</A>, <A HREF="../../../org/geotools/referencing/wkt/Formattable.html#toWKT(int)">toWKT</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_ParameterValue"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from interface ParameterValue</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_GeneralParameterValue"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from interface GeneralParameterValue</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>getDescriptor</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->


<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="FloatParameter(org.opengis.parameter.ParameterDescriptor)"><!-- --></A><H3>
FloatParameter</H3>
<PRE>
public <B>FloatParameter</B>(ParameterDescriptor&nbsp;descriptor)</PRE>
<DL>
<DD>Constructs a parameter from the specified descriptor. The descriptor
 value class
 must be <code><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Double.html" title="class or interface in java.lang">Double</A>.class</code>.
<P>
<DT><B>Parameters:</B><DD><CODE>descriptor</CODE> - The abstract definition of this parameter.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the value class is not .</DL>
<HR>

<A NAME="FloatParameter(org.opengis.parameter.ParameterDescriptor, double)"><!-- --></A><H3>
FloatParameter</H3>
<PRE>
public <B>FloatParameter</B>(ParameterDescriptor&nbsp;descriptor,
                      double&nbsp;value)</PRE>
<DL>
<DD>Constructs a parameter from the specified descriptor and value. This convenience
 constructor is equivalents to the one-argument constructor followed by a call to
 <A HREF="../../../org/geotools/parameter/FloatParameter.html#setValue(double)"><CODE>setValue(double)</CODE></A>.
<P>
<DT><B>Parameters:</B><DD><CODE>descriptor</CODE> - The abstract definition of this parameter.<DD><CODE>value</CODE> - The parameter value.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the value class is not .</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="getUnit()"><!-- --></A><H3>
getUnit</H3>
<PRE>
public <A HREF="http://jsr-108.sourceforge.net/javadoc/javax/units/Unit.html" title="class or interface in javax.units">Unit</A> <B>getUnit</B>()</PRE>
<DL>
<DD>Returns the unit of measure of the <A HREF="../../../org/geotools/parameter/FloatParameter.html#doubleValue()">parameter value</A>. The default
 implementation always delegates to <CODE>ParameterDescriptor.getUnit()</CODE>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getUnit</CODE> in interface <CODE>ParameterValue</CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The unit of measure, or  if none.</DL>
</DD>
</DL>
<HR>

<A NAME="doubleValue(javax.units.Unit)"><!-- --></A><H3>
doubleValue</H3>
<PRE>
public double <B>doubleValue</B>(<A HREF="http://jsr-108.sourceforge.net/javadoc/javax/units/Unit.html" title="class or interface in javax.units">Unit</A>&nbsp;unit)
                   throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
<DL>
<DD>Returns the numeric value of the coordinate operation parameter in the specified unit
 of measure. This convenience method apply unit conversion on the fly as needed.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>doubleValue</CODE> in interface <CODE>ParameterValue</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>unit</CODE> - The unit of measure for the value to be returned.
<DT><B>Returns:</B><DD>The numeric value represented by this parameter after conversion to type
          and conversion to .
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the specified unit is invalid for this parameter.</DL>
</DD>
</DL>
<HR>

<A NAME="doubleValue()"><!-- --></A><H3>
doubleValue</H3>
<PRE>
public double <B>doubleValue</B>()</PRE>
<DL>
<DD>Returns the numeric value of the coordinate operation parameter with its
 associated <A HREF="../../../org/geotools/parameter/FloatParameter.html#getUnit()">unit of measure</A>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>doubleValue</CODE> in interface <CODE>ParameterValue</CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The numeric value represented by this parameter after conversion to type .</DL>
</DD>
</DL>
<HR>

<A NAME="intValue()"><!-- --></A><H3>
intValue</H3>
<PRE>
public int <B>intValue</B>()</PRE>
<DL>
<DD>Returns the numeric value rounded to the nearest integer.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>intValue</CODE> in interface <CODE>ParameterValue</CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The numeric value represented by this parameter after conversion to type .</DL>
</DD>
</DL>
<HR>

<A NAME="booleanValue()"><!-- --></A><H3>
booleanValue</H3>
<PRE>
public boolean <B>booleanValue</B>()</PRE>
<DL>
<DD>Returns  if the value is different from 0,  otherwise.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>booleanValue</CODE> in interface <CODE>ParameterValue</CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The boolean value represented by this parameter.</DL>
</DD>
</DL>
<HR>

<A NAME="stringValue()"><!-- --></A><H3>
stringValue</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>stringValue</B>()</PRE>
<DL>
<DD>Returns the string representation of the value.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>stringValue</CODE> in interface <CODE>ParameterValue</CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The string value represented by this parameter.</DL>
</DD>
</DL>
<HR>

<A NAME="doubleValueList(javax.units.Unit)"><!-- --></A><H3>
doubleValueList</H3>
<PRE>
public double[] <B>doubleValueList</B>(<A HREF="http://jsr-108.sourceforge.net/javadoc/javax/units/Unit.html" title="class or interface in javax.units">Unit</A>&nbsp;unit)
                         throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
<DL>
<DD>Wraps the value in an array of length 1.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>doubleValueList</CODE> in interface <CODE>ParameterValue</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>unit</CODE> - The unit of measure for the value to be returned.
<DT><B>Returns:</B><DD>The sequence of values represented by this parameter after conversion to type
          and conversion to .
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the specified unit is invalid for this parameter.</DL>
</DD>
</DL>
<HR>

<A NAME="doubleValueList()"><!-- --></A><H3>
doubleValueList</H3>
<PRE>
public double[] <B>doubleValueList</B>()</PRE>
<DL>
<DD>Wraps the value in an array of length 1.