defaultparameterdescriptor.html

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

<!-- ========= 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="DefaultParameterDescriptor(org.opengis.parameter.ParameterDescriptor)"><!-- --></A><H3>
DefaultParameterDescriptor</H3>
<PRE>
public <B>DefaultParameterDescriptor</B>(ParameterDescriptor&nbsp;descriptor)</PRE>
<DL>
<DD>Constructs a descriptor with the same values than the specified one. This copy constructor
 may be used in order to wraps an arbitrary implementation into a Geotools one.
<P>
<DT><B>Since:</B></DT>
  <DD>2.2</DD>
</DL>
<HR>

<A NAME="DefaultParameterDescriptor(java.lang.String, int, int, int)"><!-- --></A><H3>
DefaultParameterDescriptor</H3>
<PRE>
public <B>DefaultParameterDescriptor</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,
                                  int&nbsp;defaultValue,
                                  int&nbsp;minimum,
                                  int&nbsp;maximum)</PRE>
<DL>
<DD>Constructs a mandatory parameter for a range of integer values.
<P>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The parameter name.<DD><CODE>defaultValue</CODE> - The default value for the parameter.<DD><CODE>minimum</CODE> - The minimum parameter value, or <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Integer.html#MIN_VALUE" title="class or interface in java.lang"><CODE>Integer.MIN_VALUE</CODE></A> if none.<DD><CODE>maximum</CODE> - The maximum parameter value, or <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Integer.html#MAX_VALUE" title="class or interface in java.lang"><CODE>Integer.MAX_VALUE</CODE></A> if none.</DL>
<HR>

<A NAME="DefaultParameterDescriptor(java.util.Map, int, int, int, boolean)"><!-- --></A><H3>
DefaultParameterDescriptor</H3>
<PRE>
public <B>DefaultParameterDescriptor</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,
                                  int&nbsp;defaultValue,
                                  int&nbsp;minimum,
                                  int&nbsp;maximum,
                                  boolean&nbsp;required)</PRE>
<DL>
<DD>Constructs a parameter for a range of integer values.
<P>
<DT><B>Parameters:</B><DD><CODE>properties</CODE> - The parameter properties (name, identifiers, alias...).<DD><CODE>defaultValue</CODE> - The default value for the parameter.<DD><CODE>minimum</CODE> - The minimum parameter value, or <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Integer.html#MIN_VALUE" title="class or interface in java.lang"><CODE>Integer.MIN_VALUE</CODE></A> if none.<DD><CODE>maximum</CODE> - The maximum parameter value, or <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Integer.html#MAX_VALUE" title="class or interface in java.lang"><CODE>Integer.MAX_VALUE</CODE></A> if none.<DD><CODE>required</CODE> -  if this parameter is required,  otherwise.</DL>
<HR>

<A NAME="DefaultParameterDescriptor(java.lang.String, double, double, double, javax.units.Unit)"><!-- --></A><H3>
DefaultParameterDescriptor</H3>
<PRE>
public <B>DefaultParameterDescriptor</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,
                                  double&nbsp;defaultValue,
                                  double&nbsp;minimum,
                                  double&nbsp;maximum,
                                  <A HREF="http://jsr-108.sourceforge.net/javadoc/javax/units/Unit.html" title="class or interface in javax.units">Unit</A>&nbsp;unit)</PRE>
<DL>
<DD>Constructs a mandatory parameter for a range of floating point values.
<P>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The parameter name.<DD><CODE>defaultValue</CODE> - The default value for the parameter, or <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Double.html#NaN" title="class or interface in java.lang"><CODE>Double.NaN</CODE></A> if none.<DD><CODE>minimum</CODE> - The minimum parameter value, or <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Double.html#NEGATIVE_INFINITY" title="class or interface in java.lang"><CODE>Double.NEGATIVE_INFINITY</CODE></A> if none.<DD><CODE>maximum</CODE> - The maximum parameter value, or <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Double.html#POSITIVE_INFINITY" title="class or interface in java.lang"><CODE>Double.POSITIVE_INFINITY</CODE></A> if none.<DD><CODE>unit</CODE> - The unit for default, minimum and maximum values.</DL>
<HR>

<A NAME="DefaultParameterDescriptor(java.util.Map, double, double, double, javax.units.Unit, boolean)"><!-- --></A><H3>
DefaultParameterDescriptor</H3>
<PRE>
public <B>DefaultParameterDescriptor</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,
                                  double&nbsp;defaultValue,
                                  double&nbsp;minimum,
                                  double&nbsp;maximum,
                                  <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;required)</PRE>
