diff options
Diffstat (limited to 'apidocs/com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html | 947 |
1 files changed, 947 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html new file mode 100644 index 0000000..9f33066 --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html @@ -0,0 +1,947 @@ +<!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_25) on Tue Dec 03 13:53:41 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>JDBCRepositoryBuilder (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<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="JDBCRepositoryBuilder (Carbonado 1.2.3 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/JDBCRepositoryBuilder.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-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="JDBCRepositoryBuilder.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">com.amazon.carbonado.repo.jdbc</div> +<h2 title="Class JDBCRepositoryBuilder" class="title">Class JDBCRepositoryBuilder</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">com.amazon.carbonado.spi.AbstractRepositoryBuilder</a></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.repo.jdbc.JDBCRepositoryBuilder</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">JDBCRepositoryBuilder</span> +extends <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></pre> +<div class="block">Builds a repository instance backed by a JDBC accessible database. + JDBCRepository is not independent of the underlying database schema, and so + it requires matching tables and columns in the database. It will not alter + or create tables. Use the <a href="../../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado"><code>Alias</code></a> + annotation to control precisely which tables and columns must be matched up. + + <p>Note: The current JDBC repository implementation makes certain + assumptions about the database it is accessing. It must support transactions + and multiple statements per connection. If it doesn't support savepoints, + then nested transactions are faked -- rollback of inner transaction will + appear to do nothing. + + <p> + The following extra capabilities are supported: + <ul> + <li><a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfoCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>StorableInfoCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability"><code>ShutdownCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence"><code>SequenceCapability</code></a> + <li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc"><code>JDBCConnectionCapability</code></a> + </ul></div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, bcastill, Adam D Bradley</dd></dl> +</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="overviewSummary" 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><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#JDBCRepositoryBuilder()">JDBCRepositoryBuilder</a></strong>()</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </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="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build</a></strong>(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef)</code> +<div class="block">Builds a repository instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></strong>(java.util.Collection<java.lang.String> messages)</code> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getCatalog()">getCatalog</a></strong>()</code> +<div class="block">Returns the optional catalog to search for metadata.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>javax.sql.DataSource</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDataSource()">getDataSource</a></strong>()</code> +<div class="block">Returns the source of JDBC connections, which defaults to a non-pooling + source if driver class, driver URL, username, and password are all + supplied.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDataSourceCloseOnShutdown()">getDataSourceCloseOnShutdown</a></strong>()</code> +<div class="block">Returns true if DataSource is closed when the repository is closed or + shutdown.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDataSourceLogging()">getDataSourceLogging</a></strong>()</code> +<div class="block">Returns true if debug logging is enabled.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDefaultFetchSize()">getDefaultFetchSize</a></strong>()</code> +<div class="block">Returns the default fetch size when running queries, or null if driver + default is used instead.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDriverClassName()">getDriverClassName</a></strong>()</code> +<div class="block">Returns the driver class name, which may be null if a DataSource was provided.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDriverURL()">getDriverURL</a></strong>()</code> +<div class="block">Returns the connection URL, which may be null if a DataSource was + provided.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getName()">getName</a></strong>()</code> +<div class="block">Returns the name of the repository.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getPassword()">getPassword</a></strong>()</code> +<div class="block">Returns the optional password to use with DataSource.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getSchema()">getSchema</a></strong>()</code> +<div class="block">Returns the optional schema to search for metadata.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getSequenceSelectStatement()">getSequenceSelectStatement</a></strong>()</code> +<div class="block">Returns the native sequence select statement, which is null if the + default is chosen.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getUserName()">getUserName</a></strong>()</code> +<div class="block">Returns the optional username to use with DataSource.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#isForceStoredSequence()">isForceStoredSequence</a></strong>()</code> +<div class="block">Returns true if native sequences should not be used.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#isMaster()">isMaster</a></strong>()</code> +<div class="block">Returns true if repository should assume the role of master, which is + true by default.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setAutoVersioningEnabled(boolean, java.lang.String)">setAutoVersioningEnabled</a></strong>(boolean enabled, + java.lang.String className)</code> +<div class="block">By default, JDBCRepository assumes that <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version numbers</code></a> are initialized and + incremented by triggers installed on the database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setCatalog(java.lang.String)">setCatalog</a></strong>(java.lang.String catalog)</code> +<div class="block">Optionally set the catalog to search for metadata.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDataSource(javax.sql.DataSource)">setDataSource</a></strong>(javax.sql.DataSource dataSource)</code> +<div class="block">Set the source of JDBC connections, overriding any configuration + supported by these methods: + + + <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDriverClassName(java.lang.String)"><code>setDriverClassName(java.lang.String)</code></a> + <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDriverURL(java.lang.String)"><code>setDriverURL(java.lang.String)</code></a> + <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setUserName(java.lang.String)"><code>setUserName(java.lang.String)</code></a> + <a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setPassword(java.lang.String)"><code>setPassword(java.lang.String)</code></a> + </div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDataSourceCloseOnShutdown(boolean)">setDataSourceCloseOnShutdown</a></strong>(boolean b)</code> +<div class="block">Pass true to cause the DataSource to be closed when the repository is + closed or shutdown.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDataSourceLogging(boolean)">setDataSourceLogging</a></strong>(boolean b)</code> +<div class="block">Pass true to enable debug logging.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDefaultFetchSize(java.lang.Integer)">setDefaultFetchSize</a></strong>(java.lang.Integer size)</code> +<div class="block">Set the default fetch size when running queries.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDriverClassName(java.lang.String)">setDriverClassName</a></strong>(java.lang.String driverClassName)</code> +<div class="block">Set the JDBC driver class name, which is required if a DataSource was not provided.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDriverURL(java.lang.String)">setDriverURL</a></strong>(java.lang.String url)</code> +<div class="block">Set the JDBC connection URL, which is required if a DataSource was not + provided.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setForceStoredSequence(boolean)">setForceStoredSequence</a></strong>(boolean forceStoredSequence)</code> +<div class="block">By default, native sequences are used if supported.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setMaster(boolean)">setMaster</a></strong>(boolean b)</code> +<div class="block">Set to false if repository should not assume the role of master.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setName(java.lang.String)">setName</a></strong>(java.lang.String name)</code> +<div class="block">Set name for the repository, which is required.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setPassword(java.lang.String)">setPassword</a></strong>(java.lang.String password)</code> +<div class="block">Optionally set the password to use with DataSource.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setPrimaryKeyCheckDisabled(boolean)">setPrimaryKeyCheckDisabled</a></strong>(boolean primaryKeyCheckDisabled)</code> +<div class="block">By default, JDBCRepository makes sure that every declared primary key + in the database table for a Storable lines up with a declared + PrimaryKey or AlternateKey.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setSchema(java.lang.String)">setSchema</a></strong>(java.lang.String schema)</code> +<div class="block">Optionally set the schema to search for metadata.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setSequenceSelectStatement(java.lang.String)">setSequenceSelectStatement</a></strong>(java.lang.String sequenceSelectStatement)</code> +<div class="block">Override the default native sequence select statement with a printf.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setSuppressReload(boolean, java.lang.String)">setSuppressReload</a></strong>(boolean suppress, + java.lang.String className)</code> +<div class="block">By default, JDBCRepository reloads Storables after every insert or + update.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setUserName(java.lang.String)">setUserName</a></strong>(java.lang.String username)</code> +<div class="block">Optionally set the username to use with DataSource.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.spi.AbstractRepositoryBuilder"> +<!-- --> +</a> +<h3>Methods inherited from class com.amazon.carbonado.spi.<a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></h3> +<code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">addTriggerFactory</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#assertReady()">assertReady</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#build()">build</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#getTriggerFactories()">getTriggerFactories</a>, <a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">removeTriggerFactory</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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="JDBCRepositoryBuilder()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>JDBCRepositoryBuilder</h4> +<pre>public JDBCRepositoryBuilder()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="build(java.util.concurrent.atomic.AtomicReference)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>build</h4> +<pre>public <a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> build(java.util.concurrent.atomic.AtomicReference<<a href="../../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a>> rootRef) + throws <a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">RepositoryBuilder</a></code></strong></div> +<div class="block">Builds a repository instance. + + <p>If the repository is being wrapped by a parent repository, the child + repository will need to know this fact for some operations to work + correctly. Since the parent repository is not built yet, a reference is + used instead.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rootRef</code> - reference to root parent repository, to be set by + parent repository upon being built</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if there is a problem in the builder's configuration</dd> +<dd><code><a href="../../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code> - if there is a general problem opening the repository</dd></dl> +</li> +</ul> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public java.lang.String getName()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#getName()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns the name of the repository.</div> +</li> +</ul> +<a name="setName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public void setName(java.lang.String name)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setName(java.lang.String)">RepositoryBuilder</a></code></strong></div> +<div class="block">Set name for the repository, which is required.</div> +</li> +</ul> +<a name="isMaster()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isMaster</h4> +<pre>public boolean isMaster()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#isMaster()">RepositoryBuilder</a></code></strong></div> +<div class="block">Returns true if repository should assume the role of master, which is + true by default. Repositories that link different repositories together + will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="setMaster(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaster</h4> +<pre>public void setMaster(boolean b)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/RepositoryBuilder.html#setMaster(boolean)">RepositoryBuilder</a></code></strong></div> +<div class="block">Set to false if repository should not assume the role of master. By + default, this option is true. Repositories that link different + repositories together will designate only one as the master. + + <p>A master repository is responsible for <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version</code></a> and + <a href="../../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>sequence</code></a> properties. For insert operations, a master + repository must set these properties if they are uninitialized. For + updates, the version property is checked to see if an <a href="../../../../../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><code>OptimisticLockException</code></a> should be thrown.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><code>ReplicatedRepositoryBuilder</code></a></dd></dl> +</li> +</ul> +<a name="setDataSource(javax.sql.DataSource)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDataSource</h4> +<pre>public void setDataSource(javax.sql.DataSource dataSource)</pre> +<div class="block">Set the source of JDBC connections, overriding any configuration + supported by these methods: + + <ul> + <li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDriverClassName(java.lang.String)"><code>setDriverClassName(java.lang.String)</code></a> + <li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDriverURL(java.lang.String)"><code>setDriverURL(java.lang.String)</code></a> + <li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setUserName(java.lang.String)"><code>setUserName(java.lang.String)</code></a> + <li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setPassword(java.lang.String)"><code>setPassword(java.lang.String)</code></a> + </ul></div> +</li> +</ul> +<a name="getDataSource()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataSource</h4> +<pre>public javax.sql.DataSource getDataSource() + throws <a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></pre> +<div class="block">Returns the source of JDBC connections, which defaults to a non-pooling + source if driver class, driver URL, username, and password are all + supplied.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if driver class wasn't found</dd></dl> +</li> +</ul> +<a name="setDataSourceCloseOnShutdown(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDataSourceCloseOnShutdown</h4> +<pre>public void setDataSourceCloseOnShutdown(boolean b)</pre> +<div class="block">Pass true to cause the DataSource to be closed when the repository is + closed or shutdown. By default, this option is false.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getDataSourceCloseOnShutdown()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataSourceCloseOnShutdown</h4> +<pre>public boolean getDataSourceCloseOnShutdown()</pre> +<div class="block">Returns true if DataSource is closed when the repository is closed or + shutdown. By default, this option is false.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setDataSourceLogging(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDataSourceLogging</h4> +<pre>public void setDataSourceLogging(boolean b)</pre> +<div class="block">Pass true to enable debug logging. By default, it is false.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc"><code>LoggingDataSource</code></a></dd></dl> +</li> +</ul> +<a name="getDataSourceLogging()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataSourceLogging</h4> +<pre>public boolean getDataSourceLogging()</pre> +<div class="block">Returns true if debug logging is enabled.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc"><code>LoggingDataSource</code></a></dd></dl> +</li> +</ul> +<a name="setCatalog(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCatalog</h4> +<pre>public void setCatalog(java.lang.String catalog)</pre> +<div class="block">Optionally set the catalog to search for metadata.</div> +</li> +</ul> +<a name="getCatalog()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCatalog</h4> +<pre>public java.lang.String getCatalog()</pre> +<div class="block">Returns the optional catalog to search for metadata.</div> +</li> +</ul> +<a name="setSchema(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSchema</h4> +<pre>public void setSchema(java.lang.String schema)</pre> +<div class="block">Optionally set the schema to search for metadata.</div> +</li> +</ul> +<a name="getSchema()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSchema</h4> +<pre>public java.lang.String getSchema()</pre> +<div class="block">Returns the optional schema to search for metadata.</div> +</li> +</ul> +<a name="setDriverClassName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDriverClassName</h4> +<pre>public void setDriverClassName(java.lang.String driverClassName)</pre> +<div class="block">Set the JDBC driver class name, which is required if a DataSource was not provided.</div> +</li> +</ul> +<a name="getDriverClassName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDriverClassName</h4> +<pre>public java.lang.String getDriverClassName()</pre> +<div class="block">Returns the driver class name, which may be null if a DataSource was provided.</div> +</li> +</ul> +<a name="setDriverURL(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDriverURL</h4> +<pre>public void setDriverURL(java.lang.String url)</pre> +<div class="block">Set the JDBC connection URL, which is required if a DataSource was not + provided.</div> +</li> +</ul> +<a name="getDriverURL()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDriverURL</h4> +<pre>public java.lang.String getDriverURL()</pre> +<div class="block">Returns the connection URL, which may be null if a DataSource was + provided.</div> +</li> +</ul> +<a name="setUserName(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setUserName</h4> +<pre>public void setUserName(java.lang.String username)</pre> +<div class="block">Optionally set the username to use with DataSource.</div> +</li> +</ul> +<a name="getUserName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUserName</h4> +<pre>public java.lang.String getUserName()</pre> +<div class="block">Returns the optional username to use with DataSource.</div> +</li> +</ul> +<a name="setPassword(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPassword</h4> +<pre>public void setPassword(java.lang.String password)</pre> +<div class="block">Optionally set the password to use with DataSource.</div> +</li> +</ul> +<a name="getPassword()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPassword</h4> +<pre>public java.lang.String getPassword()</pre> +<div class="block">Returns the optional password to use with DataSource.</div> +</li> +</ul> +<a name="setDefaultFetchSize(java.lang.Integer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultFetchSize</h4> +<pre>public void setDefaultFetchSize(java.lang.Integer size)</pre> +<div class="block">Set the default fetch size when running queries. Pass null to let driver + use its own default.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getDefaultFetchSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultFetchSize</h4> +<pre>public java.lang.Integer getDefaultFetchSize()</pre> +<div class="block">Returns the default fetch size when running queries, or null if driver + default is used instead.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setAutoVersioningEnabled(boolean, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAutoVersioningEnabled</h4> +<pre>public void setAutoVersioningEnabled(boolean enabled, + java.lang.String className)</pre> +<div class="block">By default, JDBCRepository assumes that <a href="../../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>version numbers</code></a> are initialized and + incremented by triggers installed on the database. Enabling automatic + versioning here causes the JDBCRepository to manage these operations + itself.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>enabled</code> - true to enable, false to disable</dd><dd><code>className</code> - name of Storable type to enable automatic version + management on; pass null to enable all</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setSuppressReload(boolean, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSuppressReload</h4> +<pre>public void setSuppressReload(boolean suppress, + java.lang.String className)</pre> +<div class="block">By default, JDBCRepository reloads Storables after every insert or + update. This ensures that any applied defaults or triggered changes are + available to the Storable. If the database has no such defaults or + triggers, suppressing reload can improve performance. + + <p>Note: If Storable has a version property and auto versioning is not + enabled, or if the Storable has any automatic properties, the Storable + might still be reloaded.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>suppress</code> - true to suppress, false to unsuppress</dd><dd><code>className</code> - name of Storable type to suppress reload for; pass null + to suppress all</dd><dt><span class="strong">Since:</span></dt> + <dd>1.1.3</dd></dl> +</li> +</ul> +<a name="getSequenceSelectStatement()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSequenceSelectStatement</h4> +<pre>public java.lang.String getSequenceSelectStatement()</pre> +<div class="block">Returns the native sequence select statement, which is null if the + default is chosen.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setSequenceSelectStatement(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSequenceSelectStatement</h4> +<pre>public void setSequenceSelectStatement(java.lang.String sequenceSelectStatement)</pre> +<div class="block">Override the default native sequence select statement with a printf. + For example, "SELECT %s.NEXTVAL FROM DUAL".</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="isForceStoredSequence()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isForceStoredSequence</h4> +<pre>public boolean isForceStoredSequence()</pre> +<div class="block">Returns true if native sequences should not be used.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setForceStoredSequence(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setForceStoredSequence</h4> +<pre>public void setForceStoredSequence(boolean forceStoredSequence)</pre> +<div class="block">By default, native sequences are used if supported. Otherwise, a table + named "CARBONADO_SEQUENCE" or "CARBONADO_SEQUENCES" is used instead to + hold sequence values. When forced, the table is always used instead of + native sequences.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="setPrimaryKeyCheckDisabled(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPrimaryKeyCheckDisabled</h4> +<pre>public void setPrimaryKeyCheckDisabled(boolean primaryKeyCheckDisabled)</pre> +<div class="block">By default, JDBCRepository makes sure that every declared primary key + in the database table for a Storable lines up with a declared + PrimaryKey or AlternateKey. This is not always the desired behavior; + for example, you may have a table which uses a bigint for its actual + primary key but uses another column with a unique index as the + "primary" key from the application's point of view. Setting this + value to true allows this check to fail gracefully instead of + throwing a <a href="../../../../../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado"><code>MismatchException</code></a>.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="errorCheck(java.util.Collection)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>errorCheck</h4> +<pre>public void errorCheck(java.util.Collection<java.lang.String> messages) + throws <a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">AbstractRepositoryBuilder</a></code></strong></div> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks. Be sure to call <code>super.errorCheck</code> as well.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck</a></code> in class <code><a href="../../../../../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>messages</code> - add any error messages to this list</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></code> - if error checking indirectly caused + another exception</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/JDBCRepositoryBuilder.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-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" target="_top">Frames</a></li> +<li><a href="JDBCRepositoryBuilder.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>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> |