summaryrefslogtreecommitdiff
path: root/apidocs/overview-summary.html
diff options
context:
space:
mode:
authorJesse Morgan <morganjm@amazon.com>2013-12-03 14:03:28 -0800
committerJesse Morgan <morganjm@amazon.com>2013-12-03 14:03:28 -0800
commitd479253768d296a40b4f699e1de9b03c7146a97a (patch)
tree208e70d81fc3e477a37d3f9ca6475c39bb6410d3 /apidocs/overview-summary.html
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/overview-summary.html')
-rw-r--r--apidocs/overview-summary.html319
1 files changed, 319 insertions, 0 deletions
diff --git a/apidocs/overview-summary.html b/apidocs/overview-summary.html
new file mode 100644
index 0000000..bb56939
--- /dev/null
+++ b/apidocs/overview-summary.html
@@ -0,0 +1,319 @@
+<!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:46 PST 2013 -->
+<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
+<title>Overview (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="Overview (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 class="navBarCell1Rev">Overview</li>
+<li>Package</li>
+<li>Class</li>
+<li>Use</li>
+<li><a href="overview-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>Prev</li>
+<li>Next</li>
+</ul>
+<ul class="navList">
+<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
+<li><a href="overview-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 class="title">Carbonado 1.2.3 API</h1>
+</div>
+<div class="contentContainer">
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Basic API table, listing packages, and an explanation">
+<caption><span>Basic API</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Package</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a href="com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></td>
+<td class="colLast">
+<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></td>
+<td class="colLast">
+<div class="block">Contains annotations and implementations for supporting property adapters.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></td>
+<td class="colLast">
+<div class="block">Contains annotations and implementations for supporting property constraints.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="contentContainer">
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Advanced API table, listing packages, and an explanation">
+<caption><span>Advanced API</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Package</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a href="com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></td>
+<td class="colLast">
+<div class="block">Common capabilities for repositories.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></td>
+<td class="colLast">
+<div class="block">Support for advanced processing of cursor results, including basic set
+ theory operations.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></td>
+<td class="colLast">
+<div class="block">Contains classes for representing query filters.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></td>
+<td class="colLast">
+<div class="block">Introspection support for Storables.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></td>
+<td class="colLast">
+<div class="block">Support for recording the evolution of a storable's layout, used internally
+ by some repositories.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></td>
+<td class="colLast">
+<div class="block">Support for LOB property types, which are Large OBjects.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></td>
+<td class="colLast">
+<div class="block">Support for generating sequences of values, intended for creating surrogate
+ keys.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="contentContainer">
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Standard Repositories table, listing packages, and an explanation">
+<caption><span>Standard Repositories</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Package</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a href="com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></td>
+<td class="colLast">
+<div class="block">Repository implementation that connects to an external SQL database via
+ JDBC.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></td>
+<td class="colLast">
+<div class="block">Repository implementation which logs activity against it.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="com/amazon/carbonado/repo/map/package-summary.html">com.amazon.carbonado.repo.map</a></td>
+<td class="colLast">
+<div class="block">Volatile repository implementation backed by a concurrent map.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a></td>
+<td class="colLast">
+<div class="block">Repository implementation that supports replication between two
+ repositories.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></td>
+<td class="colLast">
+<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley)
+ database.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="contentContainer">
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Service Provider Interface table, listing packages, and an explanation">
+<caption><span>Service Provider Interface</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Package</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a href="com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></td>
+<td class="colLast">
+<div class="block">Storable code generation support intended for use by repository implementations.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></td>
+<td class="colLast">
+<div class="block">Support for implementing a Query Engine.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></td>
+<td class="colLast">
+<div class="block">Provides support for repositories that encode/decode storables in a raw
+ binary format.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></td>
+<td class="colLast">
+<div class="block">Repository implementation that adds index support for repositories that have
+ little or no index support.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></td>
+<td class="colLast">
+<div class="block">Service Provider Interface for Carbonado.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><a href="com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></td>
+<td class="colLast">
+<div class="block">Support for dynamic creation of storables, intended for internal use by
+ repository implementations.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><a href="com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></td>
+<td class="colLast">
+<div class="block">Provides support for managing transactions.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="contentContainer">
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Generic Utilities table, listing packages, and an explanation">
+<caption><span>Generic Utilities</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Package</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<td class="colFirst"><a href="com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></td>
+<td class="colLast">
+<div class="block">Utilities used by Carbonado but which have no dependencies on
+ Carbonado.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</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 class="navBarCell1Rev">Overview</li>
+<li>Package</li>
+<li>Class</li>
+<li>Use</li>
+<li><a href="overview-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>Prev</li>
+<li>Next</li>
+</ul>
+<ul class="navList">
+<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
+<li><a href="overview-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>
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-27 11:03:27 +0000