<DL>
<DD>Constructs a parameter for a range of floating point values.
<P>
<DT><B>Parameters:</B><DD><CODE>properties</CODE> - The parameter properties (name, identifiers, alias...).<DD><CODE>defaultValue</CODE> - The default value for the parameter, or <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Double.html#NaN" title="class or interface in java.lang"><CODE>Double.NaN</CODE></A> if none.<DD><CODE>minimum</CODE> - The minimum parameter value, or <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Double.html#NEGATIVE_INFINITY" title="class or interface in java.lang"><CODE>Double.NEGATIVE_INFINITY</CODE></A> if none.<DD><CODE>maximum</CODE> - The maximum parameter value, or <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Double.html#POSITIVE_INFINITY" title="class or interface in java.lang"><CODE>Double.POSITIVE_INFINITY</CODE></A> if none.<DD><CODE>unit</CODE> - The unit for default, minimum and maximum values.<DD><CODE>required</CODE> -  if this parameter is required,  otherwise.</DL>
<HR>

<A NAME="DefaultParameterDescriptor(java.lang.String, java.lang.CharSequence, java.lang.Object, boolean)"><!-- --></A><H3>
DefaultParameterDescriptor</H3>
<PRE>
public <B>DefaultParameterDescriptor</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,
                                  <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/CharSequence.html" title="class or interface in java.lang">CharSequence</A>&nbsp;remarks,
                                  <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;defaultValue,
                                  boolean&nbsp;required)</PRE>
<DL>
<DD>Constructs a parameter for a name and a default value. The parameter type will
 be assumed the same than the default value class.
<P>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The parameter name.<DD><CODE>remarks</CODE> - An optional description as 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> or an
                     <CODE>InternationalString</CODE>, or  if none.<DD><CODE>defaultValue</CODE> - The default value.<DD><CODE>required</CODE> -  if this parameter is required,  otherwise.</DL>
<HR>

<A NAME="DefaultParameterDescriptor(java.lang.String, org.opengis.util.CodeList)"><!-- --></A><H3>
DefaultParameterDescriptor</H3>
<PRE>
public <B>DefaultParameterDescriptor</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,
                                  CodeList&nbsp;defaultValue)</PRE>
<DL>
<DD>Constructs a parameter for a code list (or enumeration).
<P>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The parameter name.<DD><CODE>defaultValue</CODE> - The default value.</DL>
<HR>

<A NAME="DefaultParameterDescriptor(java.lang.String, java.lang.Class, java.lang.Object[], java.lang.Object)"><!-- --></A><H3>
DefaultParameterDescriptor</H3>
<PRE>
public <B>DefaultParameterDescriptor</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,
                                  <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A>&nbsp;valueClass,
                                  <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;validValues,
                                  <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;defaultValue)</PRE>
<DL>
<DD>Constructs a mandatory parameter for a set of predefined values.
<P>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - The parameter name.<DD><CODE>valueClass</CODE> - The class that describe the type of the parameter.<DD><CODE>validValues</CODE> - A finite set of valid values (usually from a
        {linkplain org.opengis.util.CodeList code list}) or 
        if it doesn't apply.<DD><CODE>defaultValue</CODE> - The default value for the parameter, or .</DL>
<HR>

<A NAME="DefaultParameterDescriptor(org.opengis.metadata.citation.Citation, java.lang.String, java.lang.Class, java.lang.Object[], java.lang.Object, java.lang.Comparable, java.lang.Comparable, javax.units.Unit, boolean)"><!-- --></A><H3>
DefaultParameterDescriptor</H3>
<PRE>
public <B>DefaultParameterDescriptor</B>(Citation&nbsp;authority,
                                  <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,
                                  <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A>&nbsp;valueClass,
                                  <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;validValues,
                                  <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;defaultValue,
                                  <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Comparable.html" title="class or interface in java.lang">Comparable</A>&nbsp;minimum,
                                  <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Comparable.html" title="class or interface in java.lang">Comparable</A>&nbsp;maximum,
                                  <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;required)</PRE>
<DL>
<DD>Constructs a parameter from an authority and a name.
<P>
<DT><B>Parameters:</B><DD><CODE>authority</CODE> - The authority (e.g.
        <A HREF="../../../org/geotools/metadata/iso/citation/Citations.html#OGC"><CODE>OGC</CODE></A>).<DD><CODE>name</CODE> - The parameter name.<DD><CODE>valueClass</CODE> - The class that describe the type of the parameter.<DD><CODE>validValues</CODE> - A finite set of valid values (usually from a
        {linkplain org.opengis.util.CodeList code list}) or 
        if it doesn't apply.<DD><CODE>defaultValue</CODE> - The default value for the parameter, or .<DD><CODE>minimum</CODE> - The minimum parameter value, or .<DD><CODE>maximum</CODE> - The maximum parameter value, or .<DD><CODE>unit</CODE> - The unit for default, minimum and maximum values.<DD><CODE>required</CODE> -  if this parameter is required,
                 or  if it is optional.<DT><B>Since:</B></DT>
  <DD>2.2</DD>
