parameters.html

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

<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#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <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#hashCode()" title="class or interface in java.lang">hashCode</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#toString()" title="class or interface in java.lang">toString</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;
<P>

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

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

<A NAME="EMPTY_GROUP"><!-- --></A><H3>
EMPTY_GROUP</H3>
<PRE>
public static ParameterDescriptorGroup <B>EMPTY_GROUP</B></PRE>
<DL>
<DD>An empty parameter group. This group contains no parameters.
<P>
<DL>
</DL>
</DL>

<!-- ========= 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="Parameters()"><!-- --></A><H3>
Parameters</H3>
<PRE>
public <B>Parameters</B>()</PRE>
<DL>
</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="isValid(org.opengis.parameter.ParameterValue)"><!-- --></A><H3>
isValid</H3>
<PRE>
public static boolean <B>isValid</B>(ParameterValue&nbsp;parameter)</PRE>
<DL>
<DD>Checks a parameter value against its parameter descriptor.
 This method takes care of handling checking arrays and collections against parameter
 descriptor.
 <br><br>
 When the value class is an array (like
 ) or a <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Collection.html" title="class or interface in java.util">collection</A> (like ),
 the descriptor
 minimum value,
 maximum value and
 valid values
 will be used to check the elements.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parameter</CODE> - The parameter to test.
<DT><B>Returns:</B><DD>true if parameter is valid.<DT><B>See Also:</B><DD><A HREF="../../../org/geotools/parameter/Parameter.html#ensureValidValue(org.opengis.parameter.ParameterDescriptor, java.lang.Object)"><CODE>Parameter.ensureValidValue(org.opengis.parameter.ParameterDescriptor, java.lang.Object)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="search(org.opengis.parameter.GeneralParameterValue, java.lang.String, int)"><!-- --></A><H3>
search</H3>
<PRE>
public static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/List.html" title="class or interface in java.util">List</A> <B>search</B>(GeneralParameterValue&nbsp;param,
                          <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name,
                          int&nbsp;maxDepth)</PRE>
<DL>
<DD>Searchs all parameters with the specified name. The given  is compared against
 parameter <CODE>name</CODE> and
 <CODE>alias</CODE>. This method search recursively
 in subgroups up to the specified depth:
 <p>
 <ul>
   <li>If  is equals to 0, then this method returns 
       if and only if it matches the specified name.</li>
   <li>If  is equals to 1 and  is an instance of
       <CODE>ParameterDescriptorGroup</CODE>, then this method checks all elements
       in this group but not in subgroups.</li>
   <li>...</li>
   <li>If  is a high number (e.g. 100), then this method checks all elements
       in all subgroups up to the specified depth, which is likely to be never reached. In
       this case,  can be seen as a safeguard against never ending loops, for
       example if parameters graph contains cyclic entries.</li>
 </ul>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>param</CODE> - The parameter to inspect.<DD><CODE>name</CODE> - The name of the parameter to search for. See the class javadoc
               for a rational about the usage of name as a key instead of
               descriptor.
<DT><B>Returns:</B><DD>The set (possibly empty) of parameters with the given name.</DL>
</DD>
</DL>
<HR>

<A NAME="copy(org.opengis.parameter.ParameterValueGroup, org.opengis.parameter.ParameterValueGroup)"><!-- --></A><H3>
copy</H3>
<PRE>
public static void <B>copy</B>(ParameterValueGroup&nbsp;source,
                        ParameterValueGroup&nbsp;target)</PRE>
<DL>
<DD>Copies all parameter values from  to . A typical usage of
 this method is for transfering values from an arbitrary implementation to some specific
 implementation (e.g. a parameter group implementation backed by a
 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/awt/image/renderable/ParameterBlock.html" title="class or interface in java.awt.image.renderable"><CODE>ParameterBlock</CODE></A> for image processing operations).
<P>
<DD><DL>
<DT><B>Since:</B></DT>
  <DD>2.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="toNameValueMap(org.opengis.parameter.GeneralParameterValue, java.util.Map)"><!-- --></A><H3>
toNameValueMap</H3>
<PRE>
public static <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A> <B>toNameValueMap</B>(GeneralParameterValue&nbsp;parameters,
                                 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&nbsp;destination)</PRE>
<DL>
<DD>Gets a flat view of
 name-value
 pairs. This method copies all parameter values into the supplied  map.
 Keys are parameter names as <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> objects, and values are parameter values as
 arbitrary objects. All subgroups (if any) are extracted recursively.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parameters</CODE> - The parameters to extract values from.<DD><CODE>destination</CODE> - The destination map, or  for a default one.
<DT><B>Returns:</B><DD>, or a new map if  was null.</DL>
</DD>
</DL>
<HR>

<A NAME="ensureSet(org.opengis.parameter.ParameterValueGroup, java.lang.String, double, javax.units.Unit, boolean)"><!-- --></A><H3>
ensureSet</H3>
<PRE>
public static boolean <B>ensureSet</B>(ParameterValueGroup&nbsp;parameters,
                                <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name,
                                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,
                                boolean&nbsp;force)</PRE>
<DL>
<DD>Ensures that the specified parameter is set. The  is set if and only if
 no value were already set by the user for the given .
 <p>
 The  argument said what to do if the named parameter is already set. If the
 value matches, nothing is done in all case. If there is a mismatch and  is
 , then the parameter is overriden with the specified . Otherwise,
 the parameter is left unchanged but a warning is logged with the <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/logging/Level.html#FINE" title="class or interface in java.util.logging"><CODE>FINE</CODE></A>
 level.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parameters</CODE> - The set of projection parameters.<DD><CODE>name</CODE> - The parameter name to set.<DD><CODE>value</CODE> - The value to set, or to expect if the parameter is already set.<DD><CODE>unit</CODE> - The value unit.<DD><CODE>force</CODE> -  for forcing the parameter to the specified 
                   is case of mismatch.
<DT><B>Returns:</B><DD> if the were a mismatch, or  if the parameters can be
         used with no change.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Parameters.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../org/geotools/parameter/ParameterGroup.html" title="class in org.geotools.parameter"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/geotools/parameter/ParameterWriter.html" title="class in org.geotools.parameter"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Parameters.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
Copyright &copy; 1996-2007 <a href="http://www.geotools.org">Geotools</a>. All Rights Reserved.
</BODY>
</HTML>