matrixparameterdescriptors.html

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

 <cite><A HREF="http://geoapi.sourceforge.net/snapshot/javadoc/org/opengis/referencing/doc-files/WKT.html">Well
 Known Text</A></cite> usages.
<P>
<DT><B>Parameters:</B><DD><CODE>properties</CODE> - Set of properties. Should contains at least <code>"name"</code>.</DL>
<HR>

<A NAME="MatrixParameterDescriptors(java.util.Map, org.opengis.parameter.ParameterDescriptor[], java.lang.String, char)"><!-- --></A><H3>
MatrixParameterDescriptors</H3>
<PRE>
public <B>MatrixParameterDescriptors</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,
                                  ParameterDescriptor[]&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;prefix,
                                  char&nbsp;separator)</PRE>
<DL>
<DD>Constructs a parameter group. The properties map is given unchanged to the
 <A HREF="../../../org/geotools/referencing/AbstractIdentifiedObject.html#AbstractIdentifiedObject(java.util.Map)">super-class constructor</A>.
 The  array should contains parameters <strong>other</strong>
 than matrix elements. The first parameter is assumed to be the number of rows, and
 the second parameter the number of columns. All extra parameters are ignored.
<P>
<DT><B>Parameters:</B><DD><CODE>properties</CODE> - Set of properties. Should contains at least <code>"name"</code>.<DD><CODE>parameters</CODE> - The <code>"num_row"</code> and <code>"num_col"</code> parameters.<DD><CODE>prefix</CODE> - The prefix to insert in front of parameter name for each matrix elements.<DD><CODE>separator</CODE> - The separator between the row and the column index in parameter names.</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="descriptor(java.lang.String)"><!-- --></A><H3>
descriptor</H3>
<PRE>
public final 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><DT><B>Overrides:</B><DD><CODE><A HREF="../../../org/geotools/parameter/DefaultParameterDescriptorGroup.html#descriptor(java.lang.String)">descriptor</A></CODE> in class <CODE><A HREF="../../../org/geotools/parameter/DefaultParameterDescriptorGroup.html" title="class in org.geotools.parameter">DefaultParameterDescriptorGroup</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 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="descriptor(int, int)"><!-- --></A><H3>
descriptor</H3>
<PRE>
public final ParameterDescriptor <B>descriptor</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 parameter in this group for a matrix element at the specified
 index. row and column indices are 0 based. Indices must be lower that the
 maximum values
 given to the <A HREF="../../../org/geotools/parameter/MatrixParameterDescriptors.html#numRow"><CODE>numRow</CODE></A> and <A HREF="../../../org/geotools/parameter/MatrixParameterDescriptors.html#numCol"><CODE>numCol</CODE></A> parameters.
<P>
<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 descriptor for the specified matrix element.
<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 final <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 in this group. The number or elements is inferred from the
 default values
 given to the <A HREF="../../../org/geotools/parameter/MatrixParameterDescriptors.html#numRow"><CODE>numRow</CODE></A> and <A HREF="../../../org/geotools/parameter/MatrixParameterDescriptors.html#numCol"><CODE>numCol</CODE></A> parameters.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>descriptors</CODE> in interface <CODE>ParameterDescriptorGroup</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../org/geotools/parameter/DefaultParameterDescriptorGroup.html#descriptors()">descriptors</A></CODE> in class <CODE><A HREF="../../../org/geotools/parameter/DefaultParameterDescriptorGroup.html" title="class in org.geotools.parameter">DefaultParameterDescriptorGroup</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>The matrix parameters, including all elements.</DL>
</DD>
</DL>
<HR>

<A NAME="createValue()"><!-- --></A><H3>
createValue</H3>
<PRE>
public GeneralParameterValue <B>createValue</B>()</PRE>
<DL>
<DD>Creates a new instance of <A HREF="../../../org/geotools/parameter/MatrixParameters.html" title="class in org.geotools.parameter">parameter values</A> with
 elements initialized to the 1 on the diagonal, and 0 everywere else. The returned
 parameter group is extensible, i.e. the number of elements will depends upon the
 value associated to the <A HREF="../../../org/geotools/parameter/MatrixParameterDescriptors.html#numRow"><CODE>numRow</CODE></A> and <A HREF="../../../org/geotools/parameter/MatrixParameterDescriptors.html#numCol"><CODE>numCol</CODE></A> parameters.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>createValue</CODE> in interface <CODE>GeneralParameterDescriptor</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../org/geotools/parameter/DefaultParameterDescriptorGroup.html#createValue()">createValue</A></CODE> in class <CODE><A HREF="../../../org/geotools/parameter/DefaultParameterDescriptorGroup.html" title="class in org.geotools.parameter">DefaultParameterDescriptorGroup</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getMatrix(org.opengis.parameter.ParameterValueGroup)"><!-- --></A><H3>
getMatrix</H3>
<PRE>
public Matrix <B>getMatrix</B>(ParameterValueGroup&nbsp;parameters)
                                                   throws InvalidParameterNameException</PRE>
<DL>
<DD>Constructs a matrix from a group of parameters.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parameters</CODE> - The group of parameters.
<DT><B>Returns:</B><DD>A matrix constructed from the specified group of parameters.
<DT><B>Throws:</B>
<DD><CODE>InvalidParameterNameException</CODE> - if a parameter name was not recognized.</DL>
</DD>
</DL>
<HR>

<A NAME="equals(org.geotools.referencing.AbstractIdentifiedObject, boolean)"><!-- --></A><H3>
equals</H3>
<PRE>
public boolean <B>equals</B>(<A HREF="../../../org/geotools/referencing/AbstractIdentifiedObject.html" title="class in org.geotools.referencing">AbstractIdentifiedObject</A>&nbsp;object,
                      boolean&nbsp;compareMetadata)</PRE>
<DL>
<DD>Compares the specified object with this parameter group for equality.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../org/geotools/parameter/DefaultParameterDescriptorGroup.html#equals(org.geotools.referencing.AbstractIdentifiedObject, boolean)">equals</A></CODE> in class <CODE><A HREF="../../../org/geotools/parameter/DefaultParameterDescriptorGroup.html" title="class in org.geotools.parameter">DefaultParameterDescriptorGroup</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>object</CODE> - The object to compare to .<DD><CODE>compareMetadata</CODE> -  for performing a strict comparaison, or
          for comparing only properties relevant to transformations.
<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/DefaultParameterDescriptorGroup.html#hashCode()">hashCode</A></CODE> in class <CODE><A HREF="../../../org/geotools/parameter/DefaultParameterDescriptorGroup.html" title="class in org.geotools.parameter">DefaultParameterDescriptorGroup</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>
<!-- ========= 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/MatrixParameterDescriptors.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/ImagingParameters.html" title="class in org.geotools.parameter"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/geotools/parameter/MatrixParameters.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="MatrixParameterDescriptors.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>