<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_265) on Tue Aug 25 19:30:52 UTC 2020 -->
<title>XMLSchema (MetaCat API)</title>
<meta name="date" content="2020-08-25">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="XMLSchema (MetaCat API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":9,"i7":10,"i8":10,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/XMLSchema.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">
<li><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLNoNamespaceSchema.html" title="class in edu.ucsb.nceas.metacat.service"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaParser.html" title="class in edu.ucsb.nceas.metacat.service"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?edu/ucsb/nceas/metacat/service/XMLSchema.html" target="_top">Frames</a></li>
<li><a href="XMLSchema.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">edu.ucsb.nceas.metacat.service</div>
<h2 title="Class XMLSchema" class="title">Class XMLSchema</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>edu.ucsb.nceas.metacat.service.XMLSchema</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLNoNamespaceSchema.html" title="class in edu.ucsb.nceas.metacat.service">XMLNoNamespaceSchema</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">XMLSchema</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html#XMLSchema-java.lang.String-java.lang.String-java.lang.String-">XMLSchema</a></span>(java.lang.String fileNamespace,
java.lang.String externalFileUri,
java.lang.String formatId)</code>
<div class="block">Constructor - the schema file name will be extracted from the external
file uri.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html#getExternalFileUri--">getExternalFileUri</a></span>()</code>
<div class="block">Gets the external file uri</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html#getFileName--">getFileName</a></span>()</code>
<div class="block">Gets the file name</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html#getFileNamespace--">getFileNamespace</a></span>()</code>
<div class="block">Gets the file namespace</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html#getFormatId--">getFormatId</a></span>()</code>
<div class="block">Get the format id</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html#getLocalFileDir--">getLocalFileDir</a></span>()</code>
<div class="block">Gets the local file directory path</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html#getLocalFileUri--">getLocalFileUri</a></span>()</code>
<div class="block">Gets the local file uri</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html#getType--">getType</a></span>()</code>
<div class="block">Return the type of the schema.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html#setExternalFileUri-java.lang.String-">setExternalFileUri</a></span>(java.lang.String externalFileUri)</code>
<div class="block">Sets the external file uri.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html#setFileName-java.lang.String-">setFileName</a></span>(java.lang.String fileName)</code>
<div class="block">Set the file name.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html#setFileNamespace-java.lang.String-">setFileNamespace</a></span>(java.lang.String fileNamespace)</code>
<div class="block">Sets the file namespace</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html#setFormatId-java.lang.String-">setFormatId</a></span>(java.lang.String formatId)</code>
<div class="block">Set the format id.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="XMLSchema-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>XMLSchema</h4>
<pre>public XMLSchema(java.lang.String fileNamespace,
java.lang.String externalFileUri,
java.lang.String formatId)</pre>
<div class="block">Constructor - the schema file name will be extracted from the external
file uri. The local file uri and local file dir will be constructed using
system values and the file name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fileNamespace</code> - the file's name space</dd>
<dd><code>externalFileUri</code> - the external uri where the schema is located</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setFileName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFileName</h4>
<pre>public void setFileName(java.lang.String fileName)</pre>
<div class="block">Set the file name. The local file uri and local file dir will also get
set using system context url and dir values and the schema directory
value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fileName</code> - the file name to set</dd>
</dl>
</li>
</ul>
<a name="getFileName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFileName</h4>
<pre>public java.lang.String getFileName()</pre>
<div class="block">Gets the file name</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>string holding the file name</dd>
</dl>
</li>
</ul>
<a name="setFileNamespace-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFileNamespace</h4>
<pre>public void setFileNamespace(java.lang.String fileNamespace)</pre>
<div class="block">Sets the file namespace</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fileNamespace</code> - the namespace to set</dd>
</dl>
</li>
</ul>
<a name="getFileNamespace--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFileNamespace</h4>
<pre>public java.lang.String getFileNamespace()</pre>
<div class="block">Gets the file namespace</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string holding the file namespace</dd>
</dl>
</li>
</ul>
<a name="setExternalFileUri-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExternalFileUri</h4>
<pre>public void setExternalFileUri(java.lang.String externalFileUri)</pre>
<div class="block">Sets the external file uri. Extracts the file name from the uri and sets
the file name as well.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>externalFileUri</code> - the external file uri to set</dd>
</dl>
</li>
</ul>
<a name="getExternalFileUri--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExternalFileUri</h4>
<pre>public java.lang.String getExternalFileUri()</pre>
<div class="block">Gets the external file uri</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string holding the external file uri</dd>
</dl>
</li>
</ul>
<a name="getLocalFileUri--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalFileUri</h4>
<pre>public java.lang.String getLocalFileUri()</pre>
<div class="block">Gets the local file uri</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string holding the local file uri</dd>
</dl>
</li>
</ul>
<a name="getLocalFileDir--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalFileDir</h4>
<pre>public java.lang.String getLocalFileDir()</pre>
<div class="block">Gets the local file directory path</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string holding the local file directory path</dd>
</dl>
</li>
</ul>
<a name="getFormatId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormatId</h4>
<pre>public java.lang.String getFormatId()</pre>
<div class="block">Get the format id</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the format id</dd>
</dl>
</li>
</ul>
<a name="setFormatId-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFormatId</h4>
<pre>public void setFormatId(java.lang.String formatId)</pre>
<div class="block">Set the format id.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>formatId.</code> - </dd>
</dl>
</li>
</ul>
<a name="getType--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getType</h4>
<pre>public static java.lang.String getType()</pre>
<div class="block">Return the type of the schema. It always is "Schema"</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/XMLSchema.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">
<li><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLNoNamespaceSchema.html" title="class in edu.ucsb.nceas.metacat.service"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaParser.html" title="class in edu.ucsb.nceas.metacat.service"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?edu/ucsb/nceas/metacat/service/XMLSchema.html" target="_top">Frames</a></li>
<li><a href="XMLSchema.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><i>Copyright © 2020 Regents of the University of California. All Rights Reserved.</i></small></p>
</body>
</html>