parametergroup.html

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

<A NAME="EMPTY"><!-- --></A><H3>
EMPTY</H3>
<PRE>
public static ParameterValueGroup <B>EMPTY</B></PRE>
<DL>
<DD>An empty parameter value group. This group contains no parameter value.
<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="ParameterGroup(org.opengis.parameter.ParameterDescriptorGroup)"><!-- --></A><H3>
ParameterGroup</H3>
<PRE>
public <B>ParameterGroup</B>(ParameterDescriptorGroup&nbsp;descriptor)</PRE>
<DL>
<DD>Constructs a parameter group from the specified descriptor.
 All <A HREF="../../../org/geotools/parameter/ParameterGroup.html#values()">parameter values</A> will be initialized
 to their default value.
<P>
<DT><B>Parameters:</B><DD><CODE>descriptor</CODE> - The descriptor for this group.</DL>
<HR>

<A NAME="ParameterGroup(org.opengis.parameter.ParameterDescriptorGroup, org.opengis.parameter.GeneralParameterValue[])"><!-- --></A><H3>
ParameterGroup</H3>
<PRE>
public <B>ParameterGroup</B>(ParameterDescriptorGroup&nbsp;descriptor,
                      GeneralParameterValue[]&nbsp;values)</PRE>
<DL>
<DD>Constructs a parameter group from the specified descriptor and list of parameters.
<P>
<DT><B>Parameters:</B><DD><CODE>descriptor</CODE> - The descriptor for this group.<DD><CODE>values</CODE> - The list of parameter values.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the number of parameter
         occurences doesn't matches the number declared in the
         descriptor.</DL>
<HR>

<A NAME="ParameterGroup(java.util.Map, org.opengis.parameter.GeneralParameterValue[])"><!-- --></A><H3>
ParameterGroup</H3>
<PRE>
public <B>ParameterGroup</B>(<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;properties,
                      GeneralParameterValue[]&nbsp;values)</PRE>
<DL>
<DD>Constructs a parameter group from the specified list of parameters.
<P>
<DT><B>Parameters:</B><DD><CODE>properties</CODE> - The properties for the
        <A HREF="../../../org/geotools/parameter/DefaultParameterDescriptorGroup.html" title="class in org.geotools.parameter">operation parameter group</A>
        to construct from the list of parameters.<DD><CODE>values</CODE> - The list of parameter values.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the number of parameter
         occurences doesn't matches the number declared in the
         descriptor.</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="values()"><!-- --></A><H3>
values</H3>
<PRE>
public <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>values</B>()</PRE>
<DL>
<DD>Returns the values in this group. Changes in this list are reflected on this
 . The returned list supports the
 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/List.html#add(java.lang.Object)" title="class or interface in java.util"><CODE>add</CODE></A> operation.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>values</CODE> in interface <CODE>ParameterValueGroup</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="parameter(java.lang.String)"><!-- --></A><H3>
parameter</H3>
<PRE>
public ParameterValue <B>parameter</B>(<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)
                                               throws ParameterNotFoundException</PRE>
<DL>
<DD>Returns the value in this group for the specified
 identifier code.
 If no parameter value is found but
 a parameter descriptor is found
 (which may occurs if the parameter is optional, i.e.
 <code>minimumOccurs == 0</code>),
 then a parameter value is
 automatically created and initialized to its
 default value (if any).

 <P>This convenience method provides a way to get and set parameter values by name. For
 example the following idiom fetches a floating point value for the
 <code>"false_easting"</code> parameter:</P>

 <blockquote><code>
 double value =
 parameter("false_easting").doubleValue();
 </code></blockquote>

 <P>This method do not search recursively in subgroups. This is because more than one
 subgroup may exist for the same descriptor. The
 user must <A HREF="../../../org/geotools/parameter/ParameterGroup.html#groups(java.lang.String)">query all subgroups</A> and select explicitly
 the appropriate one to use.</P>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>parameter</CODE> in interface <CODE>ParameterValueGroup</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The case insensitive identifier code of the
              parameter to search for.