</DL>
<HR>

<A NAME="DefaultParameterDescriptor(java.util.Map, java.lang.Class, java.lang.Object[], java.lang.Object, java.lang.Comparable, java.lang.Comparable, javax.units.Unit, boolean)"><!-- --></A><H3>
DefaultParameterDescriptor</H3>
<PRE>
public <B>DefaultParameterDescriptor</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,
                                  <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A>&nbsp;valueClass,
                                  <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;validValues,
                                  <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;defaultValue,
                                  <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Comparable.html" title="class or interface in java.lang">Comparable</A>&nbsp;minimum,
                                  <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Comparable.html" title="class or interface in java.lang">Comparable</A>&nbsp;maximum,
                                  <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;required)</PRE>
<DL>
<DD>Constructs a parameter from a set of properties. The properties map is
 given unchanged to the <A HREF="../../../org/geotools/referencing/AbstractIdentifiedObject.html#AbstractIdentifiedObject(java.util.Map)">super-class constructor</A>.
<P>
<DT><B>Parameters:</B><DD><CODE>properties</CODE> - Set of properties. Should contains at least <code>"name"</code>.<DD><CODE>valueClass</CODE> - The class that describe the type of the parameter.<DD><CODE>validValues</CODE> - A finite set of valid values (usually from a
        {linkplain org.opengis.util.CodeList code list}) or 
        if it doesn't apply.<DD><CODE>defaultValue</CODE> - The default value for the parameter, or .<DD><CODE>minimum</CODE> - The minimum parameter value, or .<DD><CODE>maximum</CODE> - The maximum parameter value, or .<DD><CODE>unit</CODE> - The unit for default, minimum and maximum values.<DD><CODE>required</CODE> -  if this parameter is required,
                 or  if it is optional.</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="getMaximumOccurs()"><!-- --></A><H3>
getMaximumOccurs</H3>
<PRE>
public int <B>getMaximumOccurs</B>()</PRE>
<DL>
<DD>The maximum number of times that values for this parameter group or
 parameter can be included. For a <A HREF="../../../org/geotools/parameter/DefaultParameterDescriptor.html" title="class in org.geotools.parameter">single parameter</A>, the value is always 1.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getMaximumOccurs</CODE> in interface <CODE>GeneralParameterDescriptor</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/geotools/parameter/AbstractParameterDescriptor.html#getMaximumOccurs()">getMaximumOccurs</A></CODE> in class <CODE><A HREF="../../../org/geotools/parameter/AbstractParameterDescriptor.html" title="class in org.geotools.parameter">AbstractParameterDescriptor</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../org/geotools/parameter/AbstractParameterDescriptor.html#getMinimumOccurs()"><CODE>AbstractParameterDescriptor.getMinimumOccurs()</CODE></A></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/Parameter.html" title="class in org.geotools.parameter">parameter value</A>
 initialized with the <A HREF="../../../org/geotools/parameter/DefaultParameterDescriptor.html#getDefaultValue()">default value</A>.
 The <A HREF="../../../org/geotools/parameter/AbstractParameter.html#getDescriptor()">parameter value
 descriptor</A> for the created parameter value will be  object.
 <P>
 If the <A HREF="../../../org/geotools/parameter/DefaultParameterDescriptor.html#getValueClass()">value class</A> specified at construction time was
 a primitive type (e.g. <code>Double.<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Double.html#TYPE" title="class or interface in java.lang">TYPE</A></code> instead
 of <code><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Double.html" title="class or interface in java.lang">Double</A>.class</code>), then this method may returns a specialized
 parameter value implementation for this primitive type. Specialized implementations may
 use less storage space and be more flexible during conversions (for example from
  to <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>), but this flexibility is not always wanted.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>createValue</CODE> in interface <CODE>GeneralParameterDescriptor</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/geotools/parameter/AbstractParameterDescriptor.html#createValue()">createValue</A></CODE> in class <CODE><A HREF="../../../org/geotools/parameter/AbstractParameterDescriptor.html" title="class in org.geotools.parameter">AbstractParameterDescriptor</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getValueClass()"><!-- --></A><H3>
getValueClass</H3>