| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 --> |
| <title>XLink (Apache SIS 1.4 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="dc.created" content="2023-10-05"> |
| <meta name="description" content="declaration: module: org.apache.sis.metadata, package: org.apache.sis.xml, class: XLink"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="org.apache.sis.xml.XLink class"> |
| <meta name="keywords" content="getType()"> |
| <meta name="keywords" content="setType()"> |
| <meta name="keywords" content="getHRef()"> |
| <meta name="keywords" content="setHRef()"> |
| <meta name="keywords" content="getRole()"> |
| <meta name="keywords" content="setRole()"> |
| <meta name="keywords" content="getArcRole()"> |
| <meta name="keywords" content="setArcRole()"> |
| <meta name="keywords" content="getTitle()"> |
| <meta name="keywords" content="setTitle()"> |
| <meta name="keywords" content="getShow()"> |
| <meta name="keywords" content="setShow()"> |
| <meta name="keywords" content="getActuate()"> |
| <meta name="keywords" content="setActuate()"> |
| <meta name="keywords" content="getLabel()"> |
| <meta name="keywords" content="setLabel()"> |
| <meta name="keywords" content="getFrom()"> |
| <meta name="keywords" content="setFrom()"> |
| <meta name="keywords" content="getTo()"> |
| <meta name="keywords" content="setTo()"> |
| <meta name="keywords" content="freeze()"> |
| <meta name="keywords" content="equals()"> |
| <meta name="keywords" content="hashCode()"> |
| <meta name="keywords" content="toString()"> |
| <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"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.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"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </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="../../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</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><a href="#nested-class-summary">Nested</a></li> |
| <li>Field</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: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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="module-label-in-type">Module</span> <a href="../../../../module-summary.html">org.apache.sis.metadata</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.sis.xml</a></div> |
| <h1 title="Class XLink" class="title">Class XLink</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| <div class="inheritance">XLink</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">XLink</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></span></div> |
| <div class="block">The XML attributes defined by OGC in the |
| <a href="http://schemas.opengis.net/xlink/1.0.0/xlinks.xsd">xlink</a> schema. |
| |
| The allowed combinations of any one attribute depend on the value of the special |
| <a href="#getType()"><code>type</code></a> attribute. Following is a summary of the element types |
| (columns) on which the global attributes (rows) are allowed, with an indication |
| of whether a value is required (R) or optional (O) |
| (Source: <a href="http://www.w3.org/TR/xlink/">W3C</a>): |
| |
| <table class="sis"> |
| <caption>XLink attribute usage patterns</caption> |
| <tr> |
| <th> </th> |
| <th style="width: 14%"><a href="XLink.Type.html#SIMPLE"><code>simple</code></a></th> |
| <th style="width: 14%"><a href="XLink.Type.html#EXTENDED"><code>extended</code></a></th> |
| <th style="width: 14%"><a href="XLink.Type.html#LOCATOR"><code>locator</code></a></th> |
| <th style="width: 14%"><a href="XLink.Type.html#ARC"><code>arc</code></a></th> |
| <th style="width: 14%"><a href="XLink.Type.html#RESOURCE"><code>resource</code></a></th> |
| <th style="width: 14%"><a href="XLink.Type.html#TITLE"><code>title</code></a></th> |
| </tr> |
| <tr style="text-align:center"><td style="text-align:left"><b><a href="#getType()"><code>type</code></a></b></td> <td>R</td><td>R</td><td>R</td><td>R</td><td>R</td><td>R</td></tr> |
| <tr style="text-align:center"><td style="text-align:left"><b><a href="#getHRef()"><code>href</code></a></b></td> <td>O</td><td> </td><td>R</td><td> </td><td> </td><td> </td></tr> |
| <tr style="text-align:center"><td style="text-align:left"><b><a href="#getRole()"><code>role</code></a></b></td> <td>O</td><td>O</td><td>O</td><td> </td><td>O</td><td> </td></tr> |
| <tr style="text-align:center"><td style="text-align:left"><b><a href="#getArcRole()"><code>arcrole</code></a></b></td> <td>O</td><td> </td><td> </td><td>O</td><td> </td><td> </td></tr> |
| <tr style="text-align:center"><td style="text-align:left"><b><a href="#getTitle()"><code>title</code></a></b></td> <td>O</td><td>O</td><td>O</td><td>O</td><td>O</td><td> </td></tr> |
| <tr style="text-align:center"><td style="text-align:left"><b><a href="#getShow()"><code>show</code></a></b></td> <td>O</td><td> </td><td> </td><td>O</td><td> </td><td> </td></tr> |
| <tr style="text-align:center"><td style="text-align:left"><b><a href="#getActuate()"><code>actuate</code></a></b></td> <td>O</td><td> </td><td> </td><td>O</td><td> </td><td> </td></tr> |
| <tr style="text-align:center"><td style="text-align:left"><b><a href="#getLabel()"><code>label</code></a></b></td> <td> </td><td> </td><td>O</td><td> </td><td>O</td><td> </td></tr> |
| <tr style="text-align:center"><td style="text-align:left"><b><a href="#getFrom()"><code>from</code></a></b></td> <td> </td><td> </td><td> </td><td>O</td><td> </td><td> </td></tr> |
| <tr style="text-align:center"><td style="text-align:left"><b><a href="#getTo()"><code>to</code></a></b></td> <td> </td><td> </td><td> </td><td>O</td><td> </td><td> </td></tr> |
| </table> |
| |
| When <code>xlink</code> attributes are found at unmarshalling time instead of an object definition, |
| those attributes are given to the <a href="ReferenceResolver.html#resolve(org.apache.sis.xml.MarshalContext,java.lang.Class,org.apache.sis.xml.XLink)"><code>ReferenceResolver.resolve(MarshalContext, Class, XLink)</code></a> |
| method. Users can override that method in order to fetch an instance in some catalog for the given |
| <code>xlink</code> values.</div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>0.3</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="tag-list"> |
| <li><a href="http://www.w3.org/TR/xlink/">XML Linking Language</a></li> |
| <li><a href="http://schemas.opengis.net/xlink/1.0.0/xlinks.xsd">OGC schema</a></li> |
| <li><a href="../../../../../serialized-form.html#org.apache.sis.xml.XLink">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static enum </code></div> |
| <div class="col-second even-row-color"><code><a href="XLink.Actuate.html" class="type-name-link" title="enum class in org.apache.sis.xml">XLink.Actuate</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Communicates the desired timing of traversal from the starting resource to the ending |
| resource.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static enum </code></div> |
| <div class="col-second odd-row-color"><code><a href="XLink.Show.html" class="type-name-link" title="enum class in org.apache.sis.xml">XLink.Show</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Communicates the desired presentation of the ending resource on traversal |
| from the starting resource.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static enum </code></div> |
| <div class="col-second even-row-color"><code><a href="XLink.Type.html" class="type-name-link" title="enum class in org.apache.sis.xml">XLink.Type</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The type of a <code>xlink</code>.</div> |
| </div> |
| </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()" class="member-name-link">XLink</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new link.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.sis.xml.XLink)" class="member-name-link">XLink</a><wbr>(<a href="XLink.html" title="class in org.apache.sis.xml">XLink</a> link)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a new link as a copy of the given link.</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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Compares this <code>XLink</code> with the given object for equality.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#freeze()" class="member-name-link">freeze</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Marks this <code>xlink</code> as unmodifiable.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="XLink.Actuate.html" title="enum class in org.apache.sis.xml">XLink.Actuate</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getActuate()" class="member-name-link">getActuate</a>()</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 desired timing of traversal from the starting resource to the ending |
| resource.</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/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getArcRole()" class="member-name-link">getArcRole</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a URI reference for some description of the arc role.</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/11/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="#getFrom()" class="member-name-link">getFrom</a>()</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 starting resource.</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/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHRef()" class="member-name-link">getHRef</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a URN to an external resources, or to another part of a XML document, or an identifier.</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/11/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="#getLabel()" class="member-name-link">getLabel</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns an identification of the target of a <code>from</code> or <code>to</code> attribute.</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/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRole()" class="member-name-link">getRole</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a URI reference for some description of the arc role.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="XLink.Show.html" title="enum class in org.apache.sis.xml">XLink.Show</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getShow()" class="member-name-link">getShow</a>()</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 desired presentation of the ending resource on traversal |
| from the starting resource.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link">InternationalString</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTitle()" class="member-name-link">getTitle</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a human-readable string with a short description for the arc.</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/11/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="#getTo()" class="member-name-link">getTo</a>()</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 ending resource.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="XLink.Type.html" title="enum class in org.apache.sis.xml">XLink.Type</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getType()" class="member-name-link">getType</a>()</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 type of link.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a hash code value for this XLink.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setActuate(org.apache.sis.xml.XLink.Actuate)" class="member-name-link">setActuate</a><wbr>(<a href="XLink.Actuate.html" title="enum class in org.apache.sis.xml">XLink.Actuate</a> actuate)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the desired timing of traversal from the starting resource to the ending resource.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setArcRole(java.net.URI)" class="member-name-link">setArcRole</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> arcrole)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets a URI reference for some description of the arc role.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFrom(java.lang.String)" class="member-name-link">setFrom</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> from)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the starting resource.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setHRef(java.net.URI)" class="member-name-link">setHRef</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> href)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the URN to a resources.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLabel(java.lang.String)" class="member-name-link">setLabel</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> label)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets an identification of the target of a <code>from</code> or <code>to</code> attribute.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRole(java.net.URI)" class="member-name-link">setRole</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> role)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the URI reference for some description of the arc role.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setShow(org.apache.sis.xml.XLink.Show)" class="member-name-link">setShow</a><wbr>(<a href="XLink.Show.html" title="enum class in org.apache.sis.xml">XLink.Show</a> show)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the desired presentation of the ending resource on traversal from the starting resource.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTitle(org.opengis.util.InternationalString)" class="member-name-link">setTitle</a><wbr>(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link">InternationalString</a> title)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets a human-readable string with a short description for the arc.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTo(java.lang.String)" class="member-name-link">setTo</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> to)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the ending resource.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setType(org.apache.sis.xml.XLink.Type)" class="member-name-link">setType</a><wbr>(<a href="XLink.Type.html" title="enum class in org.apache.sis.xml">XLink.Type</a> type)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets the type of link.</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/11/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="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a string representation of this object.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/11/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/11/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/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/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/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/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/11/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/11/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="<init>()"> |
| <h3>XLink</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">XLink</span>()</div> |
| <div class="block">Creates a new link. The initial value of all attributes is <code>null</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.sis.xml.XLink)"> |
| <h3>XLink</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">XLink</span><wbr><span class="parameters">(<a href="XLink.html" title="class in org.apache.sis.xml">XLink</a> link)</span></div> |
| <div class="block">Creates a new link as a copy of the given link.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>link</code> - The link to copy, or <code>null</code> if none.</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="getType()"> |
| <h3>getType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="XLink.Type.html" title="enum class in org.apache.sis.xml">XLink.Type</a></span> <span class="element-name">getType</span>()</div> |
| <div class="block">Returns the type of link. May have one of the following values: |
| |
| <ul> |
| <li><b>simple:</b> a simple link</li> |
| <li><b>extended:</b> an extended, possibly multi-resource, link</li> |
| <li><b>locator:</b> a pointer to an external resource</li> |
| <li><b>resource:</b> an internal resource</li> |
| <li><b>arc:</b> a traversal rule between resources</li> |
| <li><b>title:</b> a descriptive title for another linking element</li> |
| </ul> |
| |
| The default value is <code>null</code>. If the <a href="#setType(org.apache.sis.xml.XLink.Type)"><code>setType(XLink.Type)</code></a> method has been |
| invoked with the <a href="XLink.Type.html#AUTO"><code>AUTO</code></a> enum, then this method |
| will infer a type from the attributes having a non-null value.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the type of link, or <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setType(org.apache.sis.xml.XLink.Type)"> |
| <h3>setType</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setType</span><wbr><span class="parameters">(<a href="XLink.Type.html" title="enum class in org.apache.sis.xml">XLink.Type</a> type)</span></div> |
| <div class="block">Sets the type of link. Any value different than <a href="XLink.Type.html#AUTO"><code>Type.AUTO</code></a> (including <code>null</code>) will overwrite the value inferred automatically by |
| <a href="#getType()"><code>getType()</code></a>. A <code>AUTO</code> value will enable automatic type detection.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>type</code> - the new type of link, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHRef()"> |
| <h3>getHRef</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></span> <span class="element-name">getHRef</span>()</div> |
| <div class="block">Returns a URN to an external resources, or to another part of a XML document, or an identifier.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a URN to a resources, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setHRef(java.net.URI)"> |
| <h3>setHRef</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setHRef</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> href)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></span></div> |
| <div class="block">Sets the URN to a resources.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>href</code> - a URN to a resources, or <code>null</code> if none.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if this <code>xlink</code> is unmodifiable.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the link type <a href="#setType(org.apache.sis.xml.XLink.Type)">has been explicitly set</a>. |
| and that type does not allow the <code>"href"</code> attribute.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRole()"> |
| <h3>getRole</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></span> <span class="element-name">getRole</span>()</div> |
| <div class="block">Returns a URI reference for some description of the arc role.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a URI reference for some description of the arc role, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRole(java.net.URI)"> |
| <h3>setRole</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setRole</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> role)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></span></div> |
| <div class="block">Sets the URI reference for some description of the arc role.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>role</code> - a URI reference for some description of the arc role, or <code>null</code> if none.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if this <code>xlink</code> is unmodifiable.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the link type <a href="#setType(org.apache.sis.xml.XLink.Type)">has been explicitly set</a>. |
| and that type does not allow the <code>"role"</code> attribute.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getArcRole()"> |
| <h3>getArcRole</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a></span> <span class="element-name">getArcRole</span>()</div> |
| <div class="block">Returns a URI reference for some description of the arc role.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a URI reference for some description of the arc role, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setArcRole(java.net.URI)"> |
| <h3>setArcRole</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setArcRole</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a> arcrole)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></span></div> |
| <div class="block">Sets a URI reference for some description of the arc role.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>arcrole</code> - a URI reference for some description of the arc role, or <code>null</code> if none.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if this <code>xlink</code> is unmodifiable.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the link type <a href="#setType(org.apache.sis.xml.XLink.Type)">has been explicitly set</a>. |
| and that type does not allow the <code>"arcrole"</code> attribute.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTitle()"> |
| <h3>getTitle</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link">InternationalString</a></span> <span class="element-name">getTitle</span>()</div> |
| <div class="block">Returns a human-readable string with a short description for the arc.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a human-readable string with a short description for the arc, or <code>null</code> if none.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTitle(org.opengis.util.InternationalString)"> |
| <h3>setTitle</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setTitle</span><wbr><span class="parameters">(<a href="http://www.geoapi.org/3.0/javadoc/org.opengis.geoapi/org/opengis/util/InternationalString.html" title="class or interface in org.opengis.util" class="external-link">InternationalString</a> title)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></span></div> |
| <div class="block">Sets a human-readable string with a short description for the arc.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>title</code> - a human-readable string with a short description for the arc, or <code>null</code> if none.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if this <code>xlink</code> is unmodifiable.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the link type <a href="#setType(org.apache.sis.xml.XLink.Type)">has been explicitly set</a>. |
| and that type does not allow the <code>"title"</code> attribute.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getShow()"> |
| <h3>getShow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="XLink.Show.html" title="enum class in org.apache.sis.xml">XLink.Show</a></span> <span class="element-name">getShow</span>()</div> |
| <div class="block">Returns the desired presentation of the ending resource on traversal |
| from the starting resource. It's value should be treated as follows: |
| |
| <ul> |
| <li><b>new:</b> load ending resource in a new window, frame, pane, or other presentation context</li> |
| <li><b>replace:</b> load the resource in the same window, frame, pane, or other presentation context</li> |
| <li><b>embed:</b> load ending resource in place of the presentation of the starting resource</li> |
| <li><b>other:</b> behavior is unconstrained; examine other markup in the link for hints</li> |
| <li><b>none:</b> behavior is unconstrained</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the desired presentation of the ending resource, or <code>null</code> if unspecified.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setShow(org.apache.sis.xml.XLink.Show)"> |
| <h3>setShow</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setShow</span><wbr><span class="parameters">(<a href="XLink.Show.html" title="enum class in org.apache.sis.xml">XLink.Show</a> show)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></span></div> |
| <div class="block">Sets the desired presentation of the ending resource on traversal from the starting resource.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>show</code> - the desired presentation of the ending resource, or <code>null</code> if unspecified.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if this <code>xlink</code> is unmodifiable.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the link type <a href="#setType(org.apache.sis.xml.XLink.Type)">has been explicitly set</a>. |
| and that type does not allow the <code>"show"</code> attribute.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getActuate()"> |
| <h3>getActuate</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="XLink.Actuate.html" title="enum class in org.apache.sis.xml">XLink.Actuate</a></span> <span class="element-name">getActuate</span>()</div> |
| <div class="block">Returns the desired timing of traversal from the starting resource to the ending |
| resource. It's value should be treated as follows: |
| |
| <ul> |
| <li><b>onLoad:</b> traverse to the ending resource immediately on loading the starting resource</li> |
| <li><b>onRequest:</b> traverse from the starting resource to the ending resource only on a post-loading event triggered for this purpose</li> |
| <li><b>other:</b> behavior is unconstrained; examine other markup in link for hints</li> |
| <li><b>none:</b> behavior is unconstrained</li> |
| </ul></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the desired timing of traversal from the starting resource to the ending resource, |
| or <code>null</code> if unspecified.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setActuate(org.apache.sis.xml.XLink.Actuate)"> |
| <h3>setActuate</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setActuate</span><wbr><span class="parameters">(<a href="XLink.Actuate.html" title="enum class in org.apache.sis.xml">XLink.Actuate</a> actuate)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></span></div> |
| <div class="block">Sets the desired timing of traversal from the starting resource to the ending resource.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>actuate</code> - the desired timing of traversal from the starting resource to the ending resource, |
| or <code>null</code> if unspecified.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if this <code>xlink</code> is unmodifiable.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the link type <a href="#setType(org.apache.sis.xml.XLink.Type)">has been explicitly set</a>. |
| and that type does not allow the <code>"actuate"</code> attribute.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLabel()"> |
| <h3>getLabel</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getLabel</span>()</div> |
| <div class="block">Returns an identification of the target of a <code>from</code> or <code>to</code> attribute.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an identification of the target of a <code>from</code> or <code>to</code> attribute, or <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLabel(java.lang.String)"> |
| <h3>setLabel</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setLabel</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> label)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></span></div> |
| <div class="block">Sets an identification of the target of a <code>from</code> or <code>to</code> attribute.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>label</code> - an identification of the target of a <code>from</code> or <code>to</code> attribute, or <code>null</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if this <code>xlink</code> is unmodifiable.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the link type <a href="#setType(org.apache.sis.xml.XLink.Type)">has been explicitly set</a>. |
| and that type does not allow the <code>"label"</code> attribute.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFrom()"> |
| <h3>getFrom</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getFrom</span>()</div> |
| <div class="block">Returns the starting resource. The value must correspond to the same value for some |
| <code>label</code> attribute.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the starting resource, or <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setFrom(java.lang.String)"> |
| <h3>setFrom</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setFrom</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> from)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></span></div> |
| <div class="block">Sets the starting resource. The value must correspond to the same value for some |
| <code>label</code> attribute.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>from</code> - the starting resource, or <code>null</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if this <code>xlink</code> is unmodifiable.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the link type <a href="#setType(org.apache.sis.xml.XLink.Type)">has been explicitly set</a>. |
| and that type does not allow the <code>"from"</code> attribute.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTo()"> |
| <h3>getTo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getTo</span>()</div> |
| <div class="block">Returns the ending resource. The value must correspond to the same value for some |
| <code>label</code> attribute.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the ending resource, or <code>null</code>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTo(java.lang.String)"> |
| <h3>setTo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setTo</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> to)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></span></div> |
| <div class="block">Sets the ending resource. The value must correspond to the same value for some |
| <code>label</code> attribute.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>to</code> - the ending resource, or <code>null</code>.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if this <code>xlink</code> is unmodifiable.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the link type <a href="#setType(org.apache.sis.xml.XLink.Type)">has been explicitly set</a>. |
| and that type does not allow the <code>"to"</code> attribute.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="freeze()"> |
| <h3>freeze</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">freeze</span>()</div> |
| <div class="block">Marks this <code>xlink</code> as unmodifiable. After this method call, any call to a setter |
| method will throw an <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link"><code>UnsupportedOperationException</code></a>. |
| |
| <p>After the first call to this method, any subsequent calls have no effect.</p></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equals(java.lang.Object)"> |
| <h3>equals</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> object)</span></div> |
| <div class="block">Compares this <code>XLink</code> with the given object for equality.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>object</code> - the object to compare with this XLink.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hashCode()"> |
| <h3>hashCode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> |
| <div class="block">Returns a hash code value for this XLink.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <div class="block">Returns a string representation of this object. The default implementation returns the |
| simple class name followed by non-null attributes, as in the example below: |
| |
| <pre class="text">XLink[type="locator", href="urn:ogc:def:method:EPSG::4326"]</pre></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| </div> |
| </div> |
| </body> |
| </html> |
