Java Doc for AbstractCoordinateOperationFactory.java in  » GIS » GeoTools-2.4.1 » org » geotools » referencing » operation » 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.referencing.operation 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.geotools.referencing.factory.ReferencingFactory
   org.geotools.referencing.operation.AbstractCoordinateOperationFactory

All known Subclasses:   org.geotools.referencing.operation.DefaultCoordinateOperationFactory,  org.geotools.referencing.operation.BufferedCoordinateOperationFactory,
AbstractCoordinateOperationFactory
abstract public class AbstractCoordinateOperationFactory extends ReferencingFactory implements CoordinateOperationFactory(Code)
Base class for coordinate operation factories. This class provides helper methods for the construction of building blocks. It doesn't figure out any operation path by itself. This more "intelligent" job is left to subclasses.
since:
   2.1
version:
   $Id: AbstractCoordinateOperationFactory.java 28264 2007-12-05 21:53:08Z desruisseaux $
author:
   Martin Desruisseaux


Field Summary
final protected static  ReferenceIdentifierAXIS_CHANGES
     The identifier for conversion using an affine transform for axis swapping and/or unit conversions.
final protected static  ReferenceIdentifierDATUM_SHIFT
     The identifier for a transformation which is a datum shift.
final protected static  ReferenceIdentifierELLIPSOID_SHIFT
     The identifier for a transformation which is a datum shift without . Only the changes in ellipsoid axis-length are taken in account.
final protected static  ReferenceIdentifierGEOCENTRIC_CONVERSION
     The identifier for a geocentric conversion.
final protected static  ReferenceIdentifierIDENTITY
     The identifier for an identity operation.
final protected static  ReferenceIdentifierINVERSE_OPERATION
     The identifier for an inverse operation.

Constructor Summary
public  AbstractCoordinateOperationFactory(Hints userHints)
     Constructs a coordinate operation factory using the specified hints.
public  AbstractCoordinateOperationFactory(Hints userHints, int priority)
     Constructs a coordinate operation factory using the specified hints and priority.
 AbstractCoordinateOperationFactory(CoordinateOperationFactory factory, Hints hints, int priority)
     If the specified factory is an instance of AbstractCoordinateOperationFactory , fetch the FactoryGroup from this instance instead of from the hints.

Method Summary
protected  CoordinateOperationconcatenate(CoordinateOperation step1, CoordinateOperation step2)
     Concatenate two operation steps.
protected  CoordinateOperationconcatenate(CoordinateOperation step1, CoordinateOperation step2, CoordinateOperation step3)
     Concatenate three transformation steps.
public  CoordinateOperationcreateConcatenatedOperation(Map properties, CoordinateOperation[] operations)
     Creates a concatenated operation from a sequence of operations.
Parameters:
  properties - Set of properties.
public  ConversioncreateDefiningConversion(Map properties, OperationMethod method, ParameterValueGroup parameters)
     Constructs a defining conversion from a set of properties.
Parameters:
  properties - Set of properties.
protected  CoordinateOperationcreateFromAffineTransform(ReferenceIdentifier name, CoordinateReferenceSystem sourceCRS, CoordinateReferenceSystem targetCRS, Matrix matrix)
     Creates a coordinate operation from a matrix, which usually describes an affine tranform. A default OperationMethod object is given to this transform.
protected  CoordinateOperationcreateFromMathTransform(ReferenceIdentifier name, CoordinateReferenceSystem sourceCRS, CoordinateReferenceSystem targetCRS, MathTransform transform)
     Creates a coordinate operation from a math transform.
Parameters:
  name - The identifier for the operation to be created.
Parameters:
  sourceCRS - The source coordinate reference system.
Parameters:
  targetCRS - The destination coordinate reference system.
Parameters:
  transform - The math transform.
protected  CoordinateOperationcreateFromMathTransform(Map properties, CoordinateReferenceSystem sourceCRS, CoordinateReferenceSystem targetCRS, MathTransform transform, OperationMethod method, Class type)
     Creates a coordinate operation from a math transform. If the specified math transform is already a coordinate operation, and if source and target CRS match, then transform is returned with no change. Otherwise, a new coordinate operation is created.
Parameters:
  properties - The properties to give to the operation.
Parameters:
  sourceCRS - The source coordinate reference system.
Parameters:
  targetCRS - The destination coordinate reference system.
Parameters:
  transform - The math transform.
Parameters:
  method - The operation method, or null .
