<!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>AbstractDatabase (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="AbstractDatabase (MetaCat API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":9,"i9":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/AbstractDatabase.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>Prev Class</li>
<li><a href="../../../../edu/ucsb/nceas/dbadapter/OracleAdapter.html" title="class in edu.ucsb.nceas.dbadapter"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?edu/ucsb/nceas/dbadapter/AbstractDatabase.html" target="_top">Frames</a></li>
<li><a href="AbstractDatabase.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.dbadapter</div>
<h2 title="Class AbstractDatabase" class="title">Class AbstractDatabase</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>edu.ucsb.nceas.dbadapter.AbstractDatabase</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/dbadapter/OracleAdapter.html" title="class in edu.ucsb.nceas.dbadapter">OracleAdapter</a>, <a href="../../../../edu/ucsb/nceas/dbadapter/PostgresqlAdapter.html" title="class in edu.ucsb.nceas.dbadapter">PostgresqlAdapter</a>, <a href="../../../../edu/ucsb/nceas/dbadapter/SqlserverAdapter.html" title="class in edu.ucsb.nceas.dbadapter">SqlserverAdapter</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">AbstractDatabase</span>
extends java.lang.Object</pre>
<div class="block">Java offers uniform database access through the use of JDBC.
But many databases still use different SQL implementations and
conventions. Thus this class offers extended programming interface
that all subclasses should implement to gain access to different
databases.
To add a new database adapter class you must create a new class
<dbname>Adapter that extends edu.ucsb.nceas.dbadapter.AbstarctDatabase
(where dbname is the name of the database or database driver you wish
to add to your application). AbstarctDatabase is an abstract class,
thus the subclasses need to implement the abstract methods.</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/dbadapter/AbstractDatabase.html#AbstractDatabase--">AbstractDatabase</a></span>()</code> </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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/dbadapter/AbstractDatabase.html#createObject-java.lang.String-">createObject</a></span>(java.lang.String className)</code>
<div class="block">Instantiate a class using the name of the class at runtime</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/dbadapter/AbstractDatabase.html#getDateTimeFunction--">getDateTimeFunction</a></span>()</code>
<div class="block">The function name that gets the current date and time
from the database server</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/dbadapter/AbstractDatabase.html#getIsNULLFunction--">getIsNULLFunction</a></span>()</code>
<div class="block">The function name that is used to return non-NULL value</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/dbadapter/AbstractDatabase.html#getLeftJoinQuery-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">getLeftJoinQuery</a></span>(java.lang.String selectFields,
java.lang.String tableA,
java.lang.String tableB,
java.lang.String joinCriteria,
java.lang.String nonJoinCriteria)</code>
<div class="block">Syntax for doing a left join
Add 'a.' in front of the fields for first table and
'b.' in front of the fields for the second table</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/dbadapter/AbstractDatabase.html#getPagedQuery-java.lang.String-java.lang.Integer-java.lang.Integer-">getPagedQuery</a></span>(java.lang.String queryWithOrderBy,
java.lang.Integer start,
java.lang.Integer count)</code>
<div class="block">for generating a query for paging</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/dbadapter/AbstractDatabase.html#getReplicationDocumentListSQL--">getReplicationDocumentListSQL</a></span>()</code>
<div class="block">This method will return the sql command to get document list in xml_document
in replication.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/dbadapter/AbstractDatabase.html#getStringDelimiter--">getStringDelimiter</a></span>()</code>
<div class="block">The character that the specific database implementation uses to
indicate string literals in SQL.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>abstract long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/dbadapter/AbstractDatabase.html#getUniqueID-java.sql.Connection-java.lang.String-">getUniqueID</a></span>(java.sql.Connection conn,
java.lang.String tableName)</code>
<div class="block">Unique ID generator</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/dbadapter/AbstractDatabase.html#main-java.lang.String:A-">main</a></span>(java.lang.String[] args)</code>
<div class="block">the main routine used to test the dbadapter utility.</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/dbadapter/AbstractDatabase.html#toDate-java.lang.String-java.lang.String-">toDate</a></span>(java.lang.String dateString,
java.lang.String format)</code>
<div class="block">MSSQL didn't support to_date function which to transfer a text string
to date type.</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="AbstractDatabase--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractDatabase</h4>
<pre>public AbstractDatabase()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getUniqueID-java.sql.Connection-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUniqueID</h4>
<pre>public abstract long getUniqueID(java.sql.Connection conn,
java.lang.String tableName)
throws java.sql.SQLException</pre>
<div class="block">Unique ID generator</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conn</code> - db connection in which the unique id was generated</dd>
<dd><code>tableName</code> - the table which unique id was generate</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>return the generated unique id as a long type</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.sql.SQLException</code> - <br/> any SQLException that can be thrown
during the db operation</dd>
</dl>
</li>
</ul>
<a name="getDateTimeFunction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDateTimeFunction</h4>
<pre>public abstract java.lang.String getDateTimeFunction()</pre>
<div class="block">The function name that gets the current date and time
from the database server</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>return the current date and time function name</dd>
</dl>
</li>
</ul>
<a name="getIsNULLFunction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIsNULLFunction</h4>
<pre>public abstract java.lang.String getIsNULLFunction()</pre>
<div class="block">The function name that is used to return non-NULL value</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>return the non-NULL function name</dd>
</dl>
</li>
</ul>
<a name="getStringDelimiter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStringDelimiter</h4>
<pre>public abstract java.lang.String getStringDelimiter()</pre>
<div class="block">The character that the specific database implementation uses to
indicate string literals in SQL. This will usually be a single
qoute (').</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>return the string delimiter</dd>
</dl>
</li>
</ul>
<a name="toDate-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toDate</h4>
<pre>public java.lang.String toDate(java.lang.String dateString,
java.lang.String format)</pre>
<div class="block">MSSQL didn't support to_date function which to transfer a text string
to date type. But Oracle and Postsql do.</div>
</li>
</ul>
<a name="getLeftJoinQuery-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLeftJoinQuery</h4>
<pre>public abstract java.lang.String getLeftJoinQuery(java.lang.String selectFields,
java.lang.String tableA,
java.lang.String tableB,
java.lang.String joinCriteria,
java.lang.String nonJoinCriteria)</pre>
<div class="block">Syntax for doing a left join
Add 'a.' in front of the fields for first table and
'b.' in front of the fields for the second table</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>selectFields</code> - fields that you want to be selected</dd>
<dd><code>tableA</code> - first table in the join</dd>
<dd><code>tableB</code> - second table in the join</dd>
<dd><code>joinCriteria</code> - the criteria based on which the join will be made</dd>
<dd><code>nonJoinCriteria</code> - all other criterias</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>return the string for teh select query</dd>
</dl>
</li>
</ul>
<a name="createObject-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createObject</h4>
<pre>public static java.lang.Object createObject(java.lang.String className)
throws java.lang.Exception</pre>
<div class="block">Instantiate a class using the name of the class at runtime</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>className</code> - the fully qualified name of the class to instantiate</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a name="main-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>main</h4>
<pre>public static void main(java.lang.String[] args)</pre>
<div class="block">the main routine used to test the dbadapter utility.</div>
</li>
</ul>
<a name="getReplicationDocumentListSQL--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReplicationDocumentListSQL</h4>
<pre>public abstract java.lang.String getReplicationDocumentListSQL()</pre>
<div class="block">This method will return the sql command to get document list in xml_document
in replication. Because it involes outer join, so this method is very flexible.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getPagedQuery-java.lang.String-java.lang.Integer-java.lang.Integer-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPagedQuery</h4>
<pre>public abstract java.lang.String getPagedQuery(java.lang.String queryWithOrderBy,
java.lang.Integer start,
java.lang.Integer count)</pre>
<div class="block">for generating a query for paging</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>queryWithOrderBy</code> - - the complete query with SELECT, FROM, WHERE and ORDER BY clauses</dd>
<dd><code>start</code> - the row number to start from</dd>
<dd><code>count</code> - the number of records from start to return</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>query specific to the RDBMS in use</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/AbstractDatabase.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>Prev Class</li>
<li><a href="../../../../edu/ucsb/nceas/dbadapter/OracleAdapter.html" title="class in edu.ucsb.nceas.dbadapter"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?edu/ucsb/nceas/dbadapter/AbstractDatabase.html" target="_top">Frames</a></li>
<li><a href="AbstractDatabase.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>