1 files changed, 234 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/lob/package-summary.html b/apidocs/com/amazon/carbonado/lob/package-summary.html
new file mode 100644
index 0000000..93d2196
--- /dev/null
+++ b/apidocs/com/amazon/carbonado/lob/package-summary.html
@@ -0,0 +1,234 @@
+<!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:44 PST 2013 -->
+<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
+<title>com.amazon.carbonado.lob (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="com.amazon.carbonado.lob (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 class="navBarCell1Rev">Package</li>
+<li>Class</li>
+<li><a href="package-use.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/layout/package-summary.html">Prev Package</a></li>
+<li><a href="../../../../com/amazon/carbonado/qe/package-summary.html">Next Package</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/amazon/carbonado/lob/package-summary.html" target="_top">Frames</a></li>
+<li><a href="package-summary.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>
+<a name="skip-navbar_top">
+<!--   -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<div class="header">
+<h1 title="Package" class="title">Package&nbsp;com.amazon.carbonado.lob</h1>
+<div class="docSummary">
+<div class="block">Support for LOB property types, which are Large OBjects.</div>
+</div>
+<p>See:&nbsp;<a href="#package_description">Description</a></p>
+</div>
+<div class="contentContainer">
+<ul class="blockList">
+<li class="blockList">
+<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
+<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Interface</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></td>
+<td class="colLast">
+<div class="block">Provides access to BLOBs, which are Binary Large OBjects.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></td>
+<td class="colLast">
+<div class="block">Provides access to CLOBs, which are Character Large OBjects.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></td>
+<td class="colLast">
+<div class="block">Marker interface for <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><code>Blobs</code></a> and <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><code>Clobs</code></a>.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+<li class="blockList">
+<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
+<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Class</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></td>
+<td class="colLast">
+<div class="block">AbstractBlob implements a small set of common Blob methods.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></td>
+<td class="colLast">
+<div class="block">AbstractClob implements a small set of common Clob methods.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></td>
+<td class="colLast">
+<div class="block">A Clob implementation which is backed by a Blob.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></td>
+<td class="colLast">
+<div class="block">Implementation of a Blob which is backed by a growable in-memory byte array.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></td>
+<td class="colLast">
+<div class="block">Implementation of a Clob which is backed by a growable in-memory character
+ array.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></td>
+<td class="colLast">
+<div class="block">Implementation of a Blob which is backed by a File.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="../../../../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></td>
+<td class="colLast">
+<div class="block">Implementation of a Clob which is backed by a read-only String.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+</ul>
+<a name="package_description">
+<!--   -->
+</a>
+<h2 title="Package com.amazon.carbonado.lob Description">Package com.amazon.carbonado.lob Description</h2>
+<div class="block">Support for LOB property types, which are Large OBjects. Properties declared
+ as <a href="../../../../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><code>Blob</code></a> or <a href="../../../../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><code>Clob</code></a> are treated differently than regular
+ properties. In particular:
+
+ <ul>
+ <li>Repository typically stores LOB data external from enclosing storable
+ <li>LOBs are accessed in a manner similar to how files are accessed
+ <li>LOB data is often read/written in chunks, so consider accessing in a transaction scope
+ <li>LOBs cannot be annotated with <a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado"><code>PrimaryKey</code></a>, <a href="../../../../com/amazon/carbonado/Key.html" title="annotation in com.amazon.carbonado"><code>Key</code></a>, <a href="../../../../com/amazon/carbonado/Index.html" title="annotation in com.amazon.carbonado"><code>Index</code></a>, <a href="../../../../com/amazon/carbonado/Join.html" title="annotation in com.amazon.carbonado"><code>Join</code></a>,
+ <a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>Version</code></a>, or <a href="../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>Sequence</code></a>
+ <li>LOBs cannot be used in a <a href="../../../../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>query filter</code></a>
+ </ul>
+
+ <p>Also, setting a LOB property does not dirty that property unless the new
+ LOB is unequal. Updating a LOB property typically involves operating on the
+ LOB itself. Setting the LOB property again is useful only when completely
+ replacing the data, which can be a relatively expensive operation.
+
+ <p>Some repositories require that large text data be stored as a LOB. If the
+ text property is intended to fit entirely in memory, consider defining the
+ property as a String instead of a LOB. This allows the repository to decide
+ if it is appropriate to store it as a LOB. If explicit control over charset
+ encoding is required, add a <a href="../../../../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>TextAdapter</code></a> annotation.</div>
+</div>
+<!-- ======= 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 class="navBarCell1Rev">Package</li>
+<li>Class</li>
+<li><a href="package-use.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/layout/package-summary.html">Prev Package</a></li>
+<li><a href="../../../../com/amazon/carbonado/qe/package-summary.html">Next Package</a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?com/amazon/carbonado/lob/package-summary.html" target="_top">Frames</a></li>
+<li><a href="package-summary.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>
+<a name="skip-navbar_bottom">
+<!--   -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<p class="legalCopy"><small>Copyright &#169; 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
+</body>
+</html>