| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.4) on Fri Sep 20 12:10:30 CEST 2019 --> |
| <title>XLink (Apache SIS 1.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2019-09-20"> |
| <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="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="XLink (Apache SIS 1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/XLink.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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.sis.xml</a></div> |
| <h2 title="Class XLink" class="title">Class XLink</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>XLink</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">XLink</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> |
| implements <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></pre> |
| <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> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.3</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="http://www.w3.org/TR/xlink/">XML Linking Language</a>, |
| <a href="http://schemas.opengis.net/xlink/1.0.0/xlinks.xsd">OGC schema</a>, |
| <a href="../../../../serialized-form.html#org.apache.sis.xml.XLink">Serialized Form</a></dd> |
| |
| <p><font size="-1">Defined in the <code>sis-metadata</code> module</font></p> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="XLink.Actuate.html" title="enum in org.apache.sis.xml">XLink.Actuate</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Communicates the desired timing of traversal from the starting resource to the ending |
| resource.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="XLink.Show.html" title="enum in org.apache.sis.xml">XLink.Show</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Communicates the desired presentation of the ending resource on traversal |
| from the starting resource.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="XLink.Type.html" title="enum in org.apache.sis.xml">XLink.Type</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">The type of a <code>xlink</code>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">XLink</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new link.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.sis.xml.XLink)">XLink</a></span>​(<a href="XLink.html" title="class in org.apache.sis.xml">XLink</a> link)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a new link as a copy of the given link.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> object)</code></th> |
| <td class="colLast"> |
| <div class="block">Compares this <code>XLink</code> with the given object for equality.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#freeze()">freeze</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Marks this <code>xlink</code> as unmodifiable.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="XLink.Actuate.html" title="enum in org.apache.sis.xml">XLink.Actuate</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getActuate()">getActuate</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the desired timing of traversal from the starting resource to the ending |
| resource.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getArcRole()">getArcRole</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a URI reference for some description of the arc role.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFrom()">getFrom</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the starting resource.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHRef()">getHRef</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a URN to an external resources, or to an other part of a XML document, or an identifier.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLabel()">getLabel</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an identification of the target of a <code>from</code> or <code>to</code> attribute.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRole()">getRole</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a URI reference for some description of the arc role.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="XLink.Show.html" title="enum in org.apache.sis.xml">XLink.Show</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getShow()">getShow</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the desired presentation of the ending resource on traversal |
| from the starting resource.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">InternationalString</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTitle()">getTitle</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a human-readable string with a short description for the arc.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTo()">getTo</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the ending resource.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="XLink.Type.html" title="enum in org.apache.sis.xml">XLink.Type</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getType()">getType</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the type of link.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a hash code value for this XLink.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setActuate(org.apache.sis.xml.XLink.Actuate)">setActuate</a></span>​(<a href="XLink.Actuate.html" title="enum in org.apache.sis.xml">XLink.Actuate</a> actuate)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the desired timing of traversal from the starting resource to the ending resource.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setArcRole(java.net.URI)">setArcRole</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a> arcrole)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets a URI reference for some description of the arc role.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFrom(java.lang.String)">setFrom</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> from)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the starting resource.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHRef(java.net.URI)">setHRef</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a> href)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the URN to a resources.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLabel(java.lang.String)">setLabel</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> label)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets an identification of the target of a <code>from</code> or <code>to</code> attribute.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRole(java.net.URI)">setRole</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a> role)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the URI reference for some description of the arc role.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setShow(org.apache.sis.xml.XLink.Show)">setShow</a></span>​(<a href="XLink.Show.html" title="enum in org.apache.sis.xml">XLink.Show</a> show)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the desired presentation of the ending resource on traversal from the starting resource.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTitle(org.opengis.util.InternationalString)">setTitle</a></span>​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">InternationalString</a> title)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets a human-readable string with a short description for the arc.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTo(java.lang.String)">setTo</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> to)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the ending resource.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setType(org.apache.sis.xml.XLink.Type)">setType</a></span>​(<a href="XLink.Type.html" title="enum in org.apache.sis.xml">XLink.Type</a> type)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the type of link.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a string representation of this object.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>XLink</h4> |
| <pre>public XLink()</pre> |
| <div class="block">Creates a new link. The initial value of all attributes is <code>null</code>.</div> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.sis.xml.XLink)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>XLink</h4> |
| <pre>public XLink​(<a href="XLink.html" title="class in org.apache.sis.xml">XLink</a> link)</pre> |
| <div class="block">Creates a new link as a copy of the given link.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>link</code> - The link to copy, or <code>null</code> if none.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getType()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getType</h4> |
| <pre class="methodSignature">public <a href="XLink.Type.html" title="enum in org.apache.sis.xml">XLink.Type</a> getType()</pre> |
| <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> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the type of link, or <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setType(org.apache.sis.xml.XLink.Type)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setType</h4> |
| <pre class="methodSignature">public void setType​(<a href="XLink.Type.html" title="enum in org.apache.sis.xml">XLink.Type</a> type)</pre> |
| <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> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>type</code> - the new type of link, or <code>null</code> if none.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getHRef()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHRef</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a> getHRef()</pre> |
| <div class="block">Returns a URN to an external resources, or to an other part of a XML document, or an identifier.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a URN to a resources, or <code>null</code> if none.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setHRef(java.net.URI)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setHRef</h4> |
| <pre class="methodSignature">public void setHRef​(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a> href) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block">Sets the URN to a resources.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>href</code> - a URN to a resources, or <code>null</code> if none.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang" class="externalLink">UnsupportedOperationException</a></code> - if this <code>xlink</code> is unmodifiable.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">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> |
| </li> |
| </ul> |
| <a id="getRole()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRole</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a> getRole()</pre> |
| <div class="block">Returns a URI reference for some description of the arc role.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a URI reference for some description of the arc role, or <code>null</code> if none.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setRole(java.net.URI)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRole</h4> |
| <pre class="methodSignature">public void setRole​(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a> role) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block">Sets the URI reference for some description of the arc role.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>role</code> - a URI reference for some description of the arc role, or <code>null</code> if none.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang" class="externalLink">UnsupportedOperationException</a></code> - if this <code>xlink</code> is unmodifiable.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">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> |
| </li> |
| </ul> |
| <a id="getArcRole()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArcRole</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a> getArcRole()</pre> |
| <div class="block">Returns a URI reference for some description of the arc role.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a URI reference for some description of the arc role, or <code>null</code> if none.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setArcRole(java.net.URI)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setArcRole</h4> |
| <pre class="methodSignature">public void setArcRole​(<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net" class="externalLink">URI</a> arcrole) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block">Sets a URI reference for some description of the arc role.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>arcrole</code> - a URI reference for some description of the arc role, or <code>null</code> if none.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang" class="externalLink">UnsupportedOperationException</a></code> - if this <code>xlink</code> is unmodifiable.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">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> |
| </li> |
| </ul> |
| <a id="getTitle()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTitle</h4> |
| <pre class="methodSignature">public <a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">InternationalString</a> getTitle()</pre> |
| <div class="block">Returns a human-readable string with a short description for the arc.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a human-readable string with a short description for the arc, or <code>null</code> if none.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setTitle(org.opengis.util.InternationalString)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTitle</h4> |
| <pre class="methodSignature">public void setTitle​(<a href="http://www.geoapi.org/3.0/javadoc/org/opengis/util/InternationalString.html?is-external=true" title="class or interface in org.opengis.util" class="externalLink">InternationalString</a> title) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block">Sets a human-readable string with a short description for the arc.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>title</code> - a human-readable string with a short description for the arc, or <code>null</code> if none.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang" class="externalLink">UnsupportedOperationException</a></code> - if this <code>xlink</code> is unmodifiable.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">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> |
| </li> |
| </ul> |
| <a id="getShow()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getShow</h4> |
| <pre class="methodSignature">public <a href="XLink.Show.html" title="enum in org.apache.sis.xml">XLink.Show</a> getShow()</pre> |
| <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> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the desired presentation of the ending resource, or <code>null</code> if unspecified.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setShow(org.apache.sis.xml.XLink.Show)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShow</h4> |
| <pre class="methodSignature">public void setShow​(<a href="XLink.Show.html" title="enum in org.apache.sis.xml">XLink.Show</a> show) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block">Sets the desired presentation of the ending resource on traversal from the starting resource.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>show</code> - the desired presentation of the ending resource, or <code>null</code> if unspecified.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang" class="externalLink">UnsupportedOperationException</a></code> - if this <code>xlink</code> is unmodifiable.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">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> |
| </li> |
| </ul> |
| <a id="getActuate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getActuate</h4> |
| <pre class="methodSignature">public <a href="XLink.Actuate.html" title="enum in org.apache.sis.xml">XLink.Actuate</a> getActuate()</pre> |
| <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> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the desired timing of traversal from the starting resource to the ending resource, |
| or <code>null</code> if unspecified.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setActuate(org.apache.sis.xml.XLink.Actuate)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setActuate</h4> |
| <pre class="methodSignature">public void setActuate​(<a href="XLink.Actuate.html" title="enum in org.apache.sis.xml">XLink.Actuate</a> actuate) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block">Sets the desired timing of traversal from the starting resource to the ending resource.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang" class="externalLink">UnsupportedOperationException</a></code> - if this <code>xlink</code> is unmodifiable.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">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> |
| </li> |
| </ul> |
| <a id="getLabel()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLabel</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getLabel()</pre> |
| <div class="block">Returns an identification of the target of a <code>from</code> or <code>to</code> attribute.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an identification of the target of a <code>from</code> or <code>to</code> attribute, or <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setLabel(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setLabel</h4> |
| <pre class="methodSignature">public void setLabel​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> label) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block">Sets an identification of the target of a <code>from</code> or <code>to</code> attribute.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang" class="externalLink">UnsupportedOperationException</a></code> - if this <code>xlink</code> is unmodifiable.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">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> |
| </li> |
| </ul> |
| <a id="getFrom()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFrom</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getFrom()</pre> |
| <div class="block">Returns the starting resource. The value must correspond to the same value for some |
| <code>label</code> attribute.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the starting resource, or <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setFrom(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFrom</h4> |
| <pre class="methodSignature">public void setFrom​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> from) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block">Sets the starting resource. The value must correspond to the same value for some |
| <code>label</code> attribute.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>from</code> - the starting resource, or <code>null</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang" class="externalLink">UnsupportedOperationException</a></code> - if this <code>xlink</code> is unmodifiable.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">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> |
| </li> |
| </ul> |
| <a id="getTo()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTo</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getTo()</pre> |
| <div class="block">Returns the ending resource. The value must correspond to the same value for some |
| <code>label</code> attribute.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the ending resource, or <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setTo(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTo</h4> |
| <pre class="methodSignature">public void setTo​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> to) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IllegalStateException</a></pre> |
| <div class="block">Sets the ending resource. The value must correspond to the same value for some |
| <code>label</code> attribute.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>to</code> - the ending resource, or <code>null</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang" class="externalLink">UnsupportedOperationException</a></code> - if this <code>xlink</code> is unmodifiable.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang" class="externalLink">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> |
| </li> |
| </ul> |
| <a id="freeze()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>freeze</h4> |
| <pre class="methodSignature">public void freeze()</pre> |
| <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/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang" class="externalLink"><code>UnsupportedOperationException</code></a>. |
| |
| <p>After the first call to this method, any subsequent calls have no effect.</p></div> |
| </li> |
| </ul> |
| <a id="equals(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>equals</h4> |
| <pre class="methodSignature">public boolean equals​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> object)</pre> |
| <div class="block">Compares this <code>XLink</code> with the given object for equality.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>object</code> - the object to compare with this XLink.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="hashCode()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hashCode</h4> |
| <pre class="methodSignature">public int hashCode()</pre> |
| <div class="block">Returns a hash code value for this XLink.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> toString()</pre> |
| <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: |
| |
| <blockquote><pre>XLink[type="locator", href="urn:ogc:def:method:EPSG::4326"]</pre></blockquote></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/XLink.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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <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="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2010–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
