org.geotools.openoffice
Interface XReferencing

All Superinterfaces:

com.sun.star.uno.XInterface

All Known Implementing Classes:

Referencing

public interface XReferencing

extends com.sun.star.uno.XInterface

Services from the org.geotools.referencing package to be exported to OpenOffice. This interface is derived from the file using the tool provided in OpenOffice SDK, and disassembling the output using the tool provided in Java SDK. This source file exists mostly for javadoc purpose and in order to keep IDE happy. The file compiled from this source file MUST be overwritten by the file generated by .

Since:

2.2

Version:

$Id: XReferencing.java 17661 2006-01-18 07:55:11Z desruisseaux $

Author:

Martin Desruisseaux

Method Summary

double	getAccuracy(com.sun.star.beans.XPropertySet xOptions, java.lang.String sourceCRS, java.lang.String targetCRS) Returns the accuracy of a transformation between two coordinate reference systems.
java.lang.String	getAxis(com.sun.star.beans.XPropertySet xOptions, java.lang.String authorityCode, int dimension) Returns the axis name for the specified dimension in an identified object.
double[][]	getBoundingBox(com.sun.star.beans.XPropertySet xOptions, java.lang.String authorityCode) Returns the valid area as a geographic bounding box for an identified object.
java.lang.String	getDescription(com.sun.star.beans.XPropertySet xOptions, java.lang.String authorityCode) Returns the identified object description from an authority code.
double[][]	getOrthodromicDistance(com.sun.star.beans.XPropertySet xOptions, double[][] source, double[][] target, java.lang.Object CRS) Computes the orthodromic distance and azimuth between two coordinates.
double[][]	getOrthodromicForward(com.sun.star.beans.XPropertySet xOptions, double[][] source, double[][] displacement, java.lang.Object CRS) Computes the coordinates after a displacement of the specified distance.
java.lang.Object	getParameter(com.sun.star.beans.XPropertySet xOptions, java.lang.String authorityCode, java.lang.String parameter) Returns the value for a coordinate reference system parameter.
java.lang.String	getRemarks(com.sun.star.beans.XPropertySet xOptions, java.lang.String authorityCode) Returns the remarks for an identified object.
java.lang.String	getScope(com.sun.star.beans.XPropertySet xOptions, java.lang.String authorityCode) Returns the scope for an identified object.
java.lang.String	getTextAngle(com.sun.star.beans.XPropertySet xOptions, double value, java.lang.Object pattern) Converts an angle to text according to a given format.
java.lang.String	getTextLatitude(com.sun.star.beans.XPropertySet xOptions, double value, java.lang.Object pattern) Converts a latitude to text according to a given format.
java.lang.String	getTextLongitude(com.sun.star.beans.XPropertySet xOptions, double value, java.lang.Object pattern) Converts a longitude to text according to a given format.
double[][]	getTransformedCoordinates(com.sun.star.beans.XPropertySet xOptions, double[][] coordinates, java.lang.String sourceCRS, java.lang.String targetCRS) Transforms coordinates from the specified source CRS to the specified target CRS.
java.lang.String	getTransformWKT(com.sun.star.beans.XPropertySet xOptions, java.lang.String sourceCRS, java.lang.String targetCRS, java.lang.Object authority) Returns the Well Know Text (WKT) of a transformation between two coordinate reference systems.
java.lang.String	getValidArea(com.sun.star.beans.XPropertySet xOptions, java.lang.String authorityCode) Returns the valid area as a textual description for an identified object.
double	getValueAngle(com.sun.star.beans.XPropertySet xOptions, java.lang.String text, java.lang.Object pattern) Converts text in degrees-minutes-seconds to an angle in decimal degrees.
java.lang.String	getWKT(com.sun.star.beans.XPropertySet xOptions, java.lang.String authorityCode, java.lang.Object authority) Returns the Well Know Text (WKT) for an identified object.

Method Detail

getValueAngle

public double getValueAngle(com.sun.star.beans.XPropertySet xOptions,
                            java.lang.String text,
                            java.lang.Object pattern)
                     throws com.sun.star.lang.IllegalArgumentException

Converts text in degrees-minutes-seconds to an angle in decimal degrees.

Parameters:

xOptions - Provided by OpenOffice.

text - The text to be converted to an angle.

pattern - The text that describes the format (example: "D?MM.m'").

Throws:

com.sun.star.lang.IllegalArgumentException - if is illegal.

getTextAngle

public java.lang.String getTextAngle(com.sun.star.beans.XPropertySet xOptions,
                                     double value,
                                     java.lang.Object pattern)
                              throws com.sun.star.lang.IllegalArgumentException

Converts an angle to text according to a given format.

Parameters:

xOptions - Provided by OpenOffice.

value - The angle value (in decimal degrees) to be converted.

pattern - The text that describes the format (example: "D?MM.m'").

Throws:

com.sun.star.lang.IllegalArgumentException - if is illegal.

getTextLongitude

public java.lang.String getTextLongitude(com.sun.star.beans.XPropertySet xOptions,
                                         double value,
                                         java.lang.Object pattern)
                                  throws com.sun.star.lang.IllegalArgumentException

Converts a longitude to text according to a given format.

Parameters:

xOptions - Provided by OpenOffice.

value - The longitude value (in decimal degrees) to be converted.

pattern - The text that describes the format (example: "D?MM.m'").

Throws:

com.sun.star.lang.IllegalArgumentException - if is illegal.

getTextLatitude

public java.lang.String getTextLatitude(com.sun.star.beans.XPropertySet xOptions,
                                        double value,
                                        java.lang.Object pattern)
                                 throws com.sun.star.lang.IllegalArgumentException

Converts a latitude to text according to a given format.

Parameters:

xOptions - Provided by OpenOffice.

value - The latitude value (in decimal degrees) to be converted.

pattern - The text that describes the format (example: "D?MM.m'").

Throws:

com.sun.star.lang.IllegalArgumentException - if is illegal.

getDescription

public java.lang.String getDescription(com.sun.star.beans.XPropertySet xOptions,
                                       java.lang.String authorityCode)

Returns the identified object description from an authority code.

Parameters:

xOptions - Provided by OpenOffice.

authorityCode - The code allocated by the authority.

getScope

public java.lang.String getScope(com.sun.star.beans.XPropertySet xOptions,
                                 java.lang.String authorityCode)

Returns the scope for an identified object.

Parameters:

xOptions - Provided by OpenOffice.

authorityCode - The code allocated by the authority.

getValidArea

public java.lang.String getValidArea(com.sun.star.beans.XPropertySet xOptions,
                                     java.lang.String authorityCode)

Returns the valid area as a textual description for an identified object.

Parameters:

xOptions - Provided by OpenOffice.

authorityCode - The code allocated by the authority.

getBoundingBox

public double[][] getBoundingBox(com.sun.star.beans.XPropertySet xOptions,
                                 java.lang.String authorityCode)

Returns the valid area as a geographic bounding box for an identified object. This method returns a 2×2 matrix. The first row contains the latitude and longitude of upper left corder, and the second row contains the latitude and longitude or bottom right corner. Units are degrees.

Parameters:

xOptions - Provided by OpenOffice.

authorityCode - The code allocated by the authority.

getRemarks

public java.lang.String getRemarks(com.sun.star.beans.XPropertySet xOptions,
                                   java.lang.String authorityCode)

Returns the remarks for an identified object.

Parameters:

xOptions - Provided by OpenOffice.

authorityCode - The code allocated by the authority.

getAxis

public java.lang.String getAxis(com.sun.star.beans.XPropertySet xOptions,
                                java.lang.String authorityCode,
                                int dimension)

Returns the axis name for the specified dimension in an identified object.

Parameters:

xOptions - Provided by OpenOffice.

authorityCode - The code allocated by the authority.

dimension - The dimension (1, 2, ...).

getParameter

public java.lang.Object getParameter(com.sun.star.beans.XPropertySet xOptions,
                                     java.lang.String authorityCode,
                                     java.lang.String parameter)

Returns the value for a coordinate reference system parameter.

Parameters:

xOptions - Provided by OpenOffice.

authorityCode - The code allocated by the authority.

parameter - The parameter name (e.g. "False easting").

getWKT

public java.lang.String getWKT(com.sun.star.beans.XPropertySet xOptions,
                               java.lang.String authorityCode,
                               java.lang.Object authority)

Returns the Well Know Text (WKT) for an identified object.

Parameters:

xOptions - Provided by OpenOffice.

authorityCode - The code allocated by the authority.

authority - The authority name for choice of parameter names. Usually "OGC".

getTransformWKT

public java.lang.String getTransformWKT(com.sun.star.beans.XPropertySet xOptions,
                                        java.lang.String sourceCRS,
                                        java.lang.String targetCRS,
                                        java.lang.Object authority)

Returns the Well Know Text (WKT) of a transformation between two coordinate reference systems.

Parameters:

xOptions - Provided by OpenOffice.

sourceCRS - The authority code for the source coordinate reference system.

targetCRS - The authority code for the target coordinate reference system.

authority - The authority name for choice of parameter names. Usually "OGC".

getAccuracy

public double getAccuracy(com.sun.star.beans.XPropertySet xOptions,
                          java.lang.String sourceCRS,
                          java.lang.String targetCRS)

Returns the accuracy of a transformation between two coordinate reference systems.

Parameters:

xOptions - Provided by OpenOffice.

sourceCRS - The authority code for the source coordinate reference system.

targetCRS - The authority code for the target coordinate reference system.

getTransformedCoordinates

public double[][] getTransformedCoordinates(com.sun.star.beans.XPropertySet xOptions,
                                            double[][] coordinates,
                                            java.lang.String sourceCRS,
                                            java.lang.String targetCRS)

Transforms coordinates from the specified source CRS to the specified target CRS.

Parameters:

xOptions - Provided by OpenOffice.

coordinates - The coordinates to transform.

sourceCRS - The authority code for the source coordinate reference system.

targetCRS - The authority code for the target coordinate reference system.

getOrthodromicDistance

public double[][] getOrthodromicDistance(com.sun.star.beans.XPropertySet xOptions,
                                         double[][] source,
                                         double[][] target,
                                         java.lang.Object CRS)

Computes the orthodromic distance and azimuth between two coordinates.

Parameters:

xOptions - Provided by OpenOffice.

source - The source positions.

target - The target positions.

CRS - Authority code of the coordinate reference system.

getOrthodromicForward

public double[][] getOrthodromicForward(com.sun.star.beans.XPropertySet xOptions,
                                        double[][] source,
                                        double[][] displacement,
                                        java.lang.Object CRS)

Computes the coordinates after a displacement of the specified distance.

Parameters:

xOptions - Provided by OpenOffice.

source - The source positions.

displacement - The distance and azimuth.

CRS - Authority code of the coordinate reference system.