blob: bdabdf353c45f842684f9c4746ec4cb9f9d947bd [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (19) -->
<title>ReferencingFunctions (Apache SIS 1.3 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.sis.openoffice, class: ReferencingFunctions">
<meta name="generator" content="javadoc/ClassWriterImpl">
<meta name="keywords" content="org.apache.sis.openoffice.ReferencingFunctions class">
<meta name="keywords" content="getServiceName()">
<meta name="keywords" content="getImplementationName()">
<meta name="keywords" content="getName()">
<meta name="keywords" content="getScope()">
<meta name="keywords" content="getDomainOfValidity()">
<meta name="keywords" content="getGeographicArea()">
<meta name="keywords" content="getAxis()">
<meta name="keywords" content="getAccuracy()">
<meta name="keywords" content="transformPoints()">
<meta name="keywords" content="transformEnvelope()">
<meta name="keywords" content="parseAngle()">
<meta name="keywords" content="formatAngle()">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../sis.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/ReferencingFunctions.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html#class">Help</a></li>
</ul>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<li>Nested</li>
<li><a href="#field-summary">Field</a></li>
<li><a href="#constructor-summary">Constr</a></li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li>Field</li>
<li><a href="#constructor-detail">Constr</a></li>
<li><a href="#method-detail">Method</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><a href="../../../../search.html">SEARCH</a>
<input type="text" id="search-input" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.openoffice</a></div>
<h1 title="Class ReferencingFunctions" class="title">Class ReferencingFunctions</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
<div class="inheritance">WeakBase
<div class="inheritance"><a href="CalcAddins.html" title="class in org.apache.sis.openoffice">CalcAddins</a>
<div class="inheritance">ReferencingFunctions</div>
</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code>XLocalizable</code>, <code>XService­Info</code>, <code>XService­Name</code>, <code>XType­Provider</code>, <code>XInterface</code>, <code>XWeak</code>, <code><a href="XReferencing.html" title="interface in org.apache.sis.openoffice">XReferencing</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ReferencingFunctions</span>
<span class="extends-implements">extends <a href="CalcAddins.html" title="class in org.apache.sis.openoffice">CalcAddins</a>
implements <a href="XReferencing.html" title="interface in org.apache.sis.openoffice">XReferencing</a></span></div>
<div class="block">Implements the <a href="XReferencing.html" title="interface in org.apache.sis.openoffice"><code>XReferencing</code></a> methods to make available to Apache OpenOffice.</div>
<dl class="notes">
<dt>Since:</dt>
<dd>0.8</dd>
<p><font size="-1">Defined in the <code>sis-openoffice</code> module</font></p>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-CalcAddins">Fields inherited from class&nbsp;<a href="CalcAddins.html" title="class in org.apache.sis.openoffice">CalcAddins</a></h3>
<code><a href="CalcAddins.html#context">context</a></code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-WeakBase">Fields inherited from class&nbsp;WeakBase</h3>
<code>_map­Types</code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-XLocalizable">Fields inherited from interface&nbsp;XLocalizable</h3>
<code>UNOTYPEINFO</code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-XServiceInfo">Fields inherited from interface&nbsp;XServiceInfo</h3>
<code>UNOTYPEINFO</code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-XServiceName">Fields inherited from interface&nbsp;XServiceName</h3>
<code>UNOTYPEINFO</code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-XTypeProvider">Fields inherited from interface&nbsp;XTypeProvider</h3>
<code>UNOTYPEINFO</code></div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-XWeak">Fields inherited from interface&nbsp;XWeak</h3>
<code>UNOTYPEINFO</code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(com.sun.star.uno.XComponentContext)" class="member-name-link">Referencing­Functions</a><wbr>(XComponent­Context&nbsp;context)</code></div>
<div class="col-last even-row-color">
<div class="block">Constructs an implementation of <code>XReferencing</code> interface.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[][]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#formatAngle(double%5B%5D%5B%5D,java.lang.Object,java.lang.Object)" class="member-name-link">format­Angle</a><wbr>(double[][]&nbsp;value,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;pattern,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;locale)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Converts an angle to text according to a given format.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAccuracy(java.lang.String,java.lang.String,java.lang.Object)" class="member-name-link">get­Accuracy</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;source­CRS,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;target­CRS,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;area­Of­Interest)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the accuracy of a transformation between two coordinate reference systems.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAxis(java.lang.String,int)" class="member-name-link">get­Axis</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;code­Or­Path,
int&nbsp;dimension)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the axis name and units for the specified dimension in a coordinate reference system or coordinate system.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDomainOfValidity(java.lang.String)" class="member-name-link">get­Domain­Of­Validity</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;code­Or­Path)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the domain of validity from an authority code.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[][]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getGeographicArea(java.lang.String)" class="member-name-link">get­Geographic­Area</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;code­Or­Path)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the domain of validity as a geographic bounding box for an identified object.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getImplementationName()" class="member-name-link">get­Implementation­Name</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Provides the implementation name of the service.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getName(java.lang.String)" class="member-name-link">get­Name</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;code­Or­Path)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the identified object name from an authority code.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getScope(java.lang.String)" class="member-name-link">get­Scope</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;code­Or­Path)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the identified object scope from an authority code.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getServiceName()" class="member-name-link">get­Service­Name</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The service name that can be used to create such an object by a factory.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[][]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#parseAngle(java.lang.String%5B%5D%5B%5D,java.lang.Object,java.lang.Object)" class="member-name-link">parse­Angle</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[][]&nbsp;text,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;pattern,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;locale)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Converts text in degrees-minutes-seconds to an angle in decimal degrees.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[][]</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#transformEnvelope(java.lang.String,java.lang.String,double%5B%5D%5B%5D)" class="member-name-link">transform­Envelope</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;source­CRS,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;target­CRS,
double[][]&nbsp;envelope)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Transforms an envelope from the specified source CRS to the specified target CRS.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double[][]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#transformPoints(java.lang.String,java.lang.String,double%5B%5D%5B%5D)" class="member-name-link">transform­Points</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;source­CRS,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;target­CRS,
double[][]&nbsp;points)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Transforms coordinates from the specified source CRS to the specified target CRS.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-CalcAddins">Methods inherited from class&nbsp;<a href="CalcAddins.html" title="class in org.apache.sis.openoffice">CalcAddins</a></h3>
<code><a href="CalcAddins.html#getJavaLocale()">get­Java­Locale</a>, <a href="CalcAddins.html#getLocale()">get­Locale</a>, <a href="CalcAddins.html#getLocalizedMessage(java.lang.Throwable)">get­Localized­Message</a>, <a href="CalcAddins.html#getLogger()">get­Logger</a>, <a href="CalcAddins.html#getSupportedServiceNames()">get­Supported­Service­Names</a>, <a href="CalcAddins.html#setLocale(com.sun.star.lang.Locale)">set­Locale</a>, <a href="CalcAddins.html#supportsService(java.lang.String)">supports­Service</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-WeakBase">Methods inherited from class&nbsp;WeakBase</h3>
<code>finalize, get­Implementation­Id, get­Types, query­Adapter</code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">get­Class</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hash­Code</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notify­All</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">to­String</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(com.sun.star.uno.XComponentContext)">
<h3>ReferencingFunctions</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ReferencingFunctions</span><wbr><span class="parameters">(XComponentContext&nbsp;context)</span></div>
<div class="block">Constructs an implementation of <code>XReferencing</code> interface.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>context</code> - the value to assign to the <a href="CalcAddins.html#context"><code>Calc­Addins​.context</code></a> field.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getServiceName()">
<h3>getServiceName</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getServiceName</span>()</div>
<div class="block">The service name that can be used to create such an object by a factory.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code>get­Service­Name</code>&nbsp;in interface&nbsp;<code>XService­Name</code></dd>
<dt>Specified by:</dt>
<dd><code><a href="CalcAddins.html#getServiceName()">get­Service­Name</a></code>&nbsp;in class&nbsp;<code><a href="CalcAddins.html" title="class in org.apache.sis.openoffice">Calc­Addins</a></code></dd>
<dt>Returns:</dt>
<dd>unique name of the service.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getImplementationName()">
<h3>getImplementationName</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getImplementationName</span>()</div>
<div class="block">Provides the implementation name of the service.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code>get­Implementation­Name</code>&nbsp;in interface&nbsp;<code>XService­Info</code></dd>
<dt>Returns:</dt>
<dd>unique name of the implementation.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getName(java.lang.String)">
<h3>getName</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;codeOrPath)</span></div>
<div class="block">Returns the identified object name from an authority code.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="XReferencing.html#getName(java.lang.String)">get­Name</a></code>&nbsp;in interface&nbsp;<code><a href="XReferencing.html" title="interface in org.apache.sis.openoffice">XReferencing</a></code></dd>
<dt>Parameters:</dt>
<dd><code>code­Or­Path</code> - the code allocated by an authority, or the path to a file.</dd>
<dt>Returns:</dt>
<dd>the object name.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getScope(java.lang.String)">
<h3>getScope</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getScope</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;codeOrPath)</span></div>
<div class="block">Returns the identified object scope from an authority code.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="XReferencing.html#getScope(java.lang.String)">get­Scope</a></code>&nbsp;in interface&nbsp;<code><a href="XReferencing.html" title="interface in org.apache.sis.openoffice">XReferencing</a></code></dd>
<dt>Parameters:</dt>
<dd><code>code­Or­Path</code> - the code allocated by an authority, or the path to a file.</dd>
<dt>Returns:</dt>
<dd>the object scope.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getDomainOfValidity(java.lang.String)">
<h3>getDomainOfValidity</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getDomainOfValidity</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;codeOrPath)</span></div>
<div class="block">Returns the domain of validity from an authority code.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="XReferencing.html#getDomainOfValidity(java.lang.String)">get­Domain­Of­Validity</a></code>&nbsp;in interface&nbsp;<code><a href="XReferencing.html" title="interface in org.apache.sis.openoffice">XReferencing</a></code></dd>
<dt>Parameters:</dt>
<dd><code>code­Or­Path</code> - the code allocated by an authority, or the path to a file.</dd>
<dt>Returns:</dt>
<dd>the domain of validity.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getGeographicArea(java.lang.String)">
<h3>getGeographicArea</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double[][]</span>&nbsp;<span class="element-name">getGeographicArea</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;codeOrPath)</span></div>
<div class="block">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.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="XReferencing.html#getGeographicArea(java.lang.String)">get­Geographic­Area</a></code>&nbsp;in interface&nbsp;<code><a href="XReferencing.html" title="interface in org.apache.sis.openoffice">XReferencing</a></code></dd>
<dt>Parameters:</dt>
<dd><code>code­Or­Path</code> - the code allocated by an authority, or the path to a file.</dd>
<dt>Returns:</dt>
<dd>the object bounding box.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getAxis(java.lang.String,int)">
<h3>getAxis</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">getAxis</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;codeOrPath,
int&nbsp;dimension)</span></div>
<div class="block">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 <cite>"Latitude"</cite>
instead of <cite>"Geodetic latitude"</cite>.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="XReferencing.html#getAxis(java.lang.String,int)">get­Axis</a></code>&nbsp;in interface&nbsp;<code><a href="XReferencing.html" title="interface in org.apache.sis.openoffice">XReferencing</a></code></dd>
<dt>Parameters:</dt>
<dd><code>code­Or­Path</code> - the code allocated by an authority, or the path to a file.</dd>
<dd><code>dimension</code> - the dimension (1, 2, …).</dd>
<dt>Returns:</dt>
<dd>the name of the requested axis.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getAccuracy(java.lang.String,java.lang.String,java.lang.Object)">
<h3>getAccuracy</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getAccuracy</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;sourceCRS,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;targetCRS,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;areaOfInterest)</span>
throws <span class="exceptions">IllegalArgumentException</span></div>
<div class="block">Returns the accuracy of a transformation between two coordinate reference systems.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="XReferencing.html#getAccuracy(java.lang.String,java.lang.String,java.lang.Object)">get­Accuracy</a></code>&nbsp;in interface&nbsp;<code><a href="XReferencing.html" title="interface in org.apache.sis.openoffice">XReferencing</a></code></dd>
<dt>Parameters:</dt>
<dd><code>source­CRS</code> - the authority code for the source coordinate reference system.</dd>
<dd><code>target­CRS</code> - the authority code for the target coordinate reference system.</dd>
<dd><code>area­Of­Interest</code> - an optional bounding box of source coordinates to transform.</dd>
<dt>Returns:</dt>
<dd>the operation accuracy.</dd>
<dt>Throws:</dt>
<dd><code>Illegal­Argument­Exception</code> - if <code>points</code> is not a <code>double[][]</code> value or void.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="transformPoints(java.lang.String,java.lang.String,double[][])">
<h3>transformPoints</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double[][]</span>&nbsp;<span class="element-name">transformPoints</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;sourceCRS,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;targetCRS,
double[][]&nbsp;points)</span></div>
<div class="block">Transforms coordinates from the specified source CRS to the specified target CRS.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="XReferencing.html#transformPoints(java.lang.String,java.lang.String,double%5B%5D%5B%5D)">transform­Points</a></code>&nbsp;in interface&nbsp;<code><a href="XReferencing.html" title="interface in org.apache.sis.openoffice">XReferencing</a></code></dd>
<dt>Parameters:</dt>
<dd><code>source­CRS</code> - the authority code for the source coordinate reference system.</dd>
<dd><code>target­CRS</code> - the authority code for the target coordinate reference system.</dd>
<dd><code>points</code> - the coordinates to transform.</dd>
<dt>Returns:</dt>
<dd>the transformed coordinates.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="transformEnvelope(java.lang.String,java.lang.String,double[][])">
<h3>transformEnvelope</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double[][]</span>&nbsp;<span class="element-name">transformEnvelope</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;sourceCRS,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;targetCRS,
double[][]&nbsp;envelope)</span></div>
<div class="block">Transforms an envelope from the specified source CRS to the specified target CRS.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="XReferencing.html#transformEnvelope(java.lang.String,java.lang.String,double%5B%5D%5B%5D)">transform­Envelope</a></code>&nbsp;in interface&nbsp;<code><a href="XReferencing.html" title="interface in org.apache.sis.openoffice">XReferencing</a></code></dd>
<dt>Parameters:</dt>
<dd><code>source­CRS</code> - the authority code for the source coordinate reference system.</dd>
<dd><code>target­CRS</code> - the authority code for the target coordinate reference system.</dd>
<dd><code>envelope</code> - points inside the envelope to transform.</dd>
<dt>Returns:</dt>
<dd>the transformed envelope.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="parseAngle(java.lang.String[][],java.lang.Object,java.lang.Object)">
<h3>parseAngle</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double[][]</span>&nbsp;<span class="element-name">parseAngle</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[][]&nbsp;text,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;pattern,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;locale)</span>
throws <span class="exceptions">IllegalArgumentException</span></div>
<div class="block">Converts text in degrees-minutes-seconds to an angle in decimal degrees.
See <a href="../measure/AngleFormat.html" title="class in org.apache.sis.measure"><code>Angle­Format</code></a> for pattern description.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="XReferencing.html#parseAngle(java.lang.String%5B%5D%5B%5D,java.lang.Object,java.lang.Object)">parse­Angle</a></code>&nbsp;in interface&nbsp;<code><a href="XReferencing.html" title="interface in org.apache.sis.openoffice">XReferencing</a></code></dd>
<dt>Parameters:</dt>
<dd><code>text</code> - the text to be converted to an angle.</dd>
<dd><code>pattern</code> - an optional text that describes the format (example: "D°MM.m'").</dd>
<dd><code>locale</code> - the convention to use (e.g. decimal separator symbol).</dd>
<dt>Returns:</dt>
<dd>the angle parsed as a number.</dd>
<dt>Throws:</dt>
<dd><code>Illegal­Argument­Exception</code> - if <code>pattern</code> is not a string value or void.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="formatAngle(double[][],java.lang.Object,java.lang.Object)">
<h3>formatAngle</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>[][]</span>&nbsp;<span class="element-name">formatAngle</span><wbr><span class="parameters">(double[][]&nbsp;value,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;pattern,
<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;locale)</span>
throws <span class="exceptions">IllegalArgumentException</span></div>
<div class="block">Converts an angle to text according to a given format. This method uses the pattern
described by <a href="../measure/AngleFormat.html" title="class in org.apache.sis.measure"><code>Angle­Format</code></a> with the following extension:
<ul>
<li>If the pattern ends with E or W, then the angle is formatted as a longitude.</li>
<li>If the pattern ends with N or S, then the angle is formatted as a latitude.</li>
</ul></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="XReferencing.html#formatAngle(double%5B%5D%5B%5D,java.lang.Object,java.lang.Object)">format­Angle</a></code>&nbsp;in interface&nbsp;<code><a href="XReferencing.html" title="interface in org.apache.sis.openoffice">XReferencing</a></code></dd>
<dt>Parameters:</dt>
<dd><code>value</code> - the angle value (in decimal degrees) to be converted.</dd>
<dd><code>pattern</code> - an optional text that describes the format (example: "D°MM.m'").</dd>
<dd><code>locale</code> - the convention to use (e.g. decimal separator symbol).</dd>
<dt>Returns:</dt>
<dd>the angle formatted as a string.</dd>
<dt>Throws:</dt>
<dd><code>Illegal­Argument­Exception</code> - if <code>pattern</code> is not a string value or void.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2010&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>