matrixparameters.html

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

descriptor</H3>
<PRE>
public GeneralParameterDescriptor <B>descriptor</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 parameter in this group for the specified name. The name can be a matrix element
 if it uses the following syntax: <code>"elt_<var>row</var>_<var>col</var>"</code> where
 <code>"elt_"</code> is the <A HREF="../../../org/geotools/parameter/MatrixParameterDescriptors.html#prefix">prefix</A> for all
 matrix elements, and <var>row</var> and <var>col</var> are row and column indices
 respectively. For example <code>"elt_2_1"</code> is the element name for the value at line 2
 and row 1. The row and column index are 0 based.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>descriptor</CODE> in interface <CODE>ParameterDescriptorGroup</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The case insensitive name of the parameter to search for.
<DT><B>Returns:</B><DD>The parameter for the given name.
<DT><B>Throws:</B>
<DD><CODE>ParameterNotFoundException</CODE> - if there is no parameter for the given name.</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 name. The name can be a matrix element
 if it uses the following syntax: <code>"elt_<var>row</var>_<var>col</var>"</code> where
 <code>"elt_"</code> is the <A HREF="../../../org/geotools/parameter/MatrixParameterDescriptors.html#prefix">prefix</A> for all
 matrix elements, and <var>row</var> and <var>col</var> are row and column indices
 respectively. For example <code>"elt_2_1"</code> is the element name for the value at line
 2 and row 1. The row and column index are 0 based.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>parameter</CODE> in interface <CODE>ParameterValueGroup</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../org/geotools/parameter/ParameterGroup.html#parameter(java.lang.String)">parameter</A></CODE> in class <CODE><A HREF="../../../org/geotools/parameter/ParameterGroup.html" title="class in org.geotools.parameter">ParameterGroup</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The case insensitive name of the parameter to search for.
<DT><B>Returns:</B><DD>The parameter value for the given name.
<DT><B>Throws:</B>
<DD><CODE>ParameterNotFoundException</CODE> - if there is no parameter for the given name.</DL>
</DD>
</DL>
<HR>

<A NAME="parameter(int, int)"><!-- --></A><H3>
parameter</H3>
<PRE>
public final ParameterValue <B>parameter</B>(int&nbsp;row,
                                      int&nbsp;column)
                                                     throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang">IndexOutOfBoundsException</A></PRE>
<DL>
<DD>Returns the value in this group for a matrix element at the specified index.
 Row and column index are 0 based.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>row</CODE> - The row indice.<DD><CODE>column</CODE> - The column indice
<DT><B>Returns:</B><DD>The parameter value for the specified matrix element (never ).
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IndexOutOfBoundsException.html" title="class or interface in java.lang">IndexOutOfBoundsException</A></CODE> - if  or  is out of bounds.</DL>
</DD>
</DL>
<HR>

<A NAME="descriptors()"><!-- --></A><H3>
descriptors</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>descriptors</B>()</PRE>
<DL>
<DD>Returns the parameters descriptors in this group. The amount of parameters depends
 on the value of <code>"num_row"</code> and <code>"num_col"</code> parameters.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>descriptors</CODE> in interface <CODE>ParameterDescriptorGroup</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<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 parameters values in this group. The amount of parameters depends
 on the value of <code>"num_row"</code> and <code>"num_col"</code> parameters.
 The parameter array will contains only matrix elements which have been requested at
 least once by one of  methods. Never requested elements
 are left to their default value and omitted from the returned array.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>values</CODE> in interface <CODE>ParameterValueGroup</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../org/geotools/parameter/ParameterGroup.html#values()">values</A></CODE> in class <CODE><A HREF="../../../org/geotools/parameter/ParameterGroup.html" title="class in org.geotools.parameter">ParameterGroup</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="createValue()"><!-- --></A><H3>
createValue</H3>
<PRE>
public GeneralParameterValue <B>createValue</B>()</PRE>
<DL>
<DD>Forward the call to the <A HREF="../../../org/geotools/parameter/MatrixParameterDescriptors.html" title="class in org.geotools.parameter">matrix parameter descriptors</A>
 specified at construction time.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>createValue</CODE> in interface <CODE>GeneralParameterDescriptor</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getMatrix()"><!-- --></A><H3>
getMatrix</H3>
<PRE>
public Matrix <B>getMatrix</B>()</PRE>
<DL>
<DD>Create a matrix from this group of parameters.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>A matrix created from this group of parameters.</DL>
</DD>
</DL>
<HR>

<A NAME="setMatrix(org.opengis.referencing.operation.Matrix)"><!-- --></A><H3>
setMatrix</H3>
<PRE>
public void <B>setMatrix</B>(Matrix&nbsp;matrix)</PRE>
<DL>
<DD>Set all parameter values to the element value in the specified matrix.
 After this method call, <A HREF="../../../org/geotools/parameter/MatrixParameters.html#values()"><CODE>values()</CODE></A> will returns only the elements
 different from the default value.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>matrix</CODE> - The matrix to copy in this group of parameters.</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>Compare this object with the specified one for equality.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../org/geotools/parameter/ParameterGroup.html#equals(java.lang.Object)">equals</A></CODE> in class <CODE><A HREF="../../../org/geotools/parameter/ParameterGroup.html" title="class in org.geotools.parameter">ParameterGroup</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="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 clone of this parameter group.
<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/ParameterGroup.html#clone()">clone</A></CODE> in class <CODE><A HREF="../../../org/geotools/parameter/ParameterGroup.html" title="class in org.geotools.parameter">ParameterGroup</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>A copy of this group of parameter values.</DL>
</DD>
</DL>
<HR>

<A NAME="write(org.geotools.io.TableWriter)"><!-- --></A><H3>
write</H3>
<PRE>
protected void <B>write</B>(<A HREF="../../../org/geotools/io/TableWriter.html" title="class in org.geotools.io">TableWriter</A>&nbsp;table)
              throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Write the content of this parameter to the specified table.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../org/geotools/parameter/AbstractParameter.html#write(org.geotools.io.TableWriter)">write</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>table</CODE> - The table where to format the parameter value.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE> - if an error occurs during output operation.</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/MatrixParameters.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/MatrixParameterDescriptors.html" title="class in org.geotools.parameter"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/geotools/parameter/Parameter.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="MatrixParameters.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="#fields_inherited_from_class_ParameterGroup">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;FIELD&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>