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/index-files | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/index-files')
24 files changed, 13578 insertions, 0 deletions
diff --git a/apidocs/index-files/index-1.html b/apidocs/index-files/index-1.html new file mode 100644 index 0000000..d90d52c --- /dev/null +++ b/apidocs/index-files/index-1.html @@ -0,0 +1,949 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>A-Index (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="A-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Letter</li> +<li><a href="index-2.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-1.html" target="_top">Frames</a></li> +<li><a href="index-1.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_A_"> +<!-- --> +</a> +<h2 class="title">A</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#abortTry()">abortTry()</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Call to quickly abort a "try" operation, returning false to the + caller.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionManager.html#abortTxn(Txn)">abortTxn(Txn)</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></dt> +<dd> +<div class="block">Aborts and closes the given internal transaction.</div> +</dd> +<dt><a href="../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">AbstractBlob</span></a> - Class in <a href="../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></dt> +<dd> +<div class="block">AbstractBlob implements a small set of common Blob methods.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractBlob.html#AbstractBlob()">AbstractBlob()</a></span> - Constructor for class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractBlob.html#AbstractBlob(com.amazon.carbonado.Repository)">AbstractBlob(Repository)</a></span> - Constructor for class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></dt> +<dd> +<div class="block">Use of this constructor indicates that setValue should operate within a + transaction.</div> +</dd> +<dt><a href="../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">AbstractClob</span></a> - Class in <a href="../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></dt> +<dd> +<div class="block">AbstractClob implements a small set of common Clob methods.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractClob.html#AbstractClob()">AbstractClob()</a></span> - Constructor for class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractClob.html#AbstractClob(com.amazon.carbonado.Repository)">AbstractClob(Repository)</a></span> - Constructor for class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></dt> +<dd> +<div class="block">Use of this constructor indicates that setValue should operate within a + transaction.</div> +</dd> +<dt><a href="../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">AbstractCursor</span></a><<a href="../com/amazon/carbonado/cursor/AbstractCursor.html" title="type parameter in AbstractCursor">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">AbstractCursor implements a small set of common Cursor methods.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/AbstractCursor.html#AbstractCursor()">AbstractCursor()</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util"><span class="strong">AbstractPool</span></a><<a href="../com/amazon/carbonado/util/AbstractPool.html" title="type parameter in AbstractPool">K</a>,<a href="../com/amazon/carbonado/util/AbstractPool.html" title="type parameter in AbstractPool">V</a>,<a href="../com/amazon/carbonado/util/AbstractPool.html" title="type parameter in AbstractPool">E</a> extends java.lang.Exception> - Class in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block">A concurrent pool of strongly referenced values mapped by key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AbstractPool.html#AbstractPool()">AbstractPool()</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">AbstractQuery</span></a><<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="type parameter in AbstractQuery">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">AbstractQuery implements a small set of common Query methods.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#AbstractQuery()">AbstractQuery()</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">AbstractQueryExecutor</span></a><<a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="type parameter in AbstractQueryExecutor">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">AbstractQueryExecutor implements a small set of common QueryExecutor methods.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html#AbstractQueryExecutor()">AbstractQueryExecutor()</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi"><span class="strong">AbstractRepository</span></a><<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="type parameter in AbstractRepository">Txn</a>> - Class in <a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></dt> +<dd> +<div class="block">Implements basic functionality required by a core Repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#AbstractRepository(java.lang.String)">AbstractRepository(String)</a></span> - Constructor for class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi"><span class="strong">AbstractRepositoryBuilder</span></a> - Class in <a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></dt> +<dd> +<div class="block">Abstract builder class for opening repositories.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#AbstractRepositoryBuilder()">AbstractRepositoryBuilder()</a></span> - Constructor for class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence"><span class="strong">AbstractSequenceValueProducer</span></a> - Class in <a href="../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html#AbstractSequenceValueProducer()">AbstractSequenceValueProducer()</a></span> - Constructor for class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">AbstractSequenceValueProducer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/AndFilter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept(Visitor<S, R, P>, P)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept(Visitor<S, R, P>, P)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ExistsFilter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept(Visitor<S, R, P>, P)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept(Visitor<S, R, P>, P)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Accept the given visitor subclass to traverse the filter tree.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept(Visitor<S, R, P>, P)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OrFilter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept(Visitor<S, R, P>, P)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#accept(com.amazon.carbonado.filter.Visitor, P)">accept(Visitor<S, R, P>, P)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#ADAPTER_FIELD_ELEMENT">ADAPTER_FIELD_ELEMENT</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Adapter field names are propertyName + "$adapter$" + number</div> +</dd> +<dt><a href="../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">AdapterDefinition</span></a> - Annotation Type in <a href="../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></dt> +<dd> +<div class="block">Allows annotations to be defined for supporting property types which are not + natively supported by the underlying storage layer.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#adaptToBlob(java.lang.String)">adaptToBlob(String)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TextAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToBoolean(char)">adaptToBoolean(char)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TrueFalseAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a character 'T' or 'F' to true or false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToBoolean(java.lang.Character)">adaptToBoolean(Character)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TrueFalseAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a character 'T' or 'F' to true or false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToBoolean(java.lang.String)">adaptToBoolean(String)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TrueFalseAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a character "T" or "F" to true or false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToBoolean(char)">adaptToBoolean(char)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">YesNoAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a character 'Y' or 'N' to true or false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToBoolean(java.lang.Character)">adaptToBoolean(Character)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">YesNoAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a character 'Y' or 'N' to true or false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToBoolean(java.lang.String)">adaptToBoolean(String)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">YesNoAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a character "Y" or "N" to true or false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToBooleanArray(byte[])">adaptToBooleanArray(byte[])</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">PrimitiveArrayAdapter.Adapter</a></dt> +<dd> +<div class="block">Unpacks a boolean array from a byte array, big-endian fashion.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToBooleanObj(char)">adaptToBooleanObj(char)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TrueFalseAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a character 'T' or 'F' to true or false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToBooleanObj(java.lang.Character)">adaptToBooleanObj(Character)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TrueFalseAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a character 'T' or 'F' to true or false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToBooleanObj(java.lang.String)">adaptToBooleanObj(String)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TrueFalseAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a character "T" or "F" to true or false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToBooleanObj(char)">adaptToBooleanObj(char)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">YesNoAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a character 'Y' or 'N' to true or false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToBooleanObj(java.lang.Character)">adaptToBooleanObj(Character)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">YesNoAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a character 'Y' or 'N' to true or false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToBooleanObj(java.lang.String)">adaptToBooleanObj(String)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">YesNoAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a character "Y" or "N" to true or false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToByteArray(short[])">adaptToByteArray(short[])</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">PrimitiveArrayAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToByteArray(char[])">adaptToByteArray(char[])</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">PrimitiveArrayAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToByteArray(int[])">adaptToByteArray(int[])</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">PrimitiveArrayAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToByteArray(long[])">adaptToByteArray(long[])</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">PrimitiveArrayAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToByteArray(float[])">adaptToByteArray(float[])</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">PrimitiveArrayAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToByteArray(double[])">adaptToByteArray(double[])</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">PrimitiveArrayAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToByteArray(boolean[])">adaptToByteArray(boolean[])</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">PrimitiveArrayAdapter.Adapter</a></dt> +<dd> +<div class="block">Packs the given boolean array into a byte array, big-endian fashion.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToChar(boolean)">adaptToChar(boolean)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TrueFalseAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a boolean true or false into 'T' or 'F'.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToChar(java.lang.Boolean)">adaptToChar(Boolean)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TrueFalseAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a boolean true into 'T', and anything else to 'F'.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToChar(boolean)">adaptToChar(boolean)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">YesNoAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a boolean true or false into 'Y' or 'N'.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToChar(java.lang.Boolean)">adaptToChar(Boolean)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">YesNoAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a boolean true into 'Y', and anything else to 'N'.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToCharacter(boolean)">adaptToCharacter(boolean)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TrueFalseAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a boolean true or false into 'T' or 'F'.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToCharacter(java.lang.Boolean)">adaptToCharacter(Boolean)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TrueFalseAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a boolean true into 'T', and anything else to 'F'.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToCharacter(boolean)">adaptToCharacter(boolean)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">YesNoAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a boolean true or false into 'Y' or 'N'.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToCharacter(java.lang.Boolean)">adaptToCharacter(Boolean)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">YesNoAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a boolean true into 'Y', and anything else to 'N'.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToCharArray(byte[])">adaptToCharArray(byte[])</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">PrimitiveArrayAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#adaptToClob(java.lang.String)">adaptToClob(String)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TextAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDate(org.joda.time.ReadableInstant)">adaptToDate(ReadableInstant)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDate(org.joda.time.LocalDateTime)">adaptToDate(LocalDateTime)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDate(org.joda.time.LocalDate)">adaptToDate(LocalDate)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDate(long)">adaptToDate(long)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDate(java.lang.Long)">adaptToDate(Long)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDate(java.lang.String)">adaptToDate(String)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDate(java.sql.Date)">adaptToDate(Date)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDate(java.sql.Time)">adaptToDate(Time)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDate(java.sql.Timestamp)">adaptToDate(Timestamp)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateMidnight(long)">adaptToDateMidnight(long)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateMidnight(java.lang.Long)">adaptToDateMidnight(Long)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateMidnight(java.lang.String)">adaptToDateMidnight(String)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateMidnight(java.util.Date)">adaptToDateMidnight(Date)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateMidnight(java.sql.Date)">adaptToDateMidnight(Date)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateMidnight(java.sql.Time)">adaptToDateMidnight(Time)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateMidnight(java.sql.Timestamp)">adaptToDateMidnight(Timestamp)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateTime(long)">adaptToDateTime(long)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateTime(java.lang.Long)">adaptToDateTime(Long)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateTime(java.lang.String)">adaptToDateTime(String)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateTime(java.util.Date)">adaptToDateTime(Date)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateTime(java.sql.Date)">adaptToDateTime(Date)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateTime(java.sql.Time)">adaptToDateTime(Time)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToDateTime(java.sql.Timestamp)">adaptToDateTime(Timestamp)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToDoubleArray(byte[])">adaptToDoubleArray(byte[])</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">PrimitiveArrayAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToFloatArray(byte[])">adaptToFloatArray(byte[])</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">PrimitiveArrayAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToIntArray(byte[])">adaptToIntArray(byte[])</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">PrimitiveArrayAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDate(long)">adaptToLocalDate(long)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDate(java.lang.Long)">adaptToLocalDate(Long)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDate(java.lang.String)">adaptToLocalDate(String)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDate(java.util.Date)">adaptToLocalDate(Date)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDate(java.sql.Date)">adaptToLocalDate(Date)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDate(java.sql.Time)">adaptToLocalDate(Time)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDate(java.sql.Timestamp)">adaptToLocalDate(Timestamp)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDateTime(long)">adaptToLocalDateTime(long)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDateTime(java.lang.Long)">adaptToLocalDateTime(Long)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDateTime(java.lang.String)">adaptToLocalDateTime(String)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDateTime(java.util.Date)">adaptToLocalDateTime(Date)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDateTime(java.sql.Date)">adaptToLocalDateTime(Date)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDateTime(java.sql.Time)">adaptToLocalDateTime(Time)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLocalDateTime(java.sql.Timestamp)">adaptToLocalDateTime(Timestamp)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLong(org.joda.time.ReadableInstant)">adaptToLong(ReadableInstant)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLong(org.joda.time.LocalDateTime)">adaptToLong(LocalDateTime)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLong(org.joda.time.LocalDate)">adaptToLong(LocalDate)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLong(java.util.Date)">adaptToLong(Date)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToLongArray(byte[])">adaptToLongArray(byte[])</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">PrimitiveArrayAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLongObj(org.joda.time.ReadableInstant)">adaptToLongObj(ReadableInstant)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLongObj(org.joda.time.LocalDateTime)">adaptToLongObj(LocalDateTime)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLongObj(org.joda.time.LocalDate)">adaptToLongObj(LocalDate)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToLongObj(java.util.Date)">adaptToLongObj(Date)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#adaptToShortArray(byte[])">adaptToShortArray(byte[])</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">PrimitiveArrayAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlDate(org.joda.time.ReadableInstant)">adaptToSqlDate(ReadableInstant)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlDate(org.joda.time.LocalDateTime)">adaptToSqlDate(LocalDateTime)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlDate(org.joda.time.LocalDate)">adaptToSqlDate(LocalDate)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlDate(java.util.Date)">adaptToSqlDate(Date)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlTime(org.joda.time.ReadableInstant)">adaptToSqlTime(ReadableInstant)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlTime(org.joda.time.LocalDateTime)">adaptToSqlTime(LocalDateTime)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlTime(java.util.Date)">adaptToSqlTime(Date)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlTimestamp(org.joda.time.ReadableInstant)">adaptToSqlTimestamp(ReadableInstant)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlTimestamp(org.joda.time.LocalDateTime)">adaptToSqlTimestamp(LocalDateTime)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlTimestamp(org.joda.time.LocalDate)">adaptToSqlTimestamp(LocalDate)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToSqlTimestamp(java.util.Date)">adaptToSqlTimestamp(Date)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToString(org.joda.time.ReadableInstant)">adaptToString(ReadableInstant)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToString(org.joda.time.LocalDateTime)">adaptToString(LocalDateTime)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToString(org.joda.time.LocalDate)">adaptToString(LocalDate)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#adaptToString(java.util.Date)">adaptToString(Date)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#adaptToString(com.amazon.carbonado.lob.Clob)">adaptToString(Clob)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TextAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#adaptToString(com.amazon.carbonado.lob.Blob)">adaptToString(Blob)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TextAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToString(boolean)">adaptToString(boolean)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TrueFalseAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a boolean true or false into "T" or "F".</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#adaptToString(java.lang.Boolean)">adaptToString(Boolean)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TrueFalseAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a boolean true into "T", and anything else to "F".</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToString(boolean)">adaptToString(boolean)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">YesNoAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a boolean true or false into "Y" or "N".</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#adaptToString(java.lang.Boolean)">adaptToString(Boolean)</a></span> - Method in class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">YesNoAdapter.Adapter</a></dt> +<dd> +<div class="block">Adapts a boolean true into "Y", and anything else to "N".</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html#add(S)">add(S)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">MergeSortBuffer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#addAccessorAnnotationDescriptor(java.lang.String)">addAccessorAnnotationDescriptor(String)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> +<div class="block">Add an arbitrary annotation to the property accessor method, as + specified by a descriptor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addAlternateKey()">addAlternateKey()</a></span> - Method in interface com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></dt> +<dd> +<div class="block">Add an alternate key to be built.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addAlternateKey()">addAlternateKey()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addAlternateKey()">addAlternateKey()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorableIndexSet.html#addAlternateKeys(com.amazon.carbonado.info.StorableInfo)">addAlternateKeys(StorableInfo<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></dt> +<dd> +<div class="block">Adds all of the alternate keys of the given storable as indexes by + calling <a href="../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#addEqualsCall(org.cojen.classfile.CodeBuilder, java.lang.String, org.cojen.classfile.TypeDesc, boolean, org.cojen.classfile.Label, org.cojen.classfile.LocalVariable)">addEqualsCall(CodeBuilder, String, TypeDesc, boolean, Label, LocalVariable)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Generates code to compare a field in this object against the same one in a + different instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addIndex()">addIndex()</a></span> - Method in interface com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></dt> +<dd> +<div class="block">Add an index to the set managed by this builder.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addIndex()">addIndex()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addIndex()">addIndex()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorableIndexSet.html#addIndexes(com.amazon.carbonado.info.StorableInfo)">addIndexes(StorableInfo<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></dt> +<dd> +<div class="block">Adds all the indexes of the given storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorableIndexSet.html#addIndexes(com.amazon.carbonado.info.StorableInfo, com.amazon.carbonado.info.Direction)">addIndexes(StorableInfo<S>, Direction)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></dt> +<dd> +<div class="block">Adds all the indexes of the given storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#addInvokeReadMethod(org.cojen.classfile.CodeAssembler)">addInvokeReadMethod(CodeAssembler)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#addInvokeReadMethod(org.cojen.classfile.CodeAssembler, org.cojen.classfile.TypeDesc)">addInvokeReadMethod(CodeAssembler, TypeDesc)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#addInvokeWriteMethod(org.cojen.classfile.CodeAssembler)">addInvokeWriteMethod(CodeAssembler)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#addInvokeWriteMethod(org.cojen.classfile.CodeAssembler, org.cojen.classfile.TypeDesc)">addInvokeWriteMethod(CodeAssembler, TypeDesc)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)">addKey(StorableKey<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></dt> +<dd> +<div class="block">Adds the key as a unique index, preserving the property arrangement.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addKeyProperty(java.lang.String, com.amazon.carbonado.info.Direction)">addKeyProperty(String, Direction)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> +<div class="block">Add a property to the primary key which is a member of the Storable type + being referenced by this one.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorableIndexSet.html#addPrimaryKey(com.amazon.carbonado.info.StorableInfo)">addPrimaryKey(StorableInfo<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></dt> +<dd> +<div class="block">Adds the primary key of the given storable as indexes by calling <a href="../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addPrimaryKey()">addPrimaryKey()</a></span> - Method in interface com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></dt> +<dd> +<div class="block">Add a primary key to be built.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addPrimaryKey()">addPrimaryKey()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addPrimaryKey()">addPrimaryKey()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#addProperty(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">addProperty(StorableProperty<S>, Direction)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns a StorableIndex with the given property added.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addProperty(java.lang.String, java.lang.Class)">addProperty(String, Class)</a></span> - Method in interface com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></dt> +<dd> +<div class="block">Add a property to the set managed by this builder.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">addProperty(SyntheticProperty)</a></span> - Method in interface com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></dt> +<dd> +<div class="block">Add an externally defined synthetic property to the list</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticPropertyList.html#addProperty(java.lang.String)">addProperty(String)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic">SyntheticPropertyList</a></dt> +<dd> +<div class="block">Adds a property to this index, with an unspecified direction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticPropertyList.html#addProperty(java.lang.String, com.amazon.carbonado.info.Direction)">addProperty(String, Direction)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic">SyntheticPropertyList</a></dt> +<dd> +<div class="block">Adds a property to this index, with the specified direction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addProperty(java.lang.String, java.lang.Class)">addProperty(String, Class)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">addProperty(SyntheticProperty)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addProperty(java.lang.String, java.lang.Class)">addProperty(String, Class)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addProperty(com.amazon.carbonado.synthetic.SyntheticProperty)">addProperty(SyntheticProperty)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/GroupedCursor.html#addToGroup(S)">addToGroup(S)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor">GroupedCursor</a></dt> +<dd> +<div class="block">This method is called when more entries are found for the current + group.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#addTrigger(com.amazon.carbonado.Trigger)">addTrigger(Trigger<? super S>)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storage.html#addTrigger(com.amazon.carbonado.Trigger)">addTrigger(Trigger<? super S>)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></dt> +<dd> +<div class="block">Register a trigger which will be called for overridden methods in the given + trigger implementation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">addTriggerFactory(TriggerFactory)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dt> +<dd> +<div class="block">Optionally add a TriggerFactory which will be called upon to create an + initial trigger for each Storable type that the Repository supports.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#addTriggerFactory(com.amazon.carbonado.TriggerFactory)">addTriggerFactory(TriggerFactory)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#addTriggers(java.lang.Class, java.lang.Iterable)">addTriggers(Class<S>, Iterable<TriggerFactory>)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#addValueHashCodeCall(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc, boolean, boolean)">addValueHashCodeCall(CodeBuilder, TypeDesc, boolean, boolean)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Generates code to compute a hashcode for a value on the stack, consuming + the value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#addValuesEqualCall(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc, boolean, org.cojen.classfile.Label, boolean)">addValuesEqualCall(CodeBuilder, TypeDesc, boolean, Label, boolean)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Generates code to compare two values on the stack, and branch to the + provided Label if they are not equal.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#after(T)">after(T)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#after(T)">after(T)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#after(T)">after(T)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a query which fetches results for this query after a given + starting point, which is useful for re-opening a cursor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html#afterDelete(S, java.lang.Object)">afterDelete(S, Object)</a></span> - Method in class com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a></dt> +<dd> +<div class="block">Called right after a bogus storable has been successfully deleted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#afterDelete(S, java.lang.Object)">afterDelete(S, Object)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#afterDelete(S, java.lang.Object)">afterDelete(S, Object)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called right after a storable has been successfully deleted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html#afterInsert(S, java.lang.Object)">afterInsert(S, Object)</a></span> - Method in class com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a></dt> +<dd> +<div class="block">Called right after a sync'd storable has been successfully inserted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#afterInsert(S, java.lang.Object)">afterInsert(S, Object)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#afterInsert(S, java.lang.Object)">afterInsert(S, Object)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called right after a storable has been successfully inserted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#afterLoad(S)">afterLoad(S)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#afterLoad(S)">afterLoad(S)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called right after a storable has been successfully loaded or + fetched.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#afterTryDelete(S, java.lang.Object)">afterTryDelete(S, Object)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#afterTryDelete(S, java.lang.Object)">afterTryDelete(S, Object)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called right after a storable has been successfully deleted via + tryDelete.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#afterTryInsert(S, java.lang.Object)">afterTryInsert(S, Object)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#afterTryInsert(S, java.lang.Object)">afterTryInsert(S, Object)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called right after a storable has been successfully inserted via + tryInsert.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#afterTryUpdate(S, java.lang.Object)">afterTryUpdate(S, Object)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#afterTryUpdate(S, java.lang.Object)">afterTryUpdate(S, Object)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called right after a storable has been successfully updated via + tryUpdate.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html#afterUpdate(S, java.lang.Object)">afterUpdate(S, Object)</a></span> - Method in class com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a></dt> +<dd> +<div class="block">Called right after a sync'd storable has been successfully updated.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#afterUpdate(S, java.lang.Object)">afterUpdate(S, Object)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#afterUpdate(S, java.lang.Object)">afterUpdate(S, Object)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called right after a storable has been successfully updated.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado"><span class="strong">Alias</span></a> - Annotation Type in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Identifies alternate names for a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> or a Storable property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#allStorage()">allStorage()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> +<div class="block">Returns all available Storage instances.</div> +</dd> +<dt><a href="../com/amazon/carbonado/AlternateKeys.html" title="annotation in com.amazon.carbonado"><span class="strong">AlternateKeys</span></a> - Annotation Type in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">List of alternate keys for a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze(Filter<S>, OrderingList<S>, QueryHints)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#analyze(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">analyze(Filter<S>, OrderingList<S>, QueryHints)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#and(com.amazon.carbonado.filter.Filter)">and(Filter<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#and(java.lang.String)">and(String)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#and(com.amazon.carbonado.filter.Filter)">and(Filter<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp)">and(String, RelOp)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#and(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">and(String, RelOp, Object)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the one given.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#and(com.amazon.carbonado.filter.Filter)">and(Filter<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#and(java.lang.String)">and(String)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#and(com.amazon.carbonado.filter.Filter)">and(Filter<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always throws an IllegalStateException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#and(com.amazon.carbonado.filter.Filter)">and(Filter<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#and(java.lang.String)">and(String)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a new query which has another <a href="../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of + results.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#and(com.amazon.carbonado.filter.Filter)">and(Filter<S>)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a new query which has another <a href="../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "and"ed to this, potentially reducing the amount of + results.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#AND_METHOD_NAME">AND_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Query API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#andExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andExists(String, Filter<?>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the "exists" test applied to a join.</div> +</dd> +<dt><a href="../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">AndFilter</span></a><<a href="../com/amazon/carbonado/filter/AndFilter.html" title="type parameter in AndFilter">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></dt> +<dd> +<div class="block">Filter tree node that performs a logical 'and' test.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#andNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">andNotExists(String, Filter<?>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns a combined filter instance that accepts records which are only + accepted by this filter and the "not exists" test applied to a join.</div> +</dd> +<dt><a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util"><span class="strong">AnnotationBuilder</span></a> - Class in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block">Builds all Annotation properties to a Cojen Annotation definition.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#AnnotationBuilder()">AnnotationBuilder()</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/util/AnnotationDescParser.html" title="class in com.amazon.carbonado.util"><span class="strong">AnnotationDescParser</span></a> - Class in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block">Parses an annotation descriptor String to a Cojen Annotation definition.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescParser.html#AnnotationDescParser(java.lang.String)">AnnotationDescParser(String)</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescParser.html" title="class in com.amazon.carbonado.util">AnnotationDescParser</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util"><span class="strong">AnnotationDescPrinter</span></a> - Class in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block">Prints machine readable, self-describing, annotation descriptors.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#AnnotationDescPrinter(boolean, java.lang.StringBuilder)">AnnotationDescPrinter(boolean, StringBuilder)</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util"><span class="strong">AnnotationPrinter</span></a> - Class in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block">Prints an Annotation into a parseable format, exactly the same as Java + Annotation syntax.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#AnnotationPrinter(boolean, java.lang.StringBuilder)">AnnotationPrinter(boolean, StringBuilder)</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util"><span class="strong">AnnotationVisitor</span></a><<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">R</a>,<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="type parameter in AnnotationVisitor">P</a>> - Class in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block">Generic annotation visitor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#AnnotationVisitor(boolean)">AnnotationVisitor(boolean)</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.StorableProperty)">append(StorableProperty<?>)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.StorableProperty, boolean)">append(StorableProperty<?>, boolean)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.ChainedProperty)">append(ChainedProperty<?>)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</dd> +<dt><a href="../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util"><span class="strong">Appender</span></a> - Interface in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block">Interface that supports an alternate way of providing a string representation + for an object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/AndFilter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo(Appendable, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo(Appendable, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ExistsFilter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo(Appendable, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable)">appendTo(Appendable)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Appends the string value of this filter into the given Appendable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo(Appendable, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Appends the string value of this filter into the given Appendable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#appendTo(java.lang.Appendable)">appendTo(Appendable)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo(Appendable, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OrFilter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo(Appendable, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#appendTo(java.lang.Appendable, com.amazon.carbonado.filter.FilterValues)">appendTo(Appendable, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#appendTo(java.lang.Appendable)">appendTo(Appendable)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Appends the chained property formatted as "name.subname.subsubname".</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/OrderedProperty.html#appendTo(java.lang.Appendable)">appendTo(Appendable)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#appendTo(java.lang.Appendable)">appendTo(Appendable)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Appends the same results as toString, but without the "StorableIndex" + prefix.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#appendTo(java.lang.Appendable)">appendTo(Appendable)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#appendTo(java.lang.Appendable)">appendTo(Appendable)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">appendTo(Appendable)</a></span> - Method in interface com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></dt> +<dd> +<div class="block">Append the string representation of this object to the given Appendable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/ControllerCursor.html#apply(com.amazon.carbonado.Cursor, com.amazon.carbonado.Query.Controller)">apply(Cursor<S>, Query.Controller)</a></span> - Static method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/ControllerCursor.html" title="class in com.amazon.carbonado.cursor">ControllerCursor</a></dt> +<dd> +<div class="block">Returns a ControllerCursor depending on whether a controller instance is + passed in or not.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/FilteredCursor.html#applyFilter(com.amazon.carbonado.Cursor, java.lang.Class, java.lang.String, java.lang.Object...)">applyFilter(Cursor<S>, Class<S>, String, Object...)</a></span> - Static method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor">FilteredCursor</a></dt> +<dd> +<div class="block">Returns a Cursor that is filtered by the given filter expression and values.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/FilteredCursor.html#applyFilter(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Cursor)">applyFilter(Filter<S>, FilterValues<S>, Cursor<S>)</a></span> - Static method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor">FilteredCursor</a></dt> +<dd> +<div class="block">Returns a Cursor that is filtered by the given Filter and FilterValues.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Comparators.html#arrayComparator(java.lang.Class, boolean)">arrayComparator(Class<T>, boolean)</a></span> - Static method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Comparators.html" title="class in com.amazon.carbonado.util">Comparators</a></dt> +<dd> +<div class="block">Returns a comparator which can sort single or multi-dimensional arrays + of primitves or Comparables.</div> +</dd> +<dt><a href="../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="class in com.amazon.carbonado.cursor"><span class="strong">ArraySortBuffer</span></a><<a href="../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="type parameter in ArraySortBuffer">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Sort buffer implementation backed by an ArrayList.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/ArraySortBuffer.html#ArraySortBuffer()">ArraySortBuffer()</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="class in com.amazon.carbonado.cursor">ArraySortBuffer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/ArraySortBuffer.html#ArraySortBuffer(int)">ArraySortBuffer(int)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="class in com.amazon.carbonado.cursor">ArraySortBuffer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(java.lang.Class, java.lang.String)">asJoinedFrom(Class<T>, String)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Prepends a join property to all properties of this filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">asJoinedFrom(ChainedProperty<T>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Prepends a join property to all properties of this filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/AndFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny(ChainedProperty<T>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny(ChainedProperty<T>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ExistsFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny(ChainedProperty<T>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny(ChainedProperty<T>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Allows join from any property type, including one-to-many joins.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny(ChainedProperty<T>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OrFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny(ChainedProperty<T>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny(ChainedProperty<T>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#assertParameterNotNull(org.cojen.classfile.CodeBuilder, int)">assertParameterNotNull(CodeBuilder, int)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Generate code to throw an exception if a parameter is null</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#assertReady()">assertReady()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></dt> +<dd> +<div class="block">Throw a configuration exception if the configuration is not filled out + sufficiently and correctly such that a repository could be instantiated + from it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractBlob.html#asString()">asString()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractBlob.html#asString(java.lang.String)">asString(String)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractBlob.html#asString(java.nio.charset.Charset)">asString(Charset)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractClob.html#asString()">asString()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Blob.html#asString()">asString()</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></dt> +<dd> +<div class="block">Convenience method to capture all the Blob data as a single String, + assuming UTF-8 encoding.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Blob.html#asString(java.lang.String)">asString(String)</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></dt> +<dd> +<div class="block">Convenience method to capture all the Blob data as a single String, + decoded against the given charset.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Blob.html#asString(java.nio.charset.Charset)">asString(Charset)</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></dt> +<dd> +<div class="block">Convenience method to capture all the Blob data as a single String, + decoded against the given charset.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/CharArrayClob.html#asString()">asString()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Clob.html#asString()">asString()</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></dt> +<dd> +<div class="block">Convenience method to capture all the Clob data as a single String.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/StringClob.html#asString()">asString()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Transaction.html#attach()">attach()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></dt> +<dd> +<div class="block">Attaches this transaction to the current thread, if it has been + detached.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionPair.html#attach()">attach()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn">TransactionPair</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionScope.html#attach()">attach()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a></dt> +<dd> +<div class="block">Attach this scope to the current thread, if it has been <a href="../com/amazon/carbonado/txn/TransactionManager.html#detachLocalScope()"><code>detached</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionManager.html#attachNotification(Txn)">attachNotification(Txn)</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></dt> +<dd> +<div class="block">Called to notify internal method that transaction is attached.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado"><span class="strong">Authoritative</span></a> - Annotation Type in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Indicates that all accesses to this <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> must come from an + authoritative source.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Automatic.html" title="annotation in com.amazon.carbonado"><span class="strong">Automatic</span></a> - Annotation Type in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Identifies a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property capable of selecting its own value on + insert.</div> +</dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Letter</li> +<li><a href="index-2.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-1.html" target="_top">Frames</a></li> +<li><a href="index-1.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-10.html b/apidocs/index-files/index-10.html new file mode 100644 index 0000000..fa12fdb --- /dev/null +++ b/apidocs/index-files/index-10.html @@ -0,0 +1,167 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>J-Index (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="J-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-9.html">Prev Letter</a></li> +<li><a href="index-11.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-10.html" target="_top">Frames</a></li> +<li><a href="index-10.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_J_"> +<!-- --> +</a> +<h2 class="title">J</h2> +<dl> +<dt><a href="../com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">JDBCBlobLoader</span></a> - Interface in <a href="../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></dt> +<dd> +<div class="block">Callback for reloading Blobs outside original transaction.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">JDBCClobLoader</span></a> - Interface in <a href="../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></dt> +<dd> +<div class="block">Callback for reloading Clobs outside original transaction.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">JDBCConnectionCapability</span></a> - Interface in <a href="../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></dt> +<dd> +<div class="block">Capability to directly access the JDBC connection being used by the current + transaction, which is thread-local.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">JDBCRepositoryBuilder</span></a> - Class in <a href="../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></dt> +<dd> +<div class="block">Builds a repository instance backed by a JDBC accessible database.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#JDBCRepositoryBuilder()">JDBCRepositoryBuilder()</a></span> - Constructor for class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">JDBCStorableInfo</span></a><<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="type parameter in JDBCStorableInfo">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></dt> +<dd> +<div class="block">Contains all the metadata describing a specific <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type as + needed by JDBCRepository.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">JDBCStorableIntrospector</span></a> - Class in <a href="../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></dt> +<dd> +<div class="block">Provides additional metadata for a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type needed by + JDBCRepository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html#JDBCStorableIntrospector()">JDBCStorableIntrospector()</a></span> - Constructor for class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCStorableIntrospector</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">JDBCStorableProperty</span></a><<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="type parameter in JDBCStorableProperty">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></dt> +<dd> +<div class="block">Contains all the metadata describing a property of a specific <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type as needed by JDBCRepository.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">JDBCSupport</span></a><<a href="../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="type parameter in JDBCSupport">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/Join.html" title="annotation in com.amazon.carbonado"><span class="strong">Join</span></a> - Annotation Type in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Identifies a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property as defining a join relationship + with another Storable type.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">JoinedQueryExecutor</span></a><<a href="../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,<a href="../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="type parameter in JoinedQueryExecutor">T</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">QueryExecutor which joins a <i>source</i> and <i>target</i> executor, + producing results of target type.</div> +</dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-9.html">Prev Letter</a></li> +<li><a href="index-11.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-10.html" target="_top">Frames</a></li> +<li><a href="index-10.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-11.html b/apidocs/index-files/index-11.html new file mode 100644 index 0000000..a6efe45 --- /dev/null +++ b/apidocs/index-files/index-11.html @@ -0,0 +1,152 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>K-Index (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="K-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-10.html">Prev Letter</a></li> +<li><a href="index-12.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-11.html" target="_top">Frames</a></li> +<li><a href="index-11.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_K_"> +<!-- --> +</a> +<h2 class="title">K</h2> +<dl> +<dt><a href="../com/amazon/carbonado/Key.html" title="annotation in com.amazon.carbonado"><span class="strong">Key</span></a> - Annotation Type in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Identifies a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property as being a member of an alternate + key.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">KeyDecoder</span></a> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">A very low-level class that decodes key components encoded by methods of + <a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw"><code>KeyEncoder</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#KeyDecoder()">KeyDecoder()</a></span> - Constructor for class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">KeyEncoder</span></a> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">A very low-level class that supports encoding of primitive data into unique, + sortable byte array keys.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#KeyEncoder()">KeyEncoder()</a></span> - Constructor for class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">KeyQueryExecutor</span></a><<a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">QueryExecutor which has a fully specified key, and so cursors produce at + most one result.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html#KeyQueryExecutor(com.amazon.carbonado.qe.KeyQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.FilteringScore)">KeyQueryExecutor(KeyQueryExecutor.Support<S>, StorableIndex<S>, FilteringScore<S>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">KeyQueryExecutor.Support</span></a><<a href="../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Provides support for <a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>KeyQueryExecutor</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorablePropertyMap.html#keySet()">keySet()</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a></dt> +<dd> </dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-10.html">Prev Letter</a></li> +<li><a href="index-12.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-11.html" target="_top">Frames</a></li> +<li><a href="index-11.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-12.html b/apidocs/index-files/index-12.html new file mode 100644 index 0000000..5685e6f --- /dev/null +++ b/apidocs/index-files/index-12.html @@ -0,0 +1,341 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>L-Index (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="L-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-11.html">Prev Letter</a></li> +<li><a href="index-13.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-12.html" target="_top">Frames</a></li> +<li><a href="index-12.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_L_"> +<!-- --> +</a> +<h2 class="title">L</h2> +<dl> +<dt><a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout"><span class="strong">Layout</span></a> - Class in <a href="../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></dt> +<dd> +<div class="block">Describes the layout of a specific generation of a storable.</div> +</dd> +<dt><a href="../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout"><span class="strong">LayoutCapability</span></a> - Interface in <a href="../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></dt> +<dd> +<div class="block">Capability to get layout information on any storable generation.</div> +</dd> +<dt><a href="../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout"><span class="strong">LayoutFactory</span></a> - Class in <a href="../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></dt> +<dd> +<div class="block">Factory for obtaining references to storable layouts.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutFactory.html#LayoutFactory(com.amazon.carbonado.Repository)">LayoutFactory(Repository)</a></span> - Constructor for class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">LayoutFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutCapability.html#layoutFor(java.lang.Class)">layoutFor(Class<? extends Storable>)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a></dt> +<dd> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutCapability.html#layoutFor(java.lang.Class, int)">layoutFor(Class<? extends Storable>, int)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutCapability.html" title="interface in com.amazon.carbonado.layout">LayoutCapability</a></dt> +<dd> +<div class="block">Returns the layout for a particular generation of the given type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class)">layoutFor(Class<? extends Storable>)</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">LayoutFactory</a></dt> +<dd> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor(Class<? extends Storable>, LayoutOptions)</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">LayoutFactory</a></dt> +<dd> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(boolean, java.lang.Class, com.amazon.carbonado.layout.LayoutOptions)">layoutFor(boolean, Class<? extends Storable>, LayoutOptions)</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">LayoutFactory</a></dt> +<dd> +<div class="block">Returns the layout matching the current definition of the given type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutFactory.html#layoutFor(java.lang.Class, int)">layoutFor(Class<? extends Storable>, int)</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">LayoutFactory</a></dt> +<dd> +<div class="block">Returns the layout for a particular generation of the given type.</div> +</dd> +<dt><a href="../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout"><span class="strong">LayoutOptions</span></a> - Class in <a href="../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></dt> +<dd> +<div class="block">Extra options encoded with a Storable layout.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutOptions.html#LayoutOptions()">LayoutOptions()</a></span> - Constructor for class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout"><span class="strong">LayoutProperty</span></a> - Class in <a href="../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></dt> +<dd> +<div class="block">Describes how a property is defined in a specific generation of a storable.</div> +</dd> +<dt><a href="../com/amazon/carbonado/layout/LayoutSync.html" title="class in com.amazon.carbonado.layout"><span class="strong">LayoutSync</span></a> - Class in <a href="../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></dt> +<dd> +<div class="block">Synchronizes layout metadata between two repositories.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutSync.html#LayoutSync(com.amazon.carbonado.Repository, com.amazon.carbonado.Repository)">LayoutSync(Repository, Repository)</a></span> - Constructor for class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutSync.html" title="class in com.amazon.carbonado.layout">LayoutSync</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">LengthConstraint</span></a> - Annotation Type in <a href="../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></dt> +<dd> +<div class="block">Limits the value of a property to lie within a specific length range.</div> +</dd> +<dt><a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">LengthConstraint.Constraint</span></a> - Class in <a href="../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></dt> +<dd> +<div class="block">Constraint implementation for <a href="../com/amazon/carbonado/constraint/LengthConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>LengthConstraint</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#LengthConstraint.Constraint(java.lang.Class, java.lang.String, com.amazon.carbonado.constraint.LengthConstraint)">LengthConstraint.Constraint(Class<?>, String, LengthConstraint)</a></span> - Constructor for class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">LengthConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#LengthConstraint.Constraint(java.lang.Class, java.lang.String, int, int)">LengthConstraint.Constraint(Class<?>, String, int, int)</a></span> - Constructor for class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">LengthConstraint.Constraint</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/cursor/LimitCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">LimitCursor</span></a><<a href="../com/amazon/carbonado/cursor/LimitCursor.html" title="type parameter in LimitCursor">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Wraps another cursor to limit the amount of elements.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/LimitCursor.html#LimitCursor(com.amazon.carbonado.Cursor, long)">LimitCursor(Cursor<S>, long)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/LimitCursor.html" title="class in com.amazon.carbonado.cursor">LimitCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html#load(com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability)">load(JDBCConnectionCapability)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCBlobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCBlobLoader</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html#load(com.amazon.carbonado.repo.jdbc.JDBCConnectionCapability)">load(JDBCConnectionCapability)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCClobLoader.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCClobLoader</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#load()">load()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Loads or reloads this object from the storage layer by a primary or + alternate key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#LOAD_COMPLETED_METHOD_NAME">LOAD_COMPLETED_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Name of protected method which must be called after load to identify all + properties as valid and to fire any load triggers.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#LOAD_METHOD_NAME">LOAD_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#LOAD_ONE_METHOD_NAME">LOAD_ONE_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Query API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#loadOne()">loadOne()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#loadOne(com.amazon.carbonado.Query.Controller)">loadOne(Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#loadOne()">loadOne()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Attempts to load exactly one matching object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#loadOne(com.amazon.carbonado.Query.Controller)">loadOne(Query.Controller)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Attempts to load exactly one matching object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#loadPropertyValue(org.cojen.classfile.LocalVariable[], java.lang.Boolean[], org.cojen.classfile.CodeAssembler, com.amazon.carbonado.raw.StorablePropertyInfo, int, boolean, org.cojen.classfile.LocalVariable, java.lang.Class, org.cojen.classfile.LocalVariable)">loadPropertyValue(LocalVariable[], Boolean[], CodeAssembler, StorablePropertyInfo, int, boolean, LocalVariable, Class<?>, LocalVariable)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Generates code to load a property value onto the operand stack.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#loadPropertyValue(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.raw.StorablePropertyInfo, int, boolean, org.cojen.classfile.LocalVariable, java.lang.Class, org.cojen.classfile.LocalVariable)">loadPropertyValue(CodeAssembler, StorablePropertyInfo, int, boolean, LocalVariable, Class<?>, LocalVariable)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Generates code to load a property value onto the operand stack.</div> +</dd> +<dt><a href="../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Lob</span></a> - Interface in <a href="../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></dt> +<dd> +<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> +</dd> +<dt><a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi"><span class="strong">LobEngine</span></a> - Class in <a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></dt> +<dd> +<div class="block">Complete Lob support for repositories, although repository is responsible + for binding Lob properties to this engine.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/LobEngine.html#LobEngine(com.amazon.carbonado.Repository, com.amazon.carbonado.Repository)">LobEngine(Repository, Repository)</a></span> - Constructor for class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/LobEngine.html#LobEngine(com.amazon.carbonado.Repository, com.amazon.carbonado.sequence.SequenceValueProducer)">LobEngine(Repository, SequenceValueProducer)</a></span> - Constructor for class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/CompositeScore.html#localForeignComparator()">localForeignComparator()</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></dt> +<dd> +<div class="block">Returns a partial comparator suited for comparing local indexes to + foreign indexes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/CompositeScore.html#localForeignComparator(com.amazon.carbonado.qe.QueryHints)">localForeignComparator(QueryHints)</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></dt> +<dd> +<div class="block">Returns a partial comparator suited for comparing local indexes to + foreign indexes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#locallyDisableDelete()">locallyDisableDelete()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> +<div class="block">Disables execution of all managed delete triggers for the current + thread.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#locallyDisableInsert()">locallyDisableInsert()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> +<div class="block">Disables execution of all managed insert triggers for the current + thread.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#locallyDisableLoad()">locallyDisableLoad()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> +<div class="block">Disables execution of all managed load triggers for the current + thread.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/TriggerSupport.html#locallyDisableLoadTrigger()">locallyDisableLoadTrigger()</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a></dt> +<dd> +<div class="block">Disables execution of load trigger for the current thread.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#locallyDisableUpdate()">locallyDisableUpdate()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> +<div class="block">Disables execution of all managed update triggers for the current + thread.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#locallyEnableDelete()">locallyEnableDelete()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> +<div class="block">Enables execution of all managed delete triggers for the current thread, + if they had been disabled before.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#locallyEnableInsert()">locallyEnableInsert()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> +<div class="block">Enables execution of all managed insert triggers for the current thread, + if they had been disabled before.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#locallyEnableLoad()">locallyEnableLoad()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> +<div class="block">Enables execution of all managed load triggers for the current thread, + if they had been disabled before.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/TriggerSupport.html#locallyEnableLoadTrigger()">locallyEnableLoadTrigger()</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a></dt> +<dd> +<div class="block">Enables execution of load trigger for the current thread, if they it + been disabled before.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#locallyEnableUpdate()">locallyEnableUpdate()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> +<div class="block">Enables execution of all managed update triggers for the current thread, + if they had been disabled before.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionManager.html#localScope()">localScope()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></dt> +<dd> +<div class="block">Returns the thread-local TransactionScope, creating it if needed.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#localTransactionScope()">localTransactionScope()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> +<div class="block">Returns the thread-local TransactionScope, creating it if needed.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#lockoutShutdown()">lockoutShutdown()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> +<div class="block">Call to prevent shutdown hook from running.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging"><span class="strong">Log</span></a> - Interface in <a href="../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></dt> +<dd> +<div class="block">Very simple Log interface.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/logging/LogAccessCapability.html" title="interface in com.amazon.carbonado.repo.logging"><span class="strong">LogAccessCapability</span></a> - Interface in <a href="../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></dt> +<dd> +<div class="block">Provides access to the Log.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">LoggingDataSource</span></a> - Class in <a href="../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></dt> +<dd> +<div class="block">Wraps another DataSource such that all SQL statements are logged as debug.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging"><span class="strong">LoggingRepositoryBuilder</span></a> - Class in <a href="../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></dt> +<dd> +<div class="block">Repository implementation which logs activity against it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#LoggingRepositoryBuilder()">LoggingRepositoryBuilder()</a></span> - Constructor for class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/IsolationLevel.html#lowestCommon(com.amazon.carbonado.IsolationLevel)">lowestCommon(IsolationLevel)</a></span> - Method in enum com.amazon.carbonado.<a href="../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></dt> +<dd> +<div class="block">Returns the lowest common isolation level between this and the one + given.</div> +</dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-11.html">Prev Letter</a></li> +<li><a href="index-13.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-12.html" target="_top">Frames</a></li> +<li><a href="index-12.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-13.html b/apidocs/index-files/index-13.html new file mode 100644 index 0000000..2550f5d --- /dev/null +++ b/apidocs/index-files/index-13.html @@ -0,0 +1,355 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>M-Index (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="M-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-12.html">Prev Letter</a></li> +<li><a href="index-14.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-13.html" target="_top">Frames</a></li> +<li><a href="index-13.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_M_"> +<!-- --> +</a> +<h2 class="title">M</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIntrospector.html#main(java.lang.String[])">main(String[])</a></span> - Static method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">StorableIntrospector</a></dt> +<dd> +<div class="block">Test program which examines candidate Storable classes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Throttle.html#main(java.lang.String[])">main(String[])</a></span> - Static method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Throttle.html" title="class in com.amazon.carbonado.util">Throttle</a></dt> +<dd> +<div class="block">Test program which exercises the CPU in an infinite loop, throttled by + the amount given in args[0].</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistDeadlockException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException(String, Throwable)</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistDeadlockException.html" title="class in com.amazon.carbonado">PersistDeadlockException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistInterruptedException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException(String, Throwable)</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistInterruptedException.html" title="class in com.amazon.carbonado">PersistInterruptedException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistMultipleException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException(String, Throwable)</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistNoneException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException(String, Throwable)</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistTimeoutException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException(String, Throwable)</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistTimeoutException.html" title="class in com.amazon.carbonado">PersistTimeoutException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryException.html#makeFetchException(java.lang.String, java.lang.Throwable)">makeFetchException(String, Throwable)</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></dt> +<dd> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchDeadlockException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException(String, Throwable)</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchDeadlockException.html" title="class in com.amazon.carbonado">FetchDeadlockException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchInterruptedException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException(String, Throwable)</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchInterruptedException.html" title="class in com.amazon.carbonado">FetchInterruptedException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchMultipleException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException(String, Throwable)</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchNoneException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException(String, Throwable)</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchTimeoutException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException(String, Throwable)</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado">FetchTimeoutException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryException.html#makePersistException(java.lang.String, java.lang.Throwable)">makePersistException(String, Throwable)</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></dt> +<dd> +<div class="block">Subclasses can override this to provide a more specialized exception.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#makePlainDescriptor(java.lang.Class)">makePlainDescriptor(Class<? extends Annotation>)</a></span> - Static method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> +<div class="block">Returns an annotation descriptor that has no parameters.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#makePlainDescriptor(java.lang.String)">makePlainDescriptor(String)</a></span> - Static method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> +<div class="block">Returns an annotation descriptor that has no parameters.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#makeReadMethodName(java.lang.String, java.lang.Class)">makeReadMethodName(String, Class)</a></span> - Static method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> +<div class="block">Generate a name for a bean "get" method ("is" method, for booleans).</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#makeWriteMethodName(java.lang.String)">makeWriteMethodName(String)</a></span> - Static method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> +<div class="block">Generate a name for a bean "set" method</div> +</dd> +<dt><a href="../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado"><span class="strong">MalformedArgumentException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">A MalformedArgumentException is thrown after detailed analysis on an + argument determined it was not suitable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedArgumentException.html#MalformedArgumentException()">MalformedArgumentException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">MalformedArgumentException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedArgumentException.html#MalformedArgumentException(java.lang.String)">MalformedArgumentException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">MalformedArgumentException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedArgumentException.html#MalformedArgumentException(java.util.List)">MalformedArgumentException(List<String>)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">MalformedArgumentException</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado"><span class="strong">MalformedFilterException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">A MalformedFilterException indicates that a + <a href="../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>query filter</code></a> is invalid.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedFilterException.html#MalformedFilterException(java.lang.String)">MalformedFilterException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado">MalformedFilterException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedFilterException.html#MalformedFilterException(java.lang.String, int)">MalformedFilterException(String, int)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado">MalformedFilterException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedFilterException.html#MalformedFilterException(java.lang.String, java.lang.String)">MalformedFilterException(String, String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado">MalformedFilterException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedFilterException.html#MalformedFilterException(java.lang.String, java.lang.String, int)">MalformedFilterException(String, String, int)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado">MalformedFilterException</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado"><span class="strong">MalformedTypeException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">A MalformedTypeException indicates that a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> is defined in a + way that violates the requirements for Storable objects.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedTypeException.html#MalformedTypeException(java.lang.Class)">MalformedTypeException(Class<?>)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedTypeException.html#MalformedTypeException(java.lang.Class, java.lang.String)">MalformedTypeException(Class<?>, String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedTypeException.html#MalformedTypeException(java.lang.Class, java.util.List)">MalformedTypeException(Class<?>, List<String>)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map"><span class="strong">MapRepositoryBuilder</span></a> - Class in <a href="../com/amazon/carbonado/repo/map/package-summary.html">com.amazon.carbonado.repo.map</a></dt> +<dd> +<div class="block">Volatile repository implementation backed by a concurrent map.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#MapRepositoryBuilder()">MapRepositoryBuilder()</a></span> - Constructor for class com.amazon.carbonado.repo.map.<a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#MARK_ALL_PROPERTIES_CLEAN">MARK_ALL_PROPERTIES_CLEAN</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#MARK_ALL_PROPERTIES_DIRTY">MARK_ALL_PROPERTIES_DIRTY</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#MARK_PROPERTIES_CLEAN">MARK_PROPERTIES_CLEAN</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#MARK_PROPERTIES_DIRTY">MARK_PROPERTIES_DIRTY</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#markAllPropertiesClean()">markAllPropertiesClean()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Marks all properties as clean, including uninitialized properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#markAllPropertiesDirty()">markAllPropertiesDirty()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Marks all properties as dirty, including uninitialized properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorableIndexSet.html#markClustered(boolean)">markClustered(boolean)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></dt> +<dd> +<div class="block">Marks all indexes as clustered or non-clustered.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#markPropertiesClean()">markPropertiesClean()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Marks all dirty properties as clean.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#markPropertiesDirty()">markPropertiesDirty()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Marks all clean properties as dirty.</div> +</dd> +<dt><a href="../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen"><span class="strong">MasterFeature</span></a> - Enum in <a href="../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></dt> +<dd> +<div class="block">Master feature to enable when using <a href="../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>MasterStorableGenerator</code></a>.</div> +</dd> +<dt><a href="../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><span class="strong">MasterStorableGenerator</span></a><<a href="../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="type parameter in MasterStorableGenerator">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></dt> +<dd> +<div class="block">Generates and caches abstract implementations of <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types + suitable for use by master repositories.</div> +</dd> +<dt><a href="../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">MasterSupport</span></a><<a href="../com/amazon/carbonado/gen/MasterSupport.html" title="type parameter in MasterSupport">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></dt> +<dd> +<div class="block">Provides runtime support for Storable classes generated by <a href="../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>MasterStorableGenerator</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/ClassFileBuilder.html#mClassFile">mClassFile</a></span> - Variable in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></dt> +<dd> +<div class="block">Partially hydrogenated class operators</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#mergeRemainder(com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result)">mergeRemainder(IndexedQueryAnalyzer<S>.Result)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Merges the remainder filter and orderings of this result with the + one given, returning a new result.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/CompositeScore.html#mergeRemainderFilter(com.amazon.carbonado.qe.CompositeScore)">mergeRemainderFilter(CompositeScore<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></dt> +<dd> +<div class="block">Merges the remainder filter of this score with the one given using an + 'or' operation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#mergeRemainderFilter(com.amazon.carbonado.qe.FilteringScore)">mergeRemainderFilter(FilteringScore<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Merges the remainder filter of this score with the one given using an + 'or' operation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#mergeRemainderFilter(com.amazon.carbonado.filter.Filter)">mergeRemainderFilter(Filter<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Merges the remainder filter of this result with the given filter, + returning a new result.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/CompositeScore.html#mergeRemainderOrdering(com.amazon.carbonado.qe.CompositeScore)">mergeRemainderOrdering(CompositeScore<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></dt> +<dd> +<div class="block">Merges the remainder orderings of this score with the one given.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#mergeRemainderOrdering(com.amazon.carbonado.qe.OrderingScore)">mergeRemainderOrdering(OrderingScore<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Merges the remainder orderings of this score with the one given.</div> +</dd> +<dt><a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor"><span class="strong">MergeSortBuffer</span></a><<a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="type parameter in MergeSortBuffer">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Sort buffer implemented via a merge sort algorithm.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer()">MergeSortBuffer()</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">MergeSortBuffer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Query.Controller)">MergeSortBuffer(Query.Controller)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">MergeSortBuffer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Storage)">MergeSortBuffer(Storage<S>)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">MergeSortBuffer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Storage, com.amazon.carbonado.Query.Controller)">MergeSortBuffer(Storage<S>, Query.Controller)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">MergeSortBuffer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Storage, java.lang.String)">MergeSortBuffer(Storage<S>, String)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">MergeSortBuffer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Storage, java.lang.String, int)">MergeSortBuffer(Storage<S>, String, int)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">MergeSortBuffer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html#MergeSortBuffer(com.amazon.carbonado.Storage, java.lang.String, int, com.amazon.carbonado.Query.Controller)">MergeSortBuffer(Storage<S>, String, int, Query.Controller)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">MergeSortBuffer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Timeout.html#micros(long)">micros(long)</a></span> - Static method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></dt> +<dd> +<div class="block">Return a new Timeout in microseconds.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Timeout.html#millis(long)">millis(long)</a></span> - Static method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></dt> +<dd> +<div class="block">Return a new Timeout in milliseconds.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/ClassFileBuilder.html#mInjector">mInjector</a></span> - Variable in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Timeout.html#minutes(long)">minutes(long)</a></span> - Static method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></dt> +<dd> +<div class="block">Return a new Timeout in minutes.</div> +</dd> +<dt><a href="../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado"><span class="strong">MismatchException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Indicates that a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> doesn't exactly match up with an external + schema.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MismatchException.html#MismatchException()">MismatchException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado">MismatchException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MismatchException.html#MismatchException(java.lang.String)">MismatchException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado">MismatchException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MismatchException.html#MismatchException(java.util.List)">MismatchException(List<String>)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado">MismatchException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MismatchException.html#MismatchException(java.lang.Class)">MismatchException(Class<?>)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado">MismatchException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MismatchException.html#MismatchException(java.lang.Class, java.lang.String)">MismatchException(Class<?>, String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado">MismatchException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MismatchException.html#MismatchException(java.lang.Class, java.util.List)">MismatchException(Class<?>, List<String>)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado">MismatchException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#mLock">mLock</a></span> - Variable in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Lock object, as passed into the constructor</div> +</dd> +<dt><a href="../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">MultiTransformedCursor</span></a><<a href="../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="type parameter in MultiTransformedCursor">S</a>,<a href="../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="type parameter in MultiTransformedCursor">T</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Abstract cursor which wraps another cursor and transforms each storable + result into a set of target storables.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MultiTransformedCursor.html#MultiTransformedCursor(com.amazon.carbonado.Cursor)">MultiTransformedCursor(Cursor<S>)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor">MultiTransformedCursor</a></dt> +<dd> </dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-12.html">Prev Letter</a></li> +<li><a href="index-14.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-13.html" target="_top">Frames</a></li> +<li><a href="index-13.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-14.html b/apidocs/index-files/index-14.html new file mode 100644 index 0000000..50d4579 --- /dev/null +++ b/apidocs/index-files/index-14.html @@ -0,0 +1,283 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>N-Index (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="N-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-13.html">Prev Letter</a></li> +<li><a href="index-15.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-14.html" target="_top">Frames</a></li> +<li><a href="index-14.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_N_"> +<!-- --> +</a> +<h2 class="title">N</h2> +<dl> +<dt><a href="../com/amazon/carbonado/Name.html" title="annotation in com.amazon.carbonado"><span class="strong">Name</span></a> - Annotation Type in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Overrides the primary name of a Storable property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Timeout.html#nanos(long)">nanos(long)</a></span> - Static method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></dt> +<dd> +<div class="block">Return a new Timeout in nanoseconds.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/SoftValuedCache.html#newCache(int)">newCache(int)</a></span> - Static method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/DetachedStorableFactory.html#newInstance()">newInstance()</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/DetachedStorableFactory.html" title="class in com.amazon.carbonado.gen">DetachedStorableFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#newInstance(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">newInstance(FilterValues<S>, OrderingList<S>, QueryHints)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> +<div class="block">Return a new or cached instance of StandardQuery implementation, using + new filter values.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html#newline(java.lang.Appendable)">newline(Appendable)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></dt> +<dd> +<div class="block">Appends a newline character.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#newRepository()">newRepository()</a></span> - Static method in class com.amazon.carbonado.repo.map.<a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a></dt> +<dd> +<div class="block">Convenience method to build a new MapRepository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/ControllerCursor.html#next()">next()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/ControllerCursor.html" title="class in com.amazon.carbonado.cursor">ControllerCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/DifferenceCursor.html#next()">next()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor">DifferenceCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/EmptyCursor.html#next()">next()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor">EmptyCursor</a></dt> +<dd> +<div class="block">Always throws NoSuchElementException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/FetchAheadCursor.html#next()">next()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="class in com.amazon.carbonado.cursor">FetchAheadCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/FilteredCursor.html#next()">next()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor">FilteredCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/GroupedCursor.html#next()">next()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor">GroupedCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/IntersectionCursor.html#next()">next()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor">IntersectionCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/IteratorCursor.html#next()">next()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor">IteratorCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/LimitCursor.html#next()">next()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/LimitCursor.html" title="class in com.amazon.carbonado.cursor">LimitCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MultiTransformedCursor.html#next()">next()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor">MultiTransformedCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Cursor.html#next()">next()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></dt> +<dd> +<div class="block">Returns the next element from this cursor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SingletonCursor.html#next()">next()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor">SingletonCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SkipCursor.html#next()">next()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SkipCursor.html" title="class in com.amazon.carbonado.cursor">SkipCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SortedCursor.html#next()">next()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor">SortedCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html#next()">next()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor">SymmetricDifferenceCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/ThrottledCursor.html#next()">next()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor">ThrottledCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/TransformedCursor.html#next()">next()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor">TransformedCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/UnionCursor.html#next()">next()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor">UnionCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#next()">next()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html#nextDecimalValue()">nextDecimalValue()</a></span> - Method in class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">AbstractSequenceValueProducer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextDecimalValue()">nextDecimalValue()</a></span> - Method in interface com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></dt> +<dd> +<div class="block">Returns the next decimal string value from the sequence, which remains + positive.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#nextGeneration()">nextGeneration()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns the next known generation of the storable's layout, or null + if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html#nextIntValue()">nextIntValue()</a></span> - Method in class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">AbstractSequenceValueProducer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html#nextIntValue()">nextIntValue()</a></span> - Method in class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence">SequenceValueGenerator</a></dt> +<dd> +<div class="block">Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextIntValue()">nextIntValue()</a></span> - Method in interface com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></dt> +<dd> +<div class="block">Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html#nextLongValue()">nextLongValue()</a></span> - Method in class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence">SequenceValueGenerator</a></dt> +<dd> +<div class="block">Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextLongValue()">nextLongValue()</a></span> - Method in interface com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></dt> +<dd> +<div class="block">Returns the next value from the sequence, which may wrap negative if all + positive values are exhausted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html#nextNumericalValue(int, int)">nextNumericalValue(int, int)</a></span> - Method in class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/AbstractSequenceValueProducer.html" title="class in com.amazon.carbonado.sequence">AbstractSequenceValueProducer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueProducer.html#nextNumericalValue(int, int)">nextNumericalValue(int, int)</a></span> - Method in interface com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></dt> +<dd> +<div class="block">Returns the next numerical string value from the sequence, which remains + positive.</div> +</dd> +<dt><a href="../com/amazon/carbonado/NonDurableCommitException.html" title="class in com.amazon.carbonado"><span class="strong">NonDurableCommitException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Thrown during a transaction commit if durability guarantees cannot be met.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/NonDurableCommitException.html#NonDurableCommitException()">NonDurableCommitException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/NonDurableCommitException.html" title="class in com.amazon.carbonado">NonDurableCommitException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/NonDurableCommitException.html#NonDurableCommitException(java.lang.String)">NonDurableCommitException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/NonDurableCommitException.html" title="class in com.amazon.carbonado">NonDurableCommitException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/NonDurableCommitException.html#NonDurableCommitException(java.lang.String, java.lang.Throwable)">NonDurableCommitException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/NonDurableCommitException.html" title="class in com.amazon.carbonado">NonDurableCommitException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/NonDurableCommitException.html#NonDurableCommitException(java.lang.Throwable)">NonDurableCommitException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/NonDurableCommitException.html" title="class in com.amazon.carbonado">NonDurableCommitException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/AndFilter.html#not()">not()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#not()">not()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ExistsFilter.html#not()">not()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#not()">not()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns the logical negation of this filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#not()">not()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OrFilter.html#not()">not()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#not()">not()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#not()">not()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Returns a query that fetches everything, possibly in a specified order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#not()">not()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#not()">not()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a new query which produces all the results not supplied in this + query.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(java.lang.String)">notJoinedFrom(String)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Removes a join property prefix from all applicable properties of this + filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">notJoinedFrom(ChainedProperty<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Removes a join property prefix from all applicable properties of this + filter.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado"><span class="strong">Nullable</span></a> - Annotation Type in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Identifies that a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property can have a null value.</div> +</dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-13.html">Prev Letter</a></li> +<li><a href="index-15.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-14.html" target="_top">Frames</a></li> +<li><a href="index-14.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-15.html b/apidocs/index-files/index-15.html new file mode 100644 index 0000000..90b3094 --- /dev/null +++ b/apidocs/index-files/index-15.html @@ -0,0 +1,346 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>O-Index (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="O-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-14.html">Prev Letter</a></li> +<li><a href="index-16.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-15.html" target="_top">Frames</a></li> +<li><a href="index-15.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_O_"> +<!-- --> +</a> +<h2 class="title">O</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html#onPanic(java.lang.Object, java.lang.Exception)">onPanic(Object, Exception)</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBPanicHandler</a></dt> +<dd> +<div class="block">Called when an Environment panics or an EnvironmentFailureException is thrown.</div> +</dd> +<dt><a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">OpenFilter</span></a><<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="type parameter in OpenFilter">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></dt> +<dd> +<div class="block">Filter which lets all results pass through.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Blob.html#openInputStream()">openInputStream()</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></dt> +<dd> +<div class="block">Returns an InputStream for reading Blob data positioned at the + start.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Blob.html#openInputStream(long)">openInputStream(long)</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></dt> +<dd> +<div class="block">Returns an InputStream for reading Blob data.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Blob.html#openInputStream(long, int)">openInputStream(long, int)</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></dt> +<dd> +<div class="block">Returns an InputStream for reading Blob data.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/ByteArrayBlob.html#openInputStream()">openInputStream()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/ByteArrayBlob.html#openInputStream(long)">openInputStream(long)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/ByteArrayBlob.html#openInputStream(long, int)">openInputStream(long, int)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/FileBlob.html#openInputStream()">openInputStream()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/FileBlob.html#openInputStream(long)">openInputStream(long)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/FileBlob.html#openInputStream(long, int)">openInputStream(long, int)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Blob.html#openOutputStream()">openOutputStream()</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></dt> +<dd> +<div class="block">Returns an OutputStream for writing Blob data, positioned at the + start.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Blob.html#openOutputStream(long)">openOutputStream(long)</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></dt> +<dd> +<div class="block">Returns an OutputStream for writing Blob data.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Blob.html#openOutputStream(long, int)">openOutputStream(long, int)</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></dt> +<dd> +<div class="block">Returns an OutputStream for writing Blob data.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/ByteArrayBlob.html#openOutputStream()">openOutputStream()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/ByteArrayBlob.html#openOutputStream(long)">openOutputStream(long)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/ByteArrayBlob.html#openOutputStream(long, int)">openOutputStream(long, int)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/FileBlob.html#openOutputStream()">openOutputStream()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/FileBlob.html#openOutputStream(long)">openOutputStream(long)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/FileBlob.html#openOutputStream(long, int)">openOutputStream(long, int)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/BlobClob.html#openReader()">openReader()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/BlobClob.html#openReader(long)">openReader(long)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/BlobClob.html#openReader(long, int)">openReader(long, int)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/CharArrayClob.html#openReader()">openReader()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/CharArrayClob.html#openReader(long)">openReader(long)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/CharArrayClob.html#openReader(long, int)">openReader(long, int)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Clob.html#openReader()">openReader()</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></dt> +<dd> +<div class="block">Returns a Reader for reading Clob data, positioned at the start.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Clob.html#openReader(long)">openReader(long)</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></dt> +<dd> +<div class="block">Returns a Reader for reading Clob data.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Clob.html#openReader(long, int)">openReader(long, int)</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></dt> +<dd> +<div class="block">Returns a Reader for reading Clob data.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/StringClob.html#openReader()">openReader()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/StringClob.html#openReader(long)">openReader(long)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/StringClob.html#openReader(long, int)">openReader(long, int)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/BlobClob.html#openWriter()">openWriter()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/BlobClob.html#openWriter(long)">openWriter(long)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/BlobClob.html#openWriter(long, int)">openWriter(long, int)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/CharArrayClob.html#openWriter()">openWriter()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/CharArrayClob.html#openWriter(long)">openWriter(long)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/CharArrayClob.html#openWriter(long, int)">openWriter(long, int)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Clob.html#openWriter()">openWriter()</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></dt> +<dd> +<div class="block">Returns a Writer for writing Clob data, positioned at the start.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Clob.html#openWriter(long)">openWriter(long)</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></dt> +<dd> +<div class="block">Returns a Writer for writing Clob data.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Clob.html#openWriter(long, int)">openWriter(long, int)</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></dt> +<dd> +<div class="block">Returns a Writer for writing Clob data.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/StringClob.html#openWriter()">openWriter()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/StringClob.html#openWriter(long)">openWriter(long)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/StringClob.html#openWriter(long, int)">openWriter(long, int)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado"><span class="strong">OptimisticLockException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">An OptimisticLockException is thrown if the <a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> is using + optimistic locking for concurrency control, and lock aquisition failed.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/OptimisticLockException.html#OptimisticLockException()">OptimisticLockException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado">OptimisticLockException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/OptimisticLockException.html#OptimisticLockException(java.lang.String)">OptimisticLockException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado">OptimisticLockException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/OptimisticLockException.html#OptimisticLockException(java.lang.String, java.lang.Throwable)">OptimisticLockException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado">OptimisticLockException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/OptimisticLockException.html#OptimisticLockException(java.lang.Throwable)">OptimisticLockException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado">OptimisticLockException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/OptimisticLockException.html#OptimisticLockException(long)">OptimisticLockException(long)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado">OptimisticLockException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/OptimisticLockException.html#OptimisticLockException(java.lang.Object)">OptimisticLockException(Object)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado">OptimisticLockException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/OptimisticLockException.html#OptimisticLockException(java.lang.Object, java.lang.Object)">OptimisticLockException(Object, Object)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado">OptimisticLockException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/OptimisticLockException.html#OptimisticLockException(java.lang.Object, java.lang.Object, com.amazon.carbonado.Storable)">OptimisticLockException(Object, Object, Storable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado">OptimisticLockException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/OptimisticLockException.html#OptimisticLockException(java.lang.Object, com.amazon.carbonado.Storable, java.lang.Object)">OptimisticLockException(Object, Storable, Object)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado">OptimisticLockException</a></dt> +<dd> +<div class="block">Construct exception for when new version was expected to have increased.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#or(com.amazon.carbonado.filter.Filter)">or(Filter<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#or(java.lang.String)">or(String)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#or(com.amazon.carbonado.filter.Filter)">or(Filter<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp)">or(String, RelOp)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#or(java.lang.String, com.amazon.carbonado.filter.RelOp, java.lang.Object)">or(String, RelOp, Object)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the one given.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#or(com.amazon.carbonado.filter.Filter)">or(Filter<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#or(java.lang.String)">or(String)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#or(com.amazon.carbonado.filter.Filter)">or(Filter<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#or(com.amazon.carbonado.filter.Filter)">or(Filter<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#or(java.lang.String)">or(String)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a new query which has another <a href="../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of + results.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#or(com.amazon.carbonado.filter.Filter)">or(Filter<S>)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a new query which has another <a href="../com/amazon/carbonado/Storage.html#query(java.lang.String)"><code>filter</code></a> logically "or"ed to this, potentially increasing the amount of + results.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#orderBy(java.lang.String)">orderBy(String)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#orderBy(java.lang.String...)">orderBy(String...)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#orderBy(java.lang.String)">orderBy(String)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#orderBy(java.lang.String...)">orderBy(String...)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#orderBy(java.lang.String)">orderBy(String)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a copy of this query ordered by a specific property value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#orderBy(java.lang.String...)">orderBy(String...)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a copy of this query ordered by specific property values.</div> +</dd> +<dt><a href="../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">OrderedProperty</span></a><<a href="../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></dt> +<dd> +<div class="block">Represents a property paired with a preferred ordering direction.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe"><span class="strong">OrderingList</span></a><<a href="../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Produces unmodifiable lists of <a href="../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><code>orderings</code></a>.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">OrderingScore</span></a><<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="type parameter in OrderingScore">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Evaluates an index for how well it matches a query's desired ordering.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#orExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orExists(String, Filter<?>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the "exists" test applied to a join.</div> +</dd> +<dt><a href="../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">OrFilter</span></a><<a href="../com/amazon/carbonado/filter/OrFilter.html" title="type parameter in OrFilter">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></dt> +<dd> +<div class="block">Filter tree node that performs a logical 'or' test.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#orNotExists(java.lang.String, com.amazon.carbonado.filter.Filter)">orNotExists(String, Filter<?>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns a combined filter instance that accepts records which are + accepted either by this filter or the "not exists" test applied to a + join.</div> +</dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-14.html">Prev Letter</a></li> +<li><a href="index-16.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-15.html" target="_top">Frames</a></li> +<li><a href="index-15.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-16.html b/apidocs/index-files/index-16.html new file mode 100644 index 0000000..2966c25 --- /dev/null +++ b/apidocs/index-files/index-16.html @@ -0,0 +1,442 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>P-Index (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="P-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-15.html">Prev Letter</a></li> +<li><a href="index-17.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-16.html" target="_top">Frames</a></li> +<li><a href="index-16.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_P_"> +<!-- --> +</a> +<h2 class="title">P</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)">parse(StorableInfo<S>, String)</a></span> - Static method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Parses a chained property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/OrderedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)">parse(StorableInfo<S>, String)</a></span> - Static method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></dt> +<dd> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/OrderedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String, com.amazon.carbonado.info.Direction)">parse(StorableInfo<S>, String, Direction)</a></span> - Static method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></dt> +<dd> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescParser.html#parse(org.cojen.classfile.attribute.Annotation)">parse(Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescParser.html" title="class in com.amazon.carbonado.util">AnnotationDescParser</a></dt> +<dd> +<div class="block">Parses the given annotation, returning the root annotation that received + the results.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#parseNameDescriptor(java.lang.String, com.amazon.carbonado.info.StorableInfo)">parseNameDescriptor(String, StorableInfo<S>)</a></span> - Static method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Parses an index descriptor and returns an index object.</div> +</dd> +<dt><a href="../com/amazon/carbonado/PartitionKey.html" title="annotation in com.amazon.carbonado"><span class="strong">PartitionKey</span></a> - Annotation Type in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Identifies a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property as being a member of the partition key.</div> +</dd> +<dt><a href="../com/amazon/carbonado/PersistDeadlockException.html" title="class in com.amazon.carbonado"><span class="strong">PersistDeadlockException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Thrown if a persist operation fails because it was selected to resolve a + deadlock.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistDeadlockException.html#PersistDeadlockException()">PersistDeadlockException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistDeadlockException.html" title="class in com.amazon.carbonado">PersistDeadlockException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistDeadlockException.html#PersistDeadlockException(java.lang.String)">PersistDeadlockException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistDeadlockException.html" title="class in com.amazon.carbonado">PersistDeadlockException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistDeadlockException.html#PersistDeadlockException(java.lang.String, java.lang.Throwable)">PersistDeadlockException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistDeadlockException.html" title="class in com.amazon.carbonado">PersistDeadlockException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistDeadlockException.html#PersistDeadlockException(java.lang.Throwable)">PersistDeadlockException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistDeadlockException.html" title="class in com.amazon.carbonado">PersistDeadlockException</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado"><span class="strong">PersistDeniedException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Thrown when a persist operation was denied either because the repository is + in read-only mode, or the connection does not have permission.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistDeniedException.html#PersistDeniedException()">PersistDeniedException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">PersistDeniedException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistDeniedException.html#PersistDeniedException(java.lang.String)">PersistDeniedException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">PersistDeniedException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistDeniedException.html#PersistDeniedException(java.lang.String, java.lang.Throwable)">PersistDeniedException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">PersistDeniedException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistDeniedException.html#PersistDeniedException(java.lang.Throwable)">PersistDeniedException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistDeniedException.html" title="class in com.amazon.carbonado">PersistDeniedException</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado"><span class="strong">PersistException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">A PersistException is caused by a failure when inserting, updating, or + deleting records from a <a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistException.html#PersistException()">PersistException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistException.html#PersistException(java.lang.String)">PersistException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistException.html#PersistException(java.lang.String, java.lang.Throwable)">PersistException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistException.html#PersistException(java.lang.Throwable)">PersistException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistException.html" title="class in com.amazon.carbonado">PersistException</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/PersistInterruptedException.html" title="class in com.amazon.carbonado"><span class="strong">PersistInterruptedException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Thrown from a persist operation that was canceled.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistInterruptedException.html#PersistInterruptedException()">PersistInterruptedException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistInterruptedException.html" title="class in com.amazon.carbonado">PersistInterruptedException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistInterruptedException.html#PersistInterruptedException(java.lang.String)">PersistInterruptedException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistInterruptedException.html" title="class in com.amazon.carbonado">PersistInterruptedException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistInterruptedException.html#PersistInterruptedException(java.lang.String, java.lang.Throwable)">PersistInterruptedException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistInterruptedException.html" title="class in com.amazon.carbonado">PersistInterruptedException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistInterruptedException.html#PersistInterruptedException(java.lang.Throwable)">PersistInterruptedException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistInterruptedException.html" title="class in com.amazon.carbonado">PersistInterruptedException</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado"><span class="strong">PersistMultipleException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">A PersistMultipleException is thrown when a persist operation would have + applied to more than one record when at most one was expected.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistMultipleException.html#PersistMultipleException()">PersistMultipleException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistMultipleException.html#PersistMultipleException(java.lang.String)">PersistMultipleException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistMultipleException.html#PersistMultipleException(java.lang.String, java.lang.Throwable)">PersistMultipleException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistMultipleException.html#PersistMultipleException(java.lang.Throwable)">PersistMultipleException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistMultipleException.html" title="class in com.amazon.carbonado">PersistMultipleException</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado"><span class="strong">PersistNoneException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">A PersistNoneException is thrown when a persist operation applied to no + records when at least one was expected.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistNoneException.html#PersistNoneException()">PersistNoneException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistNoneException.html#PersistNoneException(java.lang.String)">PersistNoneException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistNoneException.html#PersistNoneException(java.lang.String, java.lang.Throwable)">PersistNoneException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistNoneException.html#PersistNoneException(java.lang.Throwable)">PersistNoneException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado">PersistNoneException</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/PersistTimeoutException.html" title="class in com.amazon.carbonado"><span class="strong">PersistTimeoutException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Thrown if a persist operation fails because lock acquisition timed out.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistTimeoutException.html#PersistTimeoutException()">PersistTimeoutException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistTimeoutException.html" title="class in com.amazon.carbonado">PersistTimeoutException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistTimeoutException.html#PersistTimeoutException(java.lang.String)">PersistTimeoutException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistTimeoutException.html" title="class in com.amazon.carbonado">PersistTimeoutException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistTimeoutException.html#PersistTimeoutException(java.lang.String, java.lang.Throwable)">PersistTimeoutException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistTimeoutException.html" title="class in com.amazon.carbonado">PersistTimeoutException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/PersistTimeoutException.html#PersistTimeoutException(java.lang.Throwable)">PersistTimeoutException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/PersistTimeoutException.html" title="class in com.amazon.carbonado">PersistTimeoutException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Transaction.html#preCommit()">preCommit()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></dt> +<dd> +<div class="block">Calling this method commits all nested child transactions, closes all + scoped cursors, and locks out some interactions from other threads.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionPair.html#preCommit()">preCommit()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn">TransactionPair</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/ArraySortBuffer.html#prepare(java.util.Comparator)">prepare(Comparator<S>)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="class in com.amazon.carbonado.cursor">ArraySortBuffer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html#prepare(java.util.Comparator)">prepare(Comparator<S>)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">MergeSortBuffer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SortBuffer.html#prepare(java.util.Comparator)">prepare(Comparator<S>)</a></span> - Method in interface com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a></dt> +<dd> +<div class="block">Clears buffer and assigns a comparator for sorting.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#prepare()">prepare()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Prepares a new object for loading, inserting, updating, or deleting.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storage.html#prepare()">prepare()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></dt> +<dd> +<div class="block">Prepares a new object for loading, inserting, updating, or deleting.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html#prepare()">prepare()</a></span> - Method in interface com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#prepare()">prepare()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#prepare()">prepare()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#PREPARE_METHOD_NAME">PREPARE_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storage API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html#prepareForOpening(java.lang.Object)">prepareForOpening(Object)</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</a></dt> +<dd> +<div class="block">Called right before database is opened.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#previousGeneration()">previousGeneration()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns the previous known generation of the storable's layout, or null + if none.</div> +</dd> +<dt><a href="../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado"><span class="strong">PrimaryKey</span></a> - Annotation Type in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Identifies a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property as being a member of the primary + key.</div> +</dd> +<dt><a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">PrimitiveArrayAdapter</span></a> - Annotation Type in <a href="../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></dt> +<dd> +<div class="block">Allows arrays of primitive types to be encoded (big-endian) as byte arrays.</div> +</dd> +<dt><a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">PrimitiveArrayAdapter.Adapter</span></a> - Class in <a href="../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></dt> +<dd> +<div class="block">Adapter implementation for <a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>PrimitiveArrayAdapter</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#PrimitiveArrayAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.PrimitiveArrayAdapter)">PrimitiveArrayAdapter.Adapter(Class<?>, String, PrimitiveArrayAdapter)</a></span> - Constructor for class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">PrimitiveArrayAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html#PrimitiveArrayAdapter.Adapter()">PrimitiveArrayAdapter.Adapter()</a></span> - Constructor for class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/PrimitiveArrayAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">PrimitiveArrayAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#printNative()">printNative()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#printNative(java.lang.Appendable)">printNative(Appendable)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative(Appendable, int, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></dt> +<dd> +<div class="block">Does nothing and returns false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative(Appendable, int, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#printNative(java.lang.Appendable, int)">printNative(Appendable, int)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative(Appendable, int, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</a></dt> +<dd> +<div class="block">Prints native query of the wrapped executor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative(Appendable, int, FilterValues<S>)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></dt> +<dd> +<div class="block">Prints the native query to any appendable, if applicable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative(Appendable, int, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a></dt> +<dd> +<div class="block">Prints native query of the wrapped executor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#printNative(java.lang.Appendable, int)">printNative(Appendable, int)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html#printNative(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printNative(Appendable, int, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a></dt> +<dd> +<div class="block">Prints native queries of the wrapped executors.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#printNative()">printNative()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Print the native query to standard out, which is useful for performance + analysis.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#printNative(java.lang.Appendable)">printNative(Appendable)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Prints the native query to any appendable, which is useful for + performance analysis.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#printNative(java.lang.Appendable, int)">printNative(Appendable, int)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Prints the native query to any appendable, which is useful for + performance analysis.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#printPlan()">printPlan()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#printPlan(java.lang.Appendable)">printPlan(Appendable)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan(Appendable, int, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#printPlan(java.lang.Appendable, int)">printPlan(Appendable, int)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan(Appendable, int, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan(Appendable, int, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan(Appendable, int, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan(Appendable, int, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/JoinedQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan(Appendable, int, FilterValues<T>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan(Appendable, int, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan(Appendable, int, FilterValues<S>)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></dt> +<dd> +<div class="block">Prints the query plan to any appendable, if applicable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan(Appendable, int, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#printPlan(java.lang.Appendable, int)">printPlan(Appendable, int)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html#printPlan(java.lang.Appendable, int, com.amazon.carbonado.filter.FilterValues)">printPlan(Appendable, int, FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#printPlan()">printPlan()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Prints the query excecution plan to standard out, which is useful for + performance analysis.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#printPlan(java.lang.Appendable)">printPlan(Appendable)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Prints the query excecution plan to any appendable, which is useful for + performance analysis.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#printPlan(java.lang.Appendable, int)">printPlan(Appendable, int)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Prints the query excecution plan to any appendable, which is useful for + performance analysis.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#PROPERTY_MAP">PROPERTY_MAP</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#PROPERTY_STATE_CLEAN">PROPERTY_STATE_CLEAN</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Property state indicating that property value reflects a clean value</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#PROPERTY_STATE_DIRTY">PROPERTY_STATE_DIRTY</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Property state indicating that property has been set, but not saved</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#PROPERTY_STATE_FIELD_NAME">PROPERTY_STATE_FIELD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Prefix of protected field in generated storable that holds property + states.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#PROPERTY_STATE_MASK">PROPERTY_STATE_MASK</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Property state mask is 3, to cover the two bits used by a property state</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#PROPERTY_STATE_UNINITIALIZED">PROPERTY_STATE_UNINITIALIZED</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Property state indicating that property has never been set, loaded, or saved</div> +</dd> +<dt><a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">PropertyFilter</span></a><<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></dt> +<dd> +<div class="block">Filter tree node that performs a relational test against a specific property + value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#propertyMap()">propertyMap()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Returns a fixed-size map view of this Storable's properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#pushDecodingInstanceVar(org.cojen.classfile.CodeAssembler, int, org.cojen.classfile.LocalVariable)">pushDecodingInstanceVar(CodeAssembler, int, LocalVariable)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Push decoding instanceVar to stack in preparation to calling + storePropertyValue.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#pushRawSupport(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable)">pushRawSupport(CodeAssembler, LocalVariable)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Generates code to push RawSupport instance to the stack.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorablePropertyMap.html#put(java.lang.String, java.lang.Object)">put(String, Object)</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/SoftValuedCache.html#put(K, V)">put(K, V)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/SoftValuedCache.html#putIfAbsent(K, V)">putIfAbsent(K, V)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-15.html">Prev Letter</a></li> +<li><a href="index-17.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-16.html" target="_top">Frames</a></li> +<li><a href="index-16.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-17.html b/apidocs/index-files/index-17.html new file mode 100644 index 0000000..51b5a60 --- /dev/null +++ b/apidocs/index-files/index-17.html @@ -0,0 +1,230 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Q-Index (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="Q-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-16.html">Prev Letter</a></li> +<li><a href="index-18.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-17.html" target="_top">Frames</a></li> +<li><a href="index-17.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_Q_"> +<!-- --> +</a> +<h2 class="title">Q</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query(Filter<S>, FilterValues<S>, OrderingList<S>, QueryHints)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a></dt> +<dd> +<div class="block">Returns a query that handles the given query specification.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html#query()">query()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> +<div class="block">Returns a new or cached query that fetches everything.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html#query(java.lang.String)">query(String)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> +<div class="block">Returns a new or cached query for the given filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter)">query(Filter<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> +<div class="block">Returns a new or cached query for the given filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">query(Filter<S>, OrderingList<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> +<div class="block">Returns a new or cached query for the given query specification.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query(Filter<S>, OrderingList<S>, QueryHints)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> +<div class="block">Returns a new or cached query for the given query specification.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList)">query(Filter<S>, FilterValues<S>, OrderingList<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> +<div class="block">Returns a new or cached query for the given query specification.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html#query(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">query(Filter<S>, FilterValues<S>, OrderingList<S>, QueryHints)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> +<div class="block">Returns a new or cached query for the given query specification.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><span class="strong">Query</span></a><<a href="../com/amazon/carbonado/Query.html" title="type parameter in Query">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Supports complex retrieval and deletion of <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> objects.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storage.html#query()">query()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></dt> +<dd> +<div class="block">Query for all Storable instances in this Storage.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storage.html#query(java.lang.String)">query(String)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></dt> +<dd> +<div class="block">Query for Storable instances against a filter expression.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storage.html#query(com.amazon.carbonado.filter.Filter)">query(Filter<S>)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></dt> +<dd> +<div class="block">Query for Storable instances against an explicitly constructed filter + object.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado"><span class="strong">Query.Controller</span></a> - Interface in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Controller instance can be used to abort query operations.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado"><span class="strong">Query.Timeout</span></a> - Class in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Timeout controller, for aborting long running queries.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Timeout.html#Query.Timeout(long, java.util.concurrent.TimeUnit)">Query.Timeout(long, TimeUnit)</a></span> - Constructor for class com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#QUERY_METHOD_NAME">QUERY_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storage API method name</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe"><span class="strong">QueryEngine</span></a><<a href="../com/amazon/carbonado/qe/QueryEngine.html" title="type parameter in QueryEngine">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Complete rule-based query engine implementation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryEngine.html#QueryEngine(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)">QueryEngine(Class<S>, RepositoryAccess)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">QueryEngine</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><span class="strong">QueryExecutor</span></a><<a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="type parameter in QueryExecutor">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Performs all the actual work of executing a query.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe"><span class="strong">QueryExecutorCache</span></a><<a href="../com/amazon/carbonado/qe/QueryExecutorCache.html" title="type parameter in QueryExecutorCache">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">QueryExecutors should be cached since expensive analysis is often required to build + them.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutorCache.html#QueryExecutorCache(com.amazon.carbonado.qe.QueryExecutorFactory)">QueryExecutorCache(QueryExecutorFactory<S>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe">QueryExecutorCache</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">QueryExecutorFactory</span></a><<a href="../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="type parameter in QueryExecutorFactory">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Produces <a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</code></a> instances from a query specification.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe"><span class="strong">QueryFactory</span></a><<a href="../com/amazon/carbonado/qe/QueryFactory.html" title="type parameter in QueryFactory">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Produces <a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><code>Query</code></a> instances from a query specification.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#queryFactory()">queryFactory()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> +<div class="block">Return a QueryFactory which is used to form new queries from this one.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe"><span class="strong">QueryHint</span></a> - Enum in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Defines a hint key.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe"><span class="strong">QueryHints</span></a> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">An immutable map of query hints.</div> +</dd> +<dt><a href="../com/amazon/carbonado/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util"><span class="strong">QuickConstructorGenerator</span></a> - Class in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>use <code>QuickConstructorGenerator</code></i></div> +</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/QuickConstructorGenerator.html#QuickConstructorGenerator()">QuickConstructorGenerator()</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util">QuickConstructorGenerator</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-16.html">Prev Letter</a></li> +<li><a href="index-18.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-17.html" target="_top">Frames</a></li> +<li><a href="index-17.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-18.html b/apidocs/index-files/index-18.html new file mode 100644 index 0000000..a564fed --- /dev/null +++ b/apidocs/index-files/index-18.html @@ -0,0 +1,416 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>R-Index (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="R-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-17.html">Prev Letter</a></li> +<li><a href="index-19.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-18.html" target="_top">Frames</a></li> +<li><a href="index-18.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_R_"> +<!-- --> +</a> +<h2 class="title">R</h2> +<dl> +<dt><a href="../com/amazon/carbonado/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">RAFInputStream</span></a> - Class in <a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></dt> +<dd> +<div class="block">InputStream that wraps a RandomAccessFile.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/RAFInputStream.html#RAFInputStream(java.io.RandomAccessFile)">RAFInputStream(RandomAccessFile)</a></span> - Constructor for class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi">RAFInputStream</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/spi/RAFOutputStream.html" title="class in com.amazon.carbonado.spi"><span class="strong">RAFOutputStream</span></a> - Class in <a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></dt> +<dd> +<div class="block">OutputStream that wraps a RandomAccessFile.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/RAFOutputStream.html#RAFOutputStream(java.io.RandomAccessFile)">RAFOutputStream(RandomAccessFile)</a></span> - Constructor for class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/RAFOutputStream.html" title="class in com.amazon.carbonado.spi">RAFOutputStream</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#rangeComparator()">rangeComparator()</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns a partial comparator which determines which FilteringScores are + better by examining only identity and range matches.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw"><span class="strong">RawCursor</span></a><<a href="../com/amazon/carbonado/raw/RawCursor.html" title="type parameter in RawCursor">S</a>> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Abstract Cursor implementation for a repository that manipulates raw bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#RawCursor(java.util.concurrent.locks.Lock, byte[], boolean, byte[], boolean, int, boolean)">RawCursor(Lock, byte[], boolean, byte[], boolean, int, boolean)</a></span> - Constructor for class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/raw/RawStorableGenerator.html" title="class in com.amazon.carbonado.raw"><span class="strong">RawStorableGenerator</span></a> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Generates and caches abstract implementations of <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types + which are encoded and decoded in a raw format.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw"><span class="strong">RawSupport</span></a><<a href="../com/amazon/carbonado/raw/RawSupport.html" title="type parameter in RawSupport">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Provides runtime support for Storable classes generated by <a href="../com/amazon/carbonado/raw/RawStorableGenerator.html" title="class in com.amazon.carbonado.raw"><code>RawStorableGenerator</code></a>.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/RawUtil.html" title="class in com.amazon.carbonado.raw"><span class="strong">RawUtil</span></a> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Utilities for manipulating binary data.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawUtil.html#RawUtil()">RawUtil()</a></span> - Constructor for class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawUtil.html" title="class in com.amazon.carbonado.raw">RawUtil</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/RAFInputStream.html#read()">read()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi">RAFInputStream</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/RAFInputStream.html#read(byte[])">read(byte[])</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi">RAFInputStream</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/RAFInputStream.html#read(byte[], int, int)">read(byte[], int, int)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi">RAFInputStream</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#READ_FROM">READ_FROM</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#readFrom(java.io.InputStream)">readFrom(InputStream)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Restores property values and states as encoded by <a href="../com/amazon/carbonado/Storable.html#writeTo(java.io.OutputStream)"><code>Storable.writeTo(java.io.OutputStream)</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#readFully(java.io.InputStream, byte[])">readFully(InputStream, byte[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Reads as many bytes from the stream as is necessary to fill the given + byte array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutFactory.html#readLayoutFrom(java.io.InputStream)">readLayoutFrom(InputStream)</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">LayoutFactory</a></dt> +<dd> +<div class="block">Read a layout as written by <a href="../com/amazon/carbonado/layout/Layout.html#writeTo(java.io.OutputStream)"><code>Layout.writeTo(java.io.OutputStream)</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#readLength(java.io.InputStream)">readLength(InputStream)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes a length value which was encoded by <a href="../com/amazon/carbonado/raw/DataEncoder.html#writeLength(int, java.io.OutputStream)"><code>DataEncoder.writeLength(int, java.io.OutputStream)</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedure.Request.html#receive()">receive()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a></dt> +<dd> +<div class="block">Receive data from caller.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedure.Request.html#receiveInto(java.util.Collection)">receiveInto(Collection<? super D>)</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a></dt> +<dd> +<div class="block">Receive all remaining data from caller.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#reconstruct()">reconstruct()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Reconstructs the storable type defined by this layout by returning an + auto-generated class.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#reconstruct(java.lang.ClassLoader)">reconstruct(ClassLoader)</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Reconstructs the storable type defined by this layout by returning an + auto-generated class.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#reduce()">reduce()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns an equivalent filter with redundant terms eliminated.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#reduce()">reduce()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> +<div class="block">Eliminates redundant ordering properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorableIndexSet.html#reduce()">reduce()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></dt> +<dd> +<div class="block">Reduces the size of the set by removing redundant indexes, and merges + others together.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorableIndexSet.html#reduce(com.amazon.carbonado.info.Direction)">reduce(Direction)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></dt> +<dd> +<div class="block">Reduces the size of the set by removing redundant indexes, and merges + others together.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionScope.html#register(java.lang.Class, com.amazon.carbonado.Cursor)">register(Class<S>, Cursor<S>)</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a></dt> +<dd> +<div class="block">Registers the given cursor against the active transaction, allowing it + to be closed on transaction exit or transaction manager close.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#release()">release()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Release any internal resources, called when closed.</div> +</dd> +<dt><a href="../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter"><span class="strong">RelOp</span></a> - Enum in <a href="../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></dt> +<dd> +<div class="block">Relational operator enumeration.</div> +</dd> +<dt><a href="../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability"><span class="strong">RemoteProcedure</span></a><<a href="../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">R</a>,<a href="../com/amazon/carbonado/capability/RemoteProcedure.html" title="type parameter in RemoteProcedure">D</a>> - Interface in <a href="../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></dt> +<dd> +<div class="block">Defines a remote procedure which can be executed by <a href="../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability"><code>RemoteProcedureCapability</code></a>.</div> +</dd> +<dt><a href="../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability"><span class="strong">RemoteProcedure.Call</span></a><<a href="../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">R</a>,<a href="../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="type parameter in RemoteProcedure.Call">D</a>> - Interface in <a href="../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></dt> +<dd> +<div class="block">Client-side call into a remote procedure.</div> +</dd> +<dt><a href="../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability"><span class="strong">RemoteProcedure.Reply</span></a><<a href="../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="type parameter in RemoteProcedure.Reply">R</a>> - Interface in <a href="../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></dt> +<dd> +<div class="block">Reply from remote procedure implementation.</div> +</dd> +<dt><a href="../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability"><span class="strong">RemoteProcedure.Request</span></a><<a href="../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">R</a>,<a href="../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="type parameter in RemoteProcedure.Request">D</a>> - Interface in <a href="../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></dt> +<dd> +<div class="block">Request into a remote procedure, as seen by procedure implementation.</div> +</dd> +<dt><a href="../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">RemoteProcedureCapability</span></a> - Interface in <a href="../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></dt> +<dd> +<div class="block">Capability which allows arbitrary code to run on a remote host and access + its repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorablePropertyMap.html#remove(java.lang.Object)">remove(Object)</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AbstractPool.html#remove(java.lang.Object)">remove(Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a></dt> +<dd> +<div class="block">Remove a value, returning the old value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/SoftValuedCache.html#remove(K)">remove(K)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/SoftValuedCache.html#remove(K, V)">remove(K, V)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#removeTrigger(com.amazon.carbonado.Trigger)">removeTrigger(Trigger<? super S>)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storage.html#removeTrigger(com.amazon.carbonado.Trigger)">removeTrigger(Trigger<? super S>)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></dt> +<dd> +<div class="block">Remove a trigger which was registered earlier.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">removeTriggerFactory(TriggerFactory)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dt> +<dd> +<div class="block">Remove a TriggerFactory which was added earlier.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#removeTriggerFactory(com.amazon.carbonado.TriggerFactory)">removeTriggerFactory(TriggerFactory)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#repair(double)">repair(double)</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a></dt> +<dd> +<div class="block">Repairs the index by inserting missing entries and fixing + inconsistencies.</div> +</dd> +<dt><a href="../com/amazon/carbonado/spi/RepairExecutor.html" title="class in com.amazon.carbonado.spi"><span class="strong">RepairExecutor</span></a> - Class in <a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></dt> +<dd> +<div class="block">A convenience class for repositories to run dynamic repairs in separate + threads.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#replace(int, com.amazon.carbonado.info.OrderedProperty)">replace(int, OrderedProperty<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> +<div class="block">Returns a list with the given element replaced.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/SoftValuedCache.html#replace(K, V, V)">replace(K, V, V)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/SoftValuedCache.html#replace(K, V)">replace(K, V)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated"><span class="strong">ReplicatedRepositoryBuilder</span></a> - Class in <a href="../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a></dt> +<dd> +<div class="block">Repository builder for the replicated repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#ReplicatedRepositoryBuilder()">ReplicatedRepositoryBuilder()</a></span> - Constructor for class com.amazon.carbonado.repo.replicated.<a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><span class="strong">Repository</span></a> - Interface in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">A Repository represents a database for <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> + instances.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">RepositoryAccess</span></a> - Interface in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Provides internal access to a <a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>, necessary for query + execution.</div> +</dd> +<dt><a href="../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado"><span class="strong">RepositoryBuilder</span></a> - Interface in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Standard interface for building up configuration and opening a <a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> instance.</div> +</dd> +<dt><a href="../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado"><span class="strong">RepositoryException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">General checked exception thrown when accessing a <a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryException.html#RepositoryException()">RepositoryException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryException.html#RepositoryException(java.lang.String)">RepositoryException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryException.html#RepositoryException(java.lang.String, java.lang.Throwable)">RepositoryException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryException.html#RepositoryException(java.lang.Throwable)">RepositoryException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedure.Call.html#reset()">reset()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a></dt> +<dd> +<div class="block">Reset the internal object stream of the call, allowing cached + objects to get freed.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#reset()">reset()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a></dt> +<dd> +<div class="block">Reset the internal object stream of the reply, allowing cached + objects to get freed.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html#reset(int)">reset(int)</a></span> - Method in class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence">SequenceValueGenerator</a></dt> +<dd> +<div class="block">Reset the sequence.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#resetExecutor()">resetExecutor()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> +<div class="block">Resets any cached reference to a query executor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html#resetExecutors()">resetExecutors()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> +<div class="block">For each cached query, calls <a href="../com/amazon/carbonado/qe/StandardQuery.html#resetExecutor()"><code>StandardQuery.resetExecutor()</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html#resumeCheckpointer()">resumeCheckpointer()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">CheckpointCapability</a></dt> +<dd> +<div class="block">Resumes the checkpointer if it was suspended.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/ResyncCapability.html#resync(java.lang.Class, double, java.lang.String, java.lang.Object...)">resync(Class<S>, double, String, Object...)</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability">ResyncCapability</a></dt> +<dd> +<div class="block">Re-synchronizes replicated storables against the master repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/ResyncCapability.html#resync(java.lang.Class, com.amazon.carbonado.capability.ResyncCapability.Listener, double, java.lang.String, java.lang.Object...)">resync(Class<S>, ResyncCapability.Listener<? super S>, double, String, Object...)</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability">ResyncCapability</a></dt> +<dd> +<div class="block">Re-synchronizes replicated storables against the master repository.</div> +</dd> +<dt><a href="../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">ResyncCapability</span></a> - Interface in <a href="../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></dt> +<dd> +<div class="block">Capability of replicating repositories for re-synchronizing to the master + repository.</div> +</dd> +<dt><a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability"><span class="strong">ResyncCapability.Listener</span></a><<a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="type parameter in ResyncCapability.Listener">S</a>> - Class in <a href="../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></dt> +<dd> +<div class="block">Trigger which is invoked as storables get re-sync'd.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html#ResyncCapability.Listener()">ResyncCapability.Listener()</a></span> - Constructor for class com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html#returnReservedValues()">returnReservedValues()</a></span> - Method in class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence">SequenceValueGenerator</a></dt> +<dd> +<div class="block">Allow any unused reserved values to be returned for re-use.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueProducer.html#returnReservedValues()">returnReservedValues()</a></span> - Method in interface com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence">SequenceValueProducer</a></dt> +<dd> +<div class="block">Allow any unused reserved values to be returned for re-use.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueProducerPool.html#returnReservedValues(org.apache.commons.logging.Log)">returnReservedValues(Log)</a></span> - Method in class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueProducerPool.html" title="class in com.amazon.carbonado.sequence">SequenceValueProducerPool</a></dt> +<dd> +<div class="block">Returns reserved values for all <a href="../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence"><code>SequenceValueProducer</code></a>s.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionManager.html#reuseTxn(Txn)">reuseTxn(Txn)</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></dt> +<dd> +<div class="block">Called when a transaction is about to be reused.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/RelOp.html#reverse()">reverse()</a></span> - Method in enum com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/Direction.html#reverse()">reverse()</a></span> - Method in enum com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></dt> +<dd> +<div class="block">Returns the reverse direction of this.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/OrderedProperty.html#reverse()">reverse()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#reverse()">reverse()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns a StorableIndex instance with all the properties reversed.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#reverseDirections()">reverseDirections()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> +<div class="block">Returns this list with all orderings in reverse.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutSync.html#run()">run()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutSync.html" title="class in com.amazon.carbonado.layout">LayoutSync</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/TaskQueueThread.html#run()">run()</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/TaskQueueThread.html" title="class in com.amazon.carbonado.util">TaskQueueThread</a></dt> +<dd> </dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-17.html">Prev Letter</a></li> +<li><a href="index-19.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-18.html" target="_top">Frames</a></li> +<li><a href="index-18.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-19.html b/apidocs/index-files/index-19.html new file mode 100644 index 0000000..8984346 --- /dev/null +++ b/apidocs/index-files/index-19.html @@ -0,0 +1,1331 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>S-Index (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="S-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-18.html">Prev Letter</a></li> +<li><a href="index-20.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-19.html" target="_top">Frames</a></li> +<li><a href="index-19.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_S_"> +<!-- --> +</a> +<h2 class="title">S</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Timeout.html#seconds(long)">seconds(long)</a></span> - Static method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></dt> +<dd> +<div class="block">Return a new Timeout in seconds.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionManager.html#selectIsolationLevel(com.amazon.carbonado.Transaction, com.amazon.carbonado.IsolationLevel)">selectIsolationLevel(Transaction, IsolationLevel)</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></dt> +<dd> +<div class="block">Returns supported isolation level, which may be higher.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedure.Call.html#send(D)">send(D)</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a></dt> +<dd> +<div class="block">Send data to the remote procedure.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#send(R)">send(R)</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a></dt> +<dd> +<div class="block">Send reply data to the caller.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedure.Call.html#sendAll(java.lang.Iterable)">sendAll(Iterable<? extends D>)</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a></dt> +<dd> +<div class="block">Send all data from the given iterable to the remote procedure.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedure.Call.html#sendAll(com.amazon.carbonado.Cursor)">sendAll(Cursor<? extends D>)</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a></dt> +<dd> +<div class="block">Send all data from the given cursor to the remote procedure.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#sendAll(java.lang.Iterable)">sendAll(Iterable<? extends R>)</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a></dt> +<dd> +<div class="block">Reply with all data from the given iterable to the caller.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#sendAll(com.amazon.carbonado.Cursor)">sendAll(Cursor<? extends R>)</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a></dt> +<dd> +<div class="block">Reply with all data from the given cursor to the caller.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><span class="strong">Sequence</span></a> - Annotation Type in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Identifies a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property capable of selecting its own value on + insert, by a named sequence.</div> +</dd> +<dt><a href="../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">SequenceCapability</span></a> - Interface in <a href="../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></dt> +<dd> +<div class="block">Capability to use sequences.</div> +</dd> +<dt><a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence"><span class="strong">SequenceValueGenerator</span></a> - Class in <a href="../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></dt> +<dd> +<div class="block">General purpose implementation of a sequence value generator.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html#SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String)">SequenceValueGenerator(Repository, String)</a></span> - Constructor for class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence">SequenceValueGenerator</a></dt> +<dd> +<div class="block">Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html#SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String, long, int)">SequenceValueGenerator(Repository, String, long, int)</a></span> - Constructor for class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence">SequenceValueGenerator</a></dt> +<dd> +<div class="block">Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html#SequenceValueGenerator(com.amazon.carbonado.Repository, java.lang.String, long, int, int)">SequenceValueGenerator(Repository, String, long, int, int)</a></span> - Constructor for class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence">SequenceValueGenerator</a></dt> +<dd> +<div class="block">Construct a new SequenceValueGenerator which might create persistent + sequence data if it does not exist.</div> +</dd> +<dt><a href="../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">SequenceValueProducer</span></a> - Interface in <a href="../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></dt> +<dd> +<div class="block">Produces values for sequences.</div> +</dd> +<dt><a href="../com/amazon/carbonado/sequence/SequenceValueProducerPool.html" title="class in com.amazon.carbonado.sequence"><span class="strong">SequenceValueProducerPool</span></a> - Class in <a href="../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></dt> +<dd> +<div class="block">A concurrent pool of strongly referenced <a href="../com/amazon/carbonado/sequence/SequenceValueProducer.html" title="interface in com.amazon.carbonado.sequence"><code>SequenceValueProducer</code></a> + instances mapped by name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueProducerPool.html#SequenceValueProducerPool()">SequenceValueProducerPool()</a></span> - Constructor for class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueProducerPool.html" title="class in com.amazon.carbonado.sequence">SequenceValueProducerPool</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#SET_FOR_UPDATE_METHOD_NAME">SET_FOR_UPDATE_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Transaction API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#SET_PROPERTY_VALUE">SET_PROPERTY_VALUE</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#setActualRepositoryBuilder(com.amazon.carbonado.RepositoryBuilder)">setActualRepositoryBuilder(RepositoryBuilder)</a></span> - Method in class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the Repository to wrap all calls to.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#setAdapter(com.amazon.carbonado.info.StorablePropertyAdapter)">setAdapter(StorablePropertyAdapter)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> +<div class="block">Storables cannot currently have more than one adapter per property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#setAdapterParams(java.lang.String)">setAdapterParams(String)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#setAdapterTypeName(java.lang.String)">setAdapterTypeName(String)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setAllClustered(boolean)">setAllClustered(boolean)</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> +<div class="block">When all indexes are identified as clustered, the query analyzer treats + all indexes as performing equally well.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/ShutdownCapability.html#setAutoShutdownEnabled(boolean)">setAutoShutdownEnabled(boolean)</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a></dt> +<dd> +<div class="block">Request to enable or disable the automatic shutdown hook.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#setAutoShutdownEnabled(boolean)">setAutoShutdownEnabled(boolean)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setAutoVersioningEnabled(boolean, java.lang.String)">setAutoVersioningEnabled(boolean, String)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<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> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setBDBProduct(com.amazon.carbonado.repo.sleepycat.BDBProduct)">setBDBProduct(BDBProduct)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Sets the BDB product to use, which defaults to JE.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#setBlobValue(java.sql.PreparedStatement, int, com.amazon.carbonado.lob.Blob)">setBlobValue(PreparedStatement, int, Blob)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/LobEngine.html#setBlobValue(long, com.amazon.carbonado.lob.Blob)">setBlobValue(long, Blob)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></dt> +<dd> +<div class="block">Stores a value into a Blob, replacing anything that was there + before.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/LobEngine.html#setBlobValue(long, java.io.InputStream)">setBlobValue(long, InputStream)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></dt> +<dd> +<div class="block">Stores a value into a Blob, replacing anything that was there + before.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.Block.html#setBlockNumber(int)">setBlockNumber(int)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.html#setBlockSize(int)">setBlockSize(int)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCachePercent(int)">setCachePercent(int)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the percent of JVM heap used by the repository cache.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCachePercent(java.lang.Integer)">setCachePercent(Integer)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the percent of JVM heap used by the repository cache.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCacheSize(long)">setCacheSize(long)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the repository cache size, in bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCacheSize(java.lang.Long)">setCacheSize(Long)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the repository cache size, in bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setCatalog(java.lang.String)">setCatalog(String)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Optionally set the catalog to search for metadata.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCheckpointInterval(int)">setCheckpointInterval(int)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the interval to run checkpoints.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCheckpointThresholdKB(int)">setCheckpointThresholdKB(int)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the size threshold to run checkpoints.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCheckpointThresholdMinutes(int)">setCheckpointThresholdMinutes(int)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the time threshold to run checkpoints.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setChecksumEnabled(java.lang.Boolean)">setChecksumEnabled(Boolean)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">When true, enable checksum verification of pages read into the cache + from the backing filestore.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#setClassNameProvider(com.amazon.carbonado.synthetic.SyntheticBuilder.ClassNameProvider)">setClassNameProvider(SyntheticBuilder.ClassNameProvider)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#setClobValue(java.sql.PreparedStatement, int, com.amazon.carbonado.lob.Clob)">setClobValue(PreparedStatement, int, Clob)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/LobEngine.html#setClobValue(long, com.amazon.carbonado.lob.Clob)">setClobValue(long, Clob)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></dt> +<dd> +<div class="block">Stores a value into a Clob, replacing anything that was there + before.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/LobEngine.html#setClobValue(long, java.io.Reader)">setClobValue(long, Reader)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></dt> +<dd> +<div class="block">Stores a value into a Clob, replacing anything that was there + before.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutOptions.html#setCompressionType(java.lang.String)">setCompressionType(String)</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setCompressor(java.lang.String, java.lang.String)">setCompressor(String, String)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the compressor for the given class, overriding a custom StorableCodecFactory.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#setCreationHost(java.lang.String)">setCreationHost(String)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#setCreationTimestamp(long)">setCreationTimestamp(long)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#setCreationTimestamp(long)">setCreationTimestamp(long)</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#setCreationTimestamp(long)">setCreationTimestamp(long)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#setCreationUser(java.lang.String)">setCreationUser(String)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.Block.html#setData(byte[])">setData(byte[])</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setDatabaseHook(com.amazon.carbonado.repo.sleepycat.BDBRepositoryBuilder.DatabaseHook)">setDatabaseHook(BDBRepositoryBuilder.DatabaseHook)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Sets a hook to be called whenever a database is opened.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#setDatabaseName(java.lang.String)">setDatabaseName(String)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setDatabasePageSize(java.lang.Integer, java.lang.Class)">setDatabasePageSize(Integer, Class<? extends Storable>)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Sets the desired page size for a given type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setDatabasesTransactional(java.lang.Boolean)">setDatabasesTransactional(Boolean)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">When true, allows databases to be transactional.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setDataHome(java.lang.String)">setDataHome(String)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">By default, data files are stored relative to the environment home.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setDataHomeFile(java.io.File)">setDataHomeFile(File)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">By default, data files are stored relative to the environment home.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDataSource(javax.sql.DataSource)">setDataSource(DataSource)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<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>JDBCRepositoryBuilder.setDriverClassName(java.lang.String)</code></a> + <a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDriverURL(java.lang.String)"><code>JDBCRepositoryBuilder.setDriverURL(java.lang.String)</code></a> + <a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setUserName(java.lang.String)"><code>JDBCRepositoryBuilder.setUserName(java.lang.String)</code></a> + <a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setPassword(java.lang.String)"><code>JDBCRepositoryBuilder.setPassword(java.lang.String)</code></a> + </div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDataSourceCloseOnShutdown(boolean)">setDataSourceCloseOnShutdown(boolean)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Pass true to cause the DataSource to be closed when the repository is + closed or shutdown.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDataSourceLogging(boolean)">setDataSourceLogging(boolean)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Pass true to enable debug logging.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#setDefaultDirection(com.amazon.carbonado.info.Direction)">setDefaultDirection(Direction)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns a StorableIndex instance with all unspecified directions set to + the given direction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorableIndexSet.html#setDefaultDirection(com.amazon.carbonado.info.Direction)">setDefaultDirection(Direction)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></dt> +<dd> +<div class="block">Set the default direction for all index properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDefaultFetchSize(java.lang.Integer)">setDefaultFetchSize(Integer)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the default fetch size when running queries.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Transaction.html#setDesiredLockTimeout(int, java.util.concurrent.TimeUnit)">setDesiredLockTimeout(int, TimeUnit)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></dt> +<dd> +<div class="block">Specify a desired timeout for aquiring locks within this + transaction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionPair.html#setDesiredLockTimeout(int, java.util.concurrent.TimeUnit)">setDesiredLockTimeout(int, TimeUnit)</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn">TransactionPair</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDriverClassName(java.lang.String)">setDriverClassName(String)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the JDBC driver class name, which is required if a DataSource was not provided.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setDriverURL(java.lang.String)">setDriverURL(String)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the JDBC connection URL, which is required if a DataSource was not + provided.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setEnvironmentHome(java.lang.String)">setEnvironmentHome(String)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Sets the repository environment home directory, which is required.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setEnvironmentHomeFile(java.io.File)">setEnvironmentHomeFile(File)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Sets the repository environment home directory, which is required.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#setEvolutionStrategy(int)">setEvolutionStrategy(int)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#setEvolvable(boolean)">setEvolvable(boolean)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> +<div class="block">By default, generated storable implements the Unevolvable marker + interface, which can affect how it is encoded.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#setExecutor()">setExecutor()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> +<div class="block">Ensures that a cached query executor reference is available.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html#setExecutors()">setExecutors()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> +<div class="block">For each cached query, calls <a href="../com/amazon/carbonado/qe/StandardQuery.html#setExecutor()"><code>StandardQuery.setExecutor()</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#setExtraData(byte[])">setExtraData(byte[])</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#setExtraData(byte[])">setExtraData(byte[])</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#setExtraData(byte[])">setExtraData(byte[])</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#setExtraData(byte[])">setExtraData(byte[])</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#setExtraData(byte[])">setExtraData(byte[])</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setFileName(java.lang.String, java.lang.String)">setFileName(String, String)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Specify the file that a BDB database should reside in, except for log + files and caches.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setForceStoredSequence(boolean)">setForceStoredSequence(boolean)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">By default, native sequences are used if supported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Transaction.html#setForUpdate(boolean)">setForUpdate(boolean)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></dt> +<dd> +<div class="block">Set to true to force all read operations within this transaction to + acquire upgradable or write locks.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionManager.html#setForUpdate(Txn, boolean)">setForUpdate(Txn, boolean)</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></dt> +<dd> +<div class="block">Called when the Transaction.setForUpdate method is called.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionPair.html#setForUpdate(boolean)">setForUpdate(boolean)</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn">TransactionPair</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#setGeneration(int)">setGeneration(int)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#setGeneration(int)">setGeneration(int)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#setIndexName(java.lang.String)">setIndexName(String)</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#setIndexNameDescriptor(java.lang.String)">setIndexNameDescriptor(String)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setIndexRepairDiscardDuplicates(boolean)">setIndexRepairDiscardDuplicates(boolean)</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> +<div class="block">Set true to skip collisions during index repair, logging each as a + warning.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setIndexRepairEnabled(boolean)">setIndexRepairEnabled(boolean)</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> +<div class="block">By default, index repair is enabled.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setIndexRepairEnabled(boolean)">setIndexRepairEnabled(boolean)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">By default, index repair is enabled.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setIndexRepairThrottle(double)">setIndexRepairThrottle(double)</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> +<div class="block">Sets the throttle parameter used when indexes are added, dropped or bulk + repaired.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setIndexRepairThrottle(double)">setIndexRepairThrottle(double)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Sets the throttle parameter used when indexes are added, dropped or bulk + repaired.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setIndexRepairVerifyOnly(boolean)">setIndexRepairVerifyOnly(boolean)</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> +<div class="block">Set true to build and verify indexes, but don't apply any changes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setIndexSupport(boolean)">setIndexSupport(boolean)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">By default, user specified indexes are supported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#setIndexTypeDescriptor(java.lang.String)">setIndexTypeDescriptor(String)</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#setIndexTypeDescriptor(java.lang.String)">setIndexTypeDescriptor(String)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setInitialDatabaseConfig(java.lang.Object)">setInitialDatabaseConfig(Object)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Optionally set the BDB specific database configuration to use + for all databases created.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setInitialEnvironmentConfig(java.lang.Object)">setInitialEnvironmentConfig(Object)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Optionally set the BDB specific environment configuration to + use.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setInitializeLogging(boolean)">setInitializeLogging(boolean)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Ensure the transaction logging sub-system is initialized, which is + usually implied.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/StoredSequence.html#setInitialValue(long)">setInitialValue(long)</a></span> - Method in interface com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredSequence.html#setInitialValue(long)">setInitialValue(long)</a></span> - Method in interface com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#setIsNullable(boolean)">setIsNullable(boolean)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#setIsVersion(boolean)">setIsVersion(boolean)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setKeepOldLogFiles(boolean)">setKeepOldLogFiles(boolean)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">By default, transaction log files are deleted when no longer needed.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#setLayoutID(long)">setLayoutID(long)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#setLayoutID(long)">setLayoutID(long)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Blob.html#setLength(long)">setLength(long)</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></dt> +<dd> +<div class="block">Set the length of this Blob, in bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/BlobClob.html#setLength(long)">setLength(long)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/ByteArrayBlob.html#setLength(long)">setLength(long)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/CharArrayClob.html#setLength(long)">setLength(long)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Clob.html#setLength(long)">setLength(long)</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></dt> +<dd> +<div class="block">Set the length of this Clob, in characters.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/FileBlob.html#setLength(long)">setLength(long)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/StringClob.html#setLength(long)">setLength(long)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.html#setLength(long)">setLength(long)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.Block.html#setLocator(long)">setLocator(long)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.html#setLocator(long)">setLocator(long)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLockConflictDeadlockDetectMode(boolean)">setLockConflictDeadlockDetectMode(boolean)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Enable deadlock detection whenever a lock conflict occurs.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#setLockTimeout(int, java.util.concurrent.TimeUnit)">setLockTimeout(int, TimeUnit)</a></span> - Method in class com.amazon.carbonado.repo.map.<a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the lock timeout.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLockTimeout(double)">setLockTimeout(double)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the lock timeout, in seconds.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#setLockTimeoutMillis(int)">setLockTimeoutMillis(int)</a></span> - Method in class com.amazon.carbonado.repo.map.<a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the lock timeout, in milliseconds.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#setLog(com.amazon.carbonado.repo.logging.Log)">setLog(Log)</a></span> - Method in class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the Log to use.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLogFileMaxSize(java.lang.Integer)">setLogFileMaxSize(Integer)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the maximum transaction log file size for the BDB environment.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLogInMemory(boolean)">setLogInMemory(boolean)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Set true to store transaction logs in memory only instead of persistent + storage.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#setLoginTimeout(int)">setLoginTimeout(int)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#setLoginTimeout(int)">setLoginTimeout(int)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLogRegionSize(int)">setLogRegionSize(int)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the repository log region size, in bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setLogRegionSize(java.lang.Integer)">setLogRegionSize(Integer)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the repository log region size, in bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#setLogWriter(java.io.PrintWriter)">setLogWriter(PrintWriter)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#setLogWriter(java.io.PrintWriter)">setLogWriter(PrintWriter)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setMaster(boolean)">setMaster(boolean)</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setMaster(boolean)">setMaster(boolean)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#setMaster(boolean)">setMaster(boolean)</a></span> - Method in class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#setMaster(boolean)">setMaster(boolean)</a></span> - Method in class com.amazon.carbonado.repo.map.<a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#setMaster(boolean)">setMaster(boolean)</a></span> - Method in class com.amazon.carbonado.repo.replicated.<a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setMaster(boolean)">setMaster(boolean)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryBuilder.html#setMaster(boolean)">setMaster(boolean)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dt> +<dd> +<div class="block">Set to false if repository should not assume the role of master.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#setMasterRepositoryBuilder(com.amazon.carbonado.RepositoryBuilder)">setMasterRepositoryBuilder(RepositoryBuilder)</a></span> - Method in class com.amazon.carbonado.repo.replicated.<a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></dt> +<dd> +<div class="block">Set "master" respository to replicate from, which is required.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#setMatchedGeneration(int)">setMatchedGeneration(int)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setMaxLocks(java.lang.Integer)">setMaxLocks(Integer)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setMultiversion(boolean)">setMultiversion(boolean)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Set true to enable multiversion concurrency control (MVCC) on BDB + environment.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setName(java.lang.String)">setName(String)</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setName(java.lang.String)">setName(String)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#setName(java.lang.String)">setName(String)</a></span> - Method in class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#setName(java.lang.String)">setName(String)</a></span> - Method in class com.amazon.carbonado.repo.map.<a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#setName(java.lang.String)">setName(String)</a></span> - Method in class com.amazon.carbonado.repo.replicated.<a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setName(java.lang.String)">setName(String)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryBuilder.html#setName(java.lang.String)">setName(String)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dt> +<dd> +<div class="block">Set name for the repository, which is required.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/StoredSequence.html#setName(java.lang.String)">setName(String)</a></span> - Method in interface com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredSequence.html#setName(java.lang.String)">setName(String)</a></span> - Method in interface com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/StoredSequence.html#setNextValue(long)">setNextValue(long)</a></span> - Method in interface com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredSequence.html#setNextValue(long)">setNextValue(long)</a></span> - Method in interface com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#setNullable(boolean)">setNullable(boolean)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#setOrdinal(int)">setOrdinal(int)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setPanicHandler(com.amazon.carbonado.repo.sleepycat.BDBPanicHandler)">setPanicHandler(BDBPanicHandler)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the handler to call if the database panics.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setPassword(java.lang.String)">setPassword(String)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Optionally set the password to use with DataSource.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setPreShutdownHook(java.lang.Runnable)">setPreShutdownHook(Runnable)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Sets a callback to be invoked before the repository has finished running + its own shutdown hooks.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setPrimaryKeyCheckDisabled(boolean)">setPrimaryKeyCheckDisabled(boolean)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<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> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#setPrimaryKeyMember(boolean)">setPrimaryKeyMember(boolean)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setPrivate(boolean)">setPrivate(boolean)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">When true, BDB environment cannot be shared by other processes, and + region files are not created.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setProduct(java.lang.String)">setProduct(String)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Sets the BDB product to use, which defaults to JE.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#setPropertyName(java.lang.String)">setPropertyName(String)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#setPropertyTypeDescriptor(java.lang.String)">setPropertyTypeDescriptor(String)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#setPropertyValue(java.lang.String, java.lang.Object)">setPropertyValue(String, Object)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Sets a Storable property value by name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setReadOnly(boolean)">setReadOnly(boolean)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Sets the repository to read-only mode.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#setReplicaRepositoryBuilder(com.amazon.carbonado.RepositoryBuilder)">setReplicaRepositoryBuilder(RepositoryBuilder)</a></span> - Method in class com.amazon.carbonado.repo.replicated.<a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></dt> +<dd> +<div class="block">Set "replica" respository to replicate to, which is required.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setReverseSplitOff(boolean)">setReverseSplitOff(boolean)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Pass true to disable reverse split of B-tree nodes to reduce deadlocks.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setRunCheckpointer(boolean)">setRunCheckpointer(boolean)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Disable automatic checkpointing of database if another process is + responsible for that.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setRunDeadlockDetector(boolean)">setRunDeadlockDetector(boolean)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Disable automatic deadlock detection of database if another thread is + responsible for that.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setRunFullRecovery(boolean)">setRunFullRecovery(boolean)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Pass true to override the default and run a full (catastrophic) recovery + when environment is opened.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setSchema(java.lang.String)">setSchema(String)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Optionally set the schema to search for metadata.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setSequenceSelectStatement(java.lang.String)">setSequenceSelectStatement(String)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Override the default native sequence select statement with a printf.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setShutdownHook(java.lang.Runnable)">setShutdownHook(Runnable)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Sets a callback to be invoked after repository has finished running its + own shutdown hooks.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setSingleFileName(java.lang.String)">setSingleFileName(String)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Specify that all BDB databases should reside in one file, except for log + files and caches.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setStorableCodecFactory(com.amazon.carbonado.raw.StorableCodecFactory)">setStorableCodecFactory(StorableCodecFactory)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Override the default storable codec factory.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#setStorableTypeName(java.lang.String)">setStorableTypeName(String)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#setStorableTypeName(java.lang.String)">setStorableTypeName(String)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/CorruptEncodingException.html#setStorableWithPrimaryKey(com.amazon.carbonado.Storable)">setStorableWithPrimaryKey(Storable)</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></dt> +<dd> +<div class="block">If the decoder can at least extract the primary key, it should set it here.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setStrictTriggers(boolean)">setStrictTriggers(boolean)</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> +<div class="block">Set to true to require that index maintenance triggers use a "for update" transaction, + avoiding deadlocks and lock upgrade failures.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setSuppressReload(boolean, java.lang.String)">setSuppressReload(boolean, String)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">By default, JDBCRepository reloads Storables after every insert or + update.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setTransactionMaxActive(java.lang.Integer)">setTransactionMaxActive(Integer)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the maximum number of concurrent transactions, or pass null to use + the default.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setTransactionNoSync(boolean)">setTransactionNoSync(boolean)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">When true, commits are not immediately written or flushed to disk.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setTransactionTimeout(double)">setTransactionTimeout(double)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the transaction timeout, in seconds.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#setTransactionWriteNoSync(boolean)">setTransactionWriteNoSync(boolean)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">When true, commits are written, but they are not flushed to disk.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#setUserName(java.lang.String)">setUserName(String)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Optionally set the username to use with DataSource.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String)">setValue(String)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String, java.lang.String)">setValue(String, String)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractBlob.html#setValue(java.lang.String, java.nio.charset.Charset)">setValue(String, Charset)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractClob.html#setValue(java.lang.String)">setValue(String)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String)">setValue(String)</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></dt> +<dd> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying UTF-8 encoding.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String, java.lang.String)">setValue(String, String)</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></dt> +<dd> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Blob.html#setValue(java.lang.String, java.nio.charset.Charset)">setValue(String, Charset)</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></dt> +<dd> +<div class="block">Convenience method to overwrite all Blob data with the value of a single + String, applying the given charset encoding.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Clob.html#setValue(java.lang.String)">setValue(String)</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></dt> +<dd> +<div class="block">Convenience method to overwrite all Clob data with the value of a single + String.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/StringClob.html#setValue(java.lang.String)">setValue(String)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#setVersion(boolean)">setVersion(boolean)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/StoredSequence.html#setVersion(int)">setVersion(int)</a></span> - Method in interface com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.Block.html#setVersion(int)">setVersion(int)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.html#setVersion(int)">setVersion(int)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#setVersionNumber(int)">setVersionNumber(int)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#setVersionNumber(int)">setVersionNumber(int)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#setVersionNumber(int)">setVersionNumber(int)</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#setVersionNumber(int)">setVersionNumber(int)</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#setVersionNumber(int)">setVersionNumber(int)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#setWrappedRepository(com.amazon.carbonado.RepositoryBuilder)">setWrappedRepository(RepositoryBuilder)</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> +<div class="block">Set the required wrapped respository, which must support the + <a href="../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfoCapability</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#shouldCopyDerived()">shouldCopyDerived()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this derived property should be included when copying a + storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#shouldReverseOrder()">shouldReverseOrder()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns true if evaluated index must be iterated in reverse to achieve + the desired ordering.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#shouldReverseRange()">shouldReverseRange()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns true if there is a range start or end match, but natural order + of matching property is descending.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/ShutdownCapability.html#shutdown()">shutdown()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a></dt> +<dd> +<div class="block">Similar to calling close on a repository, except should only be called + when the virtual machine is in the process of shutting down.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#shutdown()">shutdown()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/TaskQueueThread.html#shutdown()">shutdown()</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/TaskQueueThread.html" title="class in com.amazon.carbonado.util">TaskQueueThread</a></dt> +<dd> +<div class="block">Indicate that this task queue thread should finish running its enqueued + tasks and then exit.</div> +</dd> +<dt><a href="../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">ShutdownCapability</span></a> - Interface in <a href="../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></dt> +<dd> +<div class="block">Capability for repositories that require special attention with the Java + virtual machine exits.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#shutdownHook()">shutdownHook()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> +<div class="block">Install custom shutdown logic by overriding this method.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">SimpleDataSource</span></a> - Class in <a href="../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></dt> +<dd> +<div class="block">SimpleDataSource does not implement any connection pooling.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#SimpleDataSource(java.lang.String, java.lang.String, java.util.Properties)">SimpleDataSource(String, String, Properties)</a></span> - Constructor for class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#SimpleDataSource(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">SimpleDataSource(String, String, String, String)</a></span> - Constructor for class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#SimpleDataSource(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Properties)">SimpleDataSource(String, String, String, String, Properties)</a></span> - Constructor for class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">SingletonCursor</span></a><<a href="../com/amazon/carbonado/cursor/SingletonCursor.html" title="type parameter in SingletonCursor">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Special cursor implementation that returns only one element.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SingletonCursor.html#SingletonCursor(S)">SingletonCursor(S)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor">SingletonCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html#size()">size()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">MergeSortBuffer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorablePropertyMap.html#size()">size()</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#size()">size()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/SoftValuedCache.html#size()">size()</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/RAFInputStream.html#skip(long)">skip(long)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi">RAFInputStream</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/cursor/SkipCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">SkipCursor</span></a><<a href="../com/amazon/carbonado/cursor/SkipCursor.html" title="type parameter in SkipCursor">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Wraps another cursor to skip an initial amount of elements.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SkipCursor.html#SkipCursor(com.amazon.carbonado.Cursor, long)">SkipCursor(Cursor<S>, long)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SkipCursor.html" title="class in com.amazon.carbonado.cursor">SkipCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/AbstractCursor.html#skipNext(int)">skipNext(int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/EmptyCursor.html#skipNext(int)">skipNext(int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor">EmptyCursor</a></dt> +<dd> +<div class="block">Always returns 0.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/FilteredCursor.html#skipNext(int)">skipNext(int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor">FilteredCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/GroupedCursor.html#skipNext(int)">skipNext(int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor">GroupedCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/LimitCursor.html#skipNext(int)">skipNext(int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/LimitCursor.html" title="class in com.amazon.carbonado.cursor">LimitCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MultiTransformedCursor.html#skipNext(int)">skipNext(int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor">MultiTransformedCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SingletonCursor.html#skipNext(int)">skipNext(int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor">SingletonCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SkipCursor.html#skipNext(int)">skipNext(int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SkipCursor.html" title="class in com.amazon.carbonado.cursor">SkipCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Cursor.html#skipNext(int)">skipNext(int)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></dt> +<dd> +<div class="block">Skips forward by the specified amount of elements, returning the actual + amount skipped.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SortedCursor.html#skipNext(int)">skipNext(int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor">SortedCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/ThrottledCursor.html#skipNext(int)">skipNext(int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor">ThrottledCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/TransformedCursor.html#skipNext(int)">skipNext(int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor">TransformedCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#skipNext(int)">skipNext(int)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util"><span class="strong">SoftValuedCache</span></a><<a href="../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">K</a>,<a href="../com/amazon/carbonado/util/SoftValuedCache.html" title="type parameter in SoftValuedCache">V</a>> - Class in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>use Cojen <code>Cache</code> interface</i></div> +</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/SoftValuedCache.html#SoftValuedCache()">SoftValuedCache()</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/ArraySortBuffer.html#sort()">sort()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="class in com.amazon.carbonado.cursor">ArraySortBuffer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html#sort()">sort()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">MergeSortBuffer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SortBuffer.html#sort()">sort()</a></span> - Method in interface com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a></dt> +<dd> +<div class="block">Finish sorting buffer.</div> +</dd> +<dt><a href="../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor"><span class="strong">SortBuffer</span></a><<a href="../com/amazon/carbonado/cursor/SortBuffer.html" title="type parameter in SortBuffer">S</a>> - Interface in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Buffers up Storable instances allowing them to be sorted.</div> +</dd> +<dt><a href="../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">SortedCursor</span></a><<a href="../com/amazon/carbonado/cursor/SortedCursor.html" title="type parameter in SortedCursor">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Wraps another Cursor and ensures the results are sorted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SortedCursor.html#SortedCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.cursor.SortBuffer, java.util.Comparator, java.util.Comparator)">SortedCursor(Cursor<S>, SortBuffer<S>, Comparator<S>, Comparator<S>)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor">SortedCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SortedCursor.html#SortedCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.cursor.SortBuffer, java.lang.Class, java.lang.String...)">SortedCursor(Cursor<S>, SortBuffer<S>, Class<S>, String...)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor">SortedCursor</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">SortedQueryExecutor</span></a><<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="type parameter in SortedQueryExecutor">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">QueryExecutor which wraps another and sorts the results.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html#SortedQueryExecutor(com.amazon.carbonado.qe.SortedQueryExecutor.Support, com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.OrderingList)">SortedQueryExecutor(SortedQueryExecutor.Support<S>, QueryExecutor<S>, OrderingList<S>, OrderingList<S>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe"><span class="strong">SortedQueryExecutor.ArraySortSupport</span></a><<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="type parameter in SortedQueryExecutor.ArraySortSupport">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html#SortedQueryExecutor.ArraySortSupport()">SortedQueryExecutor.ArraySortSupport()</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.ArraySortSupport</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe"><span class="strong">SortedQueryExecutor.MergeSortSupport</span></a><<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="type parameter in SortedQueryExecutor.MergeSortSupport">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html#SortedQueryExecutor.MergeSortSupport()">SortedQueryExecutor.MergeSortSupport()</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.MergeSortSupport</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">SortedQueryExecutor.Support</span></a><<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="type parameter in SortedQueryExecutor.Support">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Provides support for <a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>SortedQueryExecutor</code></a>.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">StandardQuery</span></a><<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="type parameter in StandardQuery">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Abstract query implementation which uses a <a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe"><code>QueryExecutor</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#StandardQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">StandardQuery(Filter<S>, FilterValues<S>, OrderingList<S>, QueryHints)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">StandardQueryFactory</span></a><<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="type parameter in StandardQueryFactory">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Builds and caches StandardQuery instances.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html#StandardQueryFactory(java.lang.Class)">StandardQueryFactory(Class<S>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html#StandardQueryFactory(java.lang.Class, boolean)">StandardQueryFactory(Class<S>, boolean)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startBackup()">startBackup()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability</a></dt> +<dd> +<div class="block">Starts the backup by disabling log file deletion.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startBackup(boolean)">startBackup(boolean)</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability</a></dt> +<dd> +<div class="block">Starts the backup by disabling log file deletion.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startIncrementalBackup(long)">startIncrementalBackup(long)</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability</a></dt> +<dd> +<div class="block">Starts an incremental backup.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html#startIncrementalBackup(long, boolean)">startIncrementalBackup(long, boolean)</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability</a></dt> +<dd> +<div class="block">Starts an incremental backup.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><span class="strong">Storable</span></a><<a href="../com/amazon/carbonado/Storable.html" title="type parameter in Storable">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a><<a href="../com/amazon/carbonado/Storable.html" title="type parameter in Storable">S</a>>> - Interface in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">A data access object in a <a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#STORABLE_TYPE_METHOD_NAME">STORABLE_TYPE_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw"><span class="strong">StorableCodec</span></a><<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Supports encoding and decoding of storables.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">StorableCodecFactory</span></a> - Interface in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Factory for creating instances of <a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw"><code>StorableCodec</code></a>.</div> +</dd> +<dt><a href="../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen"><span class="strong">StorableCopier</span></a><<a href="../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,<a href="../com/amazon/carbonado/gen/StorableCopier.html" title="type parameter in StorableCopier">T</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></dt> +<dd> +<div class="block">Copies properties between otherwise incompatible Storables.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableCopier.html#StorableCopier()">StorableCopier()</a></span> - Constructor for class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">StorableCopier</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen"><span class="strong">StorableCopier.From</span></a><<a href="../com/amazon/carbonado/gen/StorableCopier.From.html" title="type parameter in StorableCopier.From">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><span class="strong">StorableGenerator</span></a><<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="type parameter in StorableGenerator">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></dt> +<dd> +<div class="block">Generates and caches abstract implementations of <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> + types.</div> +</dd> +<dt><a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><span class="strong">StorableIndex</span></a><<a href="../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></dt> +<dd> +<div class="block">Represents an index that must be defined for a specific <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[])">StorableIndex(StorableProperty<S>[], Direction[])</a></span> - Constructor for class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[], boolean)">StorableIndex(StorableProperty<S>[], Direction[], boolean)</a></span> - Constructor for class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[], boolean, boolean)">StorableIndex(StorableProperty<S>[], Direction[], boolean, boolean)</a></span> - Constructor for class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableKey, com.amazon.carbonado.info.Direction)">StorableIndex(StorableKey<S>, Direction)</a></span> - Constructor for class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Creates a StorableIndex from a StorableKey.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.OrderedProperty[], com.amazon.carbonado.info.Direction)">StorableIndex(OrderedProperty<S>[], Direction)</a></span> - Constructor for class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Creates a StorableIndex from OrderedProperties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(java.lang.Class, com.amazon.carbonado.capability.IndexInfo)">StorableIndex(Class<S>, IndexInfo)</a></span> - Constructor for class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Creates a StorableIndex from an IndexInfo.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe"><span class="strong">StorableIndexSet</span></a><<a href="../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Manages a set of <a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><code>StorableIndex</code></a> objects, intended for reducing the + set such that the minimal amount of physical indexes need to be defined for + a specific type of <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorableIndexSet.html#StorableIndexSet()">StorableIndexSet()</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorableIndexSet.html#StorableIndexSet(com.amazon.carbonado.qe.StorableIndexSet)">StorableIndexSet(StorableIndexSet<S>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></dt> +<dd> +<div class="block">Copy constructor.</div> +</dd> +<dt><a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info"><span class="strong">StorableInfo</span></a><<a href="../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></dt> +<dd> +<div class="block">Contains all the metadata describing a specific <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</dd> +<dt><a href="../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">StorableInfoCapability</span></a> - Interface in <a href="../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></dt> +<dd> +<div class="block">Capability that returns information about known storable types in a + repository.</div> +</dd> +<dt><a href="../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><span class="strong">StorableIntrospector</span></a> - Class in <a href="../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></dt> +<dd> +<div class="block">Supports examination of <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types, returning all metadata + associated with it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIntrospector.html#StorableIntrospector()">StorableIntrospector()</a></span> - Constructor for class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">StorableIntrospector</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info"><span class="strong">StorableKey</span></a><<a href="../com/amazon/carbonado/info/StorableKey.html" title="type parameter in StorableKey">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></dt> +<dd> +<div class="block">Represents a primary, alternate or partition key of a specific <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</dd> +<dt><a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info"><span class="strong">StorableProperty</span></a><<a href="../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></dt> +<dd> +<div class="block">Contains all the metadata describing a property of a specific <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</dd> +<dt><a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info"><span class="strong">StorablePropertyAdapter</span></a> - Class in <a href="../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></dt> +<dd> +<div class="block">Information about an <a href="../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><code>adapter</code></a> annotation applied to a property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html#StorablePropertyAdapter(java.lang.String, java.lang.Class, java.lang.Class)">StorablePropertyAdapter(String, Class<?>, Class<? extends Annotation>)</a></span> - Constructor for class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></dt> +<dd> +<div class="block">Construct a generic StorablePropertyAdapter instance not attached to a + storable definition.</div> +</dd> +<dt><a href="../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info"><span class="strong">StorablePropertyAnnotation</span></a> - Class in <a href="../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></dt> +<dd> +<div class="block">Information about a custom annotation applied to a property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAnnotation.html#StorablePropertyAnnotation(java.lang.annotation.Annotation, java.lang.reflect.Method)">StorablePropertyAnnotation(Annotation, Method)</a></span> - Constructor for class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></dt> +<dd> +<div class="block">Use this constructor if an annotation was actually defined.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAnnotation.html#StorablePropertyAnnotation(java.lang.Class, java.lang.reflect.Method)">StorablePropertyAnnotation(Class<? extends Annotation>, Method)</a></span> - Constructor for class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></dt> +<dd> +<div class="block">Use this constructor if an annotation was not defined, but instead is + being automatically applied.</div> +</dd> +<dt><a href="../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info"><span class="strong">StorablePropertyConstraint</span></a> - Class in <a href="../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></dt> +<dd> +<div class="block">Information about a <a href="../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint"><code>constraint</code></a> annotation applied to a property.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw"><span class="strong">StorablePropertyInfo</span></a> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen"><span class="strong">StorablePropertyMap</span></a><<a href="../com/amazon/carbonado/gen/StorablePropertyMap.html" title="type parameter in StorablePropertyMap">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></dt> +<dd> +<div class="block">Basic implementation for <a href="../com/amazon/carbonado/Storable.html#propertyMap()"><code>Storable.propertyMap()</code></a> method.</div> +</dd> +<dt><a href="../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">StorableSupport</span></a><<a href="../com/amazon/carbonado/gen/StorableSupport.html" title="type parameter in StorableSupport">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></dt> +<dd> +<div class="block">Provides runtime support for Storable classes generated by <a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>StorableGenerator</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#storableType()">storableType()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Returns the class or interface from which this storable was + generated.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><span class="strong">Storage</span></a><<a href="../com/amazon/carbonado/Storage.html" title="type parameter in Storage">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Access for a specific type of <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> from a <a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#STORAGE_FOR_METHOD_NAME">STORAGE_FOR_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Repository API method name</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe"><span class="strong">StorageAccess</span></a><<a href="../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Provides internal access to a <a href="../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>, necessary for query + execution.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/RepositoryAccess.html#storageAccessFor(java.lang.Class)">storageAccessFor(Class<S>)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a></dt> +<dd> +<div class="block">Returns a StorageAccess instance for the given user defined Storable + class or interface.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorageAccess.html#storageDelegate(com.amazon.carbonado.info.StorableIndex)">storageDelegate(StorableIndex<S>)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a></dt> +<dd> +<div class="block">If the given index is not directly supported by storage, queries should + be delegated.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Repository.html#storageFor(java.lang.Class)">storageFor(Class<S>)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></dt> +<dd> +<div class="block">Returns a Storage instance for the given user defined Storable class or + interface.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#storageFor(java.lang.Class)">storageFor(Class<S>)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/spi/StoragePool.html" title="class in com.amazon.carbonado.spi"><span class="strong">StoragePool</span></a> - Class in <a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></dt> +<dd> +<div class="block">A concurrent pool of strongly referenced Storage instances mapped by + Storable type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoragePool.html#StoragePool()">StoragePool()</a></span> - Constructor for class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoragePool.html" title="class in com.amazon.carbonado.spi">StoragePool</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawSupport.html#store(S, byte[], byte[])">store(S, byte[], byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></dt> +<dd> +<div class="block">Try to store the entry referenced by the given key with the given + value.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat"><span class="strong">StoredDatabaseInfo</span></a> - Class in <a href="../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></dt> +<dd> +<div class="block">Stores basic information about the BDB databases managed by BDBRepository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#StoredDatabaseInfo()">StoredDatabaseInfo()</a></span> - Constructor for class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">StoredIndexInfo</span></a> - Interface in <a href="../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></dt> +<dd> +<div class="block">Stores basic information about the indexes managed by IndexedRepository.</div> +</dd> +<dt><a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><span class="strong">StoredLayout</span></a> - Interface in <a href="../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></dt> +<dd> +<div class="block">Stored information regarding the layout of a Storable type, which is used + internally by <a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout"><code>Layout</code></a>.</div> +</dd> +<dt><a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout"><span class="strong">StoredLayoutEquivalence</span></a> - Interface in <a href="../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></dt> +<dd> +<div class="block">Maps layout generations which are equivalent.</div> +</dd> +<dt><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout"><span class="strong">StoredLayoutProperty</span></a> - Interface in <a href="../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></dt> +<dd> +<div class="block">Stored property joined to a <a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout"><code>StoredLayout</code></a>, which is used internally + by <a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout"><code>LayoutProperty</code></a>.</div> +</dd> +<dt><a href="../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi"><span class="strong">StoredLob</span></a> - Class in <a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></dt> +<dd> +<div class="block">Can be used internally by repositories for supporting Lobs.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.html#StoredLob()">StoredLob()</a></span> - Constructor for class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi"><span class="strong">StoredLob.Block</span></a> - Class in <a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></dt> +<dd> +<div class="block">Blocks stored here.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.Block.html#StoredLob.Block()">StoredLob.Block()</a></span> - Constructor for class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence"><span class="strong">StoredSequence</span></a> - Interface in <a href="../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a></dt> +<dd> +<div class="block">Stores data for <a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence"><code>SequenceValueGenerator</code></a>.</div> +</dd> +<dt><a href="../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi"><span class="strong">StoredSequence</span></a> - Interface in <a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>Replaced by <a href="../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence"><code>StoredSequence</code></a></i></div> +</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#storePropertyValue(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.raw.StorablePropertyInfo, boolean, org.cojen.classfile.LocalVariable, java.lang.Class)">storePropertyValue(CodeAssembler, StorablePropertyInfo, boolean, LocalVariable, Class<?>)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Generates code to store a property value into an instance which is + already on the operand stack.</div> +</dd> +<dt><a href="../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">StringClob</span></a> - Class in <a href="../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></dt> +<dd> +<div class="block">Implementation of a Clob which is backed by a read-only String.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/StringClob.html#StringClob(java.lang.String)">StringClob(String)</a></span> - Constructor for class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#subList(int, int)">subList(int, int)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#SUPPORT_FIELD_NAME">SUPPORT_FIELD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Reference to TriggerSupport instance</div> +</dd> +<dt><a href="../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado"><span class="strong">SupportException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Indicates that an action cannot be supported by the <a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> it is being requested from.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/SupportException.html#SupportException()">SupportException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/SupportException.html#SupportException(java.lang.String)">SupportException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/SupportException.html#SupportException(java.lang.String, java.lang.Throwable)">SupportException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/SupportException.html#SupportException(java.lang.Throwable)">SupportException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/SupportException.html" title="class in com.amazon.carbonado">SupportException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionManager.html#supportsForUpdate()">supportsForUpdate()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></dt> +<dd> +<div class="block">Return true if transactions support "for update" mode.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html#suspendCheckpointer(long)">suspendCheckpointer(long)</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">CheckpointCapability</a></dt> +<dd> +<div class="block">Suspend the checkpointer until the suspension time has expired or until + manually resumed.</div> +</dd> +<dt><a href="../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">SymmetricDifferenceCursor</span></a><<a href="../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="type parameter in SymmetricDifferenceCursor">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Wraps two Cursors and performs a <i>symmetric set difference</i> + operation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html#SymmetricDifferenceCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)">SymmetricDifferenceCursor(Cursor<S>, Cursor<S>, Comparator<S>)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor">SymmetricDifferenceCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html#sync()">sync()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">CheckpointCapability</a></dt> +<dd> +<div class="block">Synchronously flushes changes to stable storage, which is cheaper than + performing a checkpoint.</div> +</dd> +<dt><a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic"><span class="strong">SyntheticBuilder</span></a> - Interface in <a href="../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></dt> +<dd> +<div class="block">A synthetic builder provides a mechanism for creating a user storable from scratch.</div> +</dd> +<dt><a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic"><span class="strong">SyntheticBuilder.ClassNameProvider</span></a> - Interface in <a href="../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></dt> +<dd> +<div class="block">Interface used to get the name for the class to generate.</div> +</dd> +<dt><a href="../com/amazon/carbonado/synthetic/SyntheticIndex.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">SyntheticIndex</span></a> - Class in <a href="../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></dt> +<dd> +<div class="block">Specification of a collection of properties which will participate in an index.</div> +</dd> +<dt><a href="../com/amazon/carbonado/synthetic/SyntheticKey.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">SyntheticKey</span></a> - Class in <a href="../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></dt> +<dd> +<div class="block">Specification of a collection of properties which will participate in a key.</div> +</dd> +<dt><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">SyntheticProperty</span></a> - Class in <a href="../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></dt> +<dd> +<div class="block">Minimal specification of a storable property for use with a <a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic"><code>SyntheticStorableBuilder</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#SyntheticProperty(java.lang.String, java.lang.Class)">SyntheticProperty(String, Class)</a></span> - Constructor for class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> +<div class="block">Every property requires minimally a name and a type</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#SyntheticProperty(java.lang.String, java.lang.Class, boolean, boolean)">SyntheticProperty(String, Class, boolean, boolean)</a></span> - Constructor for class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">SyntheticPropertyList</span></a> - Class in <a href="../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></dt> +<dd> +<div class="block">Specification of a collection of properties which will participate in a key + or index.</div> +</dd> +<dt><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">SyntheticStorableBuilder</span></a> - Class in <a href="../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></dt> +<dd> +<div class="block">Allows the definition of very simple synthetic storables.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#SyntheticStorableBuilder(java.lang.String, java.lang.ClassLoader)">SyntheticStorableBuilder(String, ClassLoader)</a></span> - Constructor for class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">SyntheticStorableReferenceAccess</span></a><<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="type parameter in SyntheticStorableReferenceAccess">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></dt> +<dd> +<div class="block">Provides access to the generated storable reference class and utility + methods.</div> +</dd> +<dt><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">SyntheticStorableReferenceBuilder</span></a><<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="type parameter in SyntheticStorableReferenceBuilder">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></dt> +<dd> +<div class="block">A SyntheticStorableReference defines new kinds of Storables from an existing + master storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#SyntheticStorableReferenceBuilder(java.lang.Class, boolean)">SyntheticStorableReferenceBuilder(Class<S>, boolean)</a></span> - Constructor for class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#SyntheticStorableReferenceBuilder(java.lang.Class, java.lang.String, boolean)">SyntheticStorableReferenceBuilder(Class<S>, String, boolean)</a></span> - Constructor for class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> </dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-18.html">Prev Letter</a></li> +<li><a href="index-20.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-19.html" target="_top">Frames</a></li> +<li><a href="index-19.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-2.html b/apidocs/index-files/index-2.html new file mode 100644 index 0000000..8c980bc --- /dev/null +++ b/apidocs/index-files/index-2.html @@ -0,0 +1,415 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>B-Index (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="B-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-1.html">Prev Letter</a></li> +<li><a href="index-3.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-2.html" target="_top">Frames</a></li> +<li><a href="index-2.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_B_"> +<!-- --> +</a> +<h2 class="title">B</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryException.html#backoff(E, int, int)">backoff(E, int, int)</a></span> - Static method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></dt> +<dd> +<div class="block">One strategy for resolving an optimistic lock failure is to try the + operation again, after waiting some bounded random amount of time.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/sleepycat/BDBPanicHandler.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">BDBPanicHandler</span></a> - Interface in <a href="../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></dt> +<dd> +<div class="block">Interface for a generic panic handler for any BDB products.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat"><span class="strong">BDBProduct</span></a> - Enum in <a href="../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></dt> +<dd> +<div class="block">Set of supported BDB products.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat"><span class="strong">BDBRepositoryBuilder</span></a> - Class in <a href="../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></dt> +<dd> +<div class="block">Builder and configuration options for BDBRepository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#BDBRepositoryBuilder()">BDBRepositoryBuilder()</a></span> - Constructor for class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">BDBRepositoryBuilder.DatabaseHook</span></a> - Interface in <a href="../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html#beforeDelete(S)">beforeDelete(S)</a></span> - Method in class com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a></dt> +<dd> +<div class="block">Called before a bogus storable is to be deleted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#beforeDelete(S)">beforeDelete(S)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#beforeDelete(com.amazon.carbonado.Transaction, S)">beforeDelete(Transaction, S)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#beforeDelete(S)">beforeDelete(S)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called before a storable is to be deleted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#beforeDelete(com.amazon.carbonado.Transaction, S)">beforeDelete(Transaction, S)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called before a storable is to be deleted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html#beforeInsert(S)">beforeInsert(S)</a></span> - Method in class com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a></dt> +<dd> +<div class="block">Called before a sync'd storable is to be inserted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#beforeInsert(S)">beforeInsert(S)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#beforeInsert(com.amazon.carbonado.Transaction, S)">beforeInsert(Transaction, S)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#beforeInsert(S)">beforeInsert(S)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called before a storable is to be inserted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#beforeInsert(com.amazon.carbonado.Transaction, S)">beforeInsert(Transaction, S)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called before a storable is to be inserted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#beforeTryDelete(S)">beforeTryDelete(S)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#beforeTryDelete(com.amazon.carbonado.Transaction, S)">beforeTryDelete(Transaction, S)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#beforeTryDelete(S)">beforeTryDelete(S)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called before a storable is to be deleted via tryDelete.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#beforeTryDelete(com.amazon.carbonado.Transaction, S)">beforeTryDelete(Transaction, S)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called before a storable is to be deleted via tryDelete.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#beforeTryInsert(S)">beforeTryInsert(S)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#beforeTryInsert(com.amazon.carbonado.Transaction, S)">beforeTryInsert(Transaction, S)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#beforeTryInsert(S)">beforeTryInsert(S)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called before a storable is to be inserted via tryInsert.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#beforeTryInsert(com.amazon.carbonado.Transaction, S)">beforeTryInsert(Transaction, S)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called before a storable is to be inserted via tryInsert.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#beforeTryUpdate(S)">beforeTryUpdate(S)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#beforeTryUpdate(com.amazon.carbonado.Transaction, S)">beforeTryUpdate(Transaction, S)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#beforeTryUpdate(S)">beforeTryUpdate(S)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called before a storable is to be updated via tryUpdate.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#beforeTryUpdate(com.amazon.carbonado.Transaction, S)">beforeTryUpdate(Transaction, S)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called before a storable is to be updated via tryUpdate.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html#beforeUpdate(S)">beforeUpdate(S)</a></span> - Method in class com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a></dt> +<dd> +<div class="block">Called before a sync'd storable is to be updated.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html#beforeUpdate(S, S)">beforeUpdate(S, S)</a></span> - Method in class com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a></dt> +<dd> +<div class="block">Overloaded version of beforeUpdate method which is passed the + storable in it's out-of-sync and sync'd states.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#beforeUpdate(S)">beforeUpdate(S)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#beforeUpdate(com.amazon.carbonado.Transaction, S)">beforeUpdate(Transaction, S)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#beforeUpdate(S)">beforeUpdate(S)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called before a storable is to be updated.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#beforeUpdate(com.amazon.carbonado.Transaction, S)">beforeUpdate(Transaction, S)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called before a storable is to be updated.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Controller.html#begin()">begin()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></dt> +<dd> +<div class="block">Called by query when it begins, possibly multiple times.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Timeout.html#begin()">begin()</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedureCapability.html#beginCall(com.amazon.carbonado.capability.RemoteProcedure)">beginCall(RemoteProcedure<R, D>)</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedureCapability.html" title="interface in com.amazon.carbonado.capability">RemoteProcedureCapability</a></dt> +<dd> +<div class="block">Begins a call to execute the given procedure on a remote host.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/GroupedCursor.html#beginGroup(S)">beginGroup(S)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor">GroupedCursor</a></dt> +<dd> +<div class="block">This method is called for the first entry in a group.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedure.Request.html#beginReply()">beginReply()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a></dt> +<dd> +<div class="block">Begin a reply after receiving all data.</div> +</dd> +<dt><a href="../com/amazon/carbonado/util/BelatedCreationException.html" title="class in com.amazon.carbonado.util"><span class="strong">BelatedCreationException</span></a> - Exception in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block">Exception throw when attempting to perform an unavailable operation on an + object undergoing belated creation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/BelatedCreationException.html#BelatedCreationException(java.lang.String)">BelatedCreationException(String)</a></span> - Constructor for exception com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/BelatedCreationException.html" title="class in com.amazon.carbonado.util">BelatedCreationException</a></dt> +<dd> +<div class="block">Create a new exception with the given message.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/BelatedCreationException.html#BelatedCreationException(java.lang.String, java.lang.Throwable)">BelatedCreationException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/BelatedCreationException.html" title="class in com.amazon.carbonado.util">BelatedCreationException</a></dt> +<dd> +<div class="block">Create a new exception with the given message and cause.</div> +</dd> +<dt><a href="../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util"><span class="strong">BelatedCreator</span></a><<a href="../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">T</a>,<a href="../com/amazon/carbonado/util/BelatedCreator.html" title="type parameter in BelatedCreator">E</a> extends java.lang.Exception> - Class in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block">Generic one-shot factory which supports late object creation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/BelatedCreator.html#BelatedCreator(java.lang.Class, int)">BelatedCreator(Class<T>, int)</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">BelatedRepositoryCreator</span></a> - Class in <a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></dt> +<dd> +<div class="block">Generic one-shot Repository builder which supports late object creation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#BelatedRepositoryCreator(org.apache.commons.logging.Log, com.amazon.carbonado.RepositoryBuilder, int)">BelatedRepositoryCreator(Log, RepositoryBuilder, int)</a></span> - Constructor for class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi">BelatedRepositoryCreator</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#BelatedRepositoryCreator(org.apache.commons.logging.Log, com.amazon.carbonado.RepositoryBuilder, java.util.concurrent.atomic.AtomicReference, int)">BelatedRepositoryCreator(Log, RepositoryBuilder, AtomicReference<Repository>, int)</a></span> - Constructor for class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi">BelatedRepositoryCreator</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi"><span class="strong">BelatedStorageCreator</span></a><<a href="../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="type parameter in BelatedStorageCreator">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></dt> +<dd> +<div class="block">Generic one-shot Storage creator which supports late object creation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/BelatedStorageCreator.html#BelatedStorageCreator(org.apache.commons.logging.Log, com.amazon.carbonado.Repository, java.lang.Class, int)">BelatedStorageCreator(Log, Repository, Class<S>, int)</a></span> - Constructor for class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi">BelatedStorageCreator</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">BinaryOpFilter</span></a><<a href="../com/amazon/carbonado/filter/BinaryOpFilter.html" title="type parameter in BinaryOpFilter">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></dt> +<dd> +<div class="block">Base class for filter tree nodes that have a left and right child.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/BinaryOpFilter.html#bind()">bind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#bind()">bind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ExistsFilter.html#bind()">bind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#bind()">bind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Walks through each property filter, assigning a bind ID to it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#bind()">bind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#bind()">bind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#bindQueryParam(java.lang.Class)">bindQueryParam(Class)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Determines which overloaded "with" method on Query should be bound to.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#blankValue(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc)">blankValue(CodeBuilder, TypeDesc)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Generates code to push a blank value to the stack.</div> +</dd> +<dt><a href="../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Blob</span></a> - Interface in <a href="../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></dt> +<dd> +<div class="block">Provides access to BLOBs, which are Binary Large OBjects.</div> +</dd> +<dt><a href="../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">BlobClob</span></a> - Class in <a href="../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></dt> +<dd> +<div class="block">A Clob implementation which is backed by a Blob.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/BlobClob.html#BlobClob(com.amazon.carbonado.lob.Blob)">BlobClob(Blob)</a></span> - Constructor for class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe"><span class="strong">BoundaryType</span></a> - Enum in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Describes a value range boundary.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/JoinedQueryExecutor.html#build(com.amazon.carbonado.qe.RepositoryAccess, com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">build(RepositoryAccess, ChainedProperty<T>, Filter<T>, OrderingList<T>, QueryHints)</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a></dt> +<dd> +<div class="block">Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build(AtomicReference<Repository>)</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build(AtomicReference<Repository>)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build(AtomicReference<Repository>)</a></span> - Method in class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build(AtomicReference<Repository>)</a></span> - Method in class com.amazon.carbonado.repo.map.<a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build(AtomicReference<Repository>)</a></span> - Method in class com.amazon.carbonado.repo.replicated.<a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build(AtomicReference<Repository>)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryBuilder.html#build()">build()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dt> +<dd> +<div class="block">Builds a repository instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryBuilder.html#build(java.util.concurrent.atomic.AtomicReference)">build(AtomicReference<Repository>)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dt> +<dd> +<div class="block">Builds a repository instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#build()">build()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/ClassFileBuilder.html#build()">build()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></dt> +<dd> +<div class="block">Defines the class for this generator</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html#build()">build()</a></span> - Method in interface com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></dt> +<dd> +<div class="block">Convenience method to generate the class.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#build()">build()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#build()">build()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Converter.html#build(java.lang.Class)">build(Class<C>)</a></span> - Static method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Converter.html#buildClass(java.lang.Class)">buildClass(Class<C>)</a></span> - Static method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildDataDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, int, org.cojen.classfile.Label, org.cojen.classfile.LocalVariable)">buildDataDecoding(CodeAssembler, StorableProperty<S>[], LocalVariable, Class<?>, boolean, int, Label, LocalVariable)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Generates bytecode instructions to decode properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildDataEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, int)">buildDataEncoding(CodeAssembler, StorableProperty<S>[], LocalVariable, Class<?>, boolean, int)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Generates bytecode instructions to encode properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildKeyDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.OrderedProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, org.cojen.classfile.LocalVariable)">buildKeyDecoding(CodeAssembler, OrderedProperty<S>[], LocalVariable, Class<?>, boolean, LocalVariable)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Generates bytecode instructions to decode properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildKeyEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.OrderedProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, org.cojen.classfile.LocalVariable, org.cojen.classfile.LocalVariable)">buildKeyEncoding(CodeAssembler, OrderedProperty<S>[], LocalVariable, Class<?>, boolean, LocalVariable, LocalVariable)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Generates bytecode instructions to encode properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#buildPkIndex(java.lang.String...)">buildPkIndex(String...)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> +<div class="block">Convenient way to define the clustered primary key index + descriptor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescParser.html#buildRootAnnotation(org.cojen.classfile.TypeDesc)">buildRootAnnotation(TypeDesc)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescParser.html" title="class in com.amazon.carbonado.util">AnnotationDescParser</a></dt> +<dd> +<div class="block">Override this method if a root annotation is not provided, as it must be + built after parsing the root annotation type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildSerialDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable)">buildSerialDecoding(CodeAssembler, StorableProperty<S>[], LocalVariable)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Generates bytecode instructions to decode properties and their states.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildSerialEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[])">buildSerialEncoding(CodeAssembler, StorableProperty<S>[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Generates bytecode instructions to encode properties and their + states.</div> +</dd> +<dt><a href="../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">ByteArrayBlob</span></a> - Class in <a href="../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></dt> +<dd> +<div class="block">Implementation of a Blob which is backed by a growable in-memory byte array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/ByteArrayBlob.html#ByteArrayBlob(int)">ByteArrayBlob(int)</a></span> - Constructor for class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></dt> +<dd> +<div class="block">Construct a ByteArrayBlob with the given initial capacity.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/ByteArrayBlob.html#ByteArrayBlob(byte[])">ByteArrayBlob(byte[])</a></span> - Constructor for class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></dt> +<dd> +<div class="block">Construct a ByteArrayBlob initially backed by the given byte array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/ByteArrayBlob.html#ByteArrayBlob(byte[], int)">ByteArrayBlob(byte[], int)</a></span> - Constructor for class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></dt> +<dd> +<div class="block">Construct a ByteArrayBlob initially backed by the given byte array.</div> +</dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-1.html">Prev Letter</a></li> +<li><a href="index-3.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-2.html" target="_top">Frames</a></li> +<li><a href="index-2.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-20.html b/apidocs/index-files/index-20.html new file mode 100644 index 0000000..df53699 --- /dev/null +++ b/apidocs/index-files/index-20.html @@ -0,0 +1,611 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>T-Index (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="T-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-19.html">Prev Letter</a></li> +<li><a href="index-21.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-20.html" target="_top">Frames</a></li> +<li><a href="index-20.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_T_"> +<!-- --> +</a> +<h2 class="title">T</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#tail()">tail()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns a new ChainedProperty which contains everything that follows + this ChainedProperty's prime property.</div> +</dd> +<dt><a href="../com/amazon/carbonado/util/TaskQueueThread.html" title="class in com.amazon.carbonado.util"><span class="strong">TaskQueueThread</span></a> - Class in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block">Simple generic queue for running tasks from a single thread.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/TaskQueueThread.html#TaskQueueThread(java.lang.String, int)">TaskQueueThread(String, int)</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/TaskQueueThread.html" title="class in com.amazon.carbonado.util">TaskQueueThread</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/TaskQueueThread.html#TaskQueueThread(java.lang.String, int, long)">TaskQueueThread(String, int, long)</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/TaskQueueThread.html" title="class in com.amazon.carbonado.util">TaskQueueThread</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">TextAdapter</span></a> - Annotation Type in <a href="../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></dt> +<dd> +<div class="block">Converts database Blobs and Clobs to Strings.</div> +</dd> +<dt><a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">TextAdapter.Adapter</span></a> - Class in <a href="../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></dt> +<dd> +<div class="block">Adapter implementation for <a href="../com/amazon/carbonado/adapter/TextAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>TextAdapter</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#TextAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.TextAdapter)">TextAdapter.Adapter(Class<?>, String, TextAdapter)</a></span> - Constructor for class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TextAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#TextAdapter.Adapter(java.lang.Class, java.lang.String, java.lang.String)">TextAdapter.Adapter(Class<?>, String, String)</a></span> - Constructor for class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TextAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#TextAdapter.Adapter(java.lang.Class, java.lang.String, java.nio.charset.Charset)">TextAdapter.Adapter(Class<?>, String, Charset)</a></span> - Constructor for class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TextAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html#TextAdapter.Adapter(java.lang.Class, java.lang.String, java.nio.charset.Charset, java.nio.charset.Charset[])">TextAdapter.Adapter(Class<?>, String, Charset, Charset[])</a></span> - Constructor for class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TextAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TextAdapter.Adapter</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">TextConstraint</span></a> - Annotation Type in <a href="../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></dt> +<dd> +<div class="block">Limits the value of a property to be a member of a specific set.</div> +</dd> +<dt><a href="../com/amazon/carbonado/constraint/TextConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">TextConstraint.Constraint</span></a> - Class in <a href="../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></dt> +<dd> +<div class="block">Constraint implementation for <a href="../com/amazon/carbonado/constraint/TextConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>TextConstraint</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/TextConstraint.Constraint.html#TextConstraint.Constraint(java.lang.Class, java.lang.String, com.amazon.carbonado.constraint.TextConstraint)">TextConstraint.Constraint(Class<?>, String, TextConstraint)</a></span> - Constructor for class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/TextConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">TextConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/TextConstraint.Constraint.html#TextConstraint.Constraint(java.lang.Class, java.lang.String, java.lang.String[], java.lang.String[])">TextConstraint.Constraint(Class<?>, String, String[], String[])</a></span> - Constructor for class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/TextConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">TextConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/EmptyCursor.html#the()">the()</a></span> - Static method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor">EmptyCursor</a></dt> +<dd> +<div class="block">Returns the empty cursor instance.</div> +</dd> +<dt><a href="../com/amazon/carbonado/util/Throttle.html" title="class in com.amazon.carbonado.util"><span class="strong">Throttle</span></a> - Class in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block">General purpose class for throttling work relative to its actual measured + performance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Throttle.html#Throttle(int)">Throttle(int)</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Throttle.html" title="class in com.amazon.carbonado.util">Throttle</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Throttle.html#throttle(double, long)">throttle(double, long)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Throttle.html" title="class in com.amazon.carbonado.util">Throttle</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">ThrottledCursor</span></a><<a href="../com/amazon/carbonado/cursor/ThrottledCursor.html" title="type parameter in ThrottledCursor">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Wraps another cursor and fetches results at a reduced speed.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/ThrottledCursor.html#ThrottledCursor(com.amazon.carbonado.Cursor, double)">ThrottledCursor(Cursor<S>, double)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor">ThrottledCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#throwConcatException(org.cojen.classfile.CodeBuilder, java.lang.Class, java.lang.String...)">throwConcatException(CodeBuilder, Class, String...)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Generate code to throw an exception with a message concatenated at runtime.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#throwException(org.cojen.classfile.CodeBuilder, java.lang.Class, java.lang.String)">throwException(CodeBuilder, Class, String)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Generate code to throw an exception with an optional message.</div> +</dd> +<dt><a href="../com/amazon/carbonado/util/ThrowUnchecked.html" title="class in com.amazon.carbonado.util"><span class="strong">ThrowUnchecked</span></a> - Class in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>use <code>ThrowUnchecked</code> instead</i></div> +</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/ThrowUnchecked.html#ThrowUnchecked()">ThrowUnchecked()</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/ThrowUnchecked.html" title="class in com.amazon.carbonado.util">ThrowUnchecked</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#timedOutNotification(long)">timedOutNotification(long)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi">BelatedRepositoryCreator</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/BelatedStorageCreator.html#timedOutNotification(long)">timedOutNotification(long)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi">BelatedStorageCreator</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/BelatedCreator.html#timedOutNotification(long)">timedOutNotification(long)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a></dt> +<dd> +<div class="block">Notification that createReal is taking too long.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableCopier.From.html#to(java.lang.Class)">to(Class<T>)</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableCopier.From.html" title="class in com.amazon.carbonado.gen">StorableCopier.From</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#TO_STRING_KEY_ONLY_METHOD_NAME">TO_STRING_KEY_ONLY_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#TO_STRING_METHOD_NAME">TO_STRING_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/Direction.html#toCharacter()">toCharacter()</a></span> - Method in enum com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></dt> +<dd> +<div class="block">Returns '+' for ASCENDING, '-' for DESCENDING, and '~' for UNSPECIFIED.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#toFetchException(java.lang.Throwable)">toFetchException(Throwable)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></dt> +<dd> +<div class="block">Transforms the given throwable into an appropriate fetch exception.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryException.html#toFetchException()">toFetchException()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></dt> +<dd> +<div class="block">Converts RepositoryException into an appropriate FetchException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryException.html#toFetchException(java.lang.String)">toFetchException(String)</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></dt> +<dd> +<div class="block">Converts RepositoryException into an appropriate FetchException, prepending + the specified message.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/ExceptionTransformer.html#toFetchException(java.lang.Throwable)">toFetchException(Throwable)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></dt> +<dd> +<div class="block">Transforms the given throwable into an appropriate fetch exception.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toFirst()">toFirst()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the first available entry.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toFirst(byte[])">toFirst(byte[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the first available entry at or after the given + key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toLast()">toLast()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the last available entry.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toLast(byte[])">toLast(byte[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the last available entry at or before the given + key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/AbstractCursor.html#toList()">toList()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/AbstractCursor.html#toList(int)">toList(int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/EmptyCursor.html#toList()">toList()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor">EmptyCursor</a></dt> +<dd> +<div class="block">Always returns an empty list.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/EmptyCursor.html#toList(int)">toList(int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor">EmptyCursor</a></dt> +<dd> +<div class="block">Always returns an empty list.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SingletonCursor.html#toList()">toList()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor">SingletonCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SingletonCursor.html#toList(int)">toList(int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor">SingletonCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Cursor.html#toList()">toList()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></dt> +<dd> +<div class="block">Copies all remaining next elements into a new modifiable list.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Cursor.html#toList(int)">toList(int)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></dt> +<dd> +<div class="block">Copies a limited amount of remaining next elements into a new modifiable + list.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toNext()">toNext()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the next available entry, returning false if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toNext(int)">toNext(int)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the next available entry, incrementing by the amount + given.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toNextKey()">toNextKey()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the next unique key, returning false if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#toPersistException(java.lang.Throwable)">toPersistException(Throwable)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></dt> +<dd> +<div class="block">Transforms the given throwable into an appropriate persist exception.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryException.html#toPersistException()">toPersistException()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></dt> +<dd> +<div class="block">Converts RepositoryException into an appropriate PersistException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryException.html#toPersistException(java.lang.String)">toPersistException(String)</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></dt> +<dd> +<div class="block">Converts RepositoryException into an appropriate PersistException, prepending + the specified message.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/ExceptionTransformer.html#toPersistException(java.lang.Throwable)">toPersistException(Throwable)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></dt> +<dd> +<div class="block">Transforms the given throwable into an appropriate persist exception.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toPrevious()">toPrevious()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the previous available entry, returning false if + none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toPrevious(int)">toPrevious(int)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the previous available entry, decrementing by the + amount given.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#toPreviousKey()">toPreviousKey()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Move the cursor to the previous unique key, returning false if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/ExceptionTransformer.html#toRepositoryException(java.lang.Throwable)">toRepositoryException(Throwable)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></dt> +<dd> +<div class="block">Transforms the given throwable into an appropriate repository + exception.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.NotJoined.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns the string value of this filter, which is also parsable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns the string value of the filter with any values substituted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/RelOp.html#toString()">toString()</a></span> - Method in enum com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a></dt> +<dd> +<div class="block">Returns one of "=", "!=", "<", ">=", ">", or "<=".</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns the chained property formatted as "name.subname.subsubname".</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/OrderedProperty.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></dt> +<dd> +<div class="block">Returns the chained property in a parseable form.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#toString()">toString()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractBlob.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractClob.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> +<div class="block">Implementation calls appendTo.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/CompositeScore.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryHints.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Timeout.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#toString()">toString()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a description of the query filter and any other arguments.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/IndexInfoImpl.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#toString()">toString()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Returns a string for debugging purposes that contains all supported + property names and values for this object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/SoftValuedCache.html#toString()">toString()</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#toStringKeyOnly()">toStringKeyOnly()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Returns a string for debugging purposes that contains supported key + property names and values for this object.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado"><span class="strong">Transaction</span></a> - Interface in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Transactions define atomic operations which can be committed or aborted as a + unit.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#transactionManager()">transactionManager()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> +<div class="block">Returns the repository's TransactionManager.</div> +</dd> +<dt><a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn"><span class="strong">TransactionManager</span></a><<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="type parameter in TransactionManager">Txn</a>> - Class in <a href="../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></dt> +<dd> +<div class="block">Generic transaction manager for repositories.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionManager.html#TransactionManager()">TransactionManager()</a></span> - Constructor for class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionManager.html#TransactionManager(com.amazon.carbonado.txn.TransactionMonitor)">TransactionManager(TransactionMonitor)</a></span> - Constructor for class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn"><span class="strong">TransactionMonitor</span></a> - Interface in <a href="../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></dt> +<dd> +<div class="block">Is notified as transactions enter and exit.</div> +</dd> +<dt><a href="../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn"><span class="strong">TransactionPair</span></a> - Class in <a href="../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></dt> +<dd> +<div class="block">Pairs two transaction together into one.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionPair.html#TransactionPair(com.amazon.carbonado.Transaction, com.amazon.carbonado.Transaction)">TransactionPair(Transaction, Transaction)</a></span> - Constructor for class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn">TransactionPair</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn"><span class="strong">TransactionScope</span></a><<a href="../com/amazon/carbonado/txn/TransactionScope.html" title="type parameter in TransactionScope">Txn</a>> - Class in <a href="../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a></dt> +<dd> +<div class="block">Container of thread local, scoped transactions.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MultiTransformedCursor.html#transform(S)">transform(S)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor">MultiTransformedCursor</a></dt> +<dd> +<div class="block">This method must be implemented to transform storables.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/TransformedCursor.html#transform(S)">transform(S)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor">TransformedCursor</a></dt> +<dd> +<div class="block">This method must be implemented to transform storables.</div> +</dd> +<dt><a href="../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">TransformedCursor</span></a><<a href="../com/amazon/carbonado/cursor/TransformedCursor.html" title="type parameter in TransformedCursor">S</a>,<a href="../com/amazon/carbonado/cursor/TransformedCursor.html" title="type parameter in TransformedCursor">T</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Abstract cursor which wraps another cursor and transforms each storable + result into a target storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/TransformedCursor.html#TransformedCursor(com.amazon.carbonado.Cursor)">TransformedCursor(Cursor<S>)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor">TransformedCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/ExceptionTransformer.html#transformIntoFetchException(java.lang.Throwable)">transformIntoFetchException(Throwable)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></dt> +<dd> +<div class="block">Override to support custom transformations, returning null if none is + applicable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/ExceptionTransformer.html#transformIntoPersistException(java.lang.Throwable)">transformIntoPersistException(Throwable)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></dt> +<dd> +<div class="block">Override to support custom transformations, returning null if none is + applicable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/ExceptionTransformer.html#transformIntoRepositoryException(java.lang.Throwable)">transformIntoRepositoryException(Throwable)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></dt> +<dd> +<div class="block">Override to support custom transformations, returning null if none is + applicable.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado"><span class="strong">Trigger</span></a><<a href="../com/amazon/carbonado/Trigger.html" title="type parameter in Trigger">S</a>> - Class in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Callback mechanism to allow custom code to run when a storable is + persisted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#Trigger()">Trigger()</a></span> - Constructor for class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado"><span class="strong">Trigger.Abort</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado"><span class="strong">TriggerFactory</span></a> - Interface in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Can be used with <a href="../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado"><code>RepositoryBuilder</code></a> to automatically register + triggers as Storable types become available.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/TriggerFactory.html#triggerFor(java.lang.Class)">triggerFor(Class<S>)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/TriggerFactory.html" title="interface in com.amazon.carbonado">TriggerFactory</a></dt> +<dd> +<div class="block">Return an appropriate trigger for the given type, or null if none.</div> +</dd> +<dt><a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><span class="strong">TriggerManager</span></a><<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="type parameter in TriggerManager">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></dt> +<dd> +<div class="block">Used by Storage implementations to manage triggers and consolidate them into + single logical triggers.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#TriggerManager()">TriggerManager()</a></span> - Constructor for class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#TriggerManager(java.lang.Class, java.lang.Iterable)">TriggerManager(Class<S>, Iterable<TriggerFactory>)</a></span> - Constructor for class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi"><span class="strong">TriggerManagerCapability</span></a> - Interface in <a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></dt> +<dd> +<div class="block">Provides the capability to get the <a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><code>TriggerManager</code></a> from a <a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>.</div> +</dd> +<dt><a href="../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">TriggerSupport</span></a><<a href="../com/amazon/carbonado/gen/TriggerSupport.html" title="type parameter in TriggerSupport">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></dt> +<dd> +<div class="block">Provides runtime support for Storable classes generated by <a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>StorableGenerator</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#trim()">trim()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns a new ChainedProperty with the last property in the chain removed.</div> +</dd> +<dt><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">TrueFalseAdapter</span></a> - Annotation Type in <a href="../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></dt> +<dd> +<div class="block">Adapter that converts 'T' or 'F' to and from a boolean value.</div> +</dd> +<dt><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">TrueFalseAdapter.Adapter</span></a> - Class in <a href="../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></dt> +<dd> +<div class="block">Adapter implementation for <a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>TrueFalseAdapter</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#TrueFalseAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.TrueFalseAdapter)">TrueFalseAdapter.Adapter(Class<?>, String, TrueFalseAdapter)</a></span> - Constructor for class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TrueFalseAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html#TrueFalseAdapter.Adapter(java.lang.Class, java.lang.String, boolean)">TrueFalseAdapter.Adapter(Class<?>, String, boolean)</a></span> - Constructor for class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/TrueFalseAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">TrueFalseAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storage.html#truncate()">truncate()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></dt> +<dd> +<div class="block">Attempts to quickly delete all Storables instances in this + Storage.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#TRY_DELETE_METHOD_NAME">TRY_DELETE_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#TRY_INSERT_METHOD_NAME">TRY_INSERT_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#TRY_LOAD_METHOD_NAME">TRY_LOAD_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#TRY_LOAD_ONE_METHOD_NAME">TRY_LOAD_ONE_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Query API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#TRY_UPDATE_METHOD_NAME">TRY_UPDATE_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawSupport.html#tryDelete(S, byte[])">tryDelete(S, byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></dt> +<dd> +<div class="block">Try to delete the entry referenced by the given key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#tryDelete()">tryDelete()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Deletes this object from the storage layer by its primary key, + regardless of whether this object has actually been loaded or not.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#tryDeleteOne()">tryDeleteOne()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne(Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#tryDeleteOne()">tryDeleteOne()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne(Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#tryDeleteOne()">tryDeleteOne()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Deletes zero or one matching objects.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#tryDeleteOne(com.amazon.carbonado.Query.Controller)">tryDeleteOne(Query.Controller)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Deletes zero or one matching objects.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawSupport.html#tryInsert(S, byte[], byte[])">tryInsert(S, byte[], byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></dt> +<dd> +<div class="block">Try to insert the entry referenced by the given key with the given + value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#tryInsert()">tryInsert()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Inserts a new persistent value for this object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawSupport.html#tryLoad(S, byte[])">tryLoad(S, byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></dt> +<dd> +<div class="block">Try to load the entry referenced by the given key, but return null + if not found.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#tryLoad()">tryLoad()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Loads or reloads this object from the storage layer by a primary or + alternate key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#tryLoadOne()">tryLoadOne()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#tryLoadOne(com.amazon.carbonado.Query.Controller)">tryLoadOne(Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#tryLoadOne()">tryLoadOne()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Tries to load one record, but returns null if nothing was found.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#tryLoadOne(com.amazon.carbonado.Query.Controller)">tryLoadOne(Query.Controller)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Tries to load one record, but returns null if nothing was found.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#tryUpdate()">tryUpdate()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Updates the persistent value of this object, regardless of whether this + object has actually been loaded or not.</div> +</dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-19.html">Prev Letter</a></li> +<li><a href="index-21.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-20.html" target="_top">Frames</a></li> +<li><a href="index-20.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-21.html b/apidocs/index-files/index-21.html new file mode 100644 index 0000000..819d2b1 --- /dev/null +++ b/apidocs/index-files/index-21.html @@ -0,0 +1,238 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>U-Index (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="U-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-20.html">Prev Letter</a></li> +<li><a href="index-22.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-21.html" target="_top">Frames</a></li> +<li><a href="index-21.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_U_"> +<!-- --> +</a> +<h2 class="title">U</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/AndFilter.html#unbind()">unbind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#unbind()">unbind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ExistsFilter.html#unbind()">unbind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#unbind()">unbind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Undoes the effect of a bind operation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#unbind()">unbind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OrFilter.html#unbind()">unbind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#unbind()">unbind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#uneraseGenericParameter(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc, int)">uneraseGenericParameter(CodeBuilder, TypeDesc, int)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Generate code to create a local variable containing the specified parameter coerced + to the specified type.</div> +</dd> +<dt><a href="../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Unevolvable</span></a> - Interface in <a href="../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></dt> +<dd> +<div class="block">Marker interface for storables that are not allowed to evolve.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Unindexed</span></a> - Interface in <a href="../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></dt> +<dd> +<div class="block">Marker interface for storables that are not allowed to have indexes.</div> +</dd> +<dt><a href="../com/amazon/carbonado/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">UnionCursor</span></a><<a href="../com/amazon/carbonado/cursor/UnionCursor.html" title="type parameter in UnionCursor">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Wraps two Cursors and performs a <i>set union</i> operation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/UnionCursor.html#UnionCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)">UnionCursor(Cursor<S>, Cursor<S>, Comparator<S>)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor">UnionCursor</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">UnionQueryAnalyzer</span></a><<a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Analyzes a query specification and determines how it can be executed as a + union of smaller queries.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#UnionQueryAnalyzer(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)">UnionQueryAnalyzer(Class<S>, RepositoryAccess)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">UnionQueryAnalyzer.Result</span></a> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">UnionQueryExecutor</span></a><<a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">QueryExecutor which wraps several others and unions the results.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html#UnionQueryExecutor(com.amazon.carbonado.qe.QueryExecutor...)">UnionQueryExecutor(QueryExecutor<S>...)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html#UnionQueryExecutor(java.util.List)">UnionQueryExecutor(List<QueryExecutor<S>>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html#UnionQueryExecutor(java.util.List, com.amazon.carbonado.qe.OrderingList)">UnionQueryExecutor(List<QueryExecutor<S>>, OrderingList<S>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#unique(boolean)">unique(boolean)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns a StorableIndex instance which is unique or not.</div> +</dd> +<dt><a href="../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado"><span class="strong">UniqueConstraintException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">A UniqueConstraintException is thrown if the <a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> storage + layer has a unique constraint check defined for a property, and a violation + has been detected.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/UniqueConstraintException.html#UniqueConstraintException()">UniqueConstraintException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado">UniqueConstraintException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/UniqueConstraintException.html#UniqueConstraintException(java.lang.String)">UniqueConstraintException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado">UniqueConstraintException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/UniqueConstraintException.html#UniqueConstraintException(java.lang.String, java.lang.Throwable)">UniqueConstraintException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado">UniqueConstraintException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/UniqueConstraintException.html#UniqueConstraintException(java.lang.Throwable)">UniqueConstraintException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado">UniqueConstraintException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#uniquify(com.amazon.carbonado.info.StorableKey)">uniquify(StorableKey<S>)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns a StorableIndex which is unique, possibly by appending + properties from the given key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorableIndexSet.html#uniquify(com.amazon.carbonado.info.StorableInfo)">uniquify(StorableInfo<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></dt> +<dd> +<div class="block">Augment non-unique indexes with primary key properties, thus making them + unique.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorableIndexSet.html#uniquify(com.amazon.carbonado.info.StorableKey)">uniquify(StorableKey<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></dt> +<dd> +<div class="block">Augment non-unique indexes with key properties, thus making them unique.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#unlockoutShutdown()">unlockoutShutdown()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> +<div class="block">Only call this to release lockoutShutdown.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionScope.html#unregister(java.lang.Class, com.amazon.carbonado.Cursor)">unregister(Class<S>, Cursor<S>)</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a></dt> +<dd> +<div class="block">Unregisters a previously registered cursor.</div> +</dd> +<dt><a href="../com/amazon/carbonado/UnsupportedTypeException.html" title="class in com.amazon.carbonado"><span class="strong">UnsupportedTypeException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Thrown by a <a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> which cannot support a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> which + is declared as <a href="../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>Independent</code></a> or <a href="../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado"><code>Authoritative</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/UnsupportedTypeException.html#UnsupportedTypeException(java.lang.String, java.lang.Class)">UnsupportedTypeException(String, Class<? extends Storable>)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/UnsupportedTypeException.html" title="class in com.amazon.carbonado">UnsupportedTypeException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#unwrap(java.lang.Class)">unwrap(Class<T>)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#unwrap(java.lang.Class)">unwrap(Class<T>)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#update()">update()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Updates the persistent value of this object, regardless of whether this + object has actually been loaded or not.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#UPDATE_METHOD_NAME">UPDATE_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#updateBlob(com.amazon.carbonado.lob.Blob, com.amazon.carbonado.lob.Blob)">updateBlob(Blob, Blob)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#updateClob(com.amazon.carbonado.lob.Clob, com.amazon.carbonado.lob.Clob)">updateClob(Clob, Clob)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a></dt> +<dd> </dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-20.html">Prev Letter</a></li> +<li><a href="index-22.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-21.html" target="_top">Frames</a></li> +<li><a href="index-21.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-22.html b/apidocs/index-files/index-22.html new file mode 100644 index 0000000..9a2bad7 --- /dev/null +++ b/apidocs/index-files/index-22.html @@ -0,0 +1,481 @@ +<!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>V-Index (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="V-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-21.html">Prev Letter</a></li> +<li><a href="index-23.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-22.html" target="_top">Frames</a></li> +<li><a href="index-22.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_V_"> +<!-- --> +</a> +<h2 class="title">V</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/RelOp.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a></dt> +<dd> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/MasterFeature.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a></dt> +<dd> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/Direction.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></dt> +<dd> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/IsolationLevel.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum com.amazon.carbonado.<a href="../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></dt> +<dd> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/BoundaryType.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a></dt> +<dd> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryHint.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a></dt> +<dd> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CompressionType.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a></dt> +<dd> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBProduct.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a></dt> +<dd> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/RelOp.html#values()">values()</a></span> - Static method in enum com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/RelOp.html" title="enum in com.amazon.carbonado.filter">RelOp</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/MasterFeature.html#values()">values()</a></span> - Static method in enum com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/MasterFeature.html" title="enum in com.amazon.carbonado.gen">MasterFeature</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorablePropertyMap.html#values()">values()</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/Direction.html#values()">values()</a></span> - Static method in enum com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/IsolationLevel.html#values()">values()</a></span> - Static method in enum com.amazon.carbonado.<a href="../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/BoundaryType.html#values()">values()</a></span> - Static method in enum com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryHint.html#values()">values()</a></span> - Static method in enum com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryHint.html" title="enum in com.amazon.carbonado.qe">QueryHint</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CompressionType.html#values()">values()</a></span> - Static method in enum com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBProduct.html#values()">values()</a></span> - Static method in enum com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a></dt> +<dd> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AbstractPool.html#values()">values()</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a></dt> +<dd> +<div class="block">Returns the pool values, which may be concurrently modified.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#verify(java.io.PrintStream)">verify(PrintStream)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Opens the BDB environment, checks if it is corrupt, and then closes it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutFactory.html#VERSION">VERSION</a></span> - Static variable in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutFactory.html" title="class in com.amazon.carbonado.layout">LayoutFactory</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><span class="strong">Version</span></a> - Annotation Type in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Designates a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property as being the authoritative version + number for the entire Storable instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Visitor.html#visit(com.amazon.carbonado.filter.OrFilter, P)">visit(OrFilter<S>, P)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Visitor.html#visit(com.amazon.carbonado.filter.AndFilter, P)">visit(AndFilter<S>, P)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Visitor.html#visit(com.amazon.carbonado.filter.PropertyFilter, P)">visit(PropertyFilter<S>, P)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Visitor.html#visit(com.amazon.carbonado.filter.ExistsFilter, P)">visit(ExistsFilter<S>, P)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Visitor.html#visit(com.amazon.carbonado.filter.OpenFilter, P)">visit(OpenFilter<S>, P)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Visitor.html#visit(com.amazon.carbonado.filter.ClosedFilter, P)">visit(ClosedFilter<S>, P)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, java.lang.annotation.Annotation, org.cojen.classfile.attribute.Annotation)">visit(String, int, Annotation, Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, int, org.cojen.classfile.attribute.Annotation)">visit(String, int, int, Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, long, org.cojen.classfile.attribute.Annotation)">visit(String, int, long, Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, float, org.cojen.classfile.attribute.Annotation)">visit(String, int, float, Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, double, org.cojen.classfile.attribute.Annotation)">visit(String, int, double, Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, boolean, org.cojen.classfile.attribute.Annotation)">visit(String, int, boolean, Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, byte, org.cojen.classfile.attribute.Annotation)">visit(String, int, byte, Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, short, org.cojen.classfile.attribute.Annotation)">visit(String, int, short, Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, char, org.cojen.classfile.attribute.Annotation)">visit(String, int, char, Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, java.lang.String, org.cojen.classfile.attribute.Annotation)">visit(String, int, String, Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, java.lang.Class, org.cojen.classfile.attribute.Annotation)">visit(String, int, Class, Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, java.lang.Enum, org.cojen.classfile.attribute.Annotation)">visit(String, int, Enum, Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, java.lang.annotation.Annotation[], org.cojen.classfile.attribute.Annotation)">visit(String, int, Annotation[], Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, int[], org.cojen.classfile.attribute.Annotation)">visit(String, int, int[], Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, long[], org.cojen.classfile.attribute.Annotation)">visit(String, int, long[], Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, float[], org.cojen.classfile.attribute.Annotation)">visit(String, int, float[], Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, double[], org.cojen.classfile.attribute.Annotation)">visit(String, int, double[], Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, boolean[], org.cojen.classfile.attribute.Annotation)">visit(String, int, boolean[], Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, byte[], org.cojen.classfile.attribute.Annotation)">visit(String, int, byte[], Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, short[], org.cojen.classfile.attribute.Annotation)">visit(String, int, short[], Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, char[], org.cojen.classfile.attribute.Annotation)">visit(String, int, char[], Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, java.lang.String[], org.cojen.classfile.attribute.Annotation)">visit(String, int, String[], Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, java.lang.Class[], org.cojen.classfile.attribute.Annotation)">visit(String, int, Class[], Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationBuilder.html#visit(java.lang.String, int, java.lang.Enum[], org.cojen.classfile.attribute.Annotation)">visit(String, int, Enum[], Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationBuilder.html" title="class in com.amazon.carbonado.util">AnnotationBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.annotation.Annotation)">visit(Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> +<div class="block">Prints the annotation to the builder passed to the constructor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, java.lang.annotation.Annotation, java.lang.Object)">visit(String, int, Annotation, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, int, java.lang.Object)">visit(String, int, int, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, long, java.lang.Object)">visit(String, int, long, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, float, java.lang.Object)">visit(String, int, float, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, double, java.lang.Object)">visit(String, int, double, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, boolean, java.lang.Object)">visit(String, int, boolean, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, byte, java.lang.Object)">visit(String, int, byte, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, short, java.lang.Object)">visit(String, int, short, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, char, java.lang.Object)">visit(String, int, char, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, java.lang.String, java.lang.Object)">visit(String, int, String, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, java.lang.Class, java.lang.Object)">visit(String, int, Class, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, java.lang.Enum, java.lang.Object)">visit(String, int, Enum, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, java.lang.annotation.Annotation[], java.lang.Object)">visit(String, int, Annotation[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, int[], java.lang.Object)">visit(String, int, int[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, long[], java.lang.Object)">visit(String, int, long[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, float[], java.lang.Object)">visit(String, int, float[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, double[], java.lang.Object)">visit(String, int, double[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, boolean[], java.lang.Object)">visit(String, int, boolean[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, byte[], java.lang.Object)">visit(String, int, byte[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, short[], java.lang.Object)">visit(String, int, short[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, char[], java.lang.Object)">visit(String, int, char[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, java.lang.String[], java.lang.Object)">visit(String, int, String[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, java.lang.Class[], java.lang.Object)">visit(String, int, Class[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html#visit(java.lang.String, int, java.lang.Enum[], java.lang.Object)">visit(String, int, Enum[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationDescPrinter.html" title="class in com.amazon.carbonado.util">AnnotationDescPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.annotation.Annotation)">visit(Annotation)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> +<div class="block">Prints the annotation to the builder passed to the constructor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, java.lang.annotation.Annotation, java.lang.Object)">visit(String, int, Annotation, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, int, java.lang.Object)">visit(String, int, int, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, long, java.lang.Object)">visit(String, int, long, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, float, java.lang.Object)">visit(String, int, float, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, double, java.lang.Object)">visit(String, int, double, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, boolean, java.lang.Object)">visit(String, int, boolean, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, byte, java.lang.Object)">visit(String, int, byte, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, short, java.lang.Object)">visit(String, int, short, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, char, java.lang.Object)">visit(String, int, char, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, java.lang.String, java.lang.Object)">visit(String, int, String, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, java.lang.Class, java.lang.Object)">visit(String, int, Class, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, java.lang.Enum, java.lang.Object)">visit(String, int, Enum, Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, java.lang.annotation.Annotation[], java.lang.Object)">visit(String, int, Annotation[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, int[], java.lang.Object)">visit(String, int, int[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, long[], java.lang.Object)">visit(String, int, long[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, float[], java.lang.Object)">visit(String, int, float[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, double[], java.lang.Object)">visit(String, int, double[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, boolean[], java.lang.Object)">visit(String, int, boolean[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, byte[], java.lang.Object)">visit(String, int, byte[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, short[], java.lang.Object)">visit(String, int, short[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, char[], java.lang.Object)">visit(String, int, char[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, java.lang.String[], java.lang.Object)">visit(String, int, String[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, java.lang.Class[], java.lang.Object)">visit(String, int, Class[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationPrinter.html#visit(java.lang.String, int, java.lang.Enum[], java.lang.Object)">visit(String, int, Enum[], Object)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationPrinter.html" title="class in com.amazon.carbonado.util">AnnotationPrinter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.annotation.Annotation, P)">visit(Annotation, P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Visits an annotation by breaking it down into its components and calling + various other visit methods.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.annotation.Annotation, P)">visit(String, int, Annotation, P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Visits an annotation by breaking it down into its components and calling + various other visit methods.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, int, P)">visit(String, int, int, P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Override to visit ints.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, long, P)">visit(String, int, long, P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Override to visit longs.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, float, P)">visit(String, int, float, P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Override to visit floats.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, double, P)">visit(String, int, double, P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Override to visit doubles.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, boolean, P)">visit(String, int, boolean, P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Override to visit booleans.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, byte, P)">visit(String, int, byte, P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Override to visit bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, short, P)">visit(String, int, short, P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Override to visit shorts.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, char, P)">visit(String, int, char, P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Override to visit chars.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.String, P)">visit(String, int, String, P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Override to visit Strings.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Class, P)">visit(String, int, Class, P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Override to visit Classes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Enum, P)">visit(String, int, Enum, P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Override to visit Enums.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.annotation.Annotation[], P)">visit(String, int, Annotation[], P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Visits each array element.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, int[], P)">visit(String, int, int[], P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Visits each array element.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, long[], P)">visit(String, int, long[], P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Visits each array element.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, float[], P)">visit(String, int, float[], P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Visits each array element.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, double[], P)">visit(String, int, double[], P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Visits each array element.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, boolean[], P)">visit(String, int, boolean[], P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Visits each array element.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, byte[], P)">visit(String, int, byte[], P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Visits each array element.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, short[], P)">visit(String, int, short[], P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Visits each array element.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, char[], P)">visit(String, int, char[], P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Visits each array element.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.String[], P)">visit(String, int, String[], P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Visits each array element.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Class[], P)">visit(String, int, Class[], P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Visits each array element.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AnnotationVisitor.html#visit(java.lang.String, int, java.lang.Enum[], P)">visit(String, int, Enum[], P)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AnnotationVisitor.html" title="class in com.amazon.carbonado.util">AnnotationVisitor</a></dt> +<dd> +<div class="block">Visits each array element.</div> +</dd> +<dt><a href="../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter"><span class="strong">Visitor</span></a><<a href="../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>,<a href="../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">R</a>,<a href="../com/amazon/carbonado/filter/Visitor.html" title="type parameter in Visitor">P</a>> - Class in <a href="../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></dt> +<dd> +<div class="block">Traverses a filter tree in its canonical order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Visitor.html#Visitor()">Visitor()</a></span> - Constructor for class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Visitor.html" title="class in com.amazon.carbonado.filter">Visitor</a></dt> +<dd> </dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-21.html">Prev Letter</a></li> +<li><a href="index-23.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-22.html" target="_top">Frames</a></li> +<li><a href="index-22.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-23.html b/apidocs/index-files/index-23.html new file mode 100644 index 0000000..605cb9a --- /dev/null +++ b/apidocs/index-files/index-23.html @@ -0,0 +1,338 @@ +<!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>W-Index (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="W-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-22.html">Prev Letter</a></li> +<li><a href="index-24.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-23.html" target="_top">Frames</a></li> +<li><a href="index-23.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_W_"> +<!-- --> +</a> +<h2 class="title">W</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/RepairExecutor.html#waitForRepairsToFinish(long)">waitForRepairsToFinish(long)</a></span> - Static method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/RepairExecutor.html" title="class in com.amazon.carbonado.spi">RepairExecutor</a></dt> +<dd> +<div class="block">Waits for repairs that were executed from the current thread to finish.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#with(int)">with(int)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#with(long)">with(long)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#with(float)">with(float)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#with(double)">with(double)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#with(boolean)">with(boolean)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#with(char)">with(char)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#with(byte)">with(byte)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#with(short)">with(short)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#with(java.lang.Object)">with(Object)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns a new FilterValues instance with the next blank parameter filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#with(int)">with(int)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always throws an IllegalStateException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#with(long)">with(long)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always throws an IllegalStateException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#with(float)">with(float)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always throws an IllegalStateException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#with(double)">with(double)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always throws an IllegalStateException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#with(boolean)">with(boolean)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always throws an IllegalStateException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#with(char)">with(char)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always throws an IllegalStateException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#with(byte)">with(byte)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always throws an IllegalStateException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#with(short)">with(short)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always throws an IllegalStateException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#with(java.lang.Object)">with(Object)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always throws an IllegalStateException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryHints.html#with(com.amazon.carbonado.qe.QueryHint)">with(QueryHint)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></dt> +<dd> +<div class="block">Returns a new QueryHints object with the given hint.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryHints.html#with(com.amazon.carbonado.qe.QueryHint, java.lang.Object)">with(QueryHint, Object)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></dt> +<dd> +<div class="block">Returns a new QueryHints object with the given hint and value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#with(int)">with(int)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#with(long)">with(long)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#with(float)">with(float)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#with(double)">with(double)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#with(boolean)">with(boolean)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#with(char)">with(char)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#with(byte)">with(byte)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#with(short)">with(short)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#with(java.lang.Object)">with(Object)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#with(int)">with(int)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#with(long)">with(long)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#with(float)">with(float)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#with(double)">with(double)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#with(boolean)">with(boolean)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#with(char)">with(char)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#with(byte)">with(byte)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#with(short)">with(short)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#with(java.lang.Object)">with(Object)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a copy of this Query with the next blank parameter filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#WITH_METHOD_NAME">WITH_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Query API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryHints.html#without(com.amazon.carbonado.qe.QueryHint)">without(QueryHint)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></dt> +<dd> +<div class="block">Returns a new QueryHints object without the given hint.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/CompositeScore.html#withRemainderFilter(com.amazon.carbonado.filter.Filter)">withRemainderFilter(Filter<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></dt> +<dd> +<div class="block">Returns a new CompositeScore with the filtering remainder replaced and + covering matches recalculated.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#withRemainderFilter(com.amazon.carbonado.filter.Filter)">withRemainderFilter(Filter<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns a new FilteringScore with the remainder replaced and covering + matches recalculated.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#withRemainderFilter(com.amazon.carbonado.filter.Filter)">withRemainderFilter(Filter<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns a new result with the remainder filter replaced.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/CompositeScore.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering(OrderingList<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></dt> +<dd> +<div class="block">Returns a new CompositeScore with the ordering remainder + replaced.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering(OrderingList<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns a new result with the remainder ordering replaced.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#withRemainderOrdering(com.amazon.carbonado.qe.OrderingList)">withRemainderOrdering(OrderingList<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns a new OrderingScore with the remainder replaced.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.Abort.html#withStackTrace()">withStackTrace()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a></dt> +<dd> +<div class="block">Returns this exception but with a fresh stack trace.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#withValues(java.lang.Object...)">withValues(Object...)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns a new FilterValues instance with the next blank parameters filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#withValues(java.lang.Object...)">withValues(Object...)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Throws an IllegalStateException unless no values passed in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#withValues(java.lang.Object...)">withValues(Object...)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#withValues(java.lang.Object...)">withValues(Object...)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a copy of this Query with the next blank parameters filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/CommonsLog.html#write(java.lang.String)">write(String)</a></span> - Method in class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/CommonsLog.html" title="class in com.amazon.carbonado.repo.logging">CommonsLog</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/Log.html#write(java.lang.String)">write(String)</a></span> - Method in interface com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/RAFOutputStream.html#write(int)">write(int)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/RAFOutputStream.html" title="class in com.amazon.carbonado.spi">RAFOutputStream</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/RAFOutputStream.html#write(byte[])">write(byte[])</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/RAFOutputStream.html" title="class in com.amazon.carbonado.spi">RAFOutputStream</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/RAFOutputStream.html#write(byte[], int, int)">write(byte[], int, int)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/RAFOutputStream.html" title="class in com.amazon.carbonado.spi">RAFOutputStream</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#WRITE_TO">WRITE_TO</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#writeLength(int, java.io.OutputStream)">writeLength(int, OutputStream)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Writes a positive length value in up to five bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#writeTo(java.io.OutputStream)">writeTo(OutputStream)</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Write a layout to be read by <a href="../com/amazon/carbonado/layout/LayoutFactory.html#readLayoutFrom(java.io.InputStream)"><code>LayoutFactory.readLayoutFrom(java.io.InputStream)</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#writeTo(java.io.OutputStream)">writeTo(OutputStream)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Serializes property values and states for temporary storage or for + network transfer.</div> +</dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-22.html">Prev Letter</a></li> +<li><a href="index-24.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-23.html" target="_top">Frames</a></li> +<li><a href="index-23.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-24.html b/apidocs/index-files/index-24.html new file mode 100644 index 0000000..6f6ebd5 --- /dev/null +++ b/apidocs/index-files/index-24.html @@ -0,0 +1,136 @@ +<!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>Y-Index (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="Y-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-23.html">Prev Letter</a></li> +<li>Next Letter</li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-24.html" target="_top">Frames</a></li> +<li><a href="index-24.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_Y_"> +<!-- --> +</a> +<h2 class="title">Y</h2> +<dl> +<dt><a href="../com/amazon/carbonado/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">YesNoAdapter</span></a> - Annotation Type in <a href="../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></dt> +<dd> +<div class="block">Adapter that converts 'Y' or 'N' to and from a boolean value.</div> +</dd> +<dt><a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">YesNoAdapter.Adapter</span></a> - Class in <a href="../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></dt> +<dd> +<div class="block">Adapter implementation for <a href="../com/amazon/carbonado/adapter/YesNoAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>YesNoAdapter</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#YesNoAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.YesNoAdapter)">YesNoAdapter.Adapter(Class<?>, String, YesNoAdapter)</a></span> - Constructor for class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">YesNoAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html#YesNoAdapter.Adapter(java.lang.Class, java.lang.String, boolean)">YesNoAdapter.Adapter(Class<?>, String, boolean)</a></span> - Constructor for class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/YesNoAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">YesNoAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#yieldConnection(java.sql.Connection)">yieldConnection(Connection)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></dt> +<dd> +<div class="block">Gives up a connection returned from getConnection.</div> +</dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-23.html">Prev Letter</a></li> +<li>Next Letter</li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-24.html" target="_top">Frames</a></li> +<li><a href="index-24.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-3.html b/apidocs/index-files/index-3.html new file mode 100644 index 0000000..6ec67f3 --- /dev/null +++ b/apidocs/index-files/index-3.html @@ -0,0 +1,1109 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>C-Index (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="C-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-2.html">Prev Letter</a></li> +<li><a href="index-4.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-3.html" target="_top">Frames</a></li> +<li><a href="index-3.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_C_"> +<!-- --> +</a> +<h2 class="title">C</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#calculateEncodedLength(java.math.BigInteger)">calculateEncodedLength(BigInteger)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Returns the amount of bytes required to encode the given BigInteger.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#calculateEncodedLength(java.math.BigDecimal)">calculateEncodedLength(BigDecimal)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Returns the amount of bytes required to encode the given BigDecimal.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#calculateEncodedLength(byte[])">calculateEncodedLength(byte[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Returns the amount of bytes required to encode the given byte array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#calculateEncodedLength(byte[], int, int)">calculateEncodedLength(byte[], int, int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Returns the amount of bytes required to encode the given byte array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#calculateEncodedLength(java.math.BigInteger)">calculateEncodedLength(BigInteger)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Returns the amount of bytes required to encode a BigInteger.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#calculateEncodedLength(java.math.BigDecimal)">calculateEncodedLength(BigDecimal)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Returns the amount of bytes required to encode a BigDecimal.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#calculateEncodedLength(byte[])">calculateEncodedLength(byte[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Returns the amount of bytes required to encode a byte array of the given + length.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#calculateEncodedLength(byte[], int, int)">calculateEncodedLength(byte[], int, int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Returns the amount of bytes required to encode the given byte array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#calculateEncodedStringLength(java.lang.String)">calculateEncodedStringLength(String)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Returns the amount of bytes required to encode the given String.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#calculateEncodedStringLength(java.lang.String)">calculateEncodedStringLength(String)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Returns the amount of bytes required to encode the given String.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#callStringBuilderAppendChar(org.cojen.classfile.CodeBuilder)">callStringBuilderAppendChar(CodeBuilder)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Appends a char to a StringBuilder.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#callStringBuilderAppendString(org.cojen.classfile.CodeBuilder)">callStringBuilderAppendString(CodeBuilder)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Appends a String to a StringBuilder.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#callStringBuilderLength(org.cojen.classfile.CodeBuilder)">callStringBuilderLength(CodeBuilder)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Calls length on a StringBuilder on the stack, leaving an int on the stack.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#callStringBuilderSetLength(org.cojen.classfile.CodeBuilder)">callStringBuilderSetLength(CodeBuilder)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Calls setLength on a StringBuilder.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#callStringBuilderToString(org.cojen.classfile.CodeBuilder)">callStringBuilderToString(CodeBuilder)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Calls toString on a StringBuilder.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/CompositeScore.html#canMergeRemainder(com.amazon.carbonado.qe.CompositeScore)">canMergeRemainder(CompositeScore<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></dt> +<dd> +<div class="block">Returns true if the filtering score can merge its remainder filter and + the ordering score can merge its remainder orderings.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#canMergeRemainder(com.amazon.carbonado.qe.IndexedQueryAnalyzer.Result)">canMergeRemainder(IndexedQueryAnalyzer<S>.Result)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns true if the given result uses the same index as this, and in + the same way.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#canMergeRemainderFilter(com.amazon.carbonado.qe.FilteringScore)">canMergeRemainderFilter(FilteringScore<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns true if the given score uses an index exactly the same as this + one.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#canMergeRemainderOrdering(com.amazon.carbonado.qe.OrderingScore)">canMergeRemainderOrdering(OrderingScore<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns true if the given score uses an index exactly the same as this + one.</div> +</dd> +<dt><a href="../com/amazon/carbonado/capability/Capability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">Capability</span></a> - Interface in <a href="../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></dt> +<dd> +<div class="block">Marker interface for identifying extra repository capabilities.</div> +</dd> +<dt><a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">ChainedProperty</span></a><<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></dt> +<dd> +<div class="block">Represents a property to filter on or to order by.</div> +</dd> +<dt><a href="../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob"><span class="strong">CharArrayClob</span></a> - Class in <a href="../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></dt> +<dd> +<div class="block">Implementation of a Clob which is backed by a growable in-memory character + array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/CharArrayClob.html#CharArrayClob(int)">CharArrayClob(int)</a></span> - Constructor for class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></dt> +<dd> +<div class="block">Construct a CharArrayClob with the given initial capacity.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/CharArrayClob.html#CharArrayClob(char[])">CharArrayClob(char[])</a></span> - Constructor for class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></dt> +<dd> +<div class="block">Construct a CharArrayClob initially backed by the given character array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/CharArrayClob.html#CharArrayClob(char[], int)">CharArrayClob(char[], int)</a></span> - Constructor for class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></dt> +<dd> +<div class="block">Construct a CharArrayClob initially backed by the given character array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#CHECK_PK_FOR_DELETE_METHOD_NAME">CHECK_PK_FOR_DELETE_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#CHECK_PK_FOR_INSERT_METHOD_NAME">CHECK_PK_FOR_INSERT_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#CHECK_PK_FOR_LOAD_METHOD_NAME">CHECK_PK_FOR_LOAD_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#CHECK_PK_FOR_UPDATE_METHOD_NAME">CHECK_PK_FOR_UPDATE_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Name of protected method in generated storable which checks that + primary keys are initialized, throwing an exception otherwise.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">CheckpointCapability</span></a> - Interface in <a href="../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></dt> +<dd> +<div class="block">Capability to control BDB checkpointing.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#checkSliceArguments(long, java.lang.Long)">checkSliceArguments(long, Long)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> +<div class="block">Called by sliced fetch to ensure that arguments are valid.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#checkSupport(com.amazon.carbonado.info.StorableProperty)">checkSupport(StorableProperty<S>)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#checkSupport(com.amazon.carbonado.info.StorableProperty[])">checkSupport(StorableProperty<S>[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic"><span class="strong">ClassFileBuilder</span></a> - Class in <a href="../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></dt> +<dd> +<div class="block">Simple interface representing a partially filled class and injector pair.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/ClassFileBuilder.html#ClassFileBuilder()">ClassFileBuilder()</a></span> - Constructor for class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html#clear()">clear()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">MergeSortBuffer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorablePropertyMap.html#clear()">clear()</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AbstractPool.html#clear()">clear()</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/SoftValuedCache.html#clear()">clear()</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#clearExecutor()">clearExecutor()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> +<div class="block">Clears any cached reference to a query executor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html#clearExecutors()">clearExecutors()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> +<div class="block">For each cached query, calls <a href="../com/amazon/carbonado/qe/StandardQuery.html#clearExecutor()"><code>StandardQuery.clearExecutor()</code></a>.</div> +</dd> +<dt><a href="../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob"><span class="strong">Clob</span></a> - Interface in <a href="../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></dt> +<dd> +<div class="block">Provides access to CLOBs, which are Character Large OBjects.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#CLONE_METHOD_NAME">CLONE_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/ArraySortBuffer.html#close()">close()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/ArraySortBuffer.html" title="class in com.amazon.carbonado.cursor">ArraySortBuffer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Cursor.html#close()">close()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></dt> +<dd> +<div class="block">Call close to release any resources being held by this cursor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/ControllerCursor.html#close()">close()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/ControllerCursor.html" title="class in com.amazon.carbonado.cursor">ControllerCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/DifferenceCursor.html#close()">close()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor">DifferenceCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/EmptyCursor.html#close()">close()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor">EmptyCursor</a></dt> +<dd> +<div class="block">Does nothing.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/FetchAheadCursor.html#close()">close()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="class in com.amazon.carbonado.cursor">FetchAheadCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/FilteredCursor.html#close()">close()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor">FilteredCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/GroupedCursor.html#close()">close()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor">GroupedCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/IntersectionCursor.html#close()">close()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor">IntersectionCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/IteratorCursor.html#close()">close()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor">IteratorCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/LimitCursor.html#close()">close()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/LimitCursor.html" title="class in com.amazon.carbonado.cursor">LimitCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html#close()">close()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">MergeSortBuffer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MultiTransformedCursor.html#close()">close()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor">MultiTransformedCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SingletonCursor.html#close()">close()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor">SingletonCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SkipCursor.html#close()">close()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SkipCursor.html" title="class in com.amazon.carbonado.cursor">SkipCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SortBuffer.html#close()">close()</a></span> - Method in interface com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SortBuffer.html" title="interface in com.amazon.carbonado.cursor">SortBuffer</a></dt> +<dd> +<div class="block">Clear and close buffer.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SortedCursor.html#close()">close()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor">SortedCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html#close()">close()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor">SymmetricDifferenceCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/ThrottledCursor.html#close()">close()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor">ThrottledCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/TransformedCursor.html#close()">close()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor">TransformedCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/UnionCursor.html#close()">close()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor">UnionCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Controller.html#close()">close()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></dt> +<dd> +<div class="block">Always called by query when finished, even when it fails.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Timeout.html#close()">close()</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#close()">close()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#close()">close()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#close()">close()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Repository.html#close()">close()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></dt> +<dd> +<div class="block">Closes this repository reference, aborting any current + transactions.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#close()">close()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/RAFInputStream.html#close()">close()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/RAFInputStream.html" title="class in com.amazon.carbonado.spi">RAFInputStream</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/RAFOutputStream.html#close()">close()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/RAFOutputStream.html" title="class in com.amazon.carbonado.spi">RAFOutputStream</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionManager.html#close(boolean)">close(boolean)</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></dt> +<dd> +<div class="block">Closes all transaction scopes.</div> +</dd> +<dt><a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">ClosedFilter</span></a><<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="type parameter in ClosedFilter">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></dt> +<dd> +<div class="block">Filter which blocks any results from passing through.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#clustered(boolean)">clustered(boolean)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns a StorableIndex instance which is clustered or not.</div> +</dd> +<dt><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen"><span class="strong">CodeBuilderUtil</span></a> - Class in <a href="../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></dt> +<dd> +<div class="block">Collection of useful utilities for generating Carbonado code.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#CodeBuilderUtil()">CodeBuilderUtil()</a></span> - Constructor for class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a> - package com.amazon.carbonado</dt> +<dd> +<div class="block">Main user-level interfaces, classes, and annotations for Carbonado.</div> +</dd> +<dt><a href="../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a> - package com.amazon.carbonado.adapter</dt> +<dd> +<div class="block">Contains annotations and implementations for supporting property adapters.</div> +</dd> +<dt><a href="../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> - package com.amazon.carbonado.capability</dt> +<dd> +<div class="block">Common capabilities for repositories.</div> +</dd> +<dt><a href="../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a> - package com.amazon.carbonado.constraint</dt> +<dd> +<div class="block">Contains annotations and implementations for supporting property constraints.</div> +</dd> +<dt><a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> - package com.amazon.carbonado.cursor</dt> +<dd> +<div class="block">Support for advanced processing of cursor results, including basic set + theory operations.</div> +</dd> +<dt><a href="../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> - package com.amazon.carbonado.filter</dt> +<dd> +<div class="block">Contains classes for representing query filters.</div> +</dd> +<dt><a href="../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a> - package com.amazon.carbonado.gen</dt> +<dd> +<div class="block">Storable code generation support intended for use by repository implementations.</div> +</dd> +<dt><a href="../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> - package com.amazon.carbonado.info</dt> +<dd> +<div class="block">Introspection support for Storables.</div> +</dd> +<dt><a href="../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a> - package com.amazon.carbonado.layout</dt> +<dd> +<div class="block">Support for recording the evolution of a storable's layout, used internally + by some repositories.</div> +</dd> +<dt><a href="../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a> - package com.amazon.carbonado.lob</dt> +<dd> +<div class="block">Support for LOB property types, which are Large OBjects.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> - package com.amazon.carbonado.qe</dt> +<dd> +<div class="block">Support for implementing a Query Engine.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> - package com.amazon.carbonado.raw</dt> +<dd> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a> - package com.amazon.carbonado.repo.indexed</dt> +<dd> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> - package com.amazon.carbonado.repo.jdbc</dt> +<dd> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a> - package com.amazon.carbonado.repo.logging</dt> +<dd> +<div class="block">Repository implementation which logs activity against it.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/map/package-summary.html">com.amazon.carbonado.repo.map</a> - package com.amazon.carbonado.repo.map</dt> +<dd> +<div class="block">Volatile repository implementation backed by a concurrent map.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/replicated/package-summary.html">com.amazon.carbonado.repo.replicated</a> - package com.amazon.carbonado.repo.replicated</dt> +<dd> +<div class="block">Repository implementation that supports replication between two + repositories.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a> - package com.amazon.carbonado.repo.sleepycat</dt> +<dd> +<div class="block">Repository implementation backed by a Sleepycat (BDB, Berkeley) + database.</div> +</dd> +<dt><a href="../com/amazon/carbonado/sequence/package-summary.html">com.amazon.carbonado.sequence</a> - package com.amazon.carbonado.sequence</dt> +<dd> +<div class="block">Support for generating sequences of values, intended for creating surrogate + keys.</div> +</dd> +<dt><a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> - package com.amazon.carbonado.spi</dt> +<dd> +<div class="block">Service Provider Interface for Carbonado.</div> +</dd> +<dt><a href="../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> - package com.amazon.carbonado.synthetic</dt> +<dd> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</div> +</dd> +<dt><a href="../com/amazon/carbonado/txn/package-summary.html">com.amazon.carbonado.txn</a> - package com.amazon.carbonado.txn</dt> +<dd> +<div class="block">Provides support for managing transactions.</div> +</dd> +<dt><a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a> - package com.amazon.carbonado.util</dt> +<dd> +<div class="block">Utilities used by Carbonado but which have no dependencies on + Carbonado.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Transaction.html#commit()">commit()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></dt> +<dd> +<div class="block">If currently in a transaction, commits all changes to the storage layer + since the last commit within the transaction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionPair.html#commit()">commit()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn">TransactionPair</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#COMMIT_METHOD_NAME">COMMIT_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Transaction API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionManager.html#commitTxn(Txn)">commitTxn(Txn)</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></dt> +<dd> +<div class="block">Commits and closes the given internal transaction.</div> +</dd> +<dt><a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen"><span class="strong">CommonMethodNames</span></a> - Class in <a href="../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></dt> +<dd> +<div class="block">Collection of constant method names for the public API.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#CommonMethodNames()">CommonMethodNames()</a></span> - Constructor for class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/repo/logging/CommonsLog.html" title="class in com.amazon.carbonado.repo.logging"><span class="strong">CommonsLog</span></a> - Class in <a href="../com/amazon/carbonado/repo/logging/package-summary.html">com.amazon.carbonado.repo.logging</a></dt> +<dd> +<div class="block">Log implementation that uses Jakarta Commons Logging at debug level.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/CommonsLog.html#CommonsLog(org.apache.commons.logging.Log)">CommonsLog(Log)</a></span> - Constructor for class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/CommonsLog.html" title="class in com.amazon.carbonado.repo.logging">CommonsLog</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/CommonsLog.html#CommonsLog(java.lang.Class)">CommonsLog(Class)</a></span> - Constructor for class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/CommonsLog.html" title="class in com.amazon.carbonado.repo.logging">CommonsLog</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.html#compact(java.lang.Class)">compact(Class<S>)</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability</a></dt> +<dd> +<div class="block">Compact an entire BDB backed storage.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">CompactionCapability</span></a> - Interface in <a href="../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></dt> +<dd> +<div class="block">Capability to compact a BDB database.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">CompactionCapability.Result</span></a><<a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="type parameter in CompactionCapability.Result">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/GroupedCursor.html#comparator()">comparator()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor">GroupedCursor</a></dt> +<dd> +<div class="block">Returns the comparator used to identify group boundaries.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SortedCursor.html#comparator()">comparator()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor">SortedCursor</a></dt> +<dd> +<div class="block">Returns a comparator representing the effective sort order of this cursor.</div> +</dd> +<dt><a href="../com/amazon/carbonado/util/Comparators.html" title="class in com.amazon.carbonado.util"><span class="strong">Comparators</span></a> - Class in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block">Collection of utility comparators.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Comparators.html#Comparators()">Comparators()</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Comparators.html" title="class in com.amazon.carbonado.util">Comparators</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/ConversionComparator.html#compare(java.lang.Class, java.lang.Class)">compare(Class, Class)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/ConversionComparator.html" title="class in com.amazon.carbonado.util">ConversionComparator</a></dt> +<dd> +<div class="block">Evaluates two types, to see which one is nearest to the from type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#compareKeysPartially(byte[], byte[])">compareKeysPartially(byte[], byte[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Returns <0 if key1 is less, 0 if equal (at least partially), + >0 if key1 is greater.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html#compareNext()">compareNext()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor">SymmetricDifferenceCursor</a></dt> +<dd> +<div class="block">Returns 0 if no next element available, <0 if next element is + from left source cursor, and >0 if next element is from right + source cursor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#compareTo(com.amazon.carbonado.synthetic.SyntheticProperty)">compareTo(SyntheticProperty)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> +<div class="block"><code>Comparable</code> implementation.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">CompositeScore</span></a><<a href="../com/amazon/carbonado/qe/CompositeScore.html" title="type parameter in CompositeScore">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Evaluates an index for how well it matches a query's desired filtering and + ordering.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GzipCompressor.html#compress(byte[], int)">compress(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GzipCompressor.html" title="class in com.amazon.carbonado.raw">GzipCompressor</a></dt> +<dd> +<div class="block">Encodes into compressed form.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="class in com.amazon.carbonado.raw"><span class="strong">CompressedEncodingStrategy</span></a><<a href="../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="type parameter in CompressedEncodingStrategy">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Extension of GenericEncodingStrategy that allows for compression.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CompressedEncodingStrategy.html#CompressedEncodingStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.raw.CompressionType)">CompressedEncodingStrategy(Class<S>, StorableIndex<S>, CompressionType)</a></span> - Constructor for class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="class in com.amazon.carbonado.raw">CompressedEncodingStrategy</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw"><span class="strong">CompressedStorableCodecFactory</span></a> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Extension of GenericStorableCodecFactory that allows for compression.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#CompressedStorableCodecFactory(java.util.Map)">CompressedStorableCodecFactory(Map<String, CompressionType>)</a></span> - Constructor for class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CompressedStorableCodecFactory</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw"><span class="strong">CompressionType</span></a> - Enum in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Available compression types for any particular storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#concat(java.lang.Class, java.lang.String)">concat(Class<S>, String)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> +<div class="block">Returns a list which concatenates this one with the given property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#concat(com.amazon.carbonado.info.OrderedProperty)">concat(OrderedProperty<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> +<div class="block">Returns a list which concatenates this one with the given property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#concat(com.amazon.carbonado.qe.OrderingList)">concat(OrderingList<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> +<div class="block">Returns a list which concatenates this one with the other one.</div> +</dd> +<dt><a href="../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado"><span class="strong">ConfigurationException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Indicates that a <a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> could not be + instantiated given the configuration information provided to a <a href="../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado"><code>RepositoryBuilder</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/ConfigurationException.html#ConfigurationException()">ConfigurationException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/ConfigurationException.html#ConfigurationException(java.lang.Throwable)">ConfigurationException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/ConfigurationException.html#ConfigurationException(java.lang.String)">ConfigurationException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/ConfigurationException.html#ConfigurationException(java.lang.String, java.lang.Throwable)">ConfigurationException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/ConfigurationException.html" title="class in com.amazon.carbonado">ConfigurationException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalForm()">conjunctiveNormalForm()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns an equivalent filter that is in conjunctive normal form.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#conjunctiveNormalFormSplit()">conjunctiveNormalFormSplit()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#conjunctiveNormalFormSplit()">conjunctiveNormalFormSplit()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Splits the filter from its conjunctive normal form.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#conjunctiveNormalFormSplit()">conjunctiveNormalFormSplit()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#conjunctiveNormalFormSplit()">conjunctiveNormalFormSplit()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#constant(java.lang.Object)">constant(Object)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> +<div class="block">Returns another PropertyFilter instance which is bound to the given constant value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#constant()">constant()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> +<div class="block">Returns the constant value of this PropertyFilter, which is valid only + if isConstant returns true.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html#constrain(double)">constrain(double)</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">FloatConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html#constrain(java.lang.CharSequence)">constrain(CharSequence)</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">FloatConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html#constrain(char)">constrain(char)</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">FloatConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html#constrain(char[])">constrain(char[])</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">FloatConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html#constrain(long)">constrain(long)</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">IntegerConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html#constrain(double)">constrain(double)</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">IntegerConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html#constrain(java.lang.CharSequence)">constrain(CharSequence)</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">IntegerConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html#constrain(char)">constrain(char)</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">IntegerConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html#constrain(char[])">constrain(char[])</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">IntegerConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(java.lang.CharSequence)">constrain(CharSequence)</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">LengthConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(boolean[])">constrain(boolean[])</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">LengthConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(byte[])">constrain(byte[])</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">LengthConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(short[])">constrain(short[])</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">LengthConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(char[])">constrain(char[])</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">LengthConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(int[])">constrain(int[])</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">LengthConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(long[])">constrain(long[])</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">LengthConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(float[])">constrain(float[])</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">LengthConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(double[])">constrain(double[])</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">LengthConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html#constrain(java.lang.Object[])">constrain(Object[])</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/LengthConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">LengthConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/TextConstraint.Constraint.html#constrain(java.lang.CharSequence)">constrain(CharSequence)</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/TextConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">TextConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/TextConstraint.Constraint.html#constrain(java.lang.String)">constrain(String)</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/TextConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">TextConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/TextConstraint.Constraint.html#constrain(char)">constrain(char)</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/TextConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">TextConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/TextConstraint.Constraint.html#constrain(char[])">constrain(char[])</a></span> - Method in class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/TextConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">TextConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#CONSTRAINT_FIELD_ELEMENT">CONSTRAINT_FIELD_ELEMENT</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Constraint field names are propertyName + "$constraint$" + number</div> +</dd> +<dt><a href="../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">ConstraintDefinition</span></a> - Annotation Type in <a href="../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></dt> +<dd> +<div class="block">Allows annotations to be defined that restrict property values.</div> +</dd> +<dt><a href="../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado"><span class="strong">ConstraintException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">A ConstraintException is thrown if the <a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> storage layer + detects any kind of constraint violation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/ConstraintException.html#ConstraintException()">ConstraintException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado">ConstraintException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/ConstraintException.html#ConstraintException(java.lang.String)">ConstraintException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado">ConstraintException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/ConstraintException.html#ConstraintException(java.lang.String, java.lang.Throwable)">ConstraintException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado">ConstraintException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/ConstraintException.html#ConstraintException(java.lang.Throwable)">ConstraintException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/ConstraintException.html" title="class in com.amazon.carbonado">ConstraintException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryHints.html#contains(com.amazon.carbonado.qe.QueryHint)">contains(QueryHint)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></dt> +<dd> +<div class="block">Returns false if hint is not provided.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorablePropertyMap.html#containsKey(java.lang.Object)">containsKey(Object)</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Controller.html#continueCheck()">continueCheck()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></dt> +<dd> +<div class="block">Periodically called by query to determine if it should continue.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Timeout.html#continueCheck()">continueCheck()</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/cursor/ControllerCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">ControllerCursor</span></a><<a href="../com/amazon/carbonado/cursor/ControllerCursor.html" title="type parameter in ControllerCursor">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Wraps another cursor and periodically calls a <a href="../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado"><code>controller</code></a>.</div> +</dd> +<dt><a href="../com/amazon/carbonado/util/ConversionComparator.html" title="class in com.amazon.carbonado.util"><span class="strong">ConversionComparator</span></a> - Class in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block">Compares type conversions, finding the one that is nearest.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/ConversionComparator.html#ConversionComparator(java.lang.Class)">ConversionComparator(Class)</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/ConversionComparator.html" title="class in com.amazon.carbonado.util">ConversionComparator</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Converter.html#conversionNotSupported(java.lang.Object, java.lang.Class, java.lang.Class)">conversionNotSupported(Object, Class, Class)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Converter.html#convert(java.lang.Object, java.lang.Class)">convert(Object, Class<T>)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Converter.html#convert(byte, java.lang.Class)">convert(byte, Class<T>)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Converter.html#convert(short, java.lang.Class)">convert(short, Class<T>)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Converter.html#convert(int, java.lang.Class)">convert(int, Class<T>)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Converter.html#convert(long, java.lang.Class)">convert(long, Class<T>)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Converter.html#convert(float, java.lang.Class)">convert(float, Class<T>)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Converter.html#convert(double, java.lang.Class)">convert(double, Class<T>)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Converter.html#convert(boolean, java.lang.Class)">convert(boolean, Class<T>)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Converter.html#convert(char, java.lang.Class)">convert(char, Class<T>)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#convertBlob(java.sql.Blob, com.amazon.carbonado.repo.jdbc.JDBCBlobLoader)">convertBlob(Blob, JDBCBlobLoader)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#convertClob(java.sql.Clob, com.amazon.carbonado.repo.jdbc.JDBCClobLoader)">convertClob(Clob, JDBCClobLoader)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util"><span class="strong">Converter</span></a> - Class in <a href="../com/amazon/carbonado/util/package-summary.html">com.amazon.carbonado.util</a></dt> +<dd> +<div class="block">General purpose type converter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/Converter.html#Converter()">Converter()</a></span> - Constructor for class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/Converter.html" title="class in com.amazon.carbonado.util">Converter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#convertValue(org.cojen.classfile.CodeBuilder, java.lang.Class, java.lang.Class)">convertValue(CodeBuilder, Class, Class)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Converts a value on the stack.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#copy()">copy()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Returns an exact shallow copy of this object, including the state.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#COPY_ALL_PROPERTIES">COPY_ALL_PROPERTIES</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#COPY_DIRTY_PROPERTIES">COPY_DIRTY_PROPERTIES</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#COPY_METHOD_NAME">COPY_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#COPY_PRIMARY_KEY_PROPERTIES">COPY_PRIMARY_KEY_PROPERTIES</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#COPY_UNEQUAL_PROPERTIES">COPY_UNEQUAL_PROPERTIES</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#COPY_VERSION_PROPERTY">COPY_VERSION_PROPERTY</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableCopier.html#copyAllProperties(S, T)">copyAllProperties(S, T)</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">StorableCopier</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#copyAllProperties(S)">copyAllProperties(S)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Copies all supported properties, skipping any that are uninitialized.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableCopier.html#copyDirtyProperties(S, T)">copyDirtyProperties(S, T)</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">StorableCopier</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#copyDirtyProperties(S)">copyDirtyProperties(S)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Copies all supported non-primary key properties which are + dirty.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#copyFromMaster(com.amazon.carbonado.Storable, S)">copyFromMaster(Storable, S)</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a></dt> +<dd> +<div class="block">Sets all the properties of the given index entry, using the applicable + properties of the given master.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#copyFromMaster(com.amazon.carbonado.Storable, S)">copyFromMaster(Storable, S)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceAccess</a></dt> +<dd> +<div class="block">Sets all the properties of the given reference, using the applicable + properties of the given master.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#copyFromMaster(com.amazon.carbonado.Storable, S)">copyFromMaster(Storable, S)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>call getReferenceAccess</i></div> +</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection)">copyInto(Collection<? super S>)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/AbstractCursor.html#copyInto(java.util.Collection, int)">copyInto(Collection<? super S>, int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/AbstractCursor.html" title="class in com.amazon.carbonado.cursor">AbstractCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Cursor.html#copyInto(java.util.Collection)">copyInto(Collection<? super S>)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></dt> +<dd> +<div class="block">Copies all remaining next elements into the given collection.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Cursor.html#copyInto(java.util.Collection, int)">copyInto(Collection<? super S>, int)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></dt> +<dd> +<div class="block">Copies a limited amount of remaining next elements into the given + collection.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/EmptyCursor.html#copyInto(java.util.Collection)">copyInto(Collection<? super S>)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor">EmptyCursor</a></dt> +<dd> +<div class="block">Performs no copy and always returns 0.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/EmptyCursor.html#copyInto(java.util.Collection, int)">copyInto(Collection<? super S>, int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor">EmptyCursor</a></dt> +<dd> +<div class="block">Performs no copy and always returns 0.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SingletonCursor.html#copyInto(java.util.Collection)">copyInto(Collection<? super S>)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor">SingletonCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SingletonCursor.html#copyInto(java.util.Collection, int)">copyInto(Collection<? super S>, int)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor">SingletonCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableCopier.html#copyPrimaryKeyProperties(S, T)">copyPrimaryKeyProperties(S, T)</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">StorableCopier</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#copyPrimaryKeyProperties(S)">copyPrimaryKeyProperties(S)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Copies all supported primary key properties, skipping any that are + uninitialized.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#copyToMasterPrimaryKey(com.amazon.carbonado.Storable, S)">copyToMasterPrimaryKey(Storable, S)</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a></dt> +<dd> +<div class="block">Sets all the primary key properties of the given master, using the + applicable properties of the given index entry.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#copyToMasterPrimaryKey(com.amazon.carbonado.Storable, S)">copyToMasterPrimaryKey(Storable, S)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceAccess</a></dt> +<dd> +<div class="block">Sets all the primary key properties of the given master, using the + applicable properties of the given reference.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#copyToMasterPrimaryKey(com.amazon.carbonado.Storable, S)">copyToMasterPrimaryKey(Storable, S)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>call getReferenceAccess</i></div> +</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableCopier.html#copyUnequalProperties(S, T)">copyUnequalProperties(S, T)</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">StorableCopier</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#copyUnequalProperties(S)">copyUnequalProperties(S)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Copies all supported non-primary key properties which are unequal, + skipping any that are uninitialized.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableCopier.html#copyVersionProperty(S, T)">copyVersionProperty(S, T)</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">StorableCopier</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#copyVersionProperty(S)">copyVersionProperty(S)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Copies the optional version property, unless it is uninitialized.</div> +</dd> +<dt><a href="../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado"><span class="strong">CorruptEncodingException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">A CorruptEncodingException is caused when decoding an encoded record fails.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/CorruptEncodingException.html#CorruptEncodingException()">CorruptEncodingException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/CorruptEncodingException.html#CorruptEncodingException(java.lang.String)">CorruptEncodingException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/CorruptEncodingException.html#CorruptEncodingException(java.lang.String, java.lang.Throwable)">CorruptEncodingException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/CorruptEncodingException.html#CorruptEncodingException(java.lang.Throwable)">CorruptEncodingException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/CorruptEncodingException.html#CorruptEncodingException(int, int)">CorruptEncodingException(int, int)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count(FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></dt> +<dd> +<div class="block">Counts results by opening a cursor and skipping entries.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count(FilterValues<S>, Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></dt> +<dd> +<div class="block">Counts results by opening a cursor and skipping entries.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count(FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count(FilterValues<S>, Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#count()">count()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns zero.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#count(com.amazon.carbonado.Query.Controller)">count(Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns zero.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count(FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count(FilterValues<S>, Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count(FilterValues<S>)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></dt> +<dd> +<div class="block">Counts the query results using the given filter values.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count(FilterValues<S>, Query.Controller)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></dt> +<dd> +<div class="block">Counts the query results using the given filter values.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues)">count(FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html#count(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">count(FilterValues<S>, Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#count()">count()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#count(com.amazon.carbonado.Query.Controller)">count(Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#count()">count()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a count of all results matched by this query.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#count(com.amazon.carbonado.Query.Controller)">count(Query.Controller)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns a count of all results matched by this query.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#countAll()">countAll()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a></dt> +<dd> +<div class="block">Counts all Storables.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#countAll(com.amazon.carbonado.Query.Controller)">countAll(Query.Controller)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a></dt> +<dd> +<div class="block">Counts all Storables.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#create(javax.sql.DataSource)">create(DataSource)</a></span> - Static method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></dt> +<dd> +<div class="block">Wraps the given DataSource which logs to the default log.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#create(javax.sql.DataSource, org.apache.commons.logging.Log)">create(DataSource, Log)</a></span> - Static method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></dt> +<dd> +<div class="block">Wraps the given DataSource which logs to the given log.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueProducerPool.html#create(java.lang.String)">create(String)</a></span> - Method in class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueProducerPool.html" title="class in com.amazon.carbonado.sequence">SequenceValueProducerPool</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoragePool.html#create(java.lang.Class)">create(Class)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoragePool.html" title="class in com.amazon.carbonado.spi">StoragePool</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AbstractPool.html#create(K)">create(K)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a></dt> +<dd> +<div class="block">Return a new value instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#createBogus()">createBogus()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi">BelatedRepositoryCreator</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/BelatedStorageCreator.html#createBogus()">createBogus()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi">BelatedStorageCreator</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/BelatedCreator.html#createBogus()">createBogus()</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a></dt> +<dd> +<div class="block">Create instance of bogus object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec(Class<S>, StorableIndex, boolean, Layout)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CustomStorableCodecFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec(Class<S>, StorableIndex, boolean, Layout, RawSupport)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CustomStorableCodecFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, boolean, com.amazon.carbonado.layout.Layout)">createCodec(Class<S>, boolean, Layout)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CustomStorableCodecFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec(Class<S>, boolean, Layout, RawSupport)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CustomStorableCodecFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec(Class<S>, StorableIndex, boolean, Layout)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec(Class<S>, StorableIndex, boolean, Layout, RawSupport)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec(Class<S>, StorableIndex, boolean, Layout)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec(Class<S>, StorableIndex, boolean, Layout, RawSupport)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SortedCursor.html#createComparator(java.lang.Class, java.lang.String...)">createComparator(Class<S>, String...)</a></span> - Static method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor">SortedCursor</a></dt> +<dd> +<div class="block">Convenience method to create a comparator which orders storables by the + given order-by properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SortedCursor.html#createComparator(com.amazon.carbonado.info.OrderedProperty...)">createComparator(OrderedProperty<S>...)</a></span> - Static method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor">SortedCursor</a></dt> +<dd> +<div class="block">Convenience method to create a comparator which orders storables by the + given properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SortedCursor.html#createComparator(java.util.List)">createComparator(List<OrderedProperty<S>>)</a></span> - Static method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor">SortedCursor</a></dt> +<dd> +<div class="block">Convenience method to create a comparator which orders storables by the + given properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/BelatedCreator.html#createdNotification(T)">createdNotification(T)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a></dt> +<dd> +<div class="block">Notification that createReal has produced the real object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#createExecutor()">createExecutor()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Creates a QueryExecutor based on this result.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#createExecutor()">createExecutor()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Creates a QueryExecutor based on this result.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorablePropertyMap.html#createMap(java.lang.Class, S)">createMap(Class<S>, S)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/LobEngine.html#createNewBlob(int)">createNewBlob(int)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></dt> +<dd> +<div class="block">Returns a new Blob whose length is zero.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/LobEngine.html#createNewClob(int)">createNewClob(int)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></dt> +<dd> +<div class="block">Returns a new Clob whose length is zero.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryEngine.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery(Filter<S>, FilterValues<S>, OrderingList<S>, QueryHints)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">QueryEngine</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html#createQuery(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">createQuery(Filter<S>, FilterValues<S>, OrderingList<S>, QueryHints)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> +<div class="block">Implement this method to return query implementations.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/BelatedRepositoryCreator.html#createReal()">createReal()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/BelatedRepositoryCreator.html" title="class in com.amazon.carbonado.spi">BelatedRepositoryCreator</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/BelatedStorageCreator.html#createReal()">createReal()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/BelatedStorageCreator.html" title="class in com.amazon.carbonado.spi">BelatedStorageCreator</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/BelatedCreator.html#createReal()">createReal()</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a></dt> +<dd> +<div class="block">Create instance of real object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueProducerPool.html#createSequenceValueProducer(java.lang.String)">createSequenceValueProducer(String)</a></span> - Method in class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueProducerPool.html" title="class in com.amazon.carbonado.sequence">SequenceValueProducerPool</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#createSequenceValueProducer(java.lang.String)">createSequenceValueProducer(String)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> +<div class="block">Called upon to create a new SequenceValueProducer instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html#createSortBuffer()">createSortBuffer()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.ArraySortSupport</a></dt> +<dd> +<div class="block">Returns a new ArraySortBuffer.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer(Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.ArraySortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.ArraySortSupport</a></dt> +<dd> +<div class="block">Returns a new ArraySortBuffer.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html#createSortBuffer()">createSortBuffer()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.MergeSortSupport</a></dt> +<dd> +<div class="block">Returns a new MergeSortBuffer.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer(Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.MergeSortSupport.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor.MergeSortSupport</a></dt> +<dd> +<div class="block">Returns a new MergeSortBuffer.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer()">createSortBuffer()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a></dt> +<dd> +<div class="block">Implementation must return an empty buffer for sorting.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html#createSortBuffer(com.amazon.carbonado.Query.Controller)">createSortBuffer(Query.Controller)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">SortedQueryExecutor.Support</a></dt> +<dd> +<div class="block">Implementation must return an empty buffer for sorting.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#createStorableClassFile(org.cojen.util.ClassInjector, java.lang.Class, boolean, java.lang.String)">createStorableClassFile(ClassInjector, Class<S>, boolean, String)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Define a classfile appropriate for most Storables.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#createStorage(java.lang.Class)">createStorage(Class<S>)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> +<div class="block">Called upon to create a new Storage instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoragePool.html#createStorage(java.lang.Class)">createStorage(Class<S>)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoragePool.html" title="class in com.amazon.carbonado.spi">StoragePool</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">createStrategy(Class<S>, StorableIndex<S>, LayoutOptions)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CompressedStorableCodecFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex)">createStrategy(Class<S>, StorableIndex<S>)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></dt> +<dd> +<div class="block">Override to return a different EncodingStrategy.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">createStrategy(Class<S>, StorableIndex<S>, LayoutOptions)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></dt> +<dd> +<div class="block">Override to return a different EncodingStrategy.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionManager.html#createTxn(Txn, com.amazon.carbonado.IsolationLevel)">createTxn(Txn, IsolationLevel)</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></dt> +<dd> +<div class="block">Creates an internal transaction representation, with the optional parent + transaction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionManager.html#createTxn(Txn, com.amazon.carbonado.IsolationLevel, int, java.util.concurrent.TimeUnit)">createTxn(Txn, IsolationLevel, int, TimeUnit)</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></dt> +<dd> +<div class="block">Creates an internal transaction representation, with the optional parent + transaction.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado"><span class="strong">Cursor</span></a><<a href="../com/amazon/carbonado/Cursor.html" title="type parameter in Cursor">S</a>> - Interface in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Represents the results of a <a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><code>Query</code></a>'s fetch + operation.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw"><span class="strong">CustomStorableCodec</span></a><<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Allows codecs to be defined for storables that have a custom encoding.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#CustomStorableCodec(java.lang.Class, boolean)">CustomStorableCodec(Class<S>, boolean)</a></span> - Constructor for class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#CustomStorableCodec(java.lang.Class, boolean, com.amazon.carbonado.raw.RawSupport)">CustomStorableCodec(Class<S>, boolean, RawSupport<S>)</a></span> - Constructor for class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">CustomStorableCodec.InstanceFactory</span></a> - Interface in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/raw/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw"><span class="strong">CustomStorableCodecFactory</span></a> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Factory for custom storable codecs.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#CustomStorableCodecFactory()">CustomStorableCodecFactory()</a></span> - Constructor for class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CustomStorableCodecFactory</a></dt> +<dd> </dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-2.html">Prev Letter</a></li> +<li><a href="index-4.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-3.html" target="_top">Frames</a></li> +<li><a href="index-3.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-4.html b/apidocs/index-files/index-4.html new file mode 100644 index 0000000..c1e3fdb --- /dev/null +++ b/apidocs/index-files/index-4.html @@ -0,0 +1,622 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>D-Index (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="D-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-3.html">Prev Letter</a></li> +<li><a href="index-5.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-4.html" target="_top">Frames</a></li> +<li><a href="index-4.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_D_"> +<!-- --> +</a> +<h2 class="title">D</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html#databaseName(java.lang.String)">databaseName(String)</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.DatabaseHook.html" title="interface in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder.DatabaseHook</a></dt> +<dd> +<div class="block">Returns an appropriate database name for the given type.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">DataDecoder</span></a> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">A very low-level class that decodes key components encoded by methods of + <a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw"><code>DataEncoder</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#DataDecoder()">DataDecoder()</a></span> - Constructor for class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw"><span class="strong">DataEncoder</span></a> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">A very low-level class that supports encoding of primitive data.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#DataEncoder()">DataEncoder()</a></span> - Constructor for class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter"><span class="strong">DateTimeAdapter</span></a> - Annotation Type in <a href="../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></dt> +<dd> +<div class="block">Converts Joda-Time datetime objects to and from other forms.</div> +</dd> +<dt><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter"><span class="strong">DateTimeAdapter.Adapter</span></a> - Class in <a href="../com/amazon/carbonado/adapter/package-summary.html">com.amazon.carbonado.adapter</a></dt> +<dd> +<div class="block">Adapter implementation for <a href="../com/amazon/carbonado/adapter/DateTimeAdapter.html" title="annotation in com.amazon.carbonado.adapter"><code>DateTimeAdapter</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#DateTimeAdapter.Adapter(java.lang.Class, java.lang.String, com.amazon.carbonado.adapter.DateTimeAdapter)">DateTimeAdapter.Adapter(Class<?>, String, DateTimeAdapter)</a></span> - Constructor for class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html#DateTimeAdapter.Adapter(java.lang.Class, java.lang.String, org.joda.time.DateTimeZone)">DateTimeAdapter.Adapter(Class<?>, String, DateTimeZone)</a></span> - Constructor for class com.amazon.carbonado.adapter.<a href="../com/amazon/carbonado/adapter/DateTimeAdapter.Adapter.html" title="class in com.amazon.carbonado.adapter">DateTimeAdapter.Adapter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutOptions.html#decode(byte[])">decode(byte[])</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decode(byte[], int, java.math.BigInteger[])">decode(byte[], int, BigInteger[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes a BigInteger.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decode(byte[], int, java.math.BigDecimal[])">decode(byte[], int, BigDecimal[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes a BigDecimal.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decode(byte[], int, byte[][])">decode(byte[], int, byte[][])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes the given byte array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#decode(S, int, byte[])">decode(S, int, byte[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html#decode(S, byte[])">decode(S, byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.Decoder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decode(byte[], int, java.math.BigInteger[])">decode(byte[], int, BigInteger[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes the given BigInteger as originally encoded for ascending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decode(byte[], int, java.math.BigDecimal[])">decode(byte[], int, BigDecimal[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes the given BigDecimal as originally encoded for ascending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decode(byte[], int, byte[][])">decode(byte[], int, byte[][])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes the given byte array as originally encoded for ascending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawSupport.html#decode(S, int, byte[])">decode(S, int, byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></dt> +<dd> +<div class="block">Used for decoding different generations of Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#decode(S, int, byte[])">decode(S, int, byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Used for decoding different generations of Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawStorableGenerator.html#DECODE_DATA_METHOD_NAME">DECODE_DATA_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawStorableGenerator.html" title="class in com.amazon.carbonado.raw">RawStorableGenerator</a></dt> +<dd> +<div class="block">Name of protected abstract method in generated storable</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawStorableGenerator.html#DECODE_KEY_METHOD_NAME">DECODE_KEY_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawStorableGenerator.html" title="class in com.amazon.carbonado.raw">RawStorableGenerator</a></dt> +<dd> +<div class="block">Name of protected abstract method in generated storable</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeBoolean(byte[], int)">decodeBoolean(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes a boolean from exactly 1 byte.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeBooleanDesc(byte[], int)">decodeBooleanDesc(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes a boolean from exactly 1 byte, as encoded for descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeBooleanObj(byte[], int)">decodeBooleanObj(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes a Boolean object from exactly 1 byte.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeBooleanObjDesc(byte[], int)">decodeBooleanObjDesc(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes a Boolean object from exactly 1 byte, as encoded for descending + order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeByte(byte[], int)">decodeByte(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes a signed byte from exactly 1 byte.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeByteDesc(byte[], int)">decodeByteDesc(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes a signed byte from exactly 1 byte, as encoded for descending + order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeByteObj(byte[], int)">decodeByteObj(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes a signed Byte object from exactly 1 or 2 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeByteObjDesc(byte[], int)">decodeByteObjDesc(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes a signed Byte object from exactly 1 or 2 bytes, as encoded for + descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeChar(byte[], int)">decodeChar(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes a char from exactly 2 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeCharacterObj(byte[], int)">decodeCharacterObj(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes a Character object from exactly 1 or 3 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeCharacterObjDesc(byte[], int)">decodeCharacterObjDesc(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes a Character object from exactly 1 or 3 bytes, as encoded for + descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeCharDesc(byte[], int)">decodeCharDesc(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes a char from exactly 2 bytes, as encoded for descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#decodeData(S, byte[])">decodeData(S, byte[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> +<div class="block">Decode the data into properties of the storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeDesc(byte[], int, java.math.BigInteger[])">decodeDesc(byte[], int, BigInteger[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes the given BigInteger as originally encoded for descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeDesc(byte[], int, java.math.BigDecimal[])">decodeDesc(byte[], int, BigDecimal[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes the given BigDecimal as originally encoded for descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeDesc(byte[], int, byte[][])">decodeDesc(byte[], int, byte[][])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes the given byte array as originally encoded for descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeDouble(byte[], int)">decodeDouble(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes a double from exactly 8 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeDoubleBits(byte[], int)">decodeDoubleBits(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeDoubleDesc(byte[], int)">decodeDoubleDesc(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes a double from exactly 8 bytes, as encoded for descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeDoubleObj(byte[], int)">decodeDoubleObj(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes a Double object from exactly 8 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeDoubleObjDesc(byte[], int)">decodeDoubleObjDesc(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes a Double object from exactly 8 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeFloat(byte[], int)">decodeFloat(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes a float from exactly 4 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeFloatBits(byte[], int)">decodeFloatBits(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeFloatDesc(byte[], int)">decodeFloatDesc(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes a float from exactly 4 bytes, as encoded for descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeFloatObj(byte[], int)">decodeFloatObj(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes a Float object from exactly 4 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeFloatObjDesc(byte[], int)">decodeFloatObjDesc(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes a Float object from exactly 4 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeInt(byte[], int)">decodeInt(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes a signed integer from exactly 4 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeIntDesc(byte[], int)">decodeIntDesc(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes a signed integer from exactly 4 bytes, as encoded for descending + order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeIntegerObj(byte[], int)">decodeIntegerObj(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes a signed Integer object from exactly 1 or 5 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeIntegerObjDesc(byte[], int)">decodeIntegerObjDesc(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes a signed Integer object from exactly 1 or 5 bytes, as encoded + for descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeLong(byte[], int)">decodeLong(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes a signed long from exactly 8 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeLongDesc(byte[], int)">decodeLongDesc(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes a signed long from exactly 8 bytes, as encoded for descending + order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeLongObj(byte[], int)">decodeLongObj(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes a signed Long object from exactly 1 or 9 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeLongObjDesc(byte[], int)">decodeLongObjDesc(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes a signed Long object from exactly 1 or 9 bytes, as encoded for + descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#decodePrimaryKey(S, byte[])">decodePrimaryKey(S, byte[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> +<div class="block">Decode the primary key into properties of the storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeShort(byte[], int)">decodeShort(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes a signed short from exactly 2 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeShortDesc(byte[], int)">decodeShortDesc(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes a signed short from exactly 2 bytes, as encoded for descending + order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeShortObj(byte[], int)">decodeShortObj(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes a signed Short object from exactly 1 or 3 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeShortObjDesc(byte[], int)">decodeShortObjDesc(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes a signed Short object from exactly 1 or 3 bytes, as encoded for + descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeSingle(byte[], int, int)">decodeSingle(byte[], int, int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes the given byte array which was encoded by <a href="../com/amazon/carbonado/raw/DataEncoder.html#encodeSingle(byte[], int, int)"><code>DataEncoder.encodeSingle(byte[], int, int)</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeSingleDesc(byte[])">decodeSingleDesc(byte[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes the given byte array which was encoded by <a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleDesc(byte[])"><code>KeyEncoder.encodeSingleDesc(byte[])</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeSingleDesc(byte[], int, int)">decodeSingleDesc(byte[], int, int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes the given byte array which was encoded by <a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleDesc(byte[])"><code>KeyEncoder.encodeSingleDesc(byte[])</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeSingleNullable(byte[])">decodeSingleNullable(byte[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes the given byte array which was encoded by <a href="../com/amazon/carbonado/raw/DataEncoder.html#encodeSingleNullable(byte[])"><code>DataEncoder.encodeSingleNullable(byte[])</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeSingleNullable(byte[], int, int)">decodeSingleNullable(byte[], int, int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes the given byte array which was encoded by <a href="../com/amazon/carbonado/raw/DataEncoder.html#encodeSingleNullable(byte[])"><code>DataEncoder.encodeSingleNullable(byte[])</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeSingleNullableDesc(byte[])">decodeSingleNullableDesc(byte[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes the given byte array which was encoded by <a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleNullableDesc(byte[])"><code>KeyEncoder.encodeSingleNullableDesc(byte[])</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeSingleNullableDesc(byte[], int, int)">decodeSingleNullableDesc(byte[], int, int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes the given byte array which was encoded by <a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleNullableDesc(byte[])"><code>KeyEncoder.encodeSingleNullableDesc(byte[])</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataDecoder.html#decodeString(byte[], int, java.lang.String[])">decodeString(byte[], int, String[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataDecoder.html" title="class in com.amazon.carbonado.raw">DataDecoder</a></dt> +<dd> +<div class="block">Decodes an encoded string from the given byte array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeString(byte[], int, java.lang.String[])">decodeString(byte[], int, String[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes an encoded string from the given byte array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyDecoder.html#decodeStringDesc(byte[], int, java.lang.String[])">decodeStringDesc(byte[], int, String[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyDecoder.html" title="class in com.amazon.carbonado.raw">KeyDecoder</a></dt> +<dd> +<div class="block">Decodes an encoded string from the given byte array as originally + encoded for descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GzipCompressor.html#decompress(byte[], int)">decompress(byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GzipCompressor.html" title="class in com.amazon.carbonado.raw">GzipCompressor</a></dt> +<dd> +<div class="block">Decodes from compressed form.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawUtil.html#decrement(byte[])">decrement(byte[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawUtil.html" title="class in com.amazon.carbonado.raw">RawUtil</a></dt> +<dd> +<div class="block">Subtracts one from an unsigned integer, represented as a byte array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html#DEFAULT_INCREMENT">DEFAULT_INCREMENT</a></span> - Static variable in class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence">SequenceValueGenerator</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html#DEFAULT_INITIAL_VALUE">DEFAULT_INITIAL_VALUE</a></span> - Static variable in class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence">SequenceValueGenerator</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html#DEFAULT_RESERVE_AMOUNT">DEFAULT_RESERVE_AMOUNT</a></span> - Static variable in class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueGenerator.html" title="class in com.amazon.carbonado.sequence">SequenceValueGenerator</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#defineCopyBridges(org.cojen.classfile.ClassFile, java.lang.Class)">defineCopyBridges(ClassFile, Class)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Add copy bridge methods for all classes/interfaces between the leaf + (genericised class) and the root (genericised baseclass).</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#definePrepareBridges(org.cojen.classfile.ClassFile, java.lang.Class)">definePrepareBridges(ClassFile, Class)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Add prepare bridge methods for all classes/interfaces between the leaf + (genericised class) and the root (genericised baseclass).</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#definePrepareMethod(org.cojen.classfile.ClassFile, java.lang.Class, org.cojen.classfile.TypeDesc)">definePrepareMethod(ClassFile, Class, TypeDesc)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Defines a Storable prepare method, which assumes that a support field + exists and a single-argument constructor exists which accepts a support + instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#definePrepareMethod(org.cojen.classfile.ClassFile, java.lang.Class, org.cojen.classfile.TypeDesc, java.lang.String, org.cojen.classfile.TypeDesc)">definePrepareMethod(ClassFile, Class, TypeDesc, String, TypeDesc)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Defines a Storable prepare method, which assumes that a support field + exists and a single-argument constructor exists which accepts a support + instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#definePropertyBeanMethods(org.cojen.classfile.ClassFile, com.amazon.carbonado.synthetic.SyntheticProperty)">definePropertyBeanMethods(ClassFile, SyntheticProperty)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> +<div class="block">Add the get & set methods for this property</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">DelegatedQueryExecutor</span></a><<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="type parameter in DelegatedQueryExecutor">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">QueryExecutor which delegates by executing a Query on a Storage.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#DelegatedQueryExecutor(com.amazon.carbonado.Storage, com.amazon.carbonado.qe.QueryExecutor)">DelegatedQueryExecutor(Storage<S>, QueryExecutor<S>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#DelegatedQueryExecutor(com.amazon.carbonado.Storage, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">DelegatedQueryExecutor(Storage<S>, Filter<S>, OrderingList<S>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe"><span class="strong">DelegatedQueryExecutorFactory</span></a><<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="type parameter in DelegatedQueryExecutorFactory">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">QueryExecutorFactory which produces executors which delegate via <a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>DelegatedQueryExecutor</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html#DelegatedQueryExecutorFactory(com.amazon.carbonado.Storage)">DelegatedQueryExecutorFactory(Storage<S>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutorFactory</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen"><span class="strong">DelegateStorableGenerator</span></a><<a href="../com/amazon/carbonado/gen/DelegateStorableGenerator.html" title="type parameter in DelegateStorableGenerator">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></dt> +<dd> +<div class="block">Generates and caches concrete implementations of <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types + which delegate to <a href="../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen"><code>DelegateSupport</code></a>.</div> +</dd> +<dt><a href="../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen"><span class="strong">DelegateSupport</span></a><<a href="../com/amazon/carbonado/gen/DelegateSupport.html" title="type parameter in DelegateSupport">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></dt> +<dd> +<div class="block">Provides runtime support for Storable classes generated by <a href="../com/amazon/carbonado/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen"><code>DelegateStorableGenerator</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#delete()">delete()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Deletes this object from the storage layer by its primary key, + regardless of whether this object has actually been loaded or not.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#DELETE_METHOD_NAME">DELETE_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#deleteAll()">deleteAll()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Does nothing.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#deleteAll(com.amazon.carbonado.Query.Controller)">deleteAll(Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Does nothing.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#deleteAll()">deleteAll()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#deleteAll(com.amazon.carbonado.Query.Controller)">deleteAll(Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#deleteAll()">deleteAll()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Deletes zero or more matching objects.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#deleteAll(com.amazon.carbonado.Query.Controller)">deleteAll(Query.Controller)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Deletes zero or more matching objects.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/LobEngine.html#deleteLob(long)">deleteLob(long)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></dt> +<dd> +<div class="block">Deletes Lob data, freeing up all space consumed by it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/LobEngine.html#deleteLob(com.amazon.carbonado.lob.Lob)">deleteLob(Lob)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></dt> +<dd> +<div class="block">Deletes Lob data, freeing up all space consumed by it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#deleteOne()">deleteOne()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne(Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#deleteOne()">deleteOne()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always throws <a href="../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado"><code>PersistNoneException</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne(Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always throws <a href="../com/amazon/carbonado/PersistNoneException.html" title="class in com.amazon.carbonado"><code>PersistNoneException</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#deleteOne()">deleteOne()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Deletes one matching object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#deleteOne(com.amazon.carbonado.Query.Controller)">deleteOne(Query.Controller)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Deletes one matching object.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Derived.html" title="annotation in com.amazon.carbonado"><span class="strong">Derived</span></a> - Annotation Type in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Identifies a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property which is not directly persisted, but + is instead derived from other property values.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Transaction.html#detach()">detach()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></dt> +<dd> +<div class="block">Detaches this transaction from the current thread.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionPair.html#detach()">detach()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn">TransactionPair</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/gen/DetachedStorableFactory.html" title="class in com.amazon.carbonado.gen"><span class="strong">DetachedStorableFactory</span></a><<a href="../com/amazon/carbonado/gen/DetachedStorableFactory.html" title="type parameter in DetachedStorableFactory">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/gen/package-summary.html">com.amazon.carbonado.gen</a></dt> +<dd> +<div class="block">Creates <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> instances which are basic data containers.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/DetachedStorableFactory.html#DetachedStorableFactory(java.lang.Class)">DetachedStorableFactory(Class<S>)</a></span> - Constructor for class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/DetachedStorableFactory.html" title="class in com.amazon.carbonado.gen">DetachedStorableFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionManager.html#detachLocalScope()">detachLocalScope()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></dt> +<dd> +<div class="block">Detaches the thread-local TransactionScope from the current thread.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionManager.html#detachNotification(Txn)">detachNotification(Txn)</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></dt> +<dd> +<div class="block">Called to notify internal method that transaction is detached.</div> +</dd> +<dt><a href="../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">DifferenceCursor</span></a><<a href="../com/amazon/carbonado/cursor/DifferenceCursor.html" title="type parameter in DifferenceCursor">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Wraps two Cursors and performs an <i>asymmetric set difference</i> + operation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/DifferenceCursor.html#DifferenceCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)">DifferenceCursor(Cursor<S>, Cursor<S>, Comparator<S>)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor">DifferenceCursor</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info"><span class="strong">Direction</span></a> - Enum in <a href="../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></dt> +<dd> +<div class="block">Describes a property sorting direction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/OrderedProperty.html#direction(com.amazon.carbonado.info.Direction)">direction(Direction)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#disableKeyAndValue()">disableKeyAndValue()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">An optimization hint which disables key and value acquisition.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#disableValue()">disableValue()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">An optimization hint which disables just value acquisition.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalForm()">disjunctiveNormalForm()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns an equivalent filter that is in disjunctive normal form.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#disjunctiveNormalFormSplit()">disjunctiveNormalFormSplit()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#disjunctiveNormalFormSplit()">disjunctiveNormalFormSplit()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Splits the filter from its disjunctive normal form.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#disjunctiveNormalFormSplit()">disjunctiveNormalFormSplit()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#disjunctiveNormalFormSplit()">disjunctiveNormalFormSplit()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/MasterStorableGenerator.html#DO_TRY_DELETE_MASTER_METHOD_NAME">DO_TRY_DELETE_MASTER_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen">MasterStorableGenerator</a></dt> +<dd> +<div class="block">Name of protected abstract method in generated storable</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#DO_TRY_DELETE_METHOD_NAME">DO_TRY_DELETE_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Name of protected abstract method in generated storable</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/MasterStorableGenerator.html#DO_TRY_INSERT_MASTER_METHOD_NAME">DO_TRY_INSERT_MASTER_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen">MasterStorableGenerator</a></dt> +<dd> +<div class="block">Name of protected abstract method in generated storable</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#DO_TRY_INSERT_METHOD_NAME">DO_TRY_INSERT_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Name of protected abstract method in generated storable</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/MasterStorableGenerator.html#DO_TRY_LOAD_MASTER_METHOD_NAME">DO_TRY_LOAD_MASTER_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen">MasterStorableGenerator</a></dt> +<dd> +<div class="block">Name of protected abstract method in generated storable</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#DO_TRY_LOAD_METHOD_NAME">DO_TRY_LOAD_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Name of protected abstract method in generated storable</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/MasterStorableGenerator.html#DO_TRY_UPDATE_MASTER_METHOD_NAME">DO_TRY_UPDATE_MASTER_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen">MasterStorableGenerator</a></dt> +<dd> +<div class="block">Name of protected abstract method in generated storable</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#DO_TRY_UPDATE_METHOD_NAME">DO_TRY_UPDATE_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Name of protected abstract method in generated storable</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/ThrowUnchecked.html#doFire(java.lang.Throwable)">doFire(Throwable)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/ThrowUnchecked.html" title="class in com.amazon.carbonado.util">ThrowUnchecked</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/DelegateSupport.html#doTryDelete(S)">doTryDelete(S)</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen">DelegateSupport</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/DelegateSupport.html#doTryInsert(S)">doTryInsert(S)</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen">DelegateSupport</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/DelegateSupport.html#doTryLoad(S)">doTryLoad(S)</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen">DelegateSupport</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/DelegateSupport.html#doTryUpdate(S)">doTryUpdate(S)</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen">DelegateSupport</a></dt> +<dd> </dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-3.html">Prev Letter</a></li> +<li><a href="index-5.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-4.html" target="_top">Frames</a></li> +<li><a href="index-4.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-5.html b/apidocs/index-files/index-5.html new file mode 100644 index 0000000..96ebc50 --- /dev/null +++ b/apidocs/index-files/index-5.html @@ -0,0 +1,764 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>E-Index (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="E-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-4.html">Prev Letter</a></li> +<li><a href="index-6.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-5.html" target="_top">Frames</a></li> +<li><a href="index-5.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_E_"> +<!-- --> +</a> +<h2 class="title">E</h2> +<dl> +<dt><a href="../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">EmptyCursor</span></a><<a href="../com/amazon/carbonado/cursor/EmptyCursor.html" title="type parameter in EmptyCursor">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Special cursor implementation that is empty.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryHints.html#emptyHints()">emptyHints()</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#emptyList()">emptyList()</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> +<div class="block">Returns a canonical empty instance.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe"><span class="strong">EmptyQuery</span></a><<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="type parameter in EmptyQuery">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Special query implementation that fetches nothing.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#EmptyQuery(com.amazon.carbonado.qe.QueryFactory, com.amazon.carbonado.qe.OrderingList)">EmptyQuery(QueryFactory<S>, OrderingList<S>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#EmptyQuery(com.amazon.carbonado.qe.QueryFactory, java.lang.String)">EmptyQuery(QueryFactory<S>, String)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#EmptyQuery(com.amazon.carbonado.qe.QueryFactory, java.lang.String...)">EmptyQuery(QueryFactory<S>, String...)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#enableKeyAndValue()">enableKeyAndValue()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Enable key and value acquisition again, after they have been + disabled.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutOptions.html#encode()">encode()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(int, byte[], int)">encode(int, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given signed integer into exactly 4 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Integer, byte[], int)">encode(Integer, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given signed Integer object into exactly 1 or 5 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(long, byte[], int)">encode(long, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given signed long into exactly 8 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Long, byte[], int)">encode(Long, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given signed Long object into exactly 1 or 9 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(byte, byte[], int)">encode(byte, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given signed byte into exactly 1 byte.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Byte, byte[], int)">encode(Byte, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given signed Byte object into exactly 1 or 2 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(short, byte[], int)">encode(short, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given signed short into exactly 2 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Short, byte[], int)">encode(Short, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given signed Short object into exactly 1 or 3 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(char, byte[], int)">encode(char, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given character into exactly 2 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Character, byte[], int)">encode(Character, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given Character object into exactly 1 or 3 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(boolean, byte[], int)">encode(boolean, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given boolean into exactly 1 byte.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Boolean, byte[], int)">encode(Boolean, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given Boolean object into exactly 1 byte.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(float, byte[], int)">encode(float, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given float into exactly 4 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Float, byte[], int)">encode(Float, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given Float object into exactly 4 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(double, byte[], int)">encode(double, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given double into exactly 8 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.Double, byte[], int)">encode(Double, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given Double object into exactly 8 bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(java.math.BigInteger, byte[], int)">encode(BigInteger, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given optional BigInteger into a variable amount of + bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(java.math.BigDecimal, byte[], int)">encode(BigDecimal, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given optional BigDecimal into a variable amount of + bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(byte[], byte[], int)">encode(byte[], byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given optional byte array into a variable amount of + bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(byte[], int, int, byte[], int)">encode(byte[], int, int, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given optional byte array into a variable amount of + bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encode(java.lang.String, byte[], int)">encode(String, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given optional String into a variable amount of bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encode(java.math.BigInteger, byte[], int)">encode(BigInteger, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given optional BigInteger into a variable amount of + bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encode(java.math.BigDecimal, byte[], int)">encode(BigDecimal, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given optional BigDecimal into a variable amount of + bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encode(byte[], byte[], int)">encode(byte[], byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given optional unsigned byte array into a variable amount of + bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encode(byte[], int, int, byte[], int)">encode(byte[], int, int, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given optional unsigned byte array into a variable amount of + bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encode(java.lang.String, byte[], int)">encode(String, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given optional String into a variable amount of bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawStorableGenerator.html#ENCODE_DATA_METHOD_NAME">ENCODE_DATA_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawStorableGenerator.html" title="class in com.amazon.carbonado.raw">RawStorableGenerator</a></dt> +<dd> +<div class="block">Name of protected abstract method in generated storable</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawStorableGenerator.html#ENCODE_KEY_METHOD_NAME">ENCODE_KEY_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawStorableGenerator.html" title="class in com.amazon.carbonado.raw">RawStorableGenerator</a></dt> +<dd> +<div class="block">Name of protected abstract method in generated storable</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#encodeData(S)">encodeData(S)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> +<div class="block">Encode all properties of the storable excluding the primary key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(int, byte[], int)">encodeDesc(int, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given signed integer into exactly 4 bytes for descending + order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.lang.Integer, byte[], int)">encodeDesc(Integer, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given signed Integer object into exactly 1 or 5 bytes for + descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(long, byte[], int)">encodeDesc(long, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given signed long into exactly 8 bytes for descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.lang.Long, byte[], int)">encodeDesc(Long, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given signed Long object into exactly 1 or 9 bytes for + descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(byte, byte[], int)">encodeDesc(byte, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given signed byte into exactly 1 byte for descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.lang.Byte, byte[], int)">encodeDesc(Byte, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given signed Byte object into exactly 1 or 2 bytes for + descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(short, byte[], int)">encodeDesc(short, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given signed short into exactly 2 bytes for descending + order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.lang.Short, byte[], int)">encodeDesc(Short, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given signed Short object into exactly 1 or 3 bytes for + descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(char, byte[], int)">encodeDesc(char, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given character into exactly 2 bytes for descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.lang.Character, byte[], int)">encodeDesc(Character, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given Character object into exactly 1 or 3 bytes for + descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(boolean, byte[], int)">encodeDesc(boolean, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given boolean into exactly 1 byte for descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.lang.Boolean, byte[], int)">encodeDesc(Boolean, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given Boolean object into exactly 1 byte for descending + order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(float, byte[], int)">encodeDesc(float, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given float into exactly 4 bytes for descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.lang.Float, byte[], int)">encodeDesc(Float, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given Float object into exactly 4 bytes for descending + order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(double, byte[], int)">encodeDesc(double, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given double into exactly 8 bytes for descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.lang.Double, byte[], int)">encodeDesc(Double, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given Double object into exactly 8 bytes for descending + order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.math.BigInteger, byte[], int)">encodeDesc(BigInteger, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given optional BigInteger into a variable amount of bytes + for descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.math.BigDecimal, byte[], int)">encodeDesc(BigDecimal, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given optional BigDecimal into a variable amount of bytes + for descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(byte[], byte[], int)">encodeDesc(byte[], byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given optional unsigned byte array into a variable amount of + bytes for descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(byte[], int, int, byte[], int)">encodeDesc(byte[], int, int, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given optional unsigned byte array into a variable amount of + bytes for descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeDesc(java.lang.String, byte[], int)">encodeDesc(String, byte[], int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given optional String into a variable amount of bytes for + descending order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#encodePrimaryKey(S)">encodePrimaryKey(S)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#encodePrimaryKey(java.lang.Object[])">encodePrimaryKey(Object[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#encodePrimaryKey(S)">encodePrimaryKey(S)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#encodePrimaryKey(S, int, int)">encodePrimaryKey(S, int, int)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#encodePrimaryKey(java.lang.Object[])">encodePrimaryKey(Object[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#encodePrimaryKey(java.lang.Object[], int, int)">encodePrimaryKey(Object[], int, int)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKey(S)">encodePrimaryKey(S)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKey(S, int, int)">encodePrimaryKey(S, int, int)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKey(java.lang.Object[])">encodePrimaryKey(Object[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKey(java.lang.Object[], int, int)">encodePrimaryKey(Object[], int, int)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Encode a key by extracting all the primary key properties from the given + storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#encodePrimaryKeyPrefix()">encodePrimaryKeyPrefix()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#encodePrimaryKeyPrefix()">encodePrimaryKeyPrefix()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Encode the primary key for when there are no values, but there may be a + prefix.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html#encodeSearchKey(S)">encodeSearchKey(S)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.SearchKeyFactory</a></dt> +<dd> +<div class="block">Build a search key by extracting all the desired properties from the + given storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html#encodeSearchKey(S, int, int)">encodeSearchKey(S, int, int)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.SearchKeyFactory</a></dt> +<dd> +<div class="block">Build a search key by extracting all the desired properties from the + given storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html#encodeSearchKey(java.lang.Object[])">encodeSearchKey(Object[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.SearchKeyFactory</a></dt> +<dd> +<div class="block">Build a search key by supplying property values without a storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html#encodeSearchKey(java.lang.Object[], int, int)">encodeSearchKey(Object[], int, int)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.SearchKeyFactory</a></dt> +<dd> +<div class="block">Build a search key by supplying property values without a storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html#encodeSearchKeyPrefix()">encodeSearchKeyPrefix()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.SearchKeyFactory</a></dt> +<dd> +<div class="block">Returns the search key for when there are no values.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encodeSingle(byte[], int, int)">encodeSingle(byte[], int, int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given byte array for use when there is only a single + property, whose type is a byte array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleDesc(byte[])">encodeSingleDesc(byte[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given byte array for use when there is only a single + required property, descending order, whose type is a byte array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleDesc(byte[], int, int)">encodeSingleDesc(byte[], int, int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given byte array for use when there is only a single + required property, descending order, whose type is a byte array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encodeSingleNullable(byte[])">encodeSingleNullable(byte[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/DataEncoder.html#encodeSingleNullable(byte[], int, int)">encodeSingleNullable(byte[], int, int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/DataEncoder.html" title="class in com.amazon.carbonado.raw">DataEncoder</a></dt> +<dd> +<div class="block">Encodes the given byte array for use when there is only a single + nullable property, whose type is a byte array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleNullableDesc(byte[])">encodeSingleNullableDesc(byte[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given byte array for use when there is only a single + nullable property, descending order, whose type is a byte array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/KeyEncoder.html#encodeSingleNullableDesc(byte[], int, int)">encodeSingleNullableDesc(byte[], int, int)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/KeyEncoder.html" title="class in com.amazon.carbonado.raw">KeyEncoder</a></dt> +<dd> +<div class="block">Encodes the given byte array for use when there is only a single + nullable property, descending order, whose type is a byte array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#endBackup()">endBackup()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></dt> +<dd> +<div class="block">Resume normal operation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionScope.html#enter(com.amazon.carbonado.IsolationLevel)">enter(IsolationLevel)</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a></dt> +<dd> +<div class="block">Enters a new transaction scope which becomes the active transaction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#ENTER_TRANSACTION_METHOD_NAME">ENTER_TRANSACTION_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Repository API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionMonitor.html#entered(com.amazon.carbonado.Transaction, com.amazon.carbonado.Transaction)">entered(Transaction, Transaction)</a></span> - Method in interface com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn">TransactionMonitor</a></dt> +<dd> +<div class="block">Called by a thread which has just entered a transaction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionScope.html#enterTop(com.amazon.carbonado.IsolationLevel)">enterTop(IsolationLevel)</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a></dt> +<dd> +<div class="block">Enters a new top-level transaction scope which becomes the active + transaction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Repository.html#enterTopTransaction(com.amazon.carbonado.IsolationLevel)">enterTopTransaction(IsolationLevel)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></dt> +<dd> +<div class="block">Causes the current thread to enter a <i>top-level</i> transaction scope + with an explict isolation level.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#enterTopTransaction(com.amazon.carbonado.IsolationLevel)">enterTopTransaction(IsolationLevel)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#enterTransaction(com.amazon.carbonado.IsolationLevel)">enterTransaction(IsolationLevel)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> +<div class="block">Enter a transaction as needed by the standard delete operation, or null + if transactions are not supported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Repository.html#enterTransaction()">enterTransaction()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></dt> +<dd> +<div class="block">Causes the current thread to enter a transaction scope.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Repository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)">enterTransaction(IsolationLevel)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></dt> +<dd> +<div class="block">Causes the current thread to enter a transaction scope with an explict + isolation level.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#enterTransaction()">enterTransaction()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#enterTransaction(com.amazon.carbonado.IsolationLevel)">enterTransaction(IsolationLevel)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorablePropertyMap.html#entrySet()">entrySet()</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">EnvironmentCapability</span></a> - Interface in <a href="../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></dt> +<dd> +<div class="block">Capability to provide direct access to the underlying BDB environment.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#EQUAL_PRIMARY_KEYS_METHOD_NAME">EQUAL_PRIMARY_KEYS_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#EQUAL_PROPERTIES_METHOD_NAME">EQUAL_PROPERTIES_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#equalLayouts(com.amazon.carbonado.layout.Layout)">equalLayouts(Layout)</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns true if the given layout matches this one.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#equalPrimaryKeys(java.lang.Object)">equalPrimaryKeys(Object)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">True if the supported properties which participate in the primary key + are equal.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#equalProperties(java.lang.Object)">equalProperties(Object)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">True if all supported properties for this object are equal.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/AndFilter.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ExistsFilter.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.NotJoined.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OrFilter.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/OrderedProperty.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractBlob.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractClob.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Lob.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dt> +<dd> +<div class="block">Two Lobs are considered equal if the object instances are the same or if + they point to the same content.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryHints.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CompressedEncodingStrategy.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="class in com.amazon.carbonado.raw">CompressedEncodingStrategy</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">True if all properties and fields are equal, but ignoring the state.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#EQUALS_METHOD_NAME">EQUALS_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck(Collection<String>)</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck(Collection<String>)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck(Collection<String>)</a></span> - Method in class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck(Collection<String>)</a></span> - Method in class com.amazon.carbonado.repo.replicated.<a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck(Collection<String>)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#errorCheck(java.util.Collection)">errorCheck(Collection<String>)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></dt> +<dd> +<div class="block">This method is called by assertReady, and subclasses must override to + perform custom checks.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate(StorableIndex<S>, Filter<S>, OrderingList<S>)</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></dt> +<dd> +<div class="block">Evaluates the given index for its filtering and ordering capabilities + against the given filter and order-by properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate(OrderedProperty<S>[], boolean, boolean, Filter<S>, OrderingList<S>)</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></dt> +<dd> +<div class="block">Evaluates the given index properties for its filtering and ordering + capabilities against the given filter and order-by properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter)">evaluate(StorableIndex<S>, Filter<S>)</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Evaluates the given index for its filtering capabilities against the + given filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter)">evaluate(OrderedProperty<S>[], boolean, boolean, Filter<S>)</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Evaluates the given index properties for its filtering capabilities + against the given filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate(StorableIndex<S>, Filter<S>, OrderingList<S>)</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Evaluates the given index for its ordering capabilities against the + given filter and order-by properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate(OrderedProperty<S>[], boolean, boolean, Filter<S>, OrderingList<S>)</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Evaluates the given index properties for its ordering capabilities + against the given filter and order-by properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#EVOLUTION_NONE">EVOLUTION_NONE</a></span> - Static variable in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> +<div class="block">Evolution strategy code</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#EVOLUTION_STANDARD">EVOLUTION_STANDARD</a></span> - Static variable in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> +<div class="block">Evolution strategy code</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIntrospector.html#examine(java.lang.Class)">examine(Class<S>)</a></span> - Static method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">StorableIntrospector</a></dt> +<dd> +<div class="block">Examines the given class and returns a StorableInfo describing it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html#examine(java.lang.Class, javax.sql.DataSource, java.lang.String, java.lang.String)">examine(Class<S>, DataSource, String, String)</a></span> - Static method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCStorableIntrospector</a></dt> +<dd> +<div class="block">Examines the given class and returns a JDBCStorableInfo describing it.</div> +</dd> +<dt><a href="../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi"><span class="strong">ExceptionTransformer</span></a> - Class in <a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></dt> +<dd> +<div class="block">Supports transforming arbitrary exceptions into appropriate repository + exceptions.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/ExceptionTransformer.html#ExceptionTransformer()">ExceptionTransformer()</a></span> - Constructor for class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedure.Call.html#execute()">execute()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a></dt> +<dd> +<div class="block">Executes the call without expecting a reply.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/RepairExecutor.html#execute(java.lang.Runnable)">execute(Runnable)</a></span> - Static method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/RepairExecutor.html" title="class in com.amazon.carbonado.spi">RepairExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/TaskQueueThread.html#execute(java.lang.Runnable)">execute(Runnable)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/TaskQueueThread.html" title="class in com.amazon.carbonado.util">TaskQueueThread</a></dt> +<dd> +<div class="block">Enqueue a task to run.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/TaskQueueThread.html#execute(java.lang.Runnable, long)">execute(Runnable, long)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/TaskQueueThread.html" title="class in com.amazon.carbonado.util">TaskQueueThread</a></dt> +<dd> +<div class="block">Enqueue a task to run.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedure.Call.html#executeAsync()">executeAsync()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a></dt> +<dd> +<div class="block">Executes the call without expecting a reply.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor(Filter<S>, OrderingList<S>, QueryHints)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutorFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryEngine.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor(Filter<S>, OrderingList<S>, QueryHints)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryEngine.html" title="class in com.amazon.carbonado.qe">QueryEngine</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutorCache.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor(Filter<S>, OrderingList<S>, QueryHints)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe">QueryExecutorCache</a></dt> +<dd> +<div class="block">Returns an executor from the cache.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutorFactory.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor(Filter<S>, OrderingList<S>, QueryHints)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a></dt> +<dd> +<div class="block">Returns an executor that handles the given query specification.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#executor()">executor()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> +<div class="block">Returns the executor in use by this query.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#executor(com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">executor(Filter<S>, OrderingList<S>, QueryHints)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer</a></dt> +<dd> +<div class="block">Returns an executor that handles the given query specification.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#executorFactory()">executorFactory()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> +<div class="block">Return a QueryExecutorFactory which is used to get an executor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#exists()">exists()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#exists(com.amazon.carbonado.Query.Controller)">exists(Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#exists()">exists()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#exists(com.amazon.carbonado.Query.Controller)">exists(Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#exists()">exists()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns true if any results are matched by this query.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#exists(com.amazon.carbonado.Query.Controller)">exists(Query.Controller)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns true if any results are matched by this query.</div> +</dd> +<dt><a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter"><span class="strong">ExistsFilter</span></a><<a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></dt> +<dd> +<div class="block">Filter tree node that performs an existence or non-existence test against a + join property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Transaction.html#exit()">exit()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></dt> +<dd> +<div class="block">Closes the current transaction, aborting all changes since the last + commit.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionPair.html#exit()">exit()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn">TransactionPair</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#EXIT_METHOD_NAME">EXIT_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Transaction API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionMonitor.html#exited(com.amazon.carbonado.Transaction, com.amazon.carbonado.Transaction)">exited(Transaction, Transaction)</a></span> - Method in interface com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionMonitor.html" title="interface in com.amazon.carbonado.txn">TransactionMonitor</a></dt> +<dd> +<div class="block">Called by a thread which has just exited a transaction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CompressedEncodingStrategy.html#extraDataDecoding(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable, int, int)">extraDataDecoding(CodeAssembler, LocalVariable, int, int)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="class in com.amazon.carbonado.raw">CompressedEncodingStrategy</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#extraDataDecoding(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable, int, int)">extraDataDecoding(CodeAssembler, LocalVariable, int, int)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Second phase decoding, which does nothing by default.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CompressedEncodingStrategy.html#extraDataEncoding(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable, int, int)">extraDataEncoding(CodeAssembler, LocalVariable, int, int)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="class in com.amazon.carbonado.raw">CompressedEncodingStrategy</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#extraDataEncoding(org.cojen.classfile.CodeAssembler, org.cojen.classfile.LocalVariable, int, int)">extraDataEncoding(CodeAssembler, LocalVariable, int, int)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Second phase encoding, which does nothing by default.</div> +</dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-4.html">Prev Letter</a></li> +<li><a href="index-6.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-5.html" target="_top">Frames</a></li> +<li><a href="index-5.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-6.html b/apidocs/index-files/index-6.html new file mode 100644 index 0000000..46aa04c --- /dev/null +++ b/apidocs/index-files/index-6.html @@ -0,0 +1,588 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>F-Index (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="F-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-5.html">Prev Letter</a></li> +<li><a href="index-7.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-6.html" target="_top">Frames</a></li> +<li><a href="index-6.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_F_"> +<!-- --> +</a> +<h2 class="title">F</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html#failedDelete(S, java.lang.Object)">failedDelete(S, Object)</a></span> - Method in class com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a></dt> +<dd> +<div class="block">Called when a delete operation failed because an exception was + thrown.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#failedDelete(S, java.lang.Object)">failedDelete(S, Object)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#failedDelete(S, java.lang.Object)">failedDelete(S, Object)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called when an delete operation failed because the record was missing or + an exception was thrown.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html#failedInsert(S, java.lang.Object)">failedInsert(S, Object)</a></span> - Method in class com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a></dt> +<dd> +<div class="block">Called when an insert operation failed because an exception was + thrown.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#failedInsert(S, java.lang.Object)">failedInsert(S, Object)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#failedInsert(S, java.lang.Object)">failedInsert(S, Object)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called when an insert operation failed due to a unique constraint + violation or an exception was thrown.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html#failedUpdate(S, java.lang.Object)">failedUpdate(S, Object)</a></span> - Method in class com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/ResyncCapability.Listener.html" title="class in com.amazon.carbonado.capability">ResyncCapability.Listener</a></dt> +<dd> +<div class="block">Called when an update operation failed because an exception was + thrown.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#failedUpdate(S, java.lang.Object)">failedUpdate(S, Object)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.html#failedUpdate(S, java.lang.Object)">failedUpdate(S, Object)</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.html" title="class in com.amazon.carbonado">Trigger</a></dt> +<dd> +<div class="block">Called when an update operation failed because the record was missing or + an exception was thrown.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch(FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch(FilterValues<S>, Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#fetch()">fetch()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns an <a href="../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#fetch(com.amazon.carbonado.Query.Controller)">fetch(Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns an <a href="../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch(FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch(FilterValues<S>, Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch(FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch(FilterValues<S>, Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch(FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch(FilterValues<S>, Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch(FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch(FilterValues<S>, Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/JoinedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch(FilterValues<T>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/JoinedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch(FilterValues<T>, Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch(FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch(FilterValues<S>, Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch(FilterValues<S>)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></dt> +<dd> +<div class="block">Returns a new cursor using the given filter values.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch(FilterValues<S>, Query.Controller)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></dt> +<dd> +<div class="block">Returns a new cursor using the given filter values.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch(FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch(FilterValues<S>, Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#fetch()">fetch()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#fetch(com.amazon.carbonado.Query.Controller)">fetch(Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues)">fetch(FilterValues<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html#fetch(com.amazon.carbonado.filter.FilterValues, com.amazon.carbonado.Query.Controller)">fetch(FilterValues<S>, Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#fetch()">fetch()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Fetches results for this query.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#fetch(com.amazon.carbonado.Query.Controller)">fetch(Query.Controller)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Fetches results for this query.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#FETCH_METHOD_NAME">FETCH_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Query API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#fetchAfter(T)">fetchAfter(T)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#fetchAfter(T, com.amazon.carbonado.Query.Controller)">fetchAfter(T, Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#fetchAfter(T)">fetchAfter(T)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Fetches results for this query after a given starting point, which is + useful for re-opening a cursor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#fetchAfter(T, com.amazon.carbonado.Query.Controller)">fetchAfter(T, Query.Controller)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Fetches results for this query after a given starting point, which is + useful for re-opening a cursor.</div> +</dd> +<dt><a href="../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">FetchAheadCursor</span></a><<a href="../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="type parameter in FetchAheadCursor">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Cursor implementation which fetches records in advance, in order to release locks.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/FetchAheadCursor.html#FetchAheadCursor(com.amazon.carbonado.Cursor, int)">FetchAheadCursor(Cursor<S>, int)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="class in com.amazon.carbonado.cursor">FetchAheadCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#fetchAll()">fetchAll()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a></dt> +<dd> +<div class="block">Perform a full scan of all Storables.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#fetchAll(com.amazon.carbonado.Query.Controller)">fetchAll(Query.Controller)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a></dt> +<dd> +<div class="block">Perform a full scan of all Storables.</div> +</dd> +<dt><a href="../com/amazon/carbonado/FetchDeadlockException.html" title="class in com.amazon.carbonado"><span class="strong">FetchDeadlockException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Thrown if a fetch operation fails because it was selected to resolve a + deadlock.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchDeadlockException.html#FetchDeadlockException()">FetchDeadlockException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchDeadlockException.html" title="class in com.amazon.carbonado">FetchDeadlockException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchDeadlockException.html#FetchDeadlockException(java.lang.String)">FetchDeadlockException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchDeadlockException.html" title="class in com.amazon.carbonado">FetchDeadlockException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchDeadlockException.html#FetchDeadlockException(java.lang.String, java.lang.Throwable)">FetchDeadlockException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchDeadlockException.html" title="class in com.amazon.carbonado">FetchDeadlockException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchDeadlockException.html#FetchDeadlockException(java.lang.Throwable)">FetchDeadlockException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchDeadlockException.html" title="class in com.amazon.carbonado">FetchDeadlockException</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado"><span class="strong">FetchException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">A FetchException is caused by a failure when selecting records from a <a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchException.html#FetchException()">FetchException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchException.html#FetchException(java.lang.String)">FetchException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchException.html#FetchException(java.lang.String, java.lang.Throwable)">FetchException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchException.html#FetchException(java.lang.Throwable)">FetchException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchException.html" title="class in com.amazon.carbonado">FetchException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query)">fetchFromIndexEntryQuery(StorableIndex<S>, Query<?>)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a></dt> +<dd> +<div class="block">Fetch Storables referenced by the given index entry query.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query, com.amazon.carbonado.Query.Controller)">fetchFromIndexEntryQuery(StorableIndex<S>, Query<?>, Query.Controller)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a></dt> +<dd> +<div class="block">Fetch Storables referenced by the given index entry query.</div> +</dd> +<dt><a href="../com/amazon/carbonado/FetchInterruptedException.html" title="class in com.amazon.carbonado"><span class="strong">FetchInterruptedException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Thrown from a fetch operation that was canceled.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchInterruptedException.html#FetchInterruptedException()">FetchInterruptedException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchInterruptedException.html" title="class in com.amazon.carbonado">FetchInterruptedException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchInterruptedException.html#FetchInterruptedException(java.lang.String)">FetchInterruptedException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchInterruptedException.html" title="class in com.amazon.carbonado">FetchInterruptedException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchInterruptedException.html#FetchInterruptedException(java.lang.String, java.lang.Throwable)">FetchInterruptedException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchInterruptedException.html" title="class in com.amazon.carbonado">FetchInterruptedException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchInterruptedException.html#FetchInterruptedException(java.lang.Throwable)">FetchInterruptedException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchInterruptedException.html" title="class in com.amazon.carbonado">FetchInterruptedException</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado"><span class="strong">FetchMultipleException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">A FetchMultipleException is thrown when a fetch operation returned more + than one record when at most one was expected.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchMultipleException.html#FetchMultipleException()">FetchMultipleException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchMultipleException.html#FetchMultipleException(java.lang.String)">FetchMultipleException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchMultipleException.html#FetchMultipleException(java.lang.String, java.lang.Throwable)">FetchMultipleException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchMultipleException.html#FetchMultipleException(java.lang.Throwable)">FetchMultipleException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchMultipleException.html" title="class in com.amazon.carbonado">FetchMultipleException</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado"><span class="strong">FetchNoneException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">A FetchNoneException is thrown when a fetch operation returned no records + when at least one was expected.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchNoneException.html#FetchNoneException()">FetchNoneException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchNoneException.html#FetchNoneException(java.lang.String)">FetchNoneException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchNoneException.html#FetchNoneException(java.lang.String, java.lang.Throwable)">FetchNoneException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchNoneException.html#FetchNoneException(java.lang.Throwable)">FetchNoneException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchNoneException.html" title="class in com.amazon.carbonado">FetchNoneException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html#fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[])">fetchOne(StorableIndex<S>, Object[])</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a></dt> +<dd> +<div class="block">Select at most one Storable referenced by an index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html#fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.Query.Controller)">fetchOne(StorableIndex<S>, Object[], Query.Controller)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a></dt> +<dd> +<div class="block">Select at most one Storable referenced by an index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedure.Call.html#fetchReply()">fetchReply()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a></dt> +<dd> +<div class="block">Executes the call and receive a reply.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice(FilterValues<S>, long, Long)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></dt> +<dd> +<div class="block">Produces a slice via skip and limit cursors.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice(FilterValues<S>, long, Long, Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></dt> +<dd> +<div class="block">Produces a slice via skip and limit cursors.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice(FilterValues<S>, long, Long)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice(FilterValues<S>, long, Long, Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#fetchSlice(long, java.lang.Long)">fetchSlice(long, Long)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns an <a href="../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice(long, Long, Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns an <a href="../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor"><code>EmptyCursor</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long)">fetchSlice(FilterValues<S>, long, Long)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></dt> +<dd> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutor.html#fetchSlice(com.amazon.carbonado.filter.FilterValues, long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice(FilterValues<S>, long, Long, Query.Controller)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></dt> +<dd> +<div class="block">Returns a new cursor using the given filter values and slice.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#fetchSlice(long, java.lang.Long)">fetchSlice(long, Long)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice(long, Long, Query.Controller)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#fetchSlice(long, java.lang.Long)">fetchSlice(long, Long)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Fetches a slice of results for this query, as defined by a numerical + range.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#fetchSlice(long, java.lang.Long, com.amazon.carbonado.Query.Controller)">fetchSlice(long, Long, Query.Controller)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Fetches a slice of results for this query, as defined by a numerical + range.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean)">fetchSubset(StorableIndex<S>, Object[], BoundaryType, Object, BoundaryType, Object, boolean, boolean)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a></dt> +<dd> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean, com.amazon.carbonado.Query.Controller)">fetchSubset(StorableIndex<S>, Object[], BoundaryType, Object, BoundaryType, Object, boolean, boolean, Query.Controller)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a></dt> +<dd> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index.</div> +</dd> +<dt><a href="../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado"><span class="strong">FetchTimeoutException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Thrown if a fetch operation fails because lock acquisition timed out.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchTimeoutException.html#FetchTimeoutException()">FetchTimeoutException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado">FetchTimeoutException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchTimeoutException.html#FetchTimeoutException(java.lang.String)">FetchTimeoutException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado">FetchTimeoutException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchTimeoutException.html#FetchTimeoutException(java.lang.String, java.lang.Throwable)">FetchTimeoutException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado">FetchTimeoutException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/FetchTimeoutException.html#FetchTimeoutException(java.lang.Throwable)">FetchTimeoutException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/FetchTimeoutException.html" title="class in com.amazon.carbonado">FetchTimeoutException</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob"><span class="strong">FileBlob</span></a> - Class in <a href="../com/amazon/carbonado/lob/package-summary.html">com.amazon.carbonado.lob</a></dt> +<dd> +<div class="block">Implementation of a Blob which is backed by a File.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/FileBlob.html#FileBlob(java.io.File)">FileBlob(File)</a></span> - Constructor for class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Trigger.Abort.html#fillInStackTrace()">fillInStackTrace()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/Trigger.Abort.html" title="class in com.amazon.carbonado">Trigger.Abort</a></dt> +<dd> +<div class="block">Override to remove the stack trace.</div> +</dd> +<dt><a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter"><span class="strong">Filter</span></a><<a href="../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></dt> +<dd> +<div class="block">An immutable tree structure representing a query result filter.</div> +</dd> +<dt><a href="../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter"><span class="strong">Filter.NotJoined</span></a> - Class in <a href="../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></dt> +<dd> +<div class="block">Result from calling <a href="../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(java.lang.String)"><code>Filter.notJoinedFrom(java.lang.String)</code></a>.</div> +</dd> +<dt><a href="../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">FilteredCursor</span></a><<a href="../com/amazon/carbonado/cursor/FilteredCursor.html" title="type parameter in FilteredCursor">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Wraps another cursor and applies custom filtering to reduce the set of + results.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/FilteredCursor.html#FilteredCursor(com.amazon.carbonado.Cursor)">FilteredCursor(Cursor<S>)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor">FilteredCursor</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">FilteredQueryExecutor</span></a><<a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="type parameter in FilteredQueryExecutor">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">QueryExecutor which wraps another and filters results.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html#FilteredQueryExecutor(com.amazon.carbonado.qe.QueryExecutor, com.amazon.carbonado.filter.Filter)">FilteredQueryExecutor(QueryExecutor<S>, Filter<S>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#filterFor(java.lang.Class, java.lang.String)">filterFor(Class<S>, String)</a></span> - Static method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns a cached filter instance that operates on the given type and + filter expression.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe"><span class="strong">FilteringScore</span></a><<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="type parameter in FilteringScore">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Evaluates an index for how well it matches a query's desired filtering.</div> +</dd> +<dt><a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter"><span class="strong">FilterValues</span></a><<a href="../com/amazon/carbonado/filter/FilterValues.html" title="type parameter in FilterValues">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></dt> +<dd> +<div class="block">Assigns values to <a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter"><code>Filter</code></a> placeholders.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html#findAdaptMethod(java.lang.Class, java.lang.Class)">findAdaptMethod(Class, Class)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></dt> +<dd> +<div class="block">Returns an adapt method that supports the given conversion, or null if + none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html#findAdaptMethodsFrom(java.lang.Class)">findAdaptMethodsFrom(Class)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></dt> +<dd> +<div class="block">Returns all the adapt methods that convert from the given type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html#findAdaptMethodsTo(java.lang.Class)">findAdaptMethodsTo(Class)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></dt> +<dd> +<div class="block">Returns all the adapt methods that convert to the given type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorableIndexSet.html#findKeyIndex(com.amazon.carbonado.info.StorableKey)">findKeyIndex(StorableKey<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></dt> +<dd> +<div class="block">Finds the best index to represent the given key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorableIndexSet.html#findPrimaryKeyIndex(com.amazon.carbonado.info.StorableInfo)">findPrimaryKeyIndex(StorableInfo<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></dt> +<dd> +<div class="block">Finds the best index to represent the primary key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#finish()">finish()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a></dt> +<dd> +<div class="block">Finish the reply.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedure.Request.html#finish()">finish()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedure.Request.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Request</a></dt> +<dd> +<div class="block">Reply and immediately finish, without sending any data to caller.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/GroupedCursor.html#finishGroup()">finishGroup()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor">GroupedCursor</a></dt> +<dd> +<div class="block">This method is called when a group is finished, and it can return an + aggregate.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/ThrowUnchecked.html#fire(java.lang.Throwable)">fire(Throwable)</a></span> - Static method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/ThrowUnchecked.html" title="class in com.amazon.carbonado.util">ThrowUnchecked</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> +<div class="block">Throws the given exception, even though it may be checked.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/ThrowUnchecked.html#fireCause(java.lang.Throwable)">fireCause(Throwable)</a></span> - Static method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/ThrowUnchecked.html" title="class in com.amazon.carbonado.util">ThrowUnchecked</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> +<div class="block">Throws the cause of the given exception, even though it may be + checked.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/ThrowUnchecked.html#fireDeclared(java.lang.Throwable, java.lang.Class...)">fireDeclared(Throwable, Class...)</a></span> - Static method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/ThrowUnchecked.html" title="class in com.amazon.carbonado.util">ThrowUnchecked</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> +<div class="block">Throws the given exception if it is unchecked or an instance of any of + the given declared types.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/ThrowUnchecked.html#fireDeclaredCause(java.lang.Throwable, java.lang.Class...)">fireDeclaredCause(Throwable, Class...)</a></span> - Static method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/ThrowUnchecked.html" title="class in com.amazon.carbonado.util">ThrowUnchecked</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> +<div class="block">Throws the cause of the given exception if it is unchecked or an + instance of any of the given declared types.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/ThrowUnchecked.html#fireDeclaredRootCause(java.lang.Throwable, java.lang.Class...)">fireDeclaredRootCause(Throwable, Class...)</a></span> - Static method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/ThrowUnchecked.html" title="class in com.amazon.carbonado.util">ThrowUnchecked</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> +<div class="block">Throws the root cause of the given exception if it is unchecked or an + instance of any of the given declared types.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/ThrowUnchecked.html#fireFirstDeclared(java.lang.Throwable, java.lang.Class...)">fireFirstDeclared(Throwable, Class...)</a></span> - Static method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/ThrowUnchecked.html" title="class in com.amazon.carbonado.util">ThrowUnchecked</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> +<div class="block">Throws the either the original exception or the first found cause if it + matches one of the given declared types or is unchecked.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/ThrowUnchecked.html#fireFirstDeclaredCause(java.lang.Throwable, java.lang.Class...)">fireFirstDeclaredCause(Throwable, Class...)</a></span> - Static method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/ThrowUnchecked.html" title="class in com.amazon.carbonado.util">ThrowUnchecked</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> +<div class="block">Throws the first found cause that matches one of the given declared + types or is unchecked.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/ThrowUnchecked.html#fireRootCause(java.lang.Throwable)">fireRootCause(Throwable)</a></span> - Static method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/ThrowUnchecked.html" title="class in com.amazon.carbonado.util">ThrowUnchecked</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> +<div class="block">Throws the root cause of the given exception, even though it may be + checked.</div> +</dd> +<dt><a href="../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">FloatConstraint</span></a> - Annotation Type in <a href="../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></dt> +<dd> +<div class="block">Limits the value of a property to be a member of a specific set.</div> +</dd> +<dt><a href="../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">FloatConstraint.Constraint</span></a> - Class in <a href="../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></dt> +<dd> +<div class="block">Constraint implementation for <a href="../com/amazon/carbonado/constraint/FloatConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>FloatConstraint</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html#FloatConstraint.Constraint(java.lang.Class, java.lang.String, com.amazon.carbonado.constraint.FloatConstraint)">FloatConstraint.Constraint(Class<?>, String, FloatConstraint)</a></span> - Constructor for class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">FloatConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html#FloatConstraint.Constraint(java.lang.Class, java.lang.String, double, double, double[], double[])">FloatConstraint.Constraint(Class<?>, String, double, double, double[], double[])</a></span> - Constructor for class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/FloatConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">FloatConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedure.Call.html#flush()">flush()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedure.Call.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Call</a></dt> +<dd> +<div class="block">Flushes all the data sent so far.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedure.Reply.html#flush()">flush()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedure.Reply.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure.Reply</a></dt> +<dd> +<div class="block">Flushes all the data sent so far.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html#forceCheckpoint()">forceCheckpoint()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/CheckpointCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">CheckpointCapability</a></dt> +<dd> +<div class="block">Forces a checkpoint to run now, even if checkpointer is suspended or + disabled.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBProduct.html#forString(java.lang.String)">forString(String)</a></span> - Static method in enum com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBProduct.html" title="enum in com.amazon.carbonado.repo.sleepycat">BDBProduct</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableCopier.html#from(java.lang.Class)">from(Class<S>)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableCopier.html" title="class in com.amazon.carbonado.gen">StorableCopier</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/Direction.html#fromCharacter(char)">fromCharacter(char)</a></span> - Static method in enum com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></dt> +<dd> +<div class="block">Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything + else.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/CompositeScore.html#fullComparator()">fullComparator()</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></dt> +<dd> +<div class="block">Returns a comparator which determines which CompositeScores are + better.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/CompositeScore.html#fullComparator(com.amazon.carbonado.qe.QueryHints)">fullComparator(QueryHints)</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></dt> +<dd> +<div class="block">Returns a comparator which determines which CompositeScores are + better.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#fullComparator()">fullComparator()</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns a comparator which determines which FilteringScores are + better.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#fullComparator()">fullComparator()</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns a comparator which determines which OrderingScores are + better.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">FullScanQueryExecutor</span></a><<a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="type parameter in FullScanQueryExecutor">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">QueryExecutor which fully scans all Storables of a given type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html#FullScanQueryExecutor(com.amazon.carbonado.qe.FullScanQueryExecutor.Support)">FullScanQueryExecutor(FullScanQueryExecutor.Support<S>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">FullScanQueryExecutor.Support</span></a><<a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="type parameter in FullScanQueryExecutor.Support">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Provides support for <a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>FullScanQueryExecutor</code></a>.</div> +</dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-5.html">Prev Letter</a></li> +<li><a href="index-7.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-6.html" target="_top">Frames</a></li> +<li><a href="index-6.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-7.html b/apidocs/index-files/index-7.html new file mode 100644 index 0000000..d2b4ac9 --- /dev/null +++ b/apidocs/index-files/index-7.html @@ -0,0 +1,2226 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>G-Index (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="G-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-6.html">Prev Letter</a></li> +<li><a href="index-8.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-7.html" target="_top">Frames</a></li> +<li><a href="index-7.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_G_"> +<!-- --> +</a> +<h2 class="title">G</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#gatherAllBridgeTypes(java.util.Set, java.lang.Class)">gatherAllBridgeTypes(Set<Class>, Class)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Collect a set of all the interfaces and recursively all superclasses for the leaf + (genericised class) and root (genericised base class).</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#gatherAllDataProperties()">gatherAllDataProperties()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Returns all non-derived data properties for storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#gatherAllKeyProperties()">gatherAllKeyProperties()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Returns all key properties as ordered properties, possibly with + unspecified directions.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#gatherAllProperties()">gatherAllProperties()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Returns all non-join, non-derived properties for storable.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw"><span class="strong">GenericEncodingStrategy</span></a><<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Generates bytecode instructions for encoding/decoding Storable properties + to/from raw bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#GenericEncodingStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex)">GenericEncodingStrategy(Class<S>, StorableIndex<S>)</a></span> - Constructor for class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#GenericEncodingStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, int, int, int, int)">GenericEncodingStrategy(Class<S>, StorableIndex<S>, int, int, int, int)</a></span> - Constructor for class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/raw/GenericInstanceFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">GenericInstanceFactory</span></a> - Interface in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Can be used with <a href="../com/amazon/carbonado/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util"><code>QuickConstructorGenerator</code></a> + for instantiating generic storable instances.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw"><span class="strong">GenericPropertyInfo</span></a> - Interface in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Minimal information required by <a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw"><code>GenericEncodingStrategy</code></a> to encode + and decode a storable property.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw"><span class="strong">GenericStorableCodec</span></a><<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Generic codec that supports any kind of storable by auto-generating and + caching storable implementations.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw"><span class="strong">GenericStorableCodec.Decoder</span></a><<a href="../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="type parameter in GenericStorableCodec.Decoder">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Used for decoding different generations of Storable.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">GenericStorableCodec.SearchKeyFactory</span></a><<a href="../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="type parameter in GenericStorableCodec.SearchKeyFactory">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Creates custom raw search keys for <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw"><span class="strong">GenericStorableCodecFactory</span></a> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Factory for generic codec that supports any kind of storable by + auto-generating and caching storable implementations.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#GenericStorableCodecFactory()">GenericStorableCodecFactory()</a></span> - Constructor for class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorablePropertyMap.html#get(java.lang.Object)">get(Object)</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty)">get(StorableProperty<S>)</a></span> - Static method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns a canonical instance which has no chain.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty...)">get(StorableProperty<S>, StorableProperty<?>...)</a></span> - Static method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns a canonical instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty[], boolean[])">get(StorableProperty<S>, StorableProperty<?>[], boolean[])</a></span> - Static method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns a canonical instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">get(StorableProperty<S>, Direction)</a></span> - Static method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></dt> +<dd> +<div class="block">Returns a canonical instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.info.Direction)">get(ChainedProperty<S>, Direction)</a></span> - Static method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></dt> +<dd> +<div class="block">Returns a canonical instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#get(java.lang.Class, java.lang.String)">get(Class<S>, String)</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> +<div class="block">Returns a canonical instance composed of the given ordering.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#get(java.lang.Class, java.lang.String...)">get(Class<S>, String...)</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#get(com.amazon.carbonado.info.OrderedProperty...)">get(OrderedProperty<S>...)</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#get(java.util.List)">get(List<OrderedProperty<S>>)</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#get(int)">get(int)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryHints.html#get(com.amazon.carbonado.qe.QueryHint)">get(QueryHint)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></dt> +<dd> +<div class="block">Returns null if hint is not provided.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueProducerPool.html#get(java.lang.String)">get(String)</a></span> - Method in class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueProducerPool.html" title="class in com.amazon.carbonado.sequence">SequenceValueProducerPool</a></dt> +<dd> +<div class="block">Returns a SequenceValueProducer instance for the given name, which is + lazily created and pooled.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AbstractPool.html#get(K)">get(K)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a></dt> +<dd> +<div class="block">Returns a value for the given key, which is lazily created and + pooled.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/BelatedCreator.html#get(int)">get(int)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a></dt> +<dd> +<div class="block">Returns real or bogus object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/SoftValuedCache.html#get(K)">get(K)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#GET_PROPERTY_VALUE">GET_PROPERTY_VALUE</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#GET_TRANSACTION_ISOLATION_LEVEL_METHOD_NAME">GET_TRANSACTION_ISOLATION_LEVEL_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Repository API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/MasterStorableGenerator.html#getAbstractClass(java.lang.Class, java.util.EnumSet)">getAbstractClass(Class<S>, EnumSet<MasterFeature>)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen">MasterStorableGenerator</a></dt> +<dd> +<div class="block">Returns an abstract implementation of the given Storable type, which + is fully thread-safe.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#getAbstractClass(java.lang.Class)">getAbstractClass(Class<S>)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Returns an abstract implementation of the given Storable type, which is + fully thread-safe.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawStorableGenerator.html#getAbstractClass(java.lang.Class, boolean)">getAbstractClass(Class<S>, boolean)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawStorableGenerator.html" title="class in com.amazon.carbonado.raw">RawStorableGenerator</a></dt> +<dd> +<div class="block">Returns an abstract implementation of the given Storable type, which is + fully thread-safe.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#getAccessorAnnotationDescriptors()">getAccessorAnnotationDescriptors()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> +<div class="block">Returns all the added accessor annotation descriptors in an unmodifiable list.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#getActualRepositoryBuilder()">getActualRepositoryBuilder()</a></span> - Method in class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the Repository that all calls are wrapped to.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getAdapter()">getAdapter()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns this property's adapter, or null if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#getAdapter()">getAdapter()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdapterConstructor()">getAdapterConstructor()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></dt> +<dd> +<div class="block">Returns the constructor for the adapter class.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdapterInstance()">getAdapterInstance()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></dt> +<dd> +<div class="block">Returns an instance of the adapter, for which an adapt method is applied to.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#getAdapterParams()">getAdapterParams()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> +<div class="block">Parameters for adapter, or null if property has no explicit adapter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#getAdapterParams()">getAdapterParams()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> +<div class="block">Parameters for adapter, or null if property has no explicit adapter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#getAdapterTypeName()">getAdapterTypeName()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> +<div class="block">Adapter type name is a fully qualified Java class name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#getAdapterTypeName()">getAdapterTypeName()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> +<div class="block">Adapter type name is a fully qualified Java class name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdaptMethod(int)">getAdaptMethod(int)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></dt> +<dd> +<div class="block">Returns a specific adapt method.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdaptMethodCount()">getAdaptMethodCount()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></dt> +<dd> +<div class="block">Returns the count of all defined adapt methods.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdaptMethods()">getAdaptMethods()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></dt> +<dd> +<div class="block">Returns a new array with all the adapt methods in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getAlias(int)">getAlias(int)</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns a specific alias for the Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getAlias(int)">getAlias(int)</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a specific alias for this property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getAliasCount()">getAliasCount()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns the count of aliases for the Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getAliasCount()">getAliasCount()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the count of aliases for this property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getAliases()">getAliases()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns a new array with all the alias names in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getAliases()">getAliases()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a new array with all the alias names in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorageAccess.html#getAllIndexes()">getAllIndexes()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a></dt> +<dd> +<div class="block">Returns all the available indexes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getAllProperties()">getAllProperties()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns all the storable properties in an unmodifiable map.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getAllProperties()">getAllProperties()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns all the properties of this layout, in their proper order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#getAllProperties()">getAllProperties()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> +<div class="block">Convenient access to all the storable properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getAllProperties()">getAllProperties()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getAlternateKey(int)">getAlternateKey(int)</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns a specific alternate key for the Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getAlternateKeyCount()">getAlternateKeyCount()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns the count of alternate keys for the Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getAlternateKeys()">getAlternateKeys()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns a new array with all the alternate keys in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAnnotation.html#getAnnotatedMethod()">getAnnotatedMethod()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></dt> +<dd> +<div class="block">Returns the method that has the annotation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAnnotation()">getAnnotation()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></dt> +<dd> +<div class="block">Returns the annotation that applied this adapter, or null if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAnnotation.html#getAnnotation()">getAnnotation()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></dt> +<dd> +<div class="block">Returns the actual annotation instance, which may be null if annotation + was automatically applied.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyConstraint.html#getAnnotation()">getAnnotation()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a></dt> +<dd> +<div class="block">Returns the annotation that applied this constraint.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAnnotation.html#getAnnotationType()">getAnnotationType()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></dt> +<dd> +<div class="block">Returns the type of annotation that was applied to the property method.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getAppliedAdapter()">getAppliedAdapter()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns the adapter that needs to be applied to properties returned from + ResultSets and set into PreparedStatements.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getArrangementScore()">getArrangementScore()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns a value which indicates how well the index property order + matches the property filter specification order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#getAssignedValue(com.amazon.carbonado.filter.PropertyFilter)">getAssignedValue(PropertyFilter<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns the value assigned to the given PropertyFilter, throwing an + exception if not assigned.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getBDBProduct()">getBDBProduct()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the BDB product to use, which is JE by default.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html#getBDBProduct()">getBDBProduct()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">EnvironmentCapability</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getBeanName()">getBeanName()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the bean name of this property, which is derived from the read + and write method names.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#getBindID()">getBindID()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> +<div class="block">Bind ID is used to distinguish this PropertyFilter instance from another + against the same property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#getBlankParameterCount()">getBlankParameterCount()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns the amount of values yet to be assigned.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#getBlankParameterCount()">getBlankParameterCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns zero.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#getBlankParameterCount()">getBlankParameterCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#getBlankParameterCount()">getBlankParameterCount()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns the amount of blank parameters that need to be filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawSupport.html#getBlob(S, java.lang.String, long)">getBlob(S, String, long)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></dt> +<dd> +<div class="block">Returns the Blob for the given locator, returning null if not found.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/LobEngine.html#getBlobValue(long)">getBlobValue(long)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></dt> +<dd> +<div class="block">Loads a Blob value, without checking if it exists or not.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.html#getBlockCount()">getBlockCount()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></dt> +<dd> +<div class="block">Returns number of blocks required to store Lob.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.Block.html#getBlockNumber()">getBlockNumber()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></dt> +<dd> +<div class="block">First block number is logically zero, but subtract 0x80000000 to get + actual number.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.html#getBlockSize()">getBlockSize()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#getBoxedType()">getBoxedType()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> +<div class="block">Returns the type of the ChainedProperty property, boxed into an object + if primitive.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCachePercent()">getCachePercent()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the percent of JVM heap used by the repository cache, or + null if default should be selected.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCacheSize()">getCacheSize()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the repository cache size, or null if default should be + selected.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Repository.html#getCapability(java.lang.Class)">getCapability(Class<C>)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></dt> +<dd> +<div class="block">Requests a specific capability of this Repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#getCapability(java.lang.Class)">getCapability(Class<C>)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> +<div class="block">Default implementation checks if Repository implements Capability + interface, and if so, returns the Repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getCatalog()">getCatalog()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the optional catalog to search for metadata.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getCatalogName()">getCatalogName()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> +<div class="block">Returns the optional catalog name for the Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#getChainCount()">getChainCount()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns amount of properties chained from prime property, which may be + zero.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ExistsFilter.html#getChainedProperty()">getChainedProperty()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></dt> +<dd> +<div class="block">Returns the join property that is being checked for existence or + non-existence.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#getChainedProperty()">getChainedProperty()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#getChainedProperty(int)">getChainedProperty(int)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/OrderedProperty.html#getChainedProperty()">getChainedProperty()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getCharOctetLength()">getCharOctetLength()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns the maximum amount of bytes for property value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCheckpointInterval()">getCheckpointInterval()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCheckpointThresholdKB()">getCheckpointThresholdKB()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCheckpointThresholdMinutes()">getCheckpointThresholdMinutes()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getChecksumEnabled()">getChecksumEnabled()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if checksum verification is enabled.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/ClassFileBuilder.html#getClassFile()">getClassFile()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#getClassNameProvider()">getClassNameProvider()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawSupport.html#getClob(S, java.lang.String, long)">getClob(S, String, long)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></dt> +<dd> +<div class="block">Returns the Clob for the given locator, returning null if not found.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/LobEngine.html#getClobValue(long)">getClobValue(long)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></dt> +<dd> +<div class="block">Loads a Clob value, without checking if it exists or not.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#getClosedFilter(java.lang.Class)">getClosedFilter(Class<S>)</a></span> - Static method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns a cached filter instance that operates on the given type, which + prevents any results from passing through.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getColumnName()">getColumnName()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns the table column for this property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getColumnSize()">getColumnSize()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">The column size is either the maximum number of characters or the + numeric precision.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#getComparator()">getComparator()</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a></dt> +<dd> +<div class="block">Returns a comparator for ordering index entries.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#getComparator()">getComparator()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceAccess</a></dt> +<dd> +<div class="block">Returns a comparator for ordering storable reference instances.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#getComparator()">getComparator()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>call getReferenceAccess</i></div> +</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getCompositeScore()">getCompositeScore()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns the score on how well the selected index performs the + desired filtering and ordering.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutOptions.html#getCompressionType()">getCompressionType()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#getCompressionType(java.lang.Class)">getCompressionType(Class<? extends Storable>)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CompressedStorableCodecFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCompressor(java.lang.String)">getCompressor(String)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Return the compressor used for the given storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#getConnection()">getConnection()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></dt> +<dd> +<div class="block">Any connection returned by this method must be closed by calling + yieldConnection.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#getConnection()">getConnection()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#getConnection(java.lang.String, java.lang.String)">getConnection(String, String)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#getConnection()">getConnection()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#getConnection(java.lang.String, java.lang.String)">getConnection(String, String)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getConstantKeyPrefixLength()">getConstantKeyPrefixLength()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Returns amount of prefix key bytes that encoding strategy instance + produces which are always the same.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyConstraint.html#getConstrainMethod()">getConstrainMethod()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a></dt> +<dd> +<div class="block">Returns the best matching property checking method in the validator.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getConstraint(int)">getConstraint(int)</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a specific constraint for this property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyConstraint.html#getConstraintConstructor()">getConstraintConstructor()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a></dt> +<dd> +<div class="block">Returns the constructor for the constraint class.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getConstraintCount()">getConstraintCount()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the count of constraints for this property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getConstraints()">getConstraints()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a new array with all the constraints in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getCovariantTypes()">getCovariantTypes()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns additional types of this property, all of which are assignable + by the primary type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getCoveringCount()">getCoveringCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns number of covering property filters which are supported by the + evaluated index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getCoveringFilter()">getCoveringFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the composite covering filter supported by the evaluated index, + or null if the covering count is zero.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getCoveringFilter()">getCoveringFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getCoveringFilters()">getCoveringFilters()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the covering filters which are supported by the evaluated index, + which is a subset of the remainder filters.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getCoveringRemainderFilter()">getCoveringRemainderFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the composite remainder filter without including the covering + filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getCreationDateTime()">getCreationDateTime()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns the date and time for when this layout generation was created.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getCreationHost()">getCreationHost()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns the host machine that created this generation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#getCreationHost()">getCreationHost()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> +<div class="block">Returns the host machine that created this generation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#getCreationTimestamp()">getCreationTimestamp()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> +<div class="block">Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getCreationTimestamp()">getCreationTimestamp()</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></dt> +<dd> +<div class="block">Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getCreationTimestamp()">getCreationTimestamp()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> +<div class="block">Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getCreationUser()">getCreationUser()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns the user that created this layout generation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#getCreationUser()">getCreationUser()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> +<div class="block">Returns the user that created this generation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedFilterException.html#getCulpritIndex()">getCulpritIndex()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado">MalformedFilterException</a></dt> +<dd> +<div class="block">Returns the index into the query filter string that is malformed, or a + negative value if not known.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#getCurrentKey()">getCurrentKey()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Returns the contents of the current key being referenced, or null + otherwise.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#getCurrentValue()">getCurrentValue()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Returns the contents of the current value being referenced, or null + otherwise.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.Block.html#getData()">getData()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getDatabaseHook()">getDatabaseHook()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the custom open database hook, or null if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getDatabaseName()">getDatabaseName()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#getDatabaseProductName()">getDatabaseProductName()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></dt> +<dd> +<div class="block">Returns the name of the database product connected to.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getDatabasesTransactional()">getDatabasesTransactional()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if the databases are configured to be transactional, + false if configured to not be transactional, null if this override was never set</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#getDataFiles()">getDataFiles()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></dt> +<dd> +<div class="block">Returns all the data files to be copied.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getDataHome()">getDataHome()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the directory to store data files.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html#getDataHome()">getDataHome()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">EnvironmentCapability</a></dt> +<dd> +<div class="block">Returns the directory where data files are stored, which is the same as + the home directory by default.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getDataHomeFile()">getDataHomeFile()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the optional directory to store data files.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getDataPrefixPadding()">getDataPrefixPadding()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getDataProperties()">getDataProperties()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getDataProperties()">getDataProperties()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns all the non-primary key properties of this layout, in their + proper order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getDataProperties()">getDataProperties()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDataSource()">getDataSource()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<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> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDataSourceCloseOnShutdown()">getDataSourceCloseOnShutdown()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if DataSource is closed when the repository is closed or + shutdown.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDataSourceLogging()">getDataSourceLogging()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if debug logging is enabled.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getDataSuffixPadding()">getDataSuffixPadding()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getDataType()">getDataType()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns the data type as defined by <code>Types</code>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getDataTypeName()">getDataTypeName()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns the data type name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html#getDeadlockCount()">getDeadlockCount()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getDecimalDigits()">getDecimalDigits()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns the amount of fractional decimal digits.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#getDecoder(int)">getDecoder(int)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>use direct decode method</i></div> +</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDefaultFetchSize()">getDefaultFetchSize()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the default fetch size when running queries, or null if driver + default is used instead.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/DelegateStorableGenerator.html#getDelegateClass(java.lang.Class, java.util.EnumSet)">getDelegateClass(Class<S>, EnumSet<MasterFeature>)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen">DelegateStorableGenerator</a></dt> +<dd> +<div class="block">Delegate class has a constructor that accepts a <a href="../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen"><code>DelegateSupport</code></a> + instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/TriggerSupport.html#getDeleteTrigger()">getDeleteTrigger()</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a></dt> +<dd> +<div class="block">Returns a trigger which must be run for all delete operations.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#getDeleteTrigger()">getDeleteTrigger()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> +<div class="block">Returns a consolidated trigger to call for delete operations, or null if + none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getDerivedFromProperties()">getDerivedFromProperties()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a new array with all the derived-from properties, which is empty + if this is not a derived property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getDerivedToProperties()">getDerivedToProperties()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a new array with all the properties which are derived from this + one.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/OrderedProperty.html#getDirection()">getDirection()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDriverClassName()">getDriverClassName()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the driver class name, which may be null if a DataSource was provided.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDriverURL()">getDriverURL()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the connection URL, which may be null if a DataSource was + provided.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getEnclosingType()">getEnclosingType()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the enclosing type of this property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html#getEnvironment()">getEnvironment()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">EnvironmentCapability</a></dt> +<dd> +<div class="block">Returns the BDB environment object, which must be cast to the expected + type, depending on the BDB product and version being used.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getEnvironmentHome()">getEnvironmentHome()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the repository environment home directory.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getEnvironmentHomeFile()">getEnvironmentHomeFile()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the repository environment home directory.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getEvolutionStrategy()">getEvolutionStrategy()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> +<div class="block">Returns EVOLUTION_NONE if evolution of records is not supported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getExclusiveRangeEndFilters()">getExclusiveRangeEndFilters()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the range end property filters supported by the evaluated + index whose operator is only <a href="../com/amazon/carbonado/filter/RelOp.html#LT"><code>RelOp.LT</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getExclusiveRangeStartFilters()">getExclusiveRangeStartFilters()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the range start property filters supported by the evaluated + index whose operator is only <a href="../com/amazon/carbonado/filter/RelOp.html#GT"><code>RelOp.GT</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElement(int)">getExternalJoinElement(int)</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a specific property in the joined class that participates in the + join.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getExternalJoinElement(int)">getExternalJoinElement(int)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElements()">getExternalJoinElements()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a new array with all the external join elements in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getExternalJoinElements()">getExternalJoinElements()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#getExtraData()">getExtraData()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> +<div class="block">Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#getExtraData()">getExtraData()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#getExtraData()">getExtraData()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> +<div class="block">Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getExtraData()">getExtraData()</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></dt> +<dd> +<div class="block">Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getExtraData()">getExtraData()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> +<div class="block">Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#getFiles()">getFiles()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>use getDataFiles and getLogFiles</i></div> +</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns the Filter that this FilterValues instance applies to.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedFilterException.html#getFilter()">getFilter()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado">MalformedFilterException</a></dt> +<dd> +<div class="block">Returns the malformed query filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns a <a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter"><code>ClosedFilter</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</a></dt> +<dd> +<div class="block">Returns the combined filter of the wrapped executor and the extra filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a></dt> +<dd> +<div class="block">Returns an open filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns combined handled and remainder filter for this result.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a></dt> +<dd> +<div class="block">Returns an open filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/JoinedQueryExecutor.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutor.html#getFilter()">getFilter()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></dt> +<dd> +<div class="block">Returns the filter used by this QueryExecutor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a></dt> +<dd> +<div class="block">Returns the combined filter of the wrapped executors.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#getFilter()">getFilter()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns the query's filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/CompositeScore.html#getFilteringScore()">getFilteringScore()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></dt> +<dd> +<div class="block">Returns the score on how well the evaluated index performs the desired + filtering.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#getFilterValues()">getFilterValues()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#getFilterValues()">getFilterValues()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#getFilterValues()">getFilterValues()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns the query's filter values, which is null if filter has no + parameters.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getForeignIndex()">getForeignIndex()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns the foreign index that was selected, or null if a local + index was selected.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getForeignProperty()">getForeignProperty()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns the simple or chained property that maps to the selected + foreign index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#getFreeOrdering()">getFreeOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns potential ordering properties that the evaluated index can + handle, if arranged to immediately follow the handled orderings.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html#getFromStorageAdapter()">getFromStorageAdapter()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></dt> +<dd> +<div class="block">Returns the optional method used to adapt the property from the + storage supported type to the user visible type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#getFromStorageAdapter()">getFromStorageAdapter()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getGeneration()">getGeneration()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns the generation of this layout, where zero represents the first + generation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getGeneration(int)">getGeneration(int)</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns the layout for a particular generation of this layout's type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#getGeneration()">getGeneration()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> +<div class="block">Generation of storable, where 0 represents the first generation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#getGeneration()">getGeneration()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></dt> +<dd> +<div class="block">Generation of storable, where 0 represents the first generation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/GroupAccessCapability.html#getGroupMembers()">getGroupMembers()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability">GroupAccessCapability</a></dt> +<dd> +<div class="block">Return all replication group members, including this repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getHandledCount()">getHandledCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the count of all handled property filters.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#getHandledCount()">getHandledCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns the number of desired orderings the evaluated index + supports.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getHandledFilter()">getHandledFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the composite handled filter, or null if no matches at all.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#getHandledOrdering()">getHandledOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns the ordering properties that the evaluated index supports.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html#getHome()">getHome()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">EnvironmentCapability</a></dt> +<dd> +<div class="block">Returns the home directory for the BDB environment.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getIdentityCount()">getIdentityCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns number of consecutive left-aligned index properties which match + property filters with an operator of <a href="../com/amazon/carbonado/filter/RelOp.html#EQ"><code>RelOp.EQ</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getIdentityFilter()">getIdentityFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the composite identity filter, or null if no identity property + filters.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getIdentityFilters()">getIdentityFilters()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the identity property filters supported by the evaluated + index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getIdentityProperties()">getIdentityProperties()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> +<div class="block">Returns auto-increment properties which are primary key members.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getInclusiveRangeEndFilters()">getInclusiveRangeEndFilters()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the range end property filters supported by the evaluated + index whose operator is only <a href="../com/amazon/carbonado/filter/RelOp.html#LE"><code>RelOp.LE</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getInclusiveRangeStartFilters()">getInclusiveRangeStartFilters()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the range start property filters supported by the evaluated + index whose operator is only <a href="../com/amazon/carbonado/filter/RelOp.html#GE"><code>RelOp.GE</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getIndex(int)">getIndex(int)</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns a specific index for the Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getIndexCount()">getIndexCount()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns the count of indexes defined for the Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html#getIndexEntryAccessors(java.lang.Class)">getIndexEntryAccessors(Class<S>)</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessCapability</a></dt> +<dd> +<div class="block">Returns index entry accessors for the known indexes of the given + storable type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#getIndexEntryStorage()">getIndexEntryStorage()</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a></dt> +<dd> +<div class="block">Returns the index entry storage.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getIndexes()">getIndexes()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns a new array with all the indexes in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/IndexInfoCapability.html#getIndexInfo(java.lang.Class)">getIndexInfo(Class<S>)</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability">IndexInfoCapability</a></dt> +<dd> +<div class="block">Returns information about the known indexes for the given storable + type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getIndexInfo()">getIndexInfo()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getIndexName()">getIndexName()</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></dt> +<dd> +<div class="block">Returns the index name, which is also a valid index name + descriptor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getIndexNameDescriptor()">getIndexNameDescriptor()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> +<div class="block">Returns the index name descriptor for the keys of this database.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getIndexPropertyCount()">getIndexPropertyCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the amount of properties in the evaluated index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#getIndexPropertyCount()">getIndexPropertyCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns the amount of properties in the evaluated index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#getIndexRepairThrottle()">getIndexRepairThrottle()</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the throttle parameter used when indexes are added, dropped or + bulk repaired.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getIndexRepairThrottle()">getIndexRepairThrottle()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the throttle parameter used when indexes are added, dropped or + bulk repaired.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getIndexSupport()">getIndexSupport()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if indexes are supported, which is true by default.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getIndexTypeDescriptor()">getIndexTypeDescriptor()</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></dt> +<dd> +<div class="block">Returns the types of the index properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getIndexTypeDescriptor()">getIndexTypeDescriptor()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> +<div class="block">Returns the types of the index properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getInitialDatabaseConfig()">getInitialDatabaseConfig()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the optional BDB specific database configuration to use + for all databases created.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getInitialEnvironmentConfig()">getInitialEnvironmentConfig()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the optional BDB specific environment configuration to use.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getInitializeLogging()">getInitializeLogging()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/StoredSequence.html#getInitialValue()">getInitialValue()</a></span> - Method in interface com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</a></dt> +<dd> +<div class="block">Returns the initial value for the sequence.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredSequence.html#getInitialValue()">getInitialValue()</a></span> - Method in interface com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> +<div class="block">Returns the initial value for the sequence.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/ClassFileBuilder.html#getInjector()">getInjector()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/TriggerSupport.html#getInsertTrigger()">getInsertTrigger()</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a></dt> +<dd> +<div class="block">Returns a trigger which must be run for all insert operations.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#getInsertTrigger()">getInsertTrigger()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> +<div class="block">Returns a consolidated trigger to call for insert operations, or null if + none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/ExceptionTransformer.html#getInstance()">getInstance()</a></span> - Static method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></dt> +<dd> +<div class="block">Returns a generic instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/QuickConstructorGenerator.html#getInstance(java.lang.Class, java.lang.Class)">getInstance(Class<?>, Class<F>)</a></span> - Static method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util">QuickConstructorGenerator</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> +<div class="block">Returns a factory instance for one type of object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElement(int)">getInternalJoinElement(int)</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a specific property in this property's class that participates + in the join.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getInternalJoinElement(int)">getInternalJoinElement(int)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElements()">getInternalJoinElements()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a new array with all the internal join elements in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getInternalJoinElements()">getInternalJoinElements()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Transaction.html#getIsolationLevel()">getIsolationLevel()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></dt> +<dd> +<div class="block">Returns the isolation level of this transaction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionPair.html#getIsolationLevel()">getIsolationLevel()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn">TransactionPair</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionScope.html#getIsolationLevel()">getIsolationLevel()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a></dt> +<dd> +<div class="block">Returns the isolation level of the active transaction, or null if there + is no active transaction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getJoinedType()">getJoinedType()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the type of property this is joined to, or null if not joined.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getJoinElementCount()">getJoinElementCount()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the count of properties that participate in this property's + join.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getKeepOldLogFiles()">getKeepOldLogFiles()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns false by default.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getKeyPrefixPadding()">getKeyPrefixPadding()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getKeySuffixPadding()">getKeySuffixPadding()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.html#getLastBlockLength()">getLastBlockLength()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></dt> +<dd> +<div class="block">Returns expected length of last block.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#getLastLogNumber()">getLastLogNumber()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></dt> +<dd> +<div class="block">Can be called after a backup has been performed to find the last log file + that has been backed up.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#getLastProperty()">getLastProperty()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns the last property in the chain, or the prime property if chain + is empty.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getLayoutID()">getLayoutID()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns a unique identifier for this layout.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#getLayoutID()">getLayoutID()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#getLayoutID()">getLayoutID()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions(Class<? extends Storable>)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CompressedStorableCodecFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions(Class<? extends Storable>)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></dt> +<dd> +<div class="block">Returns null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions(Class<? extends Storable>)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></dt> +<dd> +<div class="block">Optionally return additional information regarding storable encoding.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/BinaryOpFilter.html#getLeftFilter()">getLeftFilter()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Blob.html#getLength()">getLength()</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></dt> +<dd> +<div class="block">Returns the length of this Blob, in bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/BlobClob.html#getLength()">getLength()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/ByteArrayBlob.html#getLength()">getLength()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/CharArrayClob.html#getLength()">getLength()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Clob.html#getLength()">getLength()</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></dt> +<dd> +<div class="block">Returns the length of this Clob, in characters.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/FileBlob.html#getLength()">getLength()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/StringClob.html#getLength()">getLength()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.html#getLength()">getLength()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html#getLevels()">getLevels()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/TriggerSupport.html#getLoadTrigger()">getLoadTrigger()</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a></dt> +<dd> +<div class="block">Returns a trigger which must be run for all load and fetch operations.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#getLoadTrigger()">getLoadTrigger()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> +<div class="block">Returns a consolidated trigger to call for load operations, or null if + none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getLocalIndex()">getLocalIndex()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns the local index that was selected, or null if a foreign + index was selected.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/BlobClob.html#getLocator()">getLocator()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/ByteArrayBlob.html#getLocator()">getLocator()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></dt> +<dd> +<div class="block">Always returns null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/CharArrayClob.html#getLocator()">getLocator()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></dt> +<dd> +<div class="block">Always returns null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/FileBlob.html#getLocator()">getLocator()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></dt> +<dd> +<div class="block">Always returns null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Lob.html#getLocator()">getLocator()</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dt> +<dd> +<div class="block">Returns an object which identifies the Lob data, which may be null if + not supported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/StringClob.html#getLocator()">getLocator()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></dt> +<dd> +<div class="block">Always returns null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawSupport.html#getLocator(com.amazon.carbonado.lob.Blob)">getLocator(Blob)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></dt> +<dd> +<div class="block">Returns the locator for the given Blob, returning zero if null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawSupport.html#getLocator(com.amazon.carbonado.lob.Clob)">getLocator(Clob)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></dt> +<dd> +<div class="block">Returns the locator for the given Clob, returning zero if null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/LobEngine.html#getLocator(com.amazon.carbonado.lob.Lob)">getLocator(Lob)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></dt> +<dd> +<div class="block">Returns the locator for the given Lob, or zero if null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.Block.html#getLocator()">getLocator()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.html#getLocator()">getLocator()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionScope.html#getLock()">getLock()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a></dt> +<dd> +<div class="block">Returns lock used by TransactionScope.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLockConflictDeadlockDetectMode()">getLockConflictDeadlockDetectMode()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if deadlock detection is run whenever a lock conflict occurs.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#getLockTimeout()">getLockTimeout()</a></span> - Method in class com.amazon.carbonado.repo.map.<a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the lock timeout.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLockTimeout()">getLockTimeout()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the lock timeout, in seconds.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLockTimeoutInMicroseconds()">getLockTimeoutInMicroseconds()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the lock timeout, in microseconds, limited to max long value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#getLockTimeoutUnit()">getLockTimeoutUnit()</a></span> - Method in class com.amazon.carbonado.repo.map.<a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the lock timeout unit.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/LogAccessCapability.html#getLog()">getLog()</a></span> - Method in interface com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/LogAccessCapability.html" title="interface in com.amazon.carbonado.repo.logging">LogAccessCapability</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#getLog()">getLog()</a></span> - Method in class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a></dt> +<dd> +<div class="block">Return the Log to use.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#getLog()">getLog()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> +<div class="block">Return the main Log object for this Repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLogFileMaxSize()">getLogFileMaxSize()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns null if default size will be used.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#getLogFiles()">getLogFiles()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></dt> +<dd> +<div class="block">Returns all the transaction log files to be copied, in the exact + order in which they must be copied.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLogInMemory()">getLogInMemory()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns false by default, indicating that transaction logs are persisted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#getLoginTimeout()">getLoginTimeout()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#getLoginTimeout()">getLoginTimeout()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLogRegionSize()">getLogRegionSize()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the repository log region size, or null if the default + should be selected.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#getLogWriter()">getLogWriter()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#getLogWriter()">getLogWriter()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedTypeException.html#getMalformedType()">getMalformedType()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#getMasterClass()">getMasterClass()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceAccess</a></dt> +<dd> +<div class="block">Returns the storable class which is referenced.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/ResyncCapability.html#getMasterRepository()">getMasterRepository()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability">ResyncCapability</a></dt> +<dd> +<div class="block">Returns the immediate master Repository, for manual comparison.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#getMasterRepositoryBuilder()">getMasterRepositoryBuilder()</a></span> - Method in class com.amazon.carbonado.repo.replicated.<a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#getMatchedGeneration()">getMatchedGeneration()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></dt> +<dd> +<div class="block">Generation of matched layout.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getMaxLocks()">getMaxLocks()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/CorruptEncodingException.html#getMessage()">getMessage()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedArgumentException.html#getMessage()">getMessage()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">MalformedArgumentException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedTypeException.html#getMessage()">getMessage()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></dt> +<dd> +<div class="block">Returns first message, prefixed with the malformed type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MismatchException.html#getMessage()">getMessage()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado">MismatchException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/UnsupportedTypeException.html#getMessage()">getMessage()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/UnsupportedTypeException.html" title="class in com.amazon.carbonado">UnsupportedTypeException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedArgumentException.html#getMessages()">getMessages()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">MalformedArgumentException</a></dt> +<dd> +<div class="block">Multiple error messages may be embedded in a MalformedArgumentException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MismatchException.html#getMessages()">getMessages()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado">MismatchException</a></dt> +<dd> +<div class="block">Multiple error messages may be embedded in a MismatchException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/IndexInfo.html#getName()">getName()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></dt> +<dd> +<div class="block">Returns the name of this index, or null if not applicable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getName()">getName()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns the name of the Storable described by this StorableInfo, + which is an abbreviated form of the type's class name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getName()">getName()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the name of this property, which is the same as the bean name + unless it has been <a href="../com/amazon/carbonado/Name.html" title="annotation in com.amazon.carbonado"><code>renamed</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.repo.map.<a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.repo.replicated.<a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Repository.html#getName()">getName()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></dt> +<dd> +<div class="block">Returns the name of this repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryBuilder.html#getName()">getName()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the name of the repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/StoredSequence.html#getName()">getName()</a></span> - Method in interface com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/IndexInfoImpl.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredSequence.html#getName()">getName()</a></span> - Method in interface com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html#getName()">getName()</a></span> - Method in interface com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> +<div class="block">Frequently used by the <a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic"><code>SyntheticBuilder.ClassNameProvider</code></a> as a + basis for the generated classname</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getNameDescriptor()">getNameDescriptor()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Converts this index into a parseable name descriptor string, whose + general format is:</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/StoredSequence.html#getNextValue()">getNextValue()</a></span> - Method in interface com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</a></dt> +<dd> +<div class="block">Returns the pre-adjusted next value of the sequence.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredSequence.html#getNextValue()">getNextValue()</a></span> - Method in interface com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> +<div class="block">Returns the pre-adjusted next value of the sequence.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.NotJoined.html#getNotJoinedFilter()">getNotJoinedFilter()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></dt> +<dd> +<div class="block">Returns the filter which is no longer as from a join.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getNumber()">getNumber()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the zero-based numerical position of this property within its + enclosing type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#getOpenFilter(java.lang.Class)">getOpenFilter(Class<S>)</a></span> - Static method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns a cached filter instance that operates on the given type, which + allows all results to pass through.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#getOperator()">getOperator()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getOptions()">getOptions()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns additional options, or null if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getOrderedProperties()">getOrderedProperties()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns a new array with all the properties in it, with directions + folded in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getOrderedProperty(int)">getOrderedProperty(int)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns a specific property in this index, with the direction folded in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a></dt> +<dd> +<div class="block">Returns an empty list.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns combined handled and remainder orderings for this result.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a></dt> +<dd> +<div class="block">Returns an empty list.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/JoinedQueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a></dt> +<dd> +<div class="block">Returns an empty list.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></dt> +<dd> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/CompositeScore.html#getOrderingScore()">getOrderingScore()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></dt> +<dd> +<div class="block">Returns the score on how well the evaluated index performs the desired + ordering.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#getOrdinal()">getOrdinal()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> +<div class="block">Ordinal defines the order in which this property appears in it enclosing + layout.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getOrdinalPosition()">getOrdinalPosition()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns the one-based index of the column in the table.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html#getPagesExamine()">getPagesExamine()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html#getPagesFree()">getPagesFree()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html#getPagesTruncated()">getPagesTruncated()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getPanicHandler()">getPanicHandler()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Return the panic handler to call if the database panics.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#getParentLogger()">getParentLogger()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#getParentLogger()">getParentLogger()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getPartitionKey()">getPartitionKey()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns the partition key for the Storable, or null if none exists.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getPassword()">getPassword()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the optional password to use with DataSource.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getPreferenceScore()">getPreferenceScore()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns a value which indicates user index preference, based on the + original ordering of elements in the filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getPreparedStatementSetMethod()">getPreparedStatementSetMethod()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns the method to use to set this property (by index) into a + PreparedStatement.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getPreShutdownHook()">getPreShutdownHook()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the custom shutdown hook that runs before the repository has + finished running its own shutdown hooks, or null if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getPrimaryKey()">getPrimaryKey()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns the primary key for the Storable, never null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getPrimaryKeyIndex()">getPrimaryKeyIndex()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Returns all key properties in the form of an index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#getPrimaryKeyIndex()">getPrimaryKeyIndex()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#getPrimaryKeyIndex()">getPrimaryKeyIndex()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Returns the sequence and directions of properties that make up the + primary key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#getPrimaryKeyPrefixLength()">getPrimaryKeyPrefixLength()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#getPrimaryKeyPrefixLength()">getPrimaryKeyPrefixLength()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Returns the number of prefix bytes in the primary key, which may be + zero.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getPrimaryKeyProperties()">getPrimaryKeyProperties()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the primary key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getPrimaryKeyProperties()">getPrimaryKeyProperties()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#getPrimeProperty()">getPrimeProperty()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getProduct()">getProduct()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the BDB product to use, which is JE by default.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getProperties()">getProperties()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns a new array with all the properties in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableKey.html#getProperties()">getProperties()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a></dt> +<dd> +<div class="block">Returns all the properties of the key in a properly ordered, + unmodifiable set.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticPropertyList.html#getProperties()">getProperties()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic">SyntheticPropertyList</a></dt> +<dd> +<div class="block">Returns all the properties in this index, optionally prefixed with a '+' + or '-' to indicate direction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getProperty(int)">getProperty(int)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns a specific property in this index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getPropertyCount()">getPropertyCount()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns the count of properties in this index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticPropertyList.html#getPropertyCount()">getPropertyCount()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic">SyntheticPropertyList</a></dt> +<dd> +<div class="block">Returns the count of properties in this index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getPropertyDirection(int)">getPropertyDirection(int)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns the requested direction of a specific property in this index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/IndexInfo.html#getPropertyDirections()">getPropertyDirections()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></dt> +<dd> +<div class="block">Returns the directions of all the properties in this index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getPropertyDirections()">getPropertyDirections()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns a new array with all the property directions in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/IndexInfoImpl.html#getPropertyDirections()">getPropertyDirections()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#getPropertyList()">getPropertyList()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> +<div class="block">Frequently used by the <a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic"><code>SyntheticBuilder.ClassNameProvider</code></a> as a + basis for the generated classname</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#getPropertyName()">getPropertyName()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#getPropertyName()">getPropertyName()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html#getPropertyName()">getPropertyName()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#getPropertyName()">getPropertyName()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/IndexInfo.html#getPropertyNames()">getPropertyNames()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></dt> +<dd> +<div class="block">Returns the properties in this index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/IndexInfoImpl.html#getPropertyNames()">getPropertyNames()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#getPropertyType()">getPropertyType()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#getPropertyType(java.lang.ClassLoader)">getPropertyType(ClassLoader)</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html#getPropertyType()">getPropertyType()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></dt> +<dd> +<div class="block">Returns the user specified property type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#getPropertyType()">getPropertyType()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#getPropertyTypeDescriptor()">getPropertyTypeDescriptor()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> +<div class="block">Property type descriptor is a Java type descriptor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#getPropertyTypeDescriptor()">getPropertyTypeDescriptor()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> +<div class="block">Property type descriptor is a Java type descriptor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#getPropertyValue(java.lang.String)">getPropertyValue(String)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Returns a Storable property value by name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getQualifiedTableName()">getQualifiedTableName()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> +<div class="block">Returns the qualified table name for the Storable or null if + unsupported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorageAccess.html#getQueryExecutorFactory()">getQueryExecutorFactory()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a></dt> +<dd> +<div class="block">Returns a QueryExecutorFactory instance for storage.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getRangeEndFilters()">getRangeEndFilters()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the range end property filters supported by the evaluated + index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getRangeStartFilters()">getRangeStartFilters()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the range start property filters supported by the evaluated + index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getReadMethod()">getReadMethod()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a no-arg method used to read the property value, or null if + reading is not allowed.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getReadMethodName()">getReadMethodName()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the name of the read method, even if no read method was actually + declared.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#getReadMethodName()">getReadMethodName()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#getReadMethodName()">getReadMethodName()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> +<div class="block">Returns the name of the read method.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getReadOnly()">getReadOnly()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if repository should be opened read-only.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/GroupMembers.html#getReadWriteMembers()">getReadWriteMembers()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">GroupMembers</a></dt> +<dd> +<div class="block">Returns members intended for read and write access.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#getReferenceAccess()">getReferenceAccess()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> +<div class="block">Build and return access to the generated storable reference class.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#getReferenceClass()">getReferenceClass()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceAccess</a></dt> +<dd> +<div class="block">Returns the generated storable reference class.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getRemainderCount()">getRemainderCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns number of property filters not supported by the evaluated index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#getRemainderCount()">getRemainderCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns the number of desired orderings the evaluated index does not + support.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.NotJoined.html#getRemainderFilter()">getRemainderFilter()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></dt> +<dd> +<div class="block">Returns the filter which could not be separated.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getRemainderFilter()">getRemainderFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the composite remainder filter not supported by the evaluated + index, or null if no remainder.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getRemainderFilter()">getRemainderFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Remainder filter which overrides that in composite score.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getRemainderFilters()">getRemainderFilters()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the filters not supported by the evaluated index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getRemainderOrdering()">getRemainderOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Remainder orderings which override that in composite score.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#getRemainderOrdering()">getRemainderOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns the ordering properties that the evaluated index does not + support.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#getReplicaRepositoryBuilder()">getReplicaRepositoryBuilder()</a></span> - Method in class com.amazon.carbonado.repo.replicated.<a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getResultSetGetMethod()">getResultSetGetMethod()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns the method to use to access this property (by index) from a + ResultSet.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/BinaryOpFilter.html#getRightFilter()">getRightFilter()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></dt> +<dd> +<div class="block">Recursively calls getCause, until the root cause is found.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableSupport.html#getRootRepository()">getRootRepository()</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</a></dt> +<dd> +<div class="block">Returns the root parent Repository that the Storable came from.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/RepositoryAccess.html#getRootRepository()">getRootRepository()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getRunCheckpointer()">getRunCheckpointer()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if checkpointer is run automatically.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getRunDeadlockDetector()">getRunDeadlockDetector()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if deadlock detector is configured to run.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getRunFullRecovery()">getRunFullRecovery()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if a full (catastrophic) recovery should be performed when + environment is opened.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getSchema()">getSchema()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the optional schema to search for metadata.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getSchemaName()">getSchemaName()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> +<div class="block">Returns the optional schema name for the Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#getSearchKeyFactory(com.amazon.carbonado.info.OrderedProperty[])">getSearchKeyFactory(OrderedProperty<S>[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> +<div class="block">Returns a search key factory, which is useful for implementing indexes + and queries.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getSequenceName()">getSequenceName()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the property's sequence name, or null if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getSequenceSelectStatement()">getSequenceSelectStatement()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the native sequence select statement, which is null if the + default is chosen.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/MasterSupport.html#getSequenceValueProducer(java.lang.String)">getSequenceValueProducer(String)</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</a></dt> +<dd> +<div class="block">Returns a sequence value producer by name, or throw PersistException if not found.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceCapability.html#getSequenceValueProducer(java.lang.String)">getSequenceValueProducer(String)</a></span> - Method in interface com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">SequenceCapability</a></dt> +<dd> +<div class="block">Retrieve and/or generate a SequenceValueProducer for the given name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#getSequenceValueProducer(java.lang.String)">getSequenceValueProducer(String)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getShutdownHook()">getShutdownHook()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the custom shutdown hook that runs after the repository has + finished running its own shutdown hooks, or null if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getSingleFileName()">getSingleFileName()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the single file that all BDB databases should reside in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/OptimisticLockException.html#getStorable()">getStorable()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado">OptimisticLockException</a></dt> +<dd> +<div class="block">Returns the Storable which was acted upon, or null if not available.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#getStorableClass()">getStorableClass()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> +<div class="block">Returns a concrete Storable implementation, which is fully + thread-safe.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html#getStorableClass()">getStorableClass()</a></span> - Method in interface com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#getStorableClass()">getStorableClass()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#getStorableClass()">getStorableClass()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getStorableCodecFactory()">getStorableCodecFactory()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the storable codec factory used.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns the storable type that this filter operates on.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns the type of storable this index applies to.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getStorableType()">getStorableType()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns the type of Storable described by this StorableInfo.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutorFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#getStorableType()">getStorableType()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">getStorableType()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></dt> +<dd> +<div class="block">Returns the storable type that this executor operates on.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutorCache.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe">QueryExecutorCache</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutorFactory.html#getStorableType()">getStorableType()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryFactory.html#getStorableType()">getStorableType()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorageAccess.html#getStorableType()">getStorableType()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a></dt> +<dd> +<div class="block">Returns the specific type of Storable managed by this object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#getStorableType()">getStorableType()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns the specific type of Storable managed by this object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> +<div class="block">Returns the type of Storable that code is generated for.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#getStorableType()">getStorableType()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Returns the type of Storable produced by this codec.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storage.html#getStorableType()">getStorableType()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></dt> +<dd> +<div class="block">Returns the specific type of Storable managed by this object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getStorableTypeName()">getStorableTypeName()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Storable type name is a fully qualified Java class name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#getStorableTypeName()">getStorableTypeName()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> +<div class="block">Storable type name is a fully qualified Java class name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#getStorableTypeName()">getStorableTypeName()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></dt> +<dd> +<div class="block">Storable type name is a fully qualified Java class name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/CorruptEncodingException.html#getStorableWithPrimaryKey()">getStorableWithPrimaryKey()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></dt> +<dd> +<div class="block">If the decoder was able to extract the primary key, it will be available in the + returned Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoragePool.html#getStorage(java.lang.Class)">getStorage(Class<S>)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoragePool.html" title="class in com.amazon.carbonado.spi">StoragePool</a></dt> +<dd> +<div class="block">Returns a Storage instance for the given Storable type, which is lazily + created and pooled.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#getStorageName(java.lang.Class)">getStorageName(Class<? extends Storable>)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CustomStorableCodecFactory</a></dt> +<dd> +<div class="block">Returns null to let repository decide what the name should be.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#getStorageName(java.lang.Class)">getStorageName(Class<? extends Storable>)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></dt> +<dd> +<div class="block">Returns null to let repository decide what the name should be.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodecFactory.html#getStorageName(java.lang.Class)">getStorageName(Class<? extends Storable>)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></dt> +<dd> +<div class="block">Returns the preferred storage/database name for the given type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html#getStorageType()">getStorageType()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></dt> +<dd> +<div class="block">Returns the storage supported type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#getStorageType()">getStorageType()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html#getStorageTypePreferences()">getStorageTypePreferences()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></dt> +<dd> +<div class="block">Returns the adapter's storage type preferences.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ExistsFilter.html#getSubFilter()">getSubFilter()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></dt> +<dd> +<div class="block">Returns the filter applied to the join, which might be open.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#getSubResults()">getSubResults()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns results for each sub-query to be executed in the union.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#getSuppliedValues()">getSuppliedValues()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns all supplied values in this object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#getSuppliedValuesFor(com.amazon.carbonado.filter.Filter)">getSuppliedValuesFor(Filter<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns all supplied values in this object, as required by the given + Filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#getSupport()">getSupport()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#getSupport()">getSupport()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#getSupport()">getSupport()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Returns the default <a href="../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw"><code>RawSupport</code></a> object that is supplied to + Storable instances produced by this codec.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/LobEngine.html#getSupportTrigger(java.lang.Class, int)">getSupportTrigger(Class<S>, int)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></dt> +<dd> +<div class="block">Returns a Trigger for binding to this LobEngine.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getTableName()">getTableName()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> +<div class="block">Returns the table name for the Storable or null if unsupported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Controller.html#getTimeout()">getTimeout()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></dt> +<dd> +<div class="block">Returns a non-negative value if controller imposes an absolute upper + bound on query execution time.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Timeout.html#getTimeout()">getTimeout()</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Controller.html#getTimeoutUnit()">getTimeoutUnit()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></dt> +<dd> +<div class="block">Returns the unit for the timeout, if applicable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Timeout.html#getTimeoutUnit()">getTimeoutUnit()</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html#getToStorageAdapter()">getToStorageAdapter()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></dt> +<dd> +<div class="block">Returns the optional method used to adapt the property from the user + visible type to the storage supported type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#getToStorageAdapter()">getToStorageAdapter()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#getTotalOrdering()">getTotalOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns a total ordering, if one was imposed.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Repository.html#getTransactionIsolationLevel()">getTransactionIsolationLevel()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></dt> +<dd> +<div class="block">Returns the isolation level of the current transaction, or null if there + is no transaction in the current thread.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#getTransactionIsolationLevel()">getTransactionIsolationLevel()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionMaxActive()">getTransactionMaxActive()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the maximum number of concurrent transactions, or null if the + default is used.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionNoSync()">getTransactionNoSync()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if transactions are not written or flushed to disk.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionTimeout()">getTransactionTimeout()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the repository transaction timeout, in seconds.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionTimeoutInMicroseconds()">getTransactionTimeoutInMicroseconds()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the repository transaction timeout, in microseconds, limited to + max long value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionWriteNoSync()">getTransactionWriteNoSync()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if transactions are not flushed to disk.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryBuilder.html#getTriggerFactories()">getTriggerFactories()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dt> +<dd> +<div class="block">Returns all the TriggerFactories which were added.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#getTriggerFactories()">getTriggerFactories()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManagerCapability.html#getTriggerManagerFor(java.lang.Class)">getTriggerManagerFor(Class<S>)</a></span> - Method in interface com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi">TriggerManagerCapability</a></dt> +<dd> +<div class="block">Returns the <a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><code>TriggerManager</code></a> for the given <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionScope.html#getTxn()">getTxn()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a></dt> +<dd> +<div class="block">Returns the implementation for the active transaction, or null if there + is no active transaction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#getType()">getType()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> +<div class="block">Returns the type of the ChainedProperty.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#getType()">getType()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns the type of the last property in the chain, or of the prime + property if the chain is empty.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getType()">getType()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the primary type of this property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getType()">getType()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Returns the type of Storable that code is generated for.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#getType()">getType()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/UnsupportedTypeException.html#getType()">getType()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/UnsupportedTypeException.html" title="class in com.amazon.carbonado">UnsupportedTypeException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getTypeDescriptor()">getTypeDescriptor()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Converts this index into a parseable type descriptor string, which + basically consists of Java type descriptors appended together.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#getUnusedOrdering()">getUnusedOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns unused ordering properties of the evaluated index because they + were filtered out.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/TriggerSupport.html#getUpdateTrigger()">getUpdateTrigger()</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a></dt> +<dd> +<div class="block">Returns a trigger which must be run for all update operations.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#getUpdateTrigger()">getUpdateTrigger()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> +<div class="block">Returns a consolidated trigger to call for update operations, or null if + none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getUserName()">getUserName()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the optional username to use with DataSource.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#getUserProps()">getUserProps()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/StorableInfoCapability.html#getUserStorableTypeNames()">getUserStorableTypeNames()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability">StorableInfoCapability</a></dt> +<dd> +<div class="block">Returns an array of storable type class names for user-level storables + known to the repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#getValue(com.amazon.carbonado.filter.PropertyFilter)">getValue(PropertyFilter<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns the value assigned to the given PropertyFilter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#getValues()">getValues()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns all values in this object, including those provided by filter + constants.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#getValuesFor(com.amazon.carbonado.filter.Filter)">getValuesFor(Filter<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns all values in this object, as required by the given Filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html#getVersion()">getVersion()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">EnvironmentCapability</a></dt> +<dd> +<div class="block">Returns the major, minor, and patch version numbers.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/StoredSequence.html#getVersion()">getVersion()</a></span> - Method in interface com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.Block.html#getVersion()">getVersion()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.html#getVersion()">getVersion()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#getVersionNumber()">getVersionNumber()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> +<div class="block">Record version number for this StoredTypeLayout instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#getVersionNumber()">getVersionNumber()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#getVersionNumber()">getVersionNumber()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> +<div class="block">Record version number for this StoredPropertyLayout instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getVersionNumber()">getVersionNumber()</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></dt> +<dd> +<div class="block">Record version number for this StoredIndexInfo instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getVersionNumber()">getVersionNumber()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> +<div class="block">Record version number for this StoredDatabaseInfo instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getVersionProperty()">getVersionProperty()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns the designated version property, or null if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getVersionProperty()">getVersionProperty()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/BlobClob.html#getWrappedBlob()">getWrappedBlob()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#getWrappedRepository()">getWrappedRepository()</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getWriteMethod()">getWriteMethod()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a one argument method used to write the property value, or null + if writing is not allowed.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getWriteMethodName()">getWriteMethodName()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the name of the write method, even if no write method was + actually declared.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#getWriteMethodName()">getWriteMethodName()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#getWriteMethodName()">getWriteMethodName()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> +<div class="block">Returns the name of the write method.</div> +</dd> +<dt><a href="../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">GroupAccessCapability</span></a> - Interface in <a href="../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></dt> +<dd> +<div class="block">Capability for gaining access to replication group members.</div> +</dd> +<dt><a href="../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">GroupedCursor</span></a><<a href="../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>,<a href="../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">G</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Abstract cursor for aggregation and finding distinct data.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/GroupedCursor.html#GroupedCursor(com.amazon.carbonado.Cursor, java.util.Comparator)">GroupedCursor(Cursor<S>, Comparator<S>)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor">GroupedCursor</a></dt> +<dd> +<div class="block">Create a GroupedCursor with an existing group comparator.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/GroupedCursor.html#GroupedCursor(com.amazon.carbonado.Cursor, java.lang.Class, java.lang.String...)">GroupedCursor(Cursor<S>, Class<S>, String...)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor">GroupedCursor</a></dt> +<dd> +<div class="block">Create a GroupedCursor using properties to define the group + comparator.</div> +</dd> +<dt><a href="../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability"><span class="strong">GroupMembers</span></a> - Interface in <a href="../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/raw/GzipCompressor.html" title="class in com.amazon.carbonado.raw"><span class="strong">GzipCompressor</span></a> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Raw-level data compression using gzip.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GzipCompressor.html#GzipCompressor()">GzipCompressor()</a></span> - Constructor for class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GzipCompressor.html" title="class in com.amazon.carbonado.raw">GzipCompressor</a></dt> +<dd> </dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-6.html">Prev Letter</a></li> +<li><a href="index-8.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-7.html" target="_top">Frames</a></li> +<li><a href="index-7.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-8.html b/apidocs/index-files/index-8.html new file mode 100644 index 0000000..4d4be71 --- /dev/null +++ b/apidocs/index-files/index-8.html @@ -0,0 +1,273 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>H-Index (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="H-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-7.html">Prev Letter</a></li> +<li><a href="index-9.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-8.html" target="_top">Frames</a></li> +<li><a href="index-8.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_H_"> +<!-- --> +</a> +<h2 class="title">H</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#handleNoSuchElement()">handleNoSuchElement()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Called right before throwing NoSuchElementException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/RemoteProcedure.html#handleRequest(com.amazon.carbonado.Repository, com.amazon.carbonado.capability.RemoteProcedure.Request)">handleRequest(Repository, RemoteProcedure.Request<R, D>)</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/RemoteProcedure.html" title="interface in com.amazon.carbonado.capability">RemoteProcedure</a></dt> +<dd> +<div class="block">Request handler for remote procedure implementation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#handlesAnything()">handlesAnything()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns true if the selected index does anything at all to filter + results or to order them.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#HAS_DIRTY_PROPERTIES">HAS_DIRTY_PROPERTIES</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#hasAnyMatches()">hasAnyMatches()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns true if the identity count is greater than zero or if there is a + range match.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#hasDirtyProperties()">hasDirtyProperties()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Returns true if any non-primary key properties in this object are + dirty.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#hashCode()">hashCode()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.NotJoined.html#hashCode()">hashCode()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#hashCode()">hashCode()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#hashCode()">hashCode()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/OrderedProperty.html#hashCode()">hashCode()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#hashCode()">hashCode()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#hashCode()">hashCode()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#hashCode()">hashCode()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractBlob.html#hashCode()">hashCode()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractBlob.html" title="class in com.amazon.carbonado.lob">AbstractBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/AbstractClob.html#hashCode()">hashCode()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/AbstractClob.html" title="class in com.amazon.carbonado.lob">AbstractClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQuery.html#hashCode()">hashCode()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQuery.html" title="class in com.amazon.carbonado.qe">AbstractQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#hashCode()">hashCode()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#hashCode()">hashCode()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryHints.html#hashCode()">hashCode()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#hashCode()">hashCode()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#hashCode()">hashCode()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CompressedEncodingStrategy.html#hashCode()">hashCode()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="class in com.amazon.carbonado.raw">CompressedEncodingStrategy</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#hashCode()">hashCode()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#hashCode()">hashCode()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#hashCode()">hashCode()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#HASHCODE_METHOD_NAME">HASHCODE_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/LobEngine.html#hasLobs(java.lang.Class)">hasLobs(Class<S>)</a></span> - Static method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/ControllerCursor.html#hasNext()">hasNext()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/ControllerCursor.html" title="class in com.amazon.carbonado.cursor">ControllerCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/DifferenceCursor.html#hasNext()">hasNext()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/DifferenceCursor.html" title="class in com.amazon.carbonado.cursor">DifferenceCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/EmptyCursor.html#hasNext()">hasNext()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/EmptyCursor.html" title="class in com.amazon.carbonado.cursor">EmptyCursor</a></dt> +<dd> +<div class="block">Always returns false.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/FetchAheadCursor.html#hasNext()">hasNext()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/FetchAheadCursor.html" title="class in com.amazon.carbonado.cursor">FetchAheadCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/FilteredCursor.html#hasNext()">hasNext()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor">FilteredCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/GroupedCursor.html#hasNext()">hasNext()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor">GroupedCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Cursor.html#hasNext()">hasNext()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a></dt> +<dd> +<div class="block">Returns true if this cursor has more elements.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/IntersectionCursor.html#hasNext()">hasNext()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor">IntersectionCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/IteratorCursor.html#hasNext()">hasNext()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor">IteratorCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/LimitCursor.html#hasNext()">hasNext()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/LimitCursor.html" title="class in com.amazon.carbonado.cursor">LimitCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MultiTransformedCursor.html#hasNext()">hasNext()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MultiTransformedCursor.html" title="class in com.amazon.carbonado.cursor">MultiTransformedCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SingletonCursor.html#hasNext()">hasNext()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SingletonCursor.html" title="class in com.amazon.carbonado.cursor">SingletonCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SkipCursor.html#hasNext()">hasNext()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SkipCursor.html" title="class in com.amazon.carbonado.cursor">SkipCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SortedCursor.html#hasNext()">hasNext()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SortedCursor.html" title="class in com.amazon.carbonado.cursor">SortedCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html#hasNext()">hasNext()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/SymmetricDifferenceCursor.html" title="class in com.amazon.carbonado.cursor">SymmetricDifferenceCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/ThrottledCursor.html#hasNext()">hasNext()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/ThrottledCursor.html" title="class in com.amazon.carbonado.cursor">ThrottledCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/TransformedCursor.html#hasNext()">hasNext()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/TransformedCursor.html" title="class in com.amazon.carbonado.cursor">TransformedCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/UnionCursor.html#hasNext()">hasNext()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor">UnionCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#hasNext()">hasNext()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html#hasProperty(java.lang.String)">hasProperty(String)</a></span> - Method in interface com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></dt> +<dd> +<div class="block">Check to see if a particular property has already been added to the list of + properties to generate</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#hasProperty(java.lang.String)">hasProperty(String)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#hasProperty(java.lang.String)">hasProperty(String)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#hasRangeEnd()">hasRangeEnd()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns true if any property filter with an operator of <a href="../com/amazon/carbonado/filter/RelOp.html#LT"><code>RelOp.LT</code></a> + or <a href="../com/amazon/carbonado/filter/RelOp.html#LE"><code>RelOp.LE</code></a> matches an index property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#hasRangeMatch()">hasRangeMatch()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns true if there is both a range start and range end.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#hasRangeStart()">hasRangeStart()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns true if any property filter with an operator of <a href="../com/amazon/carbonado/filter/RelOp.html#GT"><code>RelOp.GT</code></a> + or <a href="../com/amazon/carbonado/filter/RelOp.html#GE"><code>RelOp.GE</code></a> matches an index property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/IsolationLevel.html#highestCommon(com.amazon.carbonado.IsolationLevel)">highestCommon(IsolationLevel)</a></span> - Method in enum com.amazon.carbonado.<a href="../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></dt> +<dd> +<div class="block">Returns the highest common isolation level between this and the one + given.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">HotBackupCapability</span></a> - Interface in <a href="../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></dt> +<dd> +<div class="block">Capability for performing a backup of an active BDB environment.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat"><span class="strong">HotBackupCapability.Backup</span></a> - Interface in <a href="../com/amazon/carbonado/repo/sleepycat/package-summary.html">com.amazon.carbonado.repo.sleepycat</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Timeout.html#hours(long)">hours(long)</a></span> - Static method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></dt> +<dd> +<div class="block">Return a new Timeout in hours.</div> +</dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-7.html">Prev Letter</a></li> +<li><a href="index-9.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-8.html" target="_top">Frames</a></li> +<li><a href="index-8.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> diff --git a/apidocs/index-files/index-9.html b/apidocs/index-files/index-9.html new file mode 100644 index 0000000..593671b --- /dev/null +++ b/apidocs/index-files/index-9.html @@ -0,0 +1,765 @@ +<!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:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>I-Index (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="I-Index (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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-8.html">Prev Letter</a></li> +<li><a href="index-10.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-9.html" target="_top">Frames</a></li> +<li><a href="index-9.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="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_I_"> +<!-- --> +</a> +<h2 class="title">I</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent(int)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></dt> +<dd> +<div class="block">Adds a constant amount to the given indent level.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawUtil.html#increment(byte[])">increment(byte[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawUtil.html" title="class in com.amazon.carbonado.raw">RawUtil</a></dt> +<dd> +<div class="block">Adds one to an unsigned integer, represented as a byte array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#incrementVersion(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc)">incrementVersion(CodeBuilder, TypeDesc)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Generates code to increment a version property value, already on the stack.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent(Appendable, int)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></dt> +<dd> +<div class="block">Appends spaces to the given appendable.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><span class="strong">Independent</span></a> - Annotation Type in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">A hint for a dependent <a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> to allow a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property or type + to be undefined in the underlying schema.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Index.html" title="annotation in com.amazon.carbonado"><span class="strong">Index</span></a> - Annotation Type in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">An Index annotation provides a hint to the storage layer allowing <a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><code>queries</code></a> to be performed more quickly.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">IndexedQueryAnalyzer</span></a><<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Analyzes a simple query specification and determines which index is best + suited for its execution.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#IndexedQueryAnalyzer(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)">IndexedQueryAnalyzer(Class<S>, RepositoryAccess)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">IndexedQueryAnalyzer.Result</span></a> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">IndexedQueryExecutor</span></a><<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">QueryExecutor which utilizes an index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html#IndexedQueryExecutor(com.amazon.carbonado.qe.IndexedQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.CompositeScore)">IndexedQueryExecutor(IndexedQueryExecutor.Support<S>, StorableIndex<S>, CompositeScore<S>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">IndexedQueryExecutor.Support</span></a><<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Provides support for <a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>IndexedQueryExecutor</code></a>.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed"><span class="strong">IndexedRepositoryBuilder</span></a> - Class in <a href="../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></dt> +<dd> +<div class="block">Repository builder for the indexed repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#IndexedRepositoryBuilder()">IndexedRepositoryBuilder()</a></span> - Constructor for class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">IndexEntryAccessCapability</span></a> - Interface in <a href="../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></dt> +<dd> +<div class="block">Capability for gaining low-level access to index data, which can be used for + manual inspection and repair.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">IndexEntryAccessor</span></a><<a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></dt> +<dd> +<div class="block">Provides low-level access to index data, which can be used for manual + inspection and repair.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#indexEntryQuery(com.amazon.carbonado.info.StorableIndex)">indexEntryQuery(StorableIndex<S>)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a></dt> +<dd> +<div class="block">Returns an open query if the given index supports query access.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Indexes.html" title="annotation in com.amazon.carbonado"><span class="strong">Indexes</span></a> - Annotation Type in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">The Indexes annotation is applied to a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> for specifying all + the <a href="../com/amazon/carbonado/Index.html" title="annotation in com.amazon.carbonado"><code>indexes</code></a> it should have.</div> +</dd> +<dt><a href="../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><span class="strong">IndexInfo</span></a> - Interface in <a href="../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></dt> +<dd> +<div class="block">General information about an index defined in a <a href="../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>.</div> +</dd> +<dt><a href="../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">IndexInfoCapability</span></a> - Interface in <a href="../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></dt> +<dd> +<div class="block">Capability for getting information about physical indexes for storables.</div> +</dd> +<dt><a href="../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi"><span class="strong">IndexInfoImpl</span></a> - Class in <a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></dt> +<dd> +<div class="block">Basic implementation of an <a href="../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfo</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/IndexInfoImpl.html#IndexInfoImpl(java.lang.String, boolean, boolean, java.lang.String[], com.amazon.carbonado.info.Direction[])">IndexInfoImpl(String, boolean, boolean, String[], Direction[])</a></span> - Constructor for class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIntrospector.html#inferType(java.lang.Class)">inferType(Class)</a></span> - Static method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">StorableIntrospector</a></dt> +<dd> +<div class="block">Examines a class and determines what Storable type it implements.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#initialFilterValues()">initialFilterValues()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ExistsFilter.html#initialFilterValues()">initialFilterValues()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#initialFilterValues()">initialFilterValues()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns a FilterValues instance for assigning values to a + Filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#initialFilterValues()">initialFilterValues()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#initialVersion(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc, int)">initialVersion(CodeBuilder, TypeDesc, int)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Generates code to push an initial version property value on the stack.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#insert()">insert()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Inserts a new persistent value for this object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#INSERT_METHOD_NAME">INSERT_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, com.amazon.carbonado.raw.CustomStorableCodec)">instantiate(RawSupport, CustomStorableCodec)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html" title="interface in com.amazon.carbonado.raw">CustomStorableCodec.InstanceFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[], com.amazon.carbonado.raw.CustomStorableCodec)">instantiate(RawSupport, byte[], byte[], CustomStorableCodec)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html" title="interface in com.amazon.carbonado.raw">CustomStorableCodec.InstanceFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#instantiate()">instantiate()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#instantiate(byte[], byte[])">instantiate(byte[], byte[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport)">instantiate(RawSupport<S>)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[])">instantiate(RawSupport<S>, byte[], byte[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericInstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport)">instantiate(RawSupport)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericInstanceFactory.html" title="interface in com.amazon.carbonado.raw">GenericInstanceFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericInstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[])">instantiate(RawSupport, byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericInstanceFactory.html" title="interface in com.amazon.carbonado.raw">GenericInstanceFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericInstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[])">instantiate(RawSupport, byte[], byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericInstanceFactory.html" title="interface in com.amazon.carbonado.raw">GenericInstanceFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#instantiate()">instantiate()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with no key or value defined yet.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#instantiate(byte[])">instantiate(byte[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with no value defined yet.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#instantiate(byte[], byte[])">instantiate(byte[], byte[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with a specific key and value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport)">instantiate(RawSupport<S>)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with no key or value defined yet.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[])">instantiate(RawSupport<S>, byte[], byte[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with a specific key and value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#instantiate()">instantiate()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with no key or value defined yet.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#instantiate(byte[])">instantiate(byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with no value defined yet.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#instantiate(byte[], byte[])">instantiate(byte[], byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with a specific key and value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport)">instantiate(RawSupport<S>)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with no key or value defined yet.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[])">instantiate(RawSupport<S>, byte[], byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with a specific key and value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#instantiateCurrent()">instantiateCurrent()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Returns a new Storable instance for the currently referenced entry.</div> +</dd> +<dt><a href="../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">IntegerConstraint</span></a> - Annotation Type in <a href="../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></dt> +<dd> +<div class="block">Limits the value of a property to be a member of a specific set.</div> +</dd> +<dt><a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">IntegerConstraint.Constraint</span></a> - Class in <a href="../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></dt> +<dd> +<div class="block">Constraint implementation for <a href="../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>IntegerConstraint</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html#IntegerConstraint.Constraint(java.lang.Class, java.lang.String, com.amazon.carbonado.constraint.IntegerConstraint)">IntegerConstraint.Constraint(Class<?>, String, IntegerConstraint)</a></span> - Constructor for class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">IntegerConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html#IntegerConstraint.Constraint(java.lang.Class, java.lang.String, long, long, long[], long[])">IntegerConstraint.Constraint(Class<?>, String, long, long, long[], long[])</a></span> - Constructor for class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">IntegerConstraint.Constraint</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">IntersectionCursor</span></a><<a href="../com/amazon/carbonado/cursor/IntersectionCursor.html" title="type parameter in IntersectionCursor">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Wraps two Cursors and performs a <i>set intersection</i> operation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/IntersectionCursor.html#IntersectionCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)">IntersectionCursor(Cursor<S>, Cursor<S>, Comparator<S>)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor">IntersectionCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#IS_ALT_KEY_INITIALIZED_PREFIX">IS_ALT_KEY_INITIALIZED_PREFIX</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Name prefix of protected method in generated storable that returns false + if a specific alternate key is uninitialized.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#IS_PARTITION_KEY_INITIALIZED_METHOD_NAME">IS_PARTITION_KEY_INITIALIZED_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Name of protected method in generated storable that returns false if any + partition keys are uninitialized.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#IS_PK_INITIALIZED_METHOD_NAME">IS_PK_INITIALIZED_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Name of protected method in generated storable that returns false if any + primary keys are uninitialized.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#IS_PROPERTY_CLEAN">IS_PROPERTY_CLEAN</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#IS_PROPERTY_DIRTY">IS_PROPERTY_DIRTY</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#IS_PROPERTY_SUPPORTED">IS_PROPERTY_SUPPORTED</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#IS_PROPERTY_UNINITIALIZED">IS_PROPERTY_UNINITIALIZED</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME">IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Name of protected method in generated storable that returns false if any + non-nullable, non-pk properties are uninitialized.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#IS_VERSION_INITIALIZED_METHOD_NAME">IS_VERSION_INITIALIZED_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Name of protected method in generated storable that returns false if + version property is uninitialized.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#isAllClustered()">isAllClustered()</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if all indexes should be identified as clustered.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/FilteredCursor.html#isAllowed(S)">isAllowed(S)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor">FilteredCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isAlternateKeyMember()">isAlternateKeyMember()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property is a member of an alternate key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#isAssigned(com.amazon.carbonado.filter.PropertyFilter)">isAssigned(PropertyFilter<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns true if a value is assigned to the given PropertyFilter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/IsolationLevel.html#isAtLeast(com.amazon.carbonado.IsolationLevel)">isAtLeast(IsolationLevel)</a></span> - Method in enum com.amazon.carbonado.<a href="../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></dt> +<dd> +<div class="block">Returns true if this isolation level is at least as high as the one + given.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/IsolationLevel.html#isAtMost(com.amazon.carbonado.IsolationLevel)">isAtMost(IsolationLevel)</a></span> - Method in enum com.amazon.carbonado.<a href="../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></dt> +<dd> +<div class="block">Returns true if this isolation level is no higher than the one given.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#isAuthoritative()">isAuthoritative()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#isAutoIncrement()">isAutoIncrement()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns true if property is declared as @Automatic and column is + designated as auto-increment.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isAutomatic()">isAutomatic()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true of this property is given an automatic value upon insert.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/ShutdownCapability.html#isAutoShutdownEnabled()">isAutoShutdownEnabled()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a></dt> +<dd> +<div class="block">Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#isAutoShutdownEnabled()">isAutoShutdownEnabled()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/BinaryOpFilter.html#isBound()">isBound()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#isBound()">isBound()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ExistsFilter.html#isBound()">isBound()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#isBound()">isBound()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns true if all property filters are known to be properly + bound.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#isBound()">isBound()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#isBound()">isBound()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#isClosed()">isClosed()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> +<div class="block">Always returns true.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#isClosed()">isClosed()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns true if filter prevents any results from passing through.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#isClosed()">isClosed()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionManager.html#isClosed()">isClosed()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/IndexInfo.html#isClustered()">isClustered()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></dt> +<dd> +<div class="block">Returns true if index is clustered, which means it defines the physical + ordering of storables.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#isClustered()">isClustered()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns true if index is known to be clustered, which means it defines + the physical ordering of storables.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/IndexInfoImpl.html#isClustered()">isClustered()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#isColumnNullable()">isColumnNullable()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#isConsistent(com.amazon.carbonado.Storable, S)">isConsistent(Storable, S)</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a></dt> +<dd> +<div class="block">Returns true if the properties of the given index entry match those + contained in the master, exluding any version property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#isConsistent(com.amazon.carbonado.Storable, S)">isConsistent(Storable, S)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceAccess</a></dt> +<dd> +<div class="block">Returns true if the properties of the given reference match those + contained in the master, excluding any version property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#isConsistent(com.amazon.carbonado.Storable, S)">isConsistent(Storable, S)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>call getReferenceAccess</i></div> +</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#isConstant()">isConstant()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> +<div class="block">Returns true if this PropertyFilter has a constant value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/ConversionComparator.html#isConversionPossible(java.lang.Class)">isConversionPossible(Class)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/ConversionComparator.html" title="class in com.amazon.carbonado.util">ConversionComparator</a></dt> +<dd> +<div class="block">Returns true if a coversion is possible to the given type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#isDerived()">isDerived()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns true if any property in the chain is derived.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isDerived()">isDerived()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property is derived.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html#isDerived()">isDerived()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#isDerived()">isDerived()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorablePropertyMap.html#isEmpty()">isEmpty()</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryHints.html#isEmpty()">isEmpty()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/SoftValuedCache.html#isEmpty()">isEmpty()</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/CommonsLog.html#isEnabled()">isEnabled()</a></span> - Method in class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/CommonsLog.html" title="class in com.amazon.carbonado.repo.logging">CommonsLog</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/Log.html#isEnabled()">isEnabled()</a></span> - Method in interface com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html#isExplicit()">isExplicit()</a></span> - Method in interface com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a></dt> +<dd> +<div class="block">SyntheticBuilder may choose to alter the class name to prevent a + class name collision.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#isForceStoredSequence()">isForceStoredSequence()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if native sequences should not be used.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Transaction.html#isForUpdate()">isForUpdate()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></dt> +<dd> +<div class="block">Returns true if this transaction is in update mode, which is adjusted by + calling <a href="../com/amazon/carbonado/Transaction.html#setForUpdate(boolean)"><code>Transaction.setForUpdate(boolean)</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionPair.html#isForUpdate()">isForUpdate()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn">TransactionPair</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionScope.html#isForUpdate()">isForUpdate()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a></dt> +<dd> +<div class="block">Returns true if an active transaction exists and it is for update.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#isIndependent()">isIndependent()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isIndependent()">isIndependent()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property has been designated independent.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#isIndexClustered()">isIndexClustered()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns true if evaluated index is clustered.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#isIndexClustered()">isIndexClustered()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns true if local or foreign index is clustered.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#isIndexClustered()">isIndexClustered()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns true if evaluated index is clustered.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#isIndexRepairEnabled()">isIndexRepairEnabled()</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isIndexRepairEnabled()">isIndexRepairEnabled()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#isIndexUnique()">isIndexUnique()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns true if evaluated index is unique.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isJoin()">isJoin()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property is joined in any way to another Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#isKeyMatch()">isKeyMatch()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns true if evaluated index is unique and each of its properties has + an identity match.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html#isLob()">isLob()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#isLob()">isLob()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#isMaster()">isMaster()</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#isMaster()">isMaster()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#isMaster()">isMaster()</a></span> - Method in class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#isMaster()">isMaster()</a></span> - Method in class com.amazon.carbonado.repo.map.<a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#isMaster()">isMaster()</a></span> - Method in class com.amazon.carbonado.repo.replicated.<a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isMaster()">isMaster()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryBuilder.html#isMaster()">isMaster()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if repository should assume the role of master, which is + true by default.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isMultiversion()">isMultiversion()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns false by default because multiversion concurrency control (MVCC) + is not enabled.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ExistsFilter.html#isNotExists()">isNotExists()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#isNullable()">isNullable()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns true if any property in the chain can be null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isNullable()">isNullable()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property can be null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#isNullable()">isNullable()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> +<div class="block">Returns true of property can be set to null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#isNullable()">isNullable()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> +<div class="block">Returns true of property value can be set to null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html#isNullable()">isNullable()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#isNullable()">isNullable()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#isNullable()">isNullable()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado"><span class="strong">IsolationLevel</span></a> - Enum in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Describes a transaction isolation level.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isOneToOneJoin()">isOneToOneJoin()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property is one-to-one joined to another Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#isOpen()">isOpen()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns true if filter allows all results to pass through.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#isOpen()">isOpen()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> +<div class="block">Always returns true.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#isOuterJoin(int)">isOuterJoin(int)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns true if the property at the given index should be treated as an + outer join.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isPartitionKeyMember()">isPartitionKeyMember()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property is a member of a partition key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableKey.html#isPrimary()">isPrimary()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a></dt> +<dd> +<div class="block">Returns true if this key is primary, false otherwise.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isPrimaryKeyMember()">isPrimaryKeyMember()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property is a member of a primary key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#isPrimaryKeyMember()">isPrimaryKeyMember()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> +<div class="block">Returns true if property is a member of the primary key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#isPrimaryKeyMember()">isPrimaryKeyMember()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> +<div class="block">Returns true if property is a member of the primary key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isPrivate()">isPrivate()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if BDB environment is private.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#isPropertyClean(java.lang.String)">isPropertyClean(String)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Returns true if the given property of this Storable is clean.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#isPropertyDirty(java.lang.String)">isPropertyDirty(String)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Returns true if the given property of this Storable has been set, but no + load or store operation has been performed yet.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/StorableInfoCapability.html#isPropertySupported(java.lang.Class, java.lang.String)">isPropertySupported(Class<Storable>, String)</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability">StorableInfoCapability</a></dt> +<dd> +<div class="block">Returns true if the given property exists and is supported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableSupport.html#isPropertySupported(java.lang.String)">isPropertySupported(String)</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</a></dt> +<dd> +<div class="block">Returns true if the given property exists and is supported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#isPropertySupported(java.lang.String)">isPropertySupported(String)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Returns true if the given property exists and is supported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#isPropertyUninitialized(java.lang.String)">isPropertyUninitialized(String)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Returns true if the given property of this Storable has never been + loaded or set.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#isPublicMethodFinal(java.lang.Class, java.lang.String, org.cojen.classfile.TypeDesc, org.cojen.classfile.TypeDesc[])">isPublicMethodFinal(Class, String, TypeDesc, TypeDesc[])</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Returns true if a public final method exists which matches the given + specification.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isQuery()">isQuery()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property is a query, which also implies that it is + a join property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isReverseSplitOff()">isReverseSplitOff()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#isSelectable()">isSelectable()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns true if property is both supported and not a join.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/StorableInfoCapability.html#isSupported(java.lang.Class)">isSupported(Class<Storable>)</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability">StorableInfoCapability</a></dt> +<dd> +<div class="block">Returns true if the given storable type is supported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#isSupported(java.lang.Class)">isSupported(Class<?>)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Returns true if the type of the given property type is supported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#isSupported(org.cojen.classfile.TypeDesc)">isSupported(TypeDesc)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Returns true if the type of the given property type is supported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#isSupported()">isSupported()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> +<div class="block">Returns false only if storable type is <a href="../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>independent</code></a> + and no matching table was found.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#isSupported()">isSupported()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns false only if property is independent and no matching column was + found.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#isTransactionForUpdate()">isTransactionForUpdate()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></dt> +<dd> +<div class="block">Returns true if a transaction is in progress and it is for update.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/IndexInfo.html#isUnique()">isUnique()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></dt> +<dd> +<div class="block">Returns true if index entries are unique.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#isUnique()">isUnique()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/IndexInfoImpl.html#isUnique()">isUnique()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#isUnique()">isUnique()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> +<div class="block">True if the generated derived class should be considered unique.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#isUniqueConstraintError(java.sql.SQLException)">isUniqueConstraintError(SQLException)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></dt> +<dd> +<div class="block">Examines the SQLSTATE code of the given SQL exception and determines if + it is a unique constaint violation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isVersion()">isVersion()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property is the designated version number for the + Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#isVersion()">isVersion()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> +<div class="block">Returns true if this property is the designated version number for the + Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#isVersion()">isVersion()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> +<div class="block">Returns true if this property is the designated version number for the + Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#isVersion()">isVersion()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html#isVersioned()">isVersioned()</a></span> - Method in interface com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></dt> +<dd> +<div class="block">Returns true if a property with the version attribute has been addded</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#isVersioned()">isVersioned()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#isVersioned()">isVersioned()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#isWrapperFor(java.lang.Class)">isWrapperFor(Class<?>)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#isWrapperFor(java.lang.Class)">isWrapperFor(Class<?>)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">IterableQueryExecutor</span></a><<a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">QueryExecutor which fully scans an iterable collection.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html#IterableQueryExecutor(java.lang.Class, java.lang.Iterable)">IterableQueryExecutor(Class<S>, Iterable<S>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html#IterableQueryExecutor(java.lang.Class, java.lang.Iterable, java.util.concurrent.locks.Lock)">IterableQueryExecutor(Class<S>, Iterable<S>, Lock)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html#iterator()">iterator()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">MergeSortBuffer</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">IteratorCursor</span></a><<a href="../com/amazon/carbonado/cursor/IteratorCursor.html" title="type parameter in IteratorCursor">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Adapts an Iterator into a Cursor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/IteratorCursor.html#IteratorCursor(java.lang.Iterable)">IteratorCursor(Iterable<S>)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor">IteratorCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/IteratorCursor.html#IteratorCursor(java.lang.Iterable, java.util.concurrent.locks.Lock)">IteratorCursor(Iterable<S>, Lock)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor">IteratorCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/IteratorCursor.html#IteratorCursor(java.util.Iterator)">IteratorCursor(Iterator<S>)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor">IteratorCursor</a></dt> +<dd> </dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </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>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 class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-8.html">Prev Letter</a></li> +<li><a href="index-10.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-9.html" target="_top">Frames</a></li> +<li><a href="index-9.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 © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> |