Parameters:
  type - The required super-class (e.g.
protected  CoordinateOperationcreateFromParameters(ReferenceIdentifier name, CoordinateReferenceSystem sourceCRS, CoordinateReferenceSystem targetCRS, ParameterValueGroup parameters)
     Creates a coordinate operation from a set of parameters. The is inferred automatically, if possible.
Parameters:
  name - The identifier for the operation to be created.
Parameters:
  sourceCRS - The source coordinate reference system.
Parameters:
  targetCRS - The target coordinate reference system.
Parameters:
  parameters - The parameters.
protected static  voidensureNonNull(String name, Object object)
     Makes sure an argument is non-null.
static  booleanequalsIgnoreMetadata(IdentifiedObject object1, IdentifiedObject object2)
     Compares the specified objects for equality.
static  intgetDimension(CoordinateReferenceSystem crs)
     Returns the dimension of the specified coordinate system, or 0 if the coordinate system is null.
protected static  StringgetErrorMessage(IdentifiedObject source, IdentifiedObject target)
     Returns an error message for "No path found from sourceCRS to targetCRS". This is used for the construction of OperationNotFoundException .
Parameters:
  source - The source CRS.
Parameters:
  target - The target CRS.
final  FactoryGroupgetFactoryGroup()
     Returns the set of helper methods on factories.
public  MapgetImplementationHints()
     Returns the implementation hints for this factory.
final public  MathTransformFactorygetMathTransformFactory()
     Returns the underlying math transform factory.
static  MapgetTemporaryName(IdentifiedObject source)
     Returns a temporary name for object derived from the specified one.
static  MapgetTemporaryName(CoordinateReferenceSystem source, CoordinateReferenceSystem target)
     Returns a temporary name for object derived from a concatenation.
 voidinitializeHints()
     Invoked when the AbstractCoordinateOperationFactory.hints map should be initialized.
protected  CoordinateOperationinverse(CoordinateOperation operation)
     Returns the inverse of the specified operation.
Parameters:
  operation - The operation to invert.
protected  MatrixswapAndScaleAxis(CoordinateSystem sourceCS, CoordinateSystem targetCS)
     Returns an affine transform between two coordinate systems.

Field Detail
AXIS_CHANGES
final protected static ReferenceIdentifier AXIS_CHANGES(Code)
The identifier for conversion using an affine transform for axis swapping and/or unit conversions.



DATUM_SHIFT
final protected static ReferenceIdentifier DATUM_SHIFT(Code)
The identifier for a transformation which is a datum shift.
See Also:   PositionalAccuracyImpl.DATUM_SHIFT_APPLIED



ELLIPSOID_SHIFT
final protected static ReferenceIdentifier ELLIPSOID_SHIFT(Code)
The identifier for a transformation which is a datum shift without . Only the changes in ellipsoid axis-length are taken in account. Such ellipsoid shifts are approximative and may have 1 kilometer error. This transformation is allowed only if the factory was created with Hints.LENIENT_DATUM_SHIFT set to Boolean.TRUE .
See Also:   PositionalAccuracyImpl.DATUM_SHIFT_OMITTED



GEOCENTRIC_CONVERSION
final protected static ReferenceIdentifier GEOCENTRIC_CONVERSION(Code)
The identifier for a geocentric conversion.



IDENTITY
final protected static ReferenceIdentifier IDENTITY(Code)
The identifier for an identity operation.



INVERSE_OPERATION
final protected static ReferenceIdentifier INVERSE_OPERATION(Code)
The identifier for an inverse operation.




Constructor Detail
AbstractCoordinateOperationFactory
public AbstractCoordinateOperationFactory(Hints userHints)(Code)
Constructs a coordinate operation factory using the specified hints. This constructor recognizes the Hints.CRS_FACTORY CRS , Hints.CS_FACTORY CS , Hints.DATUM_FACTORY DATUM and Hints.MATH_TRANSFORM_FACTORY MATH_TRANSFORM FACTORY hints.
Parameters:
  userHints - The hints, or null if none.



AbstractCoordinateOperationFactory
public AbstractCoordinateOperationFactory(Hints userHints, int priority)(Code)
Constructs a coordinate operation factory using the specified hints and priority. This constructor recognizes the Hints.CRS_FACTORY CRS , Hints.CS_FACTORY CS , Hints.DATUM_FACTORY DATUM and Hints.MATH_TRANSFORM_FACTORY MATH_TRANSFORM FACTORY hints.
Parameters:
  userHints - The hints, or null if none.
Parameters:
  priority - The priority for this factory, as a number betweenAbstractCoordinateOperationFactory.MINIMUM_PRIORITY MINIMUM_PRIORITY andAbstractCoordinateOperationFactory.MAXIMUM_PRIORITY MAXIMUM_PRIORITY inclusive.
since:
   2.2



AbstractCoordinateOperationFactory
AbstractCoordinateOperationFactory(CoordinateOperationFactory factory, Hints hints, int priority)(Code)
If the specified factory is an instance of AbstractCoordinateOperationFactory , fetch the FactoryGroup from this instance instead of from the hints. This constructor is strictly reserved for factory subclasses that are wrapper around an other factory, like BufferedCoordinateOperationFactory .




Method Detail
concatenate
protected CoordinateOperation concatenate(CoordinateOperation step1, CoordinateOperation step2) throws FactoryException(Code)
Concatenate two operation steps. If an operation is an AbstractCoordinateOperationFactory.AXIS_CHANGES , it will be included as part of the second operation instead of creating an ConcatenatedOperation . If a concatenated operation is created, it will get an automatically generated name.
Parameters:
  step1 - The first step, or null for the identity operation.
Parameters:
  step2 - The second step, or null for the identity operation. A concatenated operation, or null if all arguments was nul.
throws:
  FactoryException - if the operation can't be constructed.



concatenate
protected CoordinateOperation concatenate(CoordinateOperation step1, CoordinateOperation step2, CoordinateOperation step3) throws FactoryException(Code)
Concatenate three transformation steps. If the first and/or the last operation is an AbstractCoordinateOperationFactory.AXIS_CHANGES , it will be included as part of the second operation instead of creating an ConcatenatedOperation . If a concatenated operation is created, it will get an automatically generated name.
Parameters:
  step1 - The first step, or null for the identity operation.
Parameters:
  step2 - The second step, or null for the identity operation.
Parameters:
  step3 - The third step, or null for the identity operation. A concatenated operation, or null if all arguments were null.
throws:
  FactoryException - if the operation can't be constructed.



createConcatenatedOperation
public CoordinateOperation createConcatenatedOperation(Map properties, CoordinateOperation[] operations) throws FactoryException(Code)
Creates a concatenated operation from a sequence of operations.
Parameters:
  properties - Set of properties. Should contains at least "name" .
Parameters:
  operations - The sequence of operations. The concatenated operation.
throws:
  FactoryException - if the object creation failed.



createDefiningConversion
public Conversion createDefiningConversion(Map properties, OperationMethod method, ParameterValueGroup parameters) throws FactoryException(Code)
Constructs a defining conversion from a set of properties.
Parameters:
  properties - Set of properties. Should contains at least "name" .
Parameters:
  method - The operation method.
Parameters:
  parameters - The parameter values. The defining conversion.
throws:
  FactoryException - if the object creation failed.
See Also:   DefiningConversion
since:
   2.4



createFromAffineTransform
protected CoordinateOperation createFromAffineTransform(ReferenceIdentifier name, CoordinateReferenceSystem sourceCRS, CoordinateReferenceSystem targetCRS, Matrix matrix) throws FactoryException(Code)
Creates a coordinate operation from a matrix, which usually describes an affine tranform. A default OperationMethod object is given to this transform. In the special case where the name identifier is AbstractCoordinateOperationFactory.DATUM_SHIFT or AbstractCoordinateOperationFactory.ELLIPSOID_SHIFT , the operation will be an instance of Transformation instead of the usual Conversion .
Parameters:
  name - The identifier for the operation to be created.
Parameters:
  sourceCRS - The source coordinate reference system.
Parameters:
  targetCRS - The target coordinate reference system.
Parameters:
  matrix - The matrix which describe an affine transform operation. The conversion or transformation.
throws:
  FactoryException - if the operation can't be created.



createFromMathTransform
protected CoordinateOperation createFromMathTransform(ReferenceIdentifier name, CoordinateReferenceSystem sourceCRS, CoordinateReferenceSystem targetCRS, MathTransform transform) throws FactoryException(Code)
Creates a coordinate operation from a math transform.
Parameters:
  name - The identifier for the operation to be created.
Parameters:
  sourceCRS - The source coordinate reference system.
Parameters:
  targetCRS - The destination coordinate reference system.
Parameters:
  transform - The math transform. A coordinate operation using the specified math transform.
throws:
  FactoryException - if the operation can't be constructed.



createFromMathTransform
protected CoordinateOperation createFromMathTransform(Map properties, CoordinateReferenceSystem sourceCRS, CoordinateReferenceSystem targetCRS, MathTransform transform, OperationMethod method, Class type) throws FactoryException(Code)
Creates a coordinate operation from a math transform. If the specified math transform is already a coordinate operation, and if source and target CRS match, then transform is returned with no change. Otherwise, a new coordinate operation is created.
Parameters:
  properties - The properties to give to the operation.
Parameters:
  sourceCRS - The source coordinate reference system.
Parameters:
  targetCRS - The destination coordinate reference system.
Parameters:
  transform - The math transform.
Parameters:
  method - The operation method, or null .
Parameters:
  type - The required super-class (e.g. .class). A coordinate operation using the specified math transform.
throws:
  FactoryException - if the operation can't be constructed.



createFromParameters
protected CoordinateOperation createFromParameters(ReferenceIdentifier name, CoordinateReferenceSystem sourceCRS, CoordinateReferenceSystem targetCRS, ParameterValueGroup parameters) throws FactoryException(Code)
Creates a coordinate operation from a set of parameters. The is inferred automatically, if possible.
Parameters:
  name - The identifier for the operation to be created.
Parameters:
  sourceCRS - The source coordinate reference system.
Parameters:
  targetCRS - The target coordinate reference system.
Parameters:
  parameters - The parameters. The conversion or transformation.
throws:
  FactoryException - if the operation can't be created.



ensureNonNull
protected static void ensureNonNull(String name, Object object) throws IllegalArgumentException(Code)
Makes sure an argument is non-null.
Parameters:
  name - Argument name.
Parameters:
  object - User argument.
throws:
  IllegalArgumentException - if object is null.



equalsIgnoreMetadata
static boolean equalsIgnoreMetadata(IdentifiedObject object1, IdentifiedObject object2)(Code)
Compares the specified objects for equality. If both objects are Geotools implementations of , then this method will ignore the metadata during the comparaison.
Parameters:
  object1 - The first object to compare (may be null).
Parameters:
  object2 - The second object to compare (may be null). true if both objects are equals. false



getDimension
static int getDimension(CoordinateReferenceSystem crs)(Code)
Returns the dimension of the specified coordinate system, or 0 if the coordinate system is null.



getErrorMessage
protected static String getErrorMessage(IdentifiedObject source, IdentifiedObject target)(Code)
Returns an error message for "No path found from sourceCRS to targetCRS". This is used for the construction of OperationNotFoundException .
Parameters:
  source - The source CRS.
Parameters:
  target - The target CRS. A default error message.



getFactoryGroup
final FactoryGroup getFactoryGroup()(Code)
Returns the set of helper methods on factories.



getImplementationHints
public Map getImplementationHints()(Code)
Returns the implementation hints for this factory. The returned map contains values for Hints.CRS_FACTORY CRS , Hints.CS_FACTORY CS , Hints.DATUM_FACTORY DATUM and Hints.MATH_TRANSFORM_FACTORY MATH_TRANSFORM FACTORY hints. Other values may be provided as well, at implementation choice.



getMathTransformFactory
final public MathTransformFactory getMathTransformFactory()(Code)
Returns the underlying math transform factory. This factory is used for constructing MathTransform objects for all .



getTemporaryName
static Map getTemporaryName(IdentifiedObject source)(Code)
Returns a temporary name for object derived from the specified one.
Parameters:
  source - The CRS to base name on, or null if none.



getTemporaryName
static Map getTemporaryName(CoordinateReferenceSystem source, CoordinateReferenceSystem target)(Code)
Returns a temporary name for object derived from a concatenation.
Parameters:
  source - The CRS to base name on, or null if none.



initializeHints
void initializeHints()(Code)
Invoked when the AbstractCoordinateOperationFactory.hints map should be initialized. This method may be overridden by subclasses like BufferedCoordinateOperationFactory .



inverse
protected CoordinateOperation inverse(CoordinateOperation operation) throws NoninvertibleTransformException, FactoryException(Code)
Returns the inverse of the specified operation.
Parameters:
  operation - The operation to invert. The inverse of operation .
throws:
  NoninvertibleTransformException - if the operation is not invertible.
throws:
  FactoryException - if the operation creation failed for an other reason.
since:
   2.3



swapAndScaleAxis
protected Matrix swapAndScaleAxis(CoordinateSystem sourceCS, CoordinateSystem targetCS) throws OperationNotFoundException(Code)
Returns an affine transform between two coordinate systems. Only units and axis order (e.g. transforming from (NORTH,WEST) to (EAST,NORTH)) are taken in account.

Example: If coordinates in sourceCS are (x,y) pairs in metres and coordinates in targetCS are (-y,x) pairs in centimetres, then the transformation can be performed as below:

[-y(cm)] [ 0 -100 0 ] [x(m)] [ x(cm)] = [ 100 0 0 ] [y(m)] [ 1 ] [ 0 0 1 ] [1 ]

Parameters:
  sourceCS - The source coordinate system.
Parameters:
  targetCS - The target coordinate system. The transformation from sourceCS to targetCS asan affine transform. Only axis orientation and units are taken in account.
throws:
  OperationNotFoundException - If the affine transform can't be constructed.
See Also:   AbstractCS.swapAndScaleAxis



Fields inherited from org.geotools.referencing.factory.ReferencingFactory
final public static Logger LOGGER(Code)(Java Doc)

Methods inherited from org.geotools.referencing.factory.ReferencingFactory
protected static void ensureNonNull(String name, Object object) throws InvalidParameterValueException(Code)(Java Doc)
public Citation getVendor()(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.