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/index-3.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/index-files/index-3.html')
| -rw-r--r-- | apidocs/index-files/index-3.html | 1109 |
1 files changed, 1109 insertions, 0 deletions
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> |