<DT><B>Returns:</B><DD>The parameter value for the given identifier code.
<DT><B>Throws:</B>
<DD><CODE>ParameterNotFoundException</CODE> - if there is no parameter value for the given identifier
         code.</DL>
</DD>
</DL>
<HR>

<A NAME="groups(java.lang.String)"><!-- --></A><H3>
groups</H3>
<PRE>
public <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>groups</B>(<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)
            throws ParameterNotFoundException</PRE>
<DL>
<DD>Returns all subgroups with the specified name. This method do not create new groups.
 If the requested group is optional (i.e.
 <code>minimumOccurs == 0</code>)
 and no value were set, then this method returns an empty set.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>groups</CODE> in interface <CODE>ParameterValueGroup</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The case insensitive identifier code
         of the parameter group to search for.
<DT><B>Returns:</B><DD>The set of all parameter group for the given identifier code.
<DT><B>Throws:</B>
<DD><CODE>ParameterNotFoundException</CODE> - if no descriptor
         was found for the given name.</DL>
</DD>
</DL>
<HR>

<A NAME="addGroup(java.lang.String)"><!-- --></A><H3>
addGroup</H3>
<PRE>
public ParameterValueGroup <B>addGroup</B>(<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)
                                                   throws ParameterNotFoundException,
                                                          InvalidParameterCardinalityException</PRE>
<DL>
<DD>Creates a new group of the specified name. The specified name must be the
 identifier code of a descriptor group.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>addGroup</CODE> in interface <CODE>ParameterValueGroup</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The case insensitive identifier code of the
              parameter group to create.
<DT><B>Returns:</B><DD>A newly created parameter group for the given identifier code.
<DT><B>Throws:</B>
<DD><CODE>ParameterNotFoundException</CODE> - if no descriptor
         was found for the given name.
<DD><CODE>InvalidParameterCardinalityException</CODE> - if this parameter group already contains the
         maximum number of occurences
         of subgroups of the given name.</DL>
</DD>
</DL>
<HR>

<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
public boolean <B>equals</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;object)</PRE>
<DL>
<DD>Compares the specified object with this parameter for equality.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../org/geotools/parameter/AbstractParameter.html#equals(java.lang.Object)">equals</A></CODE> in class <CODE><A HREF="../../../org/geotools/parameter/AbstractParameter.html" title="class in org.geotools.parameter">AbstractParameter</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>object</CODE> - The object to compare to .
<DT><B>Returns:</B><DD> if both objects are equal.</DL>
</DD>
</DL>
<HR>

<A NAME="hashCode()"><!-- --></A><H3>
hashCode</H3>
<PRE>
public int <B>hashCode</B>()</PRE>
<DL>
<DD>Returns a hash value for this parameter.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../org/geotools/parameter/AbstractParameter.html#hashCode()">hashCode</A></CODE> in class <CODE><A HREF="../../../org/geotools/parameter/AbstractParameter.html" title="class in org.geotools.parameter">AbstractParameter</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The hash code value. This value doesn't need to be the same
         in past or future versions of this class.</DL>
</DD>
</DL>
<HR>

<A NAME="clone()"><!-- --></A><H3>
clone</H3>
<PRE>
public <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>clone</B>()</PRE>
<DL>
<DD>Returns a deep copy of this group of parameter values.
 Included parameter values and subgroups are cloned recursively.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>clone</CODE> in interface <CODE>ParameterValueGroup</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../org/geotools/parameter/AbstractParameter.html#clone()">clone</A></CODE> in class <CODE><A HREF="../../../org/geotools/parameter/AbstractParameter.html" title="class in org.geotools.parameter">AbstractParameter</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>A copy of this group of parameter values.</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/ParameterGroup.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/Parameter.html" title="class in org.geotools.parameter"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/geotools/parameter/Parameters.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="ParameterGroup.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>