parameter.html

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

<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="ensureValidValue(org.opengis.parameter.ParameterDescriptor, java.lang.Object)"><!-- --></A><H3>
ensureValidValue</H3>
<PRE>
public static void <B>ensureValidValue</B>(ParameterDescriptor&nbsp;descriptor,
                                    <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)
                             throws InvalidParameterValueException</PRE>
<DL>
<DD>Ensures that the given value is valid according the specified parameter descriptor.
 This convenience method ensures that  is assignable to the
 expected class, is between the
 minimum and
 maximum values and is one of the
 set of valid values.
 If the value fails any of those tests, then an exception is thrown.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>descriptor</CODE> - The parameter descriptor to check against.<DD><CODE>value</CODE> - The value to check, or .
<DT><B>Throws:</B>
<DD><CODE>InvalidParameterValueException</CODE> - if the parameter value is invalid.</DL>
</DD>
</DL>
<HR>

<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/Parameter.html#doubleValue()">parameter value</A>.
 If the parameter value has no unit (for example because it is a <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang"><CODE>String</CODE></A> type),
 then this method returns . Note that "no unit" doesn't means
 "dimensionless".
<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.<DT><B>See Also:</B><DD><A HREF="../../../org/geotools/parameter/Parameter.html#doubleValue()"><CODE>doubleValue()</CODE></A>, 
<A HREF="../../../org/geotools/parameter/Parameter.html#doubleValueList()"><CODE>doubleValueList()</CODE></A>, 
<A HREF="../../../org/geotools/parameter/Parameter.html#getValue()"><CODE>getValue()</CODE></A></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 InvalidParameterTypeException</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>InvalidParameterTypeException</CODE> - if the value is not a numeric type.
<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.<DT><B>See Also:</B><DD><A HREF="../../../org/geotools/parameter/Parameter.html#getUnit()"><CODE>getUnit()</CODE></A>, 
<A HREF="../../../org/geotools/parameter/Parameter.html#setValue(double, javax.units.Unit)"><CODE>setValue(double,Unit)</CODE></A>, 
<A HREF="../../../org/geotools/parameter/Parameter.html#doubleValueList(javax.units.Unit)"><CODE>doubleValueList(Unit)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="doubleValue()"><!-- --></A><H3>
doubleValue</H3>
<PRE>
public double <B>doubleValue</B>()
                   throws InvalidParameterTypeException</PRE>
<DL>
<DD>Returns the numeric value of the coordinate operation parameter with its
 associated <A HREF="../../../org/geotools/parameter/Parameter.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 .
<DT><B>Throws:</B>
<DD><CODE>InvalidParameterTypeException</CODE> - if the value is not a numeric type.<DT><B>See Also:</B><DD><A HREF="../../../org/geotools/parameter/Parameter.html#getUnit()"><CODE>getUnit()</CODE></A>, 
<A HREF="../../../org/geotools/parameter/Parameter.html#setValue(double)"><CODE>setValue(double)</CODE></A>, 
<A HREF="../../../org/geotools/parameter/Parameter.html#doubleValueList()"><CODE>doubleValueList()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="intValue()"><!-- --></A><H3>
intValue</H3>
<PRE>
public int <B>intValue</B>()
             throws InvalidParameterTypeException</PRE>
<DL>
<DD>Returns the positive integer value of an operation parameter, usually used
 for a count. An integer value does not have an associated unit of measure.
<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 .
<DT><B>Throws:</B>
<DD><CODE>InvalidParameterTypeException</CODE> - if the value is not an integer type.<DT><B>See Also:</B><DD><A HREF="../../../org/geotools/parameter/Parameter.html#setValue(int)"><CODE>setValue(int)</CODE></A>, 
<A HREF="../../../org/geotools/parameter/Parameter.html#intValueList()"><CODE>intValueList()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="booleanValue()"><!-- --></A><H3>
booleanValue</H3>
<PRE>
public boolean <B>booleanValue</B>()
                     throws InvalidParameterTypeException</PRE>
<DL>
<DD>Returns the boolean value of an operation parameter.
 A boolean value does not have an associated unit of measure.
<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.
<DT><B>Throws:</B>
<DD><CODE>InvalidParameterTypeException</CODE> - if the value is not a boolean type.<DT><B>See Also:</B><DD><A HREF="../../../org/geotools/parameter/Parameter.html#setValue(boolean)"><CODE>setValue(boolean)</CODE></A></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>()
                   throws InvalidParameterTypeException</PRE>
<DL>
<DD>Returns the string value of an operation parameter.
 A string value does not have an associated unit of measure.
<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.
<DT><B>Throws:</B>
<DD><CODE>InvalidParameterTypeException</CODE> - if the value is not a string.<DT><B>See Also:</B><DD><A HREF="../../../org/geotools/parameter/Parameter.html#getValue()"><CODE>getValue()</CODE></A>, 
<A HREF="../../../org/geotools/parameter/Parameter.html#setValue(java.lang.Object)"><CODE>setValue(Object)</CODE></A></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 InvalidParameterTypeException</PRE>
<DL>
<DD>Returns an ordered sequence of numeric values 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>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>InvalidParameterTypeException</CODE> - if the value is not an array of s.
<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.<DT><B>See Also:</B><DD><A HREF="../../../org/geotools/parameter/Parameter.html#getUnit()"><CODE>getUnit()</CODE></A>, 
<A HREF="../../../org/geotools/parameter/Parameter.html#setValue(double[], javax.units.Unit)"><CODE>setValue(double[],Unit)</CODE></A>, 
<A HREF="../../../org/geotools/parameter/Parameter.html#doubleValue(javax.units.Unit)"><CODE>doubleValue(Unit)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="doubleValueList()"><!-- --></A><H3>
doubleValueList</H3>
<PRE>
public double[] <B>doubleValueList</B>()
                         throws InvalidParameterTypeException</PRE>
<DL>
<DD>Returns an ordered sequence of two or more numeric values of an operation parameter
 list, where each value has the same associated <A HREF="http://jsr-108.sourceforge.net/javadoc/javax/units/Unit.html" title="class or interface in javax.units">unit of measure</A>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>doubleValueList</CODE> in interface <CODE>ParameterValue</CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The sequence of values represented by this parameter.
<DT><B>Throws:</B>
<DD><CODE>InvalidParameterTypeException</CODE> - if the value is not an array of s.<DT><B>See Also:</B><DD><A HREF="../../../org/geotools/parameter/Parameter.html#getUnit()"><CODE>getUnit()</CODE></A>, 
<A HREF="../../../org/geotools/parameter/Parameter.html#setValue(java.lang.Object)"><CODE>setValue(Object)</CODE></A>, 
<A HREF="../../../org/geotools/parameter/Parameter.html#doubleValue()"><CODE>doubleValue()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="intValueList()"><!-- --></A><H3>
intValueList</H3>
<PRE>
public int[] <B>intValueList</B>()
                   throws InvalidParameterTypeException</PRE>
<DL>
<DD>Returns an ordered sequence of two or more integer values of an operation parameter list,
 usually used for counts. These integer values do not have an associated unit of measure.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>intValueList</CODE> in interface <CODE>ParameterValue</CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The sequence of values represented by this parameter.
<DT><B>Throws:</B>
<DD><CODE>InvalidParameterTypeException</CODE> - if the value is not an array of s.<DT><B>See Also:</B><DD><A HREF="../../../org/geotools/parameter/Parameter.html#setValue(java.lang.Object)"><CODE>setValue(Object)</CODE></A>, 
<A HREF="../../../org/geotools/parameter/Parameter.html#intValue()"><CODE>intValue()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="valueFile()"><!-- --></A><H3>
valueFile</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/net/URI.html" title="class or interface in java.net">URI</A> <B>valueFile</B>()
              throws InvalidParameterTypeException</PRE>
<DL>
<DD>Returns a reference to a file or a part of a file containing one or more parameter
 values. When referencing a part of a file, that file must contain multiple identified
 parts, such as an XML encoded document. Furthermore, the referenced file or part of a
 file can reference another part of the same or different files, as allowed in XML documents.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>valueFile</CODE> in interface <CODE>ParameterValue</CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The reference to a file containing parameter values.