diff options
| author | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
|---|---|---|
| committer | Jesse Morgan <morganjm@amazon.com> | 2013-12-03 14:03:28 -0800 |
| commit | d479253768d296a40b4f699e1de9b03c7146a97a (patch) | |
| tree | 208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/com/amazon/carbonado/spi/LobEngine.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/spi/LobEngine.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/spi/LobEngine.html | 560 |
1 files changed, 560 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/spi/LobEngine.html b/apidocs/com/amazon/carbonado/spi/LobEngine.html new file mode 100644 index 0000000..c9dd1af --- /dev/null +++ b/apidocs/com/amazon/carbonado/spi/LobEngine.html @@ -0,0 +1,560 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>LobEngine (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="LobEngine (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/LobEngine.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/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/LobEngine.html" target="_top">Frames</a></li> +<li><a href="LobEngine.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.spi</div> +<h2 title="Class LobEngine" class="title">Class LobEngine</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.spi.LobEngine</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">LobEngine</span> +extends java.lang.Object</pre> +<div class="block">Complete Lob support for repositories, although repository is responsible + for binding Lob properties to this engine. Lobs are referenced by locators, + which are non-zero long integers. A zero locator is equivalent to null.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#getSupportTrigger(java.lang.Class, int)"><code>getSupportTrigger(Class, int)</code></a></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/spi/LobEngine.html#LobEngine(com.amazon.carbonado.Repository, com.amazon.carbonado.Repository)">LobEngine</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> lobRepo, + <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> locatorRepo)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#LobEngine(com.amazon.carbonado.Repository, com.amazon.carbonado.sequence.SequenceValueProducer)">LobEngine</a></strong>(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> lobRepo, + <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> locatorSequenceProducer)</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/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#createNewBlob(int)">createNewBlob</a></strong>(int blockSize)</code> +<div class="block">Returns a new Blob whose length is zero.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#createNewClob(int)">createNewClob</a></strong>(int blockSize)</code> +<div class="block">Returns a new Clob whose length is zero.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#deleteLob(com.amazon.carbonado.lob.Lob)">deleteLob</a></strong>(<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> lob)</code> +<div class="block">Deletes Lob data, freeing up all space consumed by it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#deleteLob(long)">deleteLob</a></strong>(long locator)</code> +<div class="block">Deletes Lob data, freeing up all space consumed by it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#getBlobValue(long)">getBlobValue</a></strong>(long locator)</code> +<div class="block">Loads a Blob value, without checking if it exists or not.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#getClobValue(long)">getClobValue</a></strong>(long locator)</code> +<div class="block">Loads a Clob value, without checking if it exists or not.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#getLocator(com.amazon.carbonado.lob.Lob)">getLocator</a></strong>(<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> lob)</code> +<div class="block">Returns the locator for the given Lob, or zero if null.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#getSupportTrigger(java.lang.Class, int)">getSupportTrigger</a></strong>(java.lang.Class<S> type, + int blockSize)</code> +<div class="block">Returns a Trigger for binding to this LobEngine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#hasLobs(java.lang.Class)">hasLobs</a></strong>(java.lang.Class<S> type)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#setBlobValue(long, com.amazon.carbonado.lob.Blob)">setBlobValue</a></strong>(long locator, + <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> data)</code> +<div class="block">Stores a value into a Blob, replacing anything that was there + before.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#setBlobValue(long, java.io.InputStream)">setBlobValue</a></strong>(long locator, + java.io.InputStream data)</code> +<div class="block">Stores a value into a Blob, replacing anything that was there + before.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#setClobValue(long, com.amazon.carbonado.lob.Clob)">setClobValue</a></strong>(long locator, + <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> data)</code> +<div class="block">Stores a value into a Clob, replacing anything that was there + before.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/spi/LobEngine.html#setClobValue(long, java.io.Reader)">setClobValue</a></strong>(long locator, + java.io.Reader data)</code> +<div class="block">Stores a value into a Clob, replacing anything that was there + before.</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="LobEngine(com.amazon.carbonado.Repository, com.amazon.carbonado.Repository)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LobEngine</h4> +<pre>public LobEngine(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> lobRepo, + <a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> locatorRepo) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lobRepo</code> - storage for Lobs - should not be replicated</dd><dd><code>locatorRepo</code> - storage for producing unique values for Lob locators + - should be root repository</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="LobEngine(com.amazon.carbonado.Repository, com.amazon.carbonado.sequence.SequenceValueProducer)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LobEngine</h4> +<pre>public LobEngine(<a href="../../../../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a> lobRepo, + <a href="../../../../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a> locatorSequenceProducer) + throws <a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lobRepo</code> - storage for Lobs - should not be replicated</dd><dd><code>locatorSequenceProducer</code> - source of unique values for Lob locators</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</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="hasLobs(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasLobs</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> boolean hasLobs(java.lang.Class<S> type)</pre> +</li> +</ul> +<a name="createNewBlob(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createNewBlob</h4> +<pre>public <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> createNewBlob(int blockSize) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns a new Blob whose length is zero.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>blockSize</code> - block size (in <i>bytes</i>) to use</dd> +<dt><span class="strong">Returns:</span></dt><dd>new empty Blob</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="createNewClob(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createNewClob</h4> +<pre>public <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> createNewClob(int blockSize) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Returns a new Clob whose length is zero.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>blockSize</code> - block size (in <i>bytes</i>) to use</dd> +<dt><span class="strong">Returns:</span></dt><dd>new empty Clob</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="getLocator(com.amazon.carbonado.lob.Lob)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLocator</h4> +<pre>public long getLocator(<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> lob)</pre> +<div class="block">Returns the locator for the given Lob, or zero if null.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.ClassCastException</code> - if Lob is unrecognized</dd></dl> +</li> +</ul> +<a name="deleteLob(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteLob</h4> +<pre>public void deleteLob(long locator) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Deletes Lob data, freeing up all space consumed by it.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="deleteLob(com.amazon.carbonado.lob.Lob)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteLob</h4> +<pre>public void deleteLob(<a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a> lob) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></pre> +<div class="block">Deletes Lob data, freeing up all space consumed by it.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd></dl> +</li> +</ul> +<a name="getBlobValue(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlobValue</h4> +<pre>public <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> getBlobValue(long locator)</pre> +<div class="block">Loads a Blob value, without checking if it exists or not.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locator</code> - lob locator as returned by getLocator</dd> +<dt><span class="strong">Returns:</span></dt><dd>Blob value or null</dd></dl> +</li> +</ul> +<a name="getClobValue(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getClobValue</h4> +<pre>public <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> getClobValue(long locator)</pre> +<div class="block">Loads a Clob value, without checking if it exists or not.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locator</code> - lob locator as returned by getLocator</dd> +<dt><span class="strong">Returns:</span></dt><dd>Clob value or null</dd></dl> +</li> +</ul> +<a name="setBlobValue(long, com.amazon.carbonado.lob.Blob)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBlobValue</h4> +<pre>public void setBlobValue(long locator, + <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a> data) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a>, + java.io.IOException</pre> +<div class="block">Stores a value into a Blob, replacing anything that was there + before. Passing null deletes the Blob, which is a convenience for + auto-generated code that may call this method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locator</code> - lob locator as created by createNewBlob</dd><dd><code>data</code> - source of data for Blob, which may be null to delete</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if locator is zero</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="setBlobValue(long, java.io.InputStream)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBlobValue</h4> +<pre>public void setBlobValue(long locator, + java.io.InputStream data) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a>, + java.io.IOException</pre> +<div class="block">Stores a value into a Blob, replacing anything that was there + before. Passing null deletes the Blob, which is a convenience for + auto-generated code that may call this method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locator</code> - lob locator as created by createNewBlob</dd><dd><code>data</code> - source of data for Blob, which may be null to delete</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if locator is zero</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="setClobValue(long, com.amazon.carbonado.lob.Clob)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setClobValue</h4> +<pre>public void setClobValue(long locator, + <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a> data) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a>, + java.io.IOException</pre> +<div class="block">Stores a value into a Clob, replacing anything that was there + before. Passing null deletes the Clob, which is a convenience for + auto-generated code that may call this method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locator</code> - lob locator as created by createNewClob</dd><dd><code>data</code> - source of data for Clob, which may be null to delete</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if locator is zero</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="setClobValue(long, java.io.Reader)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setClobValue</h4> +<pre>public void setClobValue(long locator, + java.io.Reader data) + throws <a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a>, + java.io.IOException</pre> +<div class="block">Stores a value into a Clob, replacing anything that was there + before. Passing null deletes the Clob, which is a convenience for + auto-generated code that may call this method.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locator</code> - lob locator as created by createNewClob</dd><dd><code>data</code> - source of data for Clob, which may be null to delete</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if locator is zero</dd> +<dd><code><a href="../../../../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></code></dd> +<dd><code>java.io.IOException</code></dd></dl> +</li> +</ul> +<a name="getSupportTrigger(java.lang.Class, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getSupportTrigger</h4> +<pre>public <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a><S> getSupportTrigger(java.lang.Class<S> type, + int blockSize)</pre> +<div class="block">Returns a Trigger for binding to this LobEngine. Storage implementations + which use LobEngine must install this Trigger. Trigger instances are + cached, so subsequent calls for the same trigger return the same + instance.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of Storable to create trigger for</dd><dd><code>blockSize</code> - block size to use</dd> +<dt><span class="strong">Returns:</span></dt><dd>support trigger or null if storable type has no lob properties</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/LobEngine.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/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/spi/LobEngine.html" target="_top">Frames</a></li> +<li><a href="LobEngine.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> |