Java Doc for FloatParameter.java in  » GIS » GeoTools-2.4.1 » org » geotools » parameter » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » GIS » GeoTools 2.4.1 » org.geotools.parameter 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.geotools.parameter.AbstractParameter
   org.geotools.parameter.FloatParameter

FloatParameter
public class FloatParameter extends AbstractParameter implements ParameterValue(Code)
A parameter value as a floating point (double precision) number. This class provides the same functionalities than Parameter , except that:
  • Values are always floating point numbers of type double .
  • Units are the same than the .
When those conditions are meet, ParameterRealValue is slightly more efficient than ParameterValue since it avoid the creation of Double objects.
since:
   2.1
version:
   $Id: FloatParameter.java 20874 2006-08-07 10:00:01Z jgarnett $
author:
   Martin Desruisseaux
See Also:   DefaultParameterDescriptor
See Also:   ParameterGroup



Constructor Summary
public  FloatParameter(ParameterDescriptor descriptor)
     Constructs a parameter from the specified descriptor.
public  FloatParameter(ParameterDescriptor descriptor, double value)
     Constructs a parameter from the specified descriptor and value.

Method Summary
public  booleanbooleanValue()
     Returns true if the value is different from 0, false otherwise.
public  doubledoubleValue(Unit unit)
     Returns the numeric value of the coordinate operation parameter in the specified unit of measure.
public  doubledoubleValue()
     Returns the numeric value of the coordinate operation parameter with its associated .
public  double[]doubleValueList(Unit unit)
     Wraps the value in an array of length 1.
Parameters:
  unit - The unit of measure for the value to be returned.
public  double[]doubleValueList()
     Wraps the value in an array of length 1.
public  booleanequals(Object object)
     Compares the specified object with this parameter for equality.
Parameters:
  object - The object to compare to this .
public  UnitgetUnit()
     Returns the unit of measure of the .
public  ObjectgetValue()
    
public  inthashCode()
     Returns a hash value for this parameter. The hash code value.
public  intintValue()
     Returns the numeric value rounded to the nearest integer.
public  int[]intValueList()
     Wraps the value in an array of length 1.
public  voidsetValue(double value, Unit unit)
     Set the parameter value as a floating point and its associated unit.
public  voidsetValue(double value)
     Set the parameter value as a floating point.
public  voidsetValue(int value)
     Set the parameter value as an integer.
public  voidsetValue(boolean value)
     Set the parameter value as a boolean.
public  voidsetValue(Object value)
     Set the parameter value as a Double object.
public  voidsetValue(double[] values, Unit unit)
     Always throws an exception, since this parameter is not an array.
public  StringstringValue()
     Returns the string representation of the value.
public  URIvalueFile()
     Always throws an exception, since this parameter is not an URI.


Constructor Detail
FloatParameter
public FloatParameter(ParameterDescriptor descriptor)(Code)
Constructs a parameter from the specified descriptor. The descriptor must be .class.
Parameters:
  descriptor - The abstract definition of this parameter.
throws:
  IllegalArgumentException - if the value class is not Double.class .



FloatParameter
public FloatParameter(ParameterDescriptor descriptor, double value)(Code)
Constructs a parameter from the specified descriptor and value. This convenience constructor is equivalents to the one-argument constructor followed by a call to FloatParameter.setValue(double) .
Parameters:
  descriptor - The abstract definition of this parameter.
Parameters:
  value - The parameter value.
throws:
  IllegalArgumentException - if the value class is not Double.class .




Method Detail
booleanValue
public boolean booleanValue()(Code)
Returns true if the value is different from 0, false otherwise. The boolean value represented by this parameter.



doubleValue
public double doubleValue(Unit unit) throws IllegalArgumentException(Code)
Returns the numeric value of the coordinate operation parameter in the specified unit of measure. This convenience method apply unit conversion on the fly as needed.
Parameters:
  unit - The unit of measure for the value to be returned. The numeric value represented by this parameter after conversion to type double and conversion to unit .
throws:
  IllegalArgumentException - if the specified unit is invalid for this parameter.



doubleValue
public double doubleValue()(Code)
Returns the numeric value of the coordinate operation parameter with its associated . The numeric value represented by this parameter after conversion to type double .



doubleValueList
public double[] doubleValueList(Unit unit) throws IllegalArgumentException(Code)
Wraps the value in an array of length 1.
Parameters:
  unit - The unit of measure for the value to be returned. The sequence of values represented by this parameter after conversion to type double and conversion to unit .
throws:
  IllegalArgumentException - if the specified unit is invalid for this parameter.



doubleValueList
public double[] doubleValueList()(Code)
Wraps the value in an array of length 1. The sequence of values represented by this parameter.



equals
public boolean equals(Object object)(Code)
Compares the specified object with this parameter for equality.
Parameters:
  object - The object to compare to this . true if both objects are equal.



getUnit
public Unit getUnit()(Code)
Returns the unit of measure of the . The default implementation always delegates to ParameterDescriptor.getUnit . The unit of measure, or null if none.



getValue
public Object getValue()(Code)
Returns the parameter value as { Double , The parameter value as an object.



hashCode
public int hashCode()(Code)
Returns a hash value for this parameter. The hash code value. This value doesn't need to be the samein past or future versions of this class.



intValue
public int intValue()(Code)
Returns the numeric value rounded to the nearest integer. The numeric value represented by this parameter after conversion to type int .



intValueList
public int[] intValueList()(Code)
Wraps the value in an array of length 1. The sequence of values represented by this parameter.



setValue
public void setValue(double value, Unit unit) throws InvalidParameterValueException(Code)
Set the parameter value as a floating point and its associated unit.
Parameters:
  value - The parameter value.
Parameters:
  unit - The unit for the specified value.
throws:
  InvalidParameterValueException - if the value is illegal for some reason(for example a value out of range).



setValue
public void setValue(double value) throws InvalidParameterValueException(Code)
Set the parameter value as a floating point.
Parameters:
  value - The parameter value.
throws:
  InvalidParameterValueException - if the value is illegal for some reason(for example a value out of range).



setValue
public void setValue(int value) throws InvalidParameterValueException(Code)
Set the parameter value as an integer.
Parameters:
  value - The parameter value.
throws:
  InvalidParameterValueException - if the value is illegal for some reason(for example a value out of range).



setValue
public void setValue(boolean value) throws InvalidParameterValueException(Code)
Set the parameter value as a boolean.
Parameters:
  value - The parameter value.
throws:
  InvalidParameterValueException - if the boolean type is inappropriate for this parameter.



setValue
public void setValue(Object value) throws InvalidParameterValueException(Code)
Set the parameter value as a Double object.
Parameters:
  value - The parameter value.
throws:
  InvalidParameterValueException - if the type of value is inappropriatefor this parameter, or if the value is illegal for some other reason (for examplethe value is numeric and out of range).



setValue
public void setValue(double[] values, Unit unit) throws InvalidParameterValueException(Code)
Always throws an exception, since this parameter is not an array.



stringValue
public String stringValue()(Code)
Returns the string representation of the value. The string value represented by this parameter.



valueFile
public URI valueFile() throws InvalidParameterTypeException(Code)
Always throws an exception, since this parameter is not an URI. Never return.
throws:
  InvalidParameterTypeException - The value is not a reference to a file or an URI.



Fields inherited from org.geotools.parameter.AbstractParameter
final GeneralParameterDescriptor descriptor(Code)(Java Doc)

Methods inherited from org.geotools.parameter.AbstractParameter
public Object clone()(Code)(Java Doc)
static void ensureNonNull(String name, Object object) throws IllegalArgumentException(Code)(Java Doc)
static void ensureNonNull(String name, Object[] array, int index) throws IllegalArgumentException(Code)(Java Doc)
static void ensureValidClass(Class valueClass, Object value) throws IllegalArgumentException(Code)(Java Doc)
public boolean equals(Object object)(Code)(Java Doc)
final protected String formatWKT(Formatter formatter)(Code)(Java Doc)
public GeneralParameterDescriptor getDescriptor()(Code)(Java Doc)
static String getName(GeneralParameterDescriptor descriptor)(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
final public String toString()(Code)(Java Doc)
static IllegalStateException unitlessParameter(GeneralParameterDescriptor descriptor)(Code)(Java Doc)
protected void write(TableWriter table) throws IOException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.