<!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>XMLSchemaService (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="XMLSchemaService (MetaCat API)"; } } catch(err) { } //--> var methods = {"i0":9,"i1":10,"i2":9,"i3":10,"i4":10,"i5":9,"i6":9,"i7":9,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":9,"i15":9,"i16":9,"i17":10,"i18":10,"i19":10,"i20":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/XMLSchemaService.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/XMLSchemaParser.html" title="class in edu.ucsb.nceas.metacat.service"><span class="typeNameLink">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?edu/ucsb/nceas/metacat/service/XMLSchemaService.html" target="_top">Frames</a></li> <li><a href="XMLSchemaService.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><a href="#field.summary">Field</a> | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field.detail">Field</a> | </li> <li>Constr | </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 XMLSchemaService" class="title">Class XMLSchemaService</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li><a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html" title="class in edu.ucsb.nceas.metacat.shared">edu.ucsb.nceas.metacat.shared.BaseService</a></li> <li> <ul class="inheritance"> <li>edu.ucsb.nceas.metacat.service.XMLSchemaService</li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="typeNameLabel">XMLSchemaService</span> extends <a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html" title="class in edu.ucsb.nceas.metacat.shared">BaseService</a></pre> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="field.summary"> <!-- --> </a> <h3>Field Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Field and Description</th> </tr> <tr 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/XMLSchemaService.html#NAMESPACEKEYWORD">NAMESPACEKEYWORD</a></span></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaService.html#SCHEMA_DIR">SCHEMA_DIR</a></span></code> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="fields.inherited.from.class.edu.ucsb.nceas.metacat.shared.BaseService"> <!-- --> </a> <h3>Fields inherited from class edu.ucsb.nceas.metacat.shared.<a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html" title="class in edu.ucsb.nceas.metacat.shared">BaseService</a></h3> <code><a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html#Z:Z_serviceName">_serviceName</a></code></li> </ul> </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>static boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaService.html#areAllSchemasRegistered-java.util.Vector-">areAllSchemasRegistered</a></span>(java.util.Vector<<a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html" title="class in edu.ucsb.nceas.metacat.service">XMLSchema</a>> schemaList)</code> <div class="block">Checks to see that all schemas are registered.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaService.html#doRefresh--">doRefresh</a></span>()</code> <div class="block">refresh the persistant values in this service.</div> </td> </tr> <tr id="i2" 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/XMLSchemaService.html#findDocumentNamespace-java.io.StringReader-">findDocumentNamespace</a></span>(java.io.StringReader xml)</code> <div class="block">Returns the namespace for an xml document.</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/XMLSchemaService.html#findNamespaceAndSchemaLocalLocation-java.lang.String-java.lang.String-">findNamespaceAndSchemaLocalLocation</a></span>(java.lang.String formatId, java.lang.String namespace)</code> <div class="block">Get the namespace-schemaLocation pairs string based on given formatId and namespace.</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/XMLSchemaService.html#findNoNamespaceSchemaLocalLocation-java.lang.String-java.lang.String-">findNoNamespaceSchemaLocalLocation</a></span>(java.lang.String formatId, java.lang.String noNamespaceSchemaLocation)</code> <div class="block">Get the local (official) location for a no-namespace schema based on the given format id or no-name-space schema location uri.</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaService.html#findNoNamespaceSchemaLocationAttr-java.io.StringReader-">findNoNamespaceSchemaLocationAttr</a></span>(java.io.StringReader xml)</code> <div class="block">Get the attribute value of the noNamespaceSchemaLcation of the given xml</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>static java.util.Vector<<a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html" title="class in edu.ucsb.nceas.metacat.service">XMLSchema</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaService.html#findSchemasInXML-java.io.StringReader-">findSchemasInXML</a></span>(java.io.StringReader xml)</code> <div class="block">See if schemas have been specified in the xml:schemalocation attribute.</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaService.html#getBaseUrlFromSchemaURL-java.lang.String-">getBaseUrlFromSchemaURL</a></span>(java.lang.String url)</code> <div class="block">Get a base url from the schema url.</div> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>static <a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaService.html" title="class in edu.ucsb.nceas.metacat.service">XMLSchemaService</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaService.html#getInstance--">getInstance</a></span>()</code> <div class="block">Get the single instance of XMLService.</div> </td> </tr> <tr id="i9" 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/XMLSchemaService.html#getNameSpaceAndLocation-java.lang.String-">getNameSpaceAndLocation</a></span>(java.lang.String formatId)</code> <div class="block">Get the all schema-location pairs registered for the formatId.</div> </td> </tr> <tr id="i10" 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/XMLSchemaService.html#getNameSpaceAndLocationStringWithoutFormatId--">getNameSpaceAndLocationStringWithoutFormatId</a></span>()</code> <div class="block">Gets the name space and location string.</div> </td> </tr> <tr id="i11" class="rowColor"> <td class="colFirst"><code>java.util.Vector<java.lang.String></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaService.html#getNameSpaceList--">getNameSpaceList</a></span>()</code> <div class="block">Gets a list of name spaces.</div> </td> </tr> <tr id="i12" class="altColor"> <td class="colFirst"><code>java.util.Vector<<a href="../../../../../edu/ucsb/nceas/metacat/service/XMLNoNamespaceSchema.html" title="class in edu.ucsb.nceas.metacat.service">XMLNoNamespaceSchema</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaService.html#getRegisteredNoNamespaceSchemaList--">getRegisteredNoNamespaceSchemaList</a></span>()</code> <div class="block">Gets the registered schema list without the name space.</div> </td> </tr> <tr id="i13" class="rowColor"> <td class="colFirst"><code>java.util.Vector<<a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html" title="class in edu.ucsb.nceas.metacat.service">XMLSchema</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaService.html#getRegisteredSchemaList--">getRegisteredSchemaList</a></span>()</code> <div class="block">Gets the registered schema list.</div> </td> </tr> <tr id="i14" 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/XMLSchemaService.html#getSchemaFileNameFromUri-java.lang.String-">getSchemaFileNameFromUri</a></span>(java.lang.String uri)</code> <div class="block">Get a schema file name from the schema uri.</div> </td> </tr> <tr id="i15" class="rowColor"> <td class="colFirst"><code>static boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaService.html#isNamespaceRegistered-java.lang.String-">isNamespaceRegistered</a></span>(java.lang.String namespace)</code> <div class="block">Test if the given namespace registered in Metacat</div> </td> </tr> <tr id="i16" class="altColor"> <td class="colFirst"><code>static boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaService.html#isSchemaRegistered-edu.ucsb.nceas.metacat.service.XMLSchema-">isSchemaRegistered</a></span>(<a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html" title="class in edu.ucsb.nceas.metacat.service">XMLSchema</a> xmlSchema)</code> <div class="block">Returns true if the schema is registered.</div> </td> </tr> <tr id="i17" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaService.html#populateRegisteredSchemaList--">populateRegisteredSchemaList</a></span>()</code> <div class="block">Populate the list of registered schemas.</div> </td> </tr> <tr id="i18" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaService.html#refreshable--">refreshable</a></span>()</code> </td> </tr> <tr id="i19" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaService.html#stop--">stop</a></span>()</code> </td> </tr> <tr id="i20" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaService.html#useFullSchemaValidation--">useFullSchemaValidation</a></span>()</code> <div class="block">Report whether xml parsing is set to use full schema parsing.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.edu.ucsb.nceas.metacat.shared.BaseService"> <!-- --> </a> <h3>Methods inherited from class edu.ucsb.nceas.metacat.shared.<a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html" title="class in edu.ucsb.nceas.metacat.shared">BaseService</a></h3> <code><a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html#refresh--">refresh</a></code></li> </ul> <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"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="field.detail"> <!-- --> </a> <h3>Field Detail</h3> <a name="NAMESPACEKEYWORD"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>NAMESPACEKEYWORD</h4> <pre>public static final java.lang.String NAMESPACEKEYWORD</pre> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../../constant-values.html#edu.ucsb.nceas.metacat.service.XMLSchemaService.NAMESPACEKEYWORD">Constant Field Values</a></dd> </dl> </li> </ul> <a name="SCHEMA_DIR"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>SCHEMA_DIR</h4> <pre>public static final java.lang.String SCHEMA_DIR</pre> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../../constant-values.html#edu.ucsb.nceas.metacat.service.XMLSchemaService.SCHEMA_DIR">Constant Field Values</a></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="getInstance--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getInstance</h4> <pre>public static <a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchemaService.html" title="class in edu.ucsb.nceas.metacat.service">XMLSchemaService</a> getInstance()</pre> <div class="block">Get the single instance of XMLService.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the single instance of XMLService</dd> </dl> </li> </ul> <a name="refreshable--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>refreshable</h4> <pre>public boolean refreshable()</pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html#refreshable--">refreshable</a></code> in class <code><a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html" title="class in edu.ucsb.nceas.metacat.shared">BaseService</a></code></dd> </dl> </li> </ul> <a name="doRefresh--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>doRefresh</h4> <pre>public void doRefresh() throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre> <div class="block">refresh the persistant values in this service.</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html#doRefresh--">doRefresh</a></code> in class <code><a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html" title="class in edu.ucsb.nceas.metacat.shared">BaseService</a></code></dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd> </dl> </li> </ul> <a name="stop--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>stop</h4> <pre>public void stop() throws <a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html#stop--">stop</a></code> in class <code><a href="../../../../../edu/ucsb/nceas/metacat/shared/BaseService.html" title="class in edu.ucsb.nceas.metacat.shared">BaseService</a></code></dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="../../../../../edu/ucsb/nceas/metacat/shared/ServiceException.html" title="class in edu.ucsb.nceas.metacat.shared">ServiceException</a></code></dd> </dl> </li> </ul> <a name="getRegisteredSchemaList--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getRegisteredSchemaList</h4> <pre>public java.util.Vector<<a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html" title="class in edu.ucsb.nceas.metacat.service">XMLSchema</a>> getRegisteredSchemaList()</pre> <div class="block">Gets the registered schema list. This list holds schemas that exist in the xml_catalog table that also have associated files in the schema directory.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>a list of XMLSchema objects holding registered schema information</dd> </dl> </li> </ul> <a name="getRegisteredNoNamespaceSchemaList--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getRegisteredNoNamespaceSchemaList</h4> <pre>public java.util.Vector<<a href="../../../../../edu/ucsb/nceas/metacat/service/XMLNoNamespaceSchema.html" title="class in edu.ucsb.nceas.metacat.service">XMLNoNamespaceSchema</a>> getRegisteredNoNamespaceSchemaList()</pre> <div class="block">Gets the registered schema list without the name space. This list holds schemas without the name space that exist in the xml_catalog table that also have associated files in the schema directory.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>a list of XMLNoNamespaceSchema objects</dd> </dl> </li> </ul> <a name="getNameSpaceAndLocationStringWithoutFormatId--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getNameSpaceAndLocationStringWithoutFormatId</h4> <pre>public java.lang.String getNameSpaceAndLocationStringWithoutFormatId()</pre> <div class="block">Gets the name space and location string. This is a convenience method. The string will have space delimited namespaces and locations that are held in the registered schema list. This is the old way Metacat worked. Usually, we will call the method getNameSapceAndLocation(String formatId) first. If the method return null, we will call this method.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>a string that holds space delimited registered namespaces and locations.</dd> </dl> </li> </ul> <a name="getNameSpaceAndLocation-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getNameSpaceAndLocation</h4> <pre>public java.lang.String getNameSpaceAndLocation(java.lang.String formatId)</pre> <div class="block">Get the all schema-location pairs registered for the formatId. The null will be returned, if we can find it.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>formatId</code> - </dd> <dt><span class="returnLabel">Returns:</span></dt> </dl> </li> </ul> <a name="getNameSpaceList--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getNameSpaceList</h4> <pre>public java.util.Vector<java.lang.String> getNameSpaceList()</pre> <div class="block">Gets a list of name spaces. This is a convenience method. The list will have all namespaces that are held in the registered schema list.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>a list that holds registered namespaces.</dd> </dl> </li> </ul> <a name="useFullSchemaValidation--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>useFullSchemaValidation</h4> <pre>public boolean useFullSchemaValidation()</pre> <div class="block">Report whether xml parsing is set to use full schema parsing. If full schema parsing is true, new schemas will be validated before being entered into the database and file system.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>true if the xml.useFullSchemaValidation property is set to true, false otherwise.</dd> </dl> </li> </ul> <a name="populateRegisteredSchemaList--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>populateRegisteredSchemaList</h4> <pre>public void populateRegisteredSchemaList()</pre> <div class="block">Populate the list of registered schemas. This reads all schemas in the xml_catalog table and then makes sure the schema actually exists and is readable on disk.</div> </li> </ul> <a name="areAllSchemasRegistered-java.util.Vector-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>areAllSchemasRegistered</h4> <pre>public static boolean areAllSchemasRegistered(java.util.Vector<<a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html" title="class in edu.ucsb.nceas.metacat.service">XMLSchema</a>> schemaList)</pre> <div class="block">Checks to see that all schemas are registered. If a single one in the list is not, this will return false.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>schemaList</code> - a list of schemas as they appear in xml.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>true if all schemas are registered.</dd> </dl> </li> </ul> <a name="isSchemaRegistered-edu.ucsb.nceas.metacat.service.XMLSchema-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isSchemaRegistered</h4> <pre>public static boolean isSchemaRegistered(<a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html" title="class in edu.ucsb.nceas.metacat.service">XMLSchema</a> xmlSchema)</pre> <div class="block">Returns true if the schema is registered.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>schema</code> - a single schema as it appears in xml</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>true if the schema is registered, false otherwise.</dd> </dl> </li> </ul> <a name="isNamespaceRegistered-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>isNamespaceRegistered</h4> <pre>public static boolean isNamespaceRegistered(java.lang.String namespace)</pre> <div class="block">Test if the given namespace registered in Metacat</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>namespace</code> - the namespace will be tested</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>true if the namespace is registered; otherwise false.</dd> </dl> </li> </ul> <a name="findNamespaceAndSchemaLocalLocation-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>findNamespaceAndSchemaLocalLocation</h4> <pre>public java.lang.String findNamespaceAndSchemaLocalLocation(java.lang.String formatId, java.lang.String namespace) throws <a href="../../../../../edu/ucsb/nceas/metacat/client/MetacatException.html" title="class in edu.ucsb.nceas.metacat.client">MetacatException</a></pre> <div class="block">Get the namespace-schemaLocation pairs string based on given formatId and namespace. The algorithm is: 1. Look up all pairs of namespace--schemalocation for the given formatId in the xml_catalog table. If we find it, return all of the pairs. 2. If we can't find anything on the step 1, look up the record for the given namespace. If we find it, return all of pairs namespace-location without formatid. 3. Return null if we can't find anything.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>formatId</code> - the given format id</dd> <dd><code>namespace</code> - the given namespace</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>the string of the namespace-schemaLocation pairs (separated by white spaces). The null will be returned, if we can't find one.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="../../../../../edu/ucsb/nceas/metacat/client/MetacatException.html" title="class in edu.ucsb.nceas.metacat.client">MetacatException</a></code></dd> </dl> </li> </ul> <a name="findNoNamespaceSchemaLocalLocation-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>findNoNamespaceSchemaLocalLocation</h4> <pre>public java.lang.String findNoNamespaceSchemaLocalLocation(java.lang.String formatId, java.lang.String noNamespaceSchemaLocation) throws <a href="../../../../../edu/ucsb/nceas/metacat/client/MetacatException.html" title="class in edu.ucsb.nceas.metacat.client">MetacatException</a></pre> <div class="block">Get the local (official) location for a no-namespace schema based on the given format id or no-name-space schema location uri. The format id has the higher priority 1. Compare the given format id with all registered no-namespace schema. If a match is found, return it. 2. If the step 1 return null, compare the given noNamespaceSchemaLocationuri.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>formatId</code> - </dd> <dd><code>noNamespaceSchemaLocation</code> - </dd> <dt><span class="returnLabel">Returns:</span></dt> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="../../../../../edu/ucsb/nceas/metacat/client/MetacatException.html" title="class in edu.ucsb.nceas.metacat.client">MetacatException</a></code></dd> </dl> </li> </ul> <a name="findSchemasInXML-java.io.StringReader-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>findSchemasInXML</h4> <pre>public static java.util.Vector<<a href="../../../../../edu/ucsb/nceas/metacat/service/XMLSchema.html" title="class in edu.ucsb.nceas.metacat.service">XMLSchema</a>> findSchemasInXML(java.io.StringReader xml) throws java.io.IOException</pre> <div class="block">See if schemas have been specified in the xml:schemalocation attribute. If so, return a vector of the system ids.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>xml</code> - the document we want to look in for schema location</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a vector of XMLSchema objects, or an empty vector if none are found</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.io.IOException</code></dd> </dl> </li> </ul> <a name="findDocumentNamespace-java.io.StringReader-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>findDocumentNamespace</h4> <pre>public static java.lang.String findDocumentNamespace(java.io.StringReader xml) throws java.io.IOException, edu.ucsb.nceas.utilities.PropertyNotFoundException, org.xml.sax.SAXException</pre> <div class="block">Returns the namespace for an xml document.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>xml</code> - the document to search</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a string holding the namespace. Null will be returned if there is no namespace.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>org.xml.sax.SAXException</code></dd> <dd><code>edu.ucsb.nceas.utilities.PropertyNotFoundException</code></dd> <dd><code>java.io.IOException</code></dd> </dl> </li> </ul> <a name="findNoNamespaceSchemaLocationAttr-java.io.StringReader-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>findNoNamespaceSchemaLocationAttr</h4> <pre>public static java.lang.String findNoNamespaceSchemaLocationAttr(java.io.StringReader xml) throws edu.ucsb.nceas.utilities.PropertyNotFoundException, org.xml.sax.SAXException, java.io.IOException</pre> <div class="block">Get the attribute value of the noNamespaceSchemaLcation of the given xml</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>xml</code> - the xml obect needs to be searched</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>the attribute value of the noNamespaceSchemaLcation. The null will return if it can't be found.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>org.xml.sax.SAXException</code></dd> <dd><code>edu.ucsb.nceas.utilities.PropertyNotFoundException</code></dd> <dd><code>java.io.IOException</code></dd> </dl> </li> </ul> <a name="getSchemaFileNameFromUri-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSchemaFileNameFromUri</h4> <pre>public static java.lang.String getSchemaFileNameFromUri(java.lang.String uri)</pre> <div class="block">Get a schema file name from the schema uri.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>uri</code> - the uri from which to extract the file name</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a string holding the file name</dd> </dl> </li> </ul> <a name="getBaseUrlFromSchemaURL-java.lang.String-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>getBaseUrlFromSchemaURL</h4> <pre>public static java.lang.String getBaseUrlFromSchemaURL(java.lang.String url)</pre> <div class="block">Get a base url from the schema url. If url=http://www.example.com/example.xsd, http://www.example.com/ will be returned.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>uri</code> - the uri from which to extract the base url</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a string holding the base url. null will be return if it is not url.</dd> </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/XMLSchemaService.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/XMLSchemaParser.html" title="class in edu.ucsb.nceas.metacat.service"><span class="typeNameLink">Prev Class</span></a></li> <li>Next Class</li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?edu/ucsb/nceas/metacat/service/XMLSchemaService.html" target="_top">Frames</a></li> <li><a href="XMLSchemaService.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><a href="#field.summary">Field</a> | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field.detail">Field</a> | </li> <li>Constr | </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>