Object
WeakBase
CalcAddins
ReferencingFunctions
- All Implemented Interfaces:
XLocalizable
,XServiceInfo
,XServiceName
,XTypeProvider
,XInterface
,XWeak
,XReferencing
Implements the
XReferencing
methods to make available to Apache OpenOffice.- Since:
- 0.8
-
Field Summary
Fields inherited from class CalcAddins
context
Fields inherited from class WeakBase
_mapTypes
Fields inherited from interface XLocalizable
UNOTYPEINFO
Fields inherited from interface XServiceInfo
UNOTYPEINFO
Fields inherited from interface XServiceName
UNOTYPEINFO
Fields inherited from interface XTypeProvider
UNOTYPEINFO
Fields inherited from interface XWeak
UNOTYPEINFO
-
Constructor Summary
ConstructorDescriptionReferencingFunctions
(XComponentContext context) Constructs an implementation ofXReferencing
interface. -
Method Summary
Modifier and TypeMethodDescriptionString[][]
formatAngle
(double[][] value, Object pattern, Object locale) Converts an angle to text according to a given format.double
getAccuracy
(String sourceCRS, String targetCRS, Object areaOfInterest) Returns the accuracy of a transformation between two coordinate reference systems.Returns the axis name and units for the specified dimension in a coordinate reference system or coordinate system.getDomainOfValidity
(String codeOrPath) Returns the domain of validity from an authority code.double[][]
getGeographicArea
(String codeOrPath) Returns the domain of validity as a geographic bounding box for an identified object.Provides the implementation name of the service.Returns the identified object name from an authority code.Returns the identified object scope from an authority code.The service name that can be used to create such an object by a factory.double[][]
parseAngle
(String[][] text, Object pattern, Object locale) Converts text in degrees-minutes-seconds to an angle in decimal degrees.double[][]
transformEnvelope
(String sourceCRS, String targetCRS, double[][] envelope) Transforms an envelope from the specified source CRS to the specified target CRS.double[][]
transformPoints
(String sourceCRS, String targetCRS, double[][] points) Transforms coordinates from the specified source CRS to the specified target CRS.Methods inherited from class CalcAddins
getJavaLocale, getLocale, getLocalizedMessage, getLogger, getSupportedServiceNames, setLocale, supportsService
Methods inherited from class WeakBase
finalize, getImplementationId, getTypes, queryAdapter
-
Constructor Details
-
ReferencingFunctions
public ReferencingFunctions(XComponentContext context) Constructs an implementation ofXReferencing
interface.- Parameters:
context
- the value to assign to theCalcAddins.context
field.
-
-
Method Details
-
getServiceName
The service name that can be used to create such an object by a factory.- Specified by:
getServiceName
in interfaceXServiceName
- Specified by:
getServiceName
in classCalcAddins
- Returns:
- unique name of the service.
-
getImplementationName
Provides the implementation name of the service.- Specified by:
getImplementationName
in interfaceXServiceInfo
- Returns:
- unique name of the implementation.
-
getName
Returns the identified object name from an authority code.- Specified by:
getName
in interfaceXReferencing
- Parameters:
codeOrPath
- the code allocated by an authority, or the path to a file.- Returns:
- the object name.
-
getScope
Returns the identified object scope from an authority code.- Specified by:
getScope
in interfaceXReferencing
- Parameters:
codeOrPath
- the code allocated by an authority, or the path to a file.- Returns:
- the object scope.
-
getDomainOfValidity
Returns the domain of validity from an authority code.- Specified by:
getDomainOfValidity
in interfaceXReferencing
- Parameters:
codeOrPath
- the code allocated by an authority, or the path to a file.- Returns:
- the domain of validity.
-
getGeographicArea
Returns the domain of validity 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 corner, and the second row contains the latitude and longitude of bottom right corner. Units are degrees.- Specified by:
getGeographicArea
in interfaceXReferencing
- Parameters:
codeOrPath
- the code allocated by an authority, or the path to a file.- Returns:
- the object bounding box.
-
getAxis
Returns the axis name and units for the specified dimension in a coordinate reference system or coordinate system. This method returns a short axis name as used in Well Known Text (WKT) format, for example "Latitude" instead of "Geodetic latitude".- Specified by:
getAxis
in interfaceXReferencing
- Parameters:
codeOrPath
- the code allocated by an authority, or the path to a file.dimension
- the dimension (1, 2, …).- Returns:
- the name of the requested axis.
-
getAccuracy
public double getAccuracy(String sourceCRS, String targetCRS, Object areaOfInterest) throws IllegalArgumentException Returns the accuracy of a transformation between two coordinate reference systems.- Specified by:
getAccuracy
in interfaceXReferencing
- Parameters:
sourceCRS
- the authority code for the source coordinate reference system.targetCRS
- the authority code for the target coordinate reference system.areaOfInterest
- an optional bounding box of source coordinates to transform.- Returns:
- the operation accuracy.
- Throws:
IllegalArgumentException
- ifpoints
is not adouble[][]
value or void.
-
transformPoints
Transforms coordinates from the specified source CRS to the specified target CRS.- Specified by:
transformPoints
in interfaceXReferencing
- Parameters:
sourceCRS
- the authority code for the source coordinate reference system.targetCRS
- the authority code for the target coordinate reference system.points
- the coordinates to transform.- Returns:
- the transformed coordinates.
-
transformEnvelope
Transforms an envelope from the specified source CRS to the specified target CRS.- Specified by:
transformEnvelope
in interfaceXReferencing
- Parameters:
sourceCRS
- the authority code for the source coordinate reference system.targetCRS
- the authority code for the target coordinate reference system.envelope
- points inside the envelope to transform.- Returns:
- the transformed envelope.
-
parseAngle
public double[][] parseAngle(String[][] text, Object pattern, Object locale) throws IllegalArgumentException Converts text in degrees-minutes-seconds to an angle in decimal degrees. SeeAngleFormat
for pattern description.- Specified by:
parseAngle
in interfaceXReferencing
- Parameters:
text
- the text to be converted to an angle.pattern
- an optional text that describes the format (example: "D°MM.m'").locale
- the convention to use (e.g. decimal separator symbol).- Returns:
- the angle parsed as a number.
- Throws:
IllegalArgumentException
- ifpattern
is not a string value or void.
-
formatAngle
public String[][] formatAngle(double[][] value, Object pattern, Object locale) throws IllegalArgumentException Converts an angle to text according to a given format. This method uses the pattern described byAngleFormat
with the following extension:- If the pattern ends with E or W, then the angle is formatted as a longitude.
- If the pattern ends with N or S, then the angle is formatted as a latitude.
- Specified by:
formatAngle
in interfaceXReferencing
- Parameters:
value
- the angle value (in decimal degrees) to be converted.pattern
- an optional text that describes the format (example: "D°MM.m'").locale
- the convention to use (e.g. decimal separator symbol).- Returns:
- the angle formatted as a string.
- Throws:
IllegalArgumentException
- ifpattern
is not a string value or void.
-