blob: ec9e764b4281ccc019bf55224cfc92576f33362e [file] [log] [blame]
<!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 (version 1.7.0_67) on Sat Sep 20 17:22:57 FET 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>DbAdapterDetector (Cayenne Documentation 3.1 API)</title>
<meta name="date" content="2014-09-20">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DbAdapterDetector (Cayenne Documentation 3.1 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/DbAdapterDetector.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="../../../../../org/apache/cayenne/configuration/server/DataSourceFactory.html" title="interface in org.apache.cayenne.configuration.server"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cayenne/configuration/server/DbAdapterFactory.html" title="interface in org.apache.cayenne.configuration.server"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cayenne/configuration/server/DbAdapterDetector.html" target="_top">Frames</a></li>
<li><a href="DbAdapterDetector.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">org.apache.cayenne.configuration.server</div>
<h2 title="Interface DbAdapterDetector" class="title">Interface DbAdapterDetector</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/cayenne/dba/db2/DB2Sniffer.html" title="class in org.apache.cayenne.dba.db2">DB2Sniffer</a>, <a href="../../../../../org/apache/cayenne/dba/derby/DerbySniffer.html" title="class in org.apache.cayenne.dba.derby">DerbySniffer</a>, <a href="../../../../../org/apache/cayenne/dba/frontbase/FrontBaseSniffer.html" title="class in org.apache.cayenne.dba.frontbase">FrontBaseSniffer</a>, <a href="../../../../../org/apache/cayenne/dba/h2/H2Sniffer.html" title="class in org.apache.cayenne.dba.h2">H2Sniffer</a>, <a href="../../../../../org/apache/cayenne/dba/hsqldb/HSQLDBSniffer.html" title="class in org.apache.cayenne.dba.hsqldb">HSQLDBSniffer</a>, <a href="../../../../../org/apache/cayenne/dba/ingres/IngresSniffer.html" title="class in org.apache.cayenne.dba.ingres">IngresSniffer</a>, <a href="../../../../../org/apache/cayenne/dba/mysql/MySQLSniffer.html" title="class in org.apache.cayenne.dba.mysql">MySQLSniffer</a>, <a href="../../../../../org/apache/cayenne/dba/openbase/OpenBaseSniffer.html" title="class in org.apache.cayenne.dba.openbase">OpenBaseSniffer</a>, <a href="../../../../../org/apache/cayenne/dba/oracle/OracleSniffer.html" title="class in org.apache.cayenne.dba.oracle">OracleSniffer</a>, <a href="../../../../../org/apache/cayenne/dba/postgres/PostgresSniffer.html" title="class in org.apache.cayenne.dba.postgres">PostgresSniffer</a>, <a href="../../../../../org/apache/cayenne/dba/sqlite/SQLiteSniffer.html" title="class in org.apache.cayenne.dba.sqlite">SQLiteSniffer</a>, <a href="../../../../../org/apache/cayenne/dba/sqlserver/SQLServerSniffer.html" title="class in org.apache.cayenne.dba.sqlserver">SQLServerSniffer</a>, <a href="../../../../../org/apache/cayenne/dba/sybase/SybaseSniffer.html" title="class in org.apache.cayenne.dba.sybase">SybaseSniffer</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">DbAdapterDetector</span></pre>
<div class="block">A factory interface providing DbAdapter based on JDBC metadata. It allows custom
DbAdapters to contribute database detection algorithms to
<a href="../../../../../org/apache/cayenne/configuration/server/DefaultDbAdapterFactory.html" title="class in org.apache.cayenne.configuration.server"><code>DefaultDbAdapterFactory</code></a>.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.1</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/cayenne/dba/DbAdapter.html" title="interface in org.apache.cayenne.dba">DbAdapter</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/cayenne/configuration/server/DbAdapterDetector.html#createAdapter(java.sql.DatabaseMetaData)">createAdapter</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/sql/DatabaseMetaData.html?is-external=true" title="class or interface in java.sql">DatabaseMetaData</a>&nbsp;md)</code>
<div class="block">Returns an instance of DbAdapter if the factory detects that it knows how to handle
the database or null if the database is not known to the factory, thus allowing
multiple factories to be chained.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="createAdapter(java.sql.DatabaseMetaData)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createAdapter</h4>
<pre><a href="../../../../../org/apache/cayenne/dba/DbAdapter.html" title="interface in org.apache.cayenne.dba">DbAdapter</a>&nbsp;createAdapter(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/sql/DatabaseMetaData.html?is-external=true" title="class or interface in java.sql">DatabaseMetaData</a>&nbsp;md)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></pre>
<div class="block">Returns an instance of DbAdapter if the factory detects that it knows how to handle
the database or null if the database is not known to the factory, thus allowing
multiple factories to be chained.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</a></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/DbAdapterDetector.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="../../../../../org/apache/cayenne/configuration/server/DataSourceFactory.html" title="interface in org.apache.cayenne.configuration.server"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/cayenne/configuration/server/DbAdapterFactory.html" title="interface in org.apache.cayenne.configuration.server"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/cayenne/configuration/server/DbAdapterDetector.html" target="_top">Frames</a></li>
<li><a href="DbAdapterDetector.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>Copyright &#169; 2001&#x2013;2014 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p>
</body>
</html>