<!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:50 UTC 2020 --> <title>DBEntityResolver (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="DBEntityResolver (MetaCat API)"; } } catch(err) { } //--> var methods = {"i0":9,"i1":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/DBEntityResolver.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/DBDTDHandler.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../edu/ucsb/nceas/metacat/DBQuery.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?edu/ucsb/nceas/metacat/DBEntityResolver.html" target="_top">Frames</a></li> <li><a href="DBEntityResolver.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</div> <h2 title="Class DBEntityResolver" class="title">Class DBEntityResolver</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>edu.ucsb.nceas.metacat.DBEntityResolver</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>org.xml.sax.EntityResolver</dd> </dl> <hr> <br> <pre>public class <span class="typeNameLabel">DBEntityResolver</span> extends java.lang.Object implements org.xml.sax.EntityResolver</pre> <div class="block">A database aware Class implementing EntityResolver interface for the SAX parser to call when processing the XML stream and intercepting any external entities (including the external DTD subset and external parameter entities, if any) before including them.</div> </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/DBEntityResolver.html#DBEntityResolver-edu.ucsb.nceas.metacat.database.DBConnection-">DBEntityResolver</a></span>(<a href="../../../../edu/ucsb/nceas/metacat/database/DBConnection.html" title="class in edu.ucsb.nceas.metacat.database">DBConnection</a> conn)</code> <div class="block">Construct an instance of the DBEntityResolver class</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBEntityResolver.html#DBEntityResolver-edu.ucsb.nceas.metacat.database.DBConnection-org.xml.sax.helpers.DefaultHandler-java.io.Reader-">DBEntityResolver</a></span>(<a href="../../../../edu/ucsb/nceas/metacat/database/DBConnection.html" title="class in edu.ucsb.nceas.metacat.database">DBConnection</a> conn, org.xml.sax.helpers.DefaultHandler handler, java.io.Reader dtd)</code> <div class="block">Construct an instance of the DBEntityResolver class</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>static java.io.InputStream</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBEntityResolver.html#checkURLConnection-java.lang.String-">checkURLConnection</a></span>(java.lang.String systemId)</code> <div class="block">Check URL Connection for @systemId, and return an InputStream that can be used to read from the systemId URL.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>org.xml.sax.InputSource</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/DBEntityResolver.html#resolveEntity-java.lang.String-java.lang.String-">resolveEntity</a></span>(java.lang.String publicId, java.lang.String systemId)</code> <div class="block">The Parser call this method before opening any external entity except the top-level document entity (including the external DTD subset, external entities referenced within the DTD, and external entities referenced within the document element)</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="DBEntityResolver-edu.ucsb.nceas.metacat.database.DBConnection-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>DBEntityResolver</h4> <pre>public DBEntityResolver(<a href="../../../../edu/ucsb/nceas/metacat/database/DBConnection.html" title="class in edu.ucsb.nceas.metacat.database">DBConnection</a> conn)</pre> <div class="block">Construct an instance of the DBEntityResolver class</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>conn</code> - the JDBC connection to which information is written</dd> </dl> </li> </ul> <a name="DBEntityResolver-edu.ucsb.nceas.metacat.database.DBConnection-org.xml.sax.helpers.DefaultHandler-java.io.Reader-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>DBEntityResolver</h4> <pre>public DBEntityResolver(<a href="../../../../edu/ucsb/nceas/metacat/database/DBConnection.html" title="class in edu.ucsb.nceas.metacat.database">DBConnection</a> conn, org.xml.sax.helpers.DefaultHandler handler, java.io.Reader dtd)</pre> <div class="block">Construct an instance of the DBEntityResolver class</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>conn</code> - the JDBC connection to which information is written</dd> <dd><code>handler</code> - the SAX handler to determine parsing context</dd> <dd><code>dtd</code> - Reader of new dtd to be uploaded on server's file system</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="resolveEntity-java.lang.String-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>resolveEntity</h4> <pre>public org.xml.sax.InputSource resolveEntity(java.lang.String publicId, java.lang.String systemId) throws org.xml.sax.SAXException</pre> <div class="block">The Parser call this method before opening any external entity except the top-level document entity (including the external DTD subset, external entities referenced within the DTD, and external entities referenced within the document element)</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code>resolveEntity</code> in interface <code>org.xml.sax.EntityResolver</code></dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>org.xml.sax.SAXException</code></dd> </dl> </li> </ul> <a name="checkURLConnection-java.lang.String-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>checkURLConnection</h4> <pre>public static java.io.InputStream checkURLConnection(java.lang.String systemId) throws org.xml.sax.SAXException</pre> <div class="block">Check URL Connection for @systemId, and return an InputStream that can be used to read from the systemId URL. The parser ends up using this via the InputSource to read the DTD.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>systemId</code> - a URI (in practice URL) to be checked and opened</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>org.xml.sax.SAXException</code></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/DBEntityResolver.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/DBDTDHandler.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../edu/ucsb/nceas/metacat/DBQuery.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?edu/ucsb/nceas/metacat/DBEntityResolver.html" target="_top">Frames</a></li> <li><a href="DBEntityResolver.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>