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-9.html |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/index-files/index-9.html')
-rw-r--r-- | apidocs/index-files/index-9.html | 765 |
1 files changed, 765 insertions, 0 deletions
diff --git a/apidocs/index-files/index-9.html b/apidocs/index-files/index-9.html new file mode 100644 index 0000000..593671b --- /dev/null +++ b/apidocs/index-files/index-9.html @@ -0,0 +1,765 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_25) on Tue Dec 03 13:53:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>I-Index (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="I-Index (Carbonado 1.2.3 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../overview-summary.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="../overview-tree.html">Tree</a></li> +<li><a href="../deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-8.html">Prev Letter</a></li> +<li><a href="index-10.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-9.html" target="_top">Frames</a></li> +<li><a href="index-9.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_I_"> +<!-- --> +</a> +<h2 class="title">I</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html#increaseIndent(int)">increaseIndent(int)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></dt> +<dd> +<div class="block">Adds a constant amount to the given indent level.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawUtil.html#increment(byte[])">increment(byte[])</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawUtil.html" title="class in com.amazon.carbonado.raw">RawUtil</a></dt> +<dd> +<div class="block">Adds one to an unsigned integer, represented as a byte array.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#incrementVersion(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc)">incrementVersion(CodeBuilder, TypeDesc)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Generates code to increment a version property value, already on the stack.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html#indent(java.lang.Appendable, int)">indent(Appendable, int)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></dt> +<dd> +<div class="block">Appends spaces to the given appendable.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><span class="strong">Independent</span></a> - Annotation Type in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">A hint for a dependent <a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> to allow a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> property or type + to be undefined in the underlying schema.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Index.html" title="annotation in com.amazon.carbonado"><span class="strong">Index</span></a> - Annotation Type in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">An Index annotation provides a hint to the storage layer allowing <a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><code>queries</code></a> to be performed more quickly.</div> +</dd> +<dt><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">IndexedQueryAnalyzer</span></a><<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Analyzes a simple query specification and determines which index is best + suited for its execution.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#IndexedQueryAnalyzer(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)">IndexedQueryAnalyzer(Class<S>, RepositoryAccess)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">IndexedQueryAnalyzer.Result</span></a> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">IndexedQueryExecutor</span></a><<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">QueryExecutor which utilizes an index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html#IndexedQueryExecutor(com.amazon.carbonado.qe.IndexedQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.CompositeScore)">IndexedQueryExecutor(IndexedQueryExecutor.Support<S>, StorableIndex<S>, CompositeScore<S>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe"><span class="strong">IndexedQueryExecutor.Support</span></a><<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Provides support for <a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe"><code>IndexedQueryExecutor</code></a>.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed"><span class="strong">IndexedRepositoryBuilder</span></a> - Class in <a href="../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></dt> +<dd> +<div class="block">Repository builder for the indexed repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#IndexedRepositoryBuilder()">IndexedRepositoryBuilder()</a></span> - Constructor for class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">IndexEntryAccessCapability</span></a> - Interface in <a href="../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></dt> +<dd> +<div class="block">Capability for gaining low-level access to index data, which can be used for + manual inspection and repair.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">IndexEntryAccessor</span></a><<a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="type parameter in IndexEntryAccessor">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></dt> +<dd> +<div class="block">Provides low-level access to index data, which can be used for manual + inspection and repair.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#indexEntryQuery(com.amazon.carbonado.info.StorableIndex)">indexEntryQuery(StorableIndex<S>)</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a></dt> +<dd> +<div class="block">Returns an open query if the given index supports query access.</div> +</dd> +<dt><a href="../com/amazon/carbonado/Indexes.html" title="annotation in com.amazon.carbonado"><span class="strong">Indexes</span></a> - Annotation Type in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">The Indexes annotation is applied to a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> for specifying all + the <a href="../com/amazon/carbonado/Index.html" title="annotation in com.amazon.carbonado"><code>indexes</code></a> it should have.</div> +</dd> +<dt><a href="../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><span class="strong">IndexInfo</span></a> - Interface in <a href="../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></dt> +<dd> +<div class="block">General information about an index defined in a <a href="../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado"><code>Storage</code></a>.</div> +</dd> +<dt><a href="../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">IndexInfoCapability</span></a> - Interface in <a href="../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></dt> +<dd> +<div class="block">Capability for getting information about physical indexes for storables.</div> +</dd> +<dt><a href="../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi"><span class="strong">IndexInfoImpl</span></a> - Class in <a href="../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></dt> +<dd> +<div class="block">Basic implementation of an <a href="../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfo</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/IndexInfoImpl.html#IndexInfoImpl(java.lang.String, boolean, boolean, java.lang.String[], com.amazon.carbonado.info.Direction[])">IndexInfoImpl(String, boolean, boolean, String[], Direction[])</a></span> - Constructor for class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIntrospector.html#inferType(java.lang.Class)">inferType(Class)</a></span> - Static method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">StorableIntrospector</a></dt> +<dd> +<div class="block">Examines a class and determines what Storable type it implements.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#initialFilterValues()">initialFilterValues()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ExistsFilter.html#initialFilterValues()">initialFilterValues()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#initialFilterValues()">initialFilterValues()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns a FilterValues instance for assigning values to a + Filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#initialFilterValues()">initialFilterValues()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#initialVersion(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc, int)">initialVersion(CodeBuilder, TypeDesc, int)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Generates code to push an initial version property value on the stack.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#insert()">insert()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Inserts a new persistent value for this object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#INSERT_METHOD_NAME">INSERT_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, com.amazon.carbonado.raw.CustomStorableCodec)">instantiate(RawSupport, CustomStorableCodec)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html" title="interface in com.amazon.carbonado.raw">CustomStorableCodec.InstanceFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[], com.amazon.carbonado.raw.CustomStorableCodec)">instantiate(RawSupport, byte[], byte[], CustomStorableCodec)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.InstanceFactory.html" title="interface in com.amazon.carbonado.raw">CustomStorableCodec.InstanceFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#instantiate()">instantiate()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#instantiate(byte[], byte[])">instantiate(byte[], byte[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport)">instantiate(RawSupport<S>)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[])">instantiate(RawSupport<S>, byte[], byte[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericInstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport)">instantiate(RawSupport)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericInstanceFactory.html" title="interface in com.amazon.carbonado.raw">GenericInstanceFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericInstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[])">instantiate(RawSupport, byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericInstanceFactory.html" title="interface in com.amazon.carbonado.raw">GenericInstanceFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericInstanceFactory.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[])">instantiate(RawSupport, byte[], byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericInstanceFactory.html" title="interface in com.amazon.carbonado.raw">GenericInstanceFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#instantiate()">instantiate()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with no key or value defined yet.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#instantiate(byte[])">instantiate(byte[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with no value defined yet.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#instantiate(byte[], byte[])">instantiate(byte[], byte[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with a specific key and value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport)">instantiate(RawSupport<S>)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with no key or value defined yet.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[])">instantiate(RawSupport<S>, byte[], byte[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with a specific key and value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#instantiate()">instantiate()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with no key or value defined yet.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#instantiate(byte[])">instantiate(byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with no value defined yet.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#instantiate(byte[], byte[])">instantiate(byte[], byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with a specific key and value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport)">instantiate(RawSupport<S>)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with no key or value defined yet.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#instantiate(com.amazon.carbonado.raw.RawSupport, byte[], byte[])">instantiate(RawSupport<S>, byte[], byte[])</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Instantiate a Storable with a specific key and value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#instantiateCurrent()">instantiateCurrent()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Returns a new Storable instance for the currently referenced entry.</div> +</dd> +<dt><a href="../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint"><span class="strong">IntegerConstraint</span></a> - Annotation Type in <a href="../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></dt> +<dd> +<div class="block">Limits the value of a property to be a member of a specific set.</div> +</dd> +<dt><a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint"><span class="strong">IntegerConstraint.Constraint</span></a> - Class in <a href="../com/amazon/carbonado/constraint/package-summary.html">com.amazon.carbonado.constraint</a></dt> +<dd> +<div class="block">Constraint implementation for <a href="../com/amazon/carbonado/constraint/IntegerConstraint.html" title="annotation in com.amazon.carbonado.constraint"><code>IntegerConstraint</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html#IntegerConstraint.Constraint(java.lang.Class, java.lang.String, com.amazon.carbonado.constraint.IntegerConstraint)">IntegerConstraint.Constraint(Class<?>, String, IntegerConstraint)</a></span> - Constructor for class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">IntegerConstraint.Constraint</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html#IntegerConstraint.Constraint(java.lang.Class, java.lang.String, long, long, long[], long[])">IntegerConstraint.Constraint(Class<?>, String, long, long, long[], long[])</a></span> - Constructor for class com.amazon.carbonado.constraint.<a href="../com/amazon/carbonado/constraint/IntegerConstraint.Constraint.html" title="class in com.amazon.carbonado.constraint">IntegerConstraint.Constraint</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">IntersectionCursor</span></a><<a href="../com/amazon/carbonado/cursor/IntersectionCursor.html" title="type parameter in IntersectionCursor">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Wraps two Cursors and performs a <i>set intersection</i> operation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/IntersectionCursor.html#IntersectionCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)">IntersectionCursor(Cursor<S>, Cursor<S>, Comparator<S>)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/IntersectionCursor.html" title="class in com.amazon.carbonado.cursor">IntersectionCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#IS_ALT_KEY_INITIALIZED_PREFIX">IS_ALT_KEY_INITIALIZED_PREFIX</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Name prefix of protected method in generated storable that returns false + if a specific alternate key is uninitialized.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#IS_PARTITION_KEY_INITIALIZED_METHOD_NAME">IS_PARTITION_KEY_INITIALIZED_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Name of protected method in generated storable that returns false if any + partition keys are uninitialized.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#IS_PK_INITIALIZED_METHOD_NAME">IS_PK_INITIALIZED_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Name of protected method in generated storable that returns false if any + primary keys are uninitialized.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#IS_PROPERTY_CLEAN">IS_PROPERTY_CLEAN</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#IS_PROPERTY_DIRTY">IS_PROPERTY_DIRTY</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#IS_PROPERTY_SUPPORTED">IS_PROPERTY_SUPPORTED</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#IS_PROPERTY_UNINITIALIZED">IS_PROPERTY_UNINITIALIZED</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME">IS_REQUIRED_DATA_INITIALIZED_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Name of protected method in generated storable that returns false if any + non-nullable, non-pk properties are uninitialized.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#IS_VERSION_INITIALIZED_METHOD_NAME">IS_VERSION_INITIALIZED_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Name of protected method in generated storable that returns false if + version property is uninitialized.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#isAllClustered()">isAllClustered()</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if all indexes should be identified as clustered.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/FilteredCursor.html#isAllowed(S)">isAllowed(S)</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/FilteredCursor.html" title="class in com.amazon.carbonado.cursor">FilteredCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isAlternateKeyMember()">isAlternateKeyMember()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property is a member of an alternate key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#isAssigned(com.amazon.carbonado.filter.PropertyFilter)">isAssigned(PropertyFilter<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns true if a value is assigned to the given PropertyFilter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/IsolationLevel.html#isAtLeast(com.amazon.carbonado.IsolationLevel)">isAtLeast(IsolationLevel)</a></span> - Method in enum com.amazon.carbonado.<a href="../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></dt> +<dd> +<div class="block">Returns true if this isolation level is at least as high as the one + given.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/IsolationLevel.html#isAtMost(com.amazon.carbonado.IsolationLevel)">isAtMost(IsolationLevel)</a></span> - Method in enum com.amazon.carbonado.<a href="../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado">IsolationLevel</a></dt> +<dd> +<div class="block">Returns true if this isolation level is no higher than the one given.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#isAuthoritative()">isAuthoritative()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#isAutoIncrement()">isAutoIncrement()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns true if property is declared as @Automatic and column is + designated as auto-increment.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isAutomatic()">isAutomatic()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true of this property is given an automatic value upon insert.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/ShutdownCapability.html#isAutoShutdownEnabled()">isAutoShutdownEnabled()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/ShutdownCapability.html" title="interface in com.amazon.carbonado.capability">ShutdownCapability</a></dt> +<dd> +<div class="block">Returns true if repository has a shutdown hook registered to + automatically call shutdown when the virtual machine exits.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#isAutoShutdownEnabled()">isAutoShutdownEnabled()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/BinaryOpFilter.html#isBound()">isBound()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#isBound()">isBound()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ExistsFilter.html#isBound()">isBound()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#isBound()">isBound()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns true if all property filters are known to be properly + bound.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#isBound()">isBound()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#isBound()">isBound()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#isClosed()">isClosed()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> +<div class="block">Always returns true.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#isClosed()">isClosed()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns true if filter prevents any results from passing through.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#isClosed()">isClosed()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionManager.html#isClosed()">isClosed()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionManager.html" title="class in com.amazon.carbonado.txn">TransactionManager</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/IndexInfo.html#isClustered()">isClustered()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></dt> +<dd> +<div class="block">Returns true if index is clustered, which means it defines the physical + ordering of storables.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#isClustered()">isClustered()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns true if index is known to be clustered, which means it defines + the physical ordering of storables.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/IndexInfoImpl.html#isClustered()">isClustered()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#isColumnNullable()">isColumnNullable()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#isConsistent(com.amazon.carbonado.Storable, S)">isConsistent(Storable, S)</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a></dt> +<dd> +<div class="block">Returns true if the properties of the given index entry match those + contained in the master, exluding any version property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#isConsistent(com.amazon.carbonado.Storable, S)">isConsistent(Storable, S)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceAccess</a></dt> +<dd> +<div class="block">Returns true if the properties of the given reference match those + contained in the master, excluding any version property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#isConsistent(com.amazon.carbonado.Storable, S)">isConsistent(Storable, S)</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>call getReferenceAccess</i></div> +</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#isConstant()">isConstant()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> +<div class="block">Returns true if this PropertyFilter has a constant value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/ConversionComparator.html#isConversionPossible(java.lang.Class)">isConversionPossible(Class)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/ConversionComparator.html" title="class in com.amazon.carbonado.util">ConversionComparator</a></dt> +<dd> +<div class="block">Returns true if a coversion is possible to the given type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#isDerived()">isDerived()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns true if any property in the chain is derived.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isDerived()">isDerived()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property is derived.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html#isDerived()">isDerived()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#isDerived()">isDerived()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorablePropertyMap.html#isEmpty()">isEmpty()</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryHints.html#isEmpty()">isEmpty()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/SoftValuedCache.html#isEmpty()">isEmpty()</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/CommonsLog.html#isEnabled()">isEnabled()</a></span> - Method in class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/CommonsLog.html" title="class in com.amazon.carbonado.repo.logging">CommonsLog</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/Log.html#isEnabled()">isEnabled()</a></span> - Method in interface com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/Log.html" title="interface in com.amazon.carbonado.repo.logging">Log</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html#isExplicit()">isExplicit()</a></span> - Method in interface com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a></dt> +<dd> +<div class="block">SyntheticBuilder may choose to alter the class name to prevent a + class name collision.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#isForceStoredSequence()">isForceStoredSequence()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if native sequences should not be used.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Transaction.html#isForUpdate()">isForUpdate()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></dt> +<dd> +<div class="block">Returns true if this transaction is in update mode, which is adjusted by + calling <a href="../com/amazon/carbonado/Transaction.html#setForUpdate(boolean)"><code>Transaction.setForUpdate(boolean)</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionPair.html#isForUpdate()">isForUpdate()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn">TransactionPair</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionScope.html#isForUpdate()">isForUpdate()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a></dt> +<dd> +<div class="block">Returns true if an active transaction exists and it is for update.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#isIndependent()">isIndependent()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isIndependent()">isIndependent()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property has been designated independent.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#isIndexClustered()">isIndexClustered()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns true if evaluated index is clustered.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#isIndexClustered()">isIndexClustered()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns true if local or foreign index is clustered.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#isIndexClustered()">isIndexClustered()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns true if evaluated index is clustered.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#isIndexRepairEnabled()">isIndexRepairEnabled()</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isIndexRepairEnabled()">isIndexRepairEnabled()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#isIndexUnique()">isIndexUnique()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns true if evaluated index is unique.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isJoin()">isJoin()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property is joined in any way to another Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#isKeyMatch()">isKeyMatch()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns true if evaluated index is unique and each of its properties has + an identity match.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html#isLob()">isLob()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#isLob()">isLob()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#isMaster()">isMaster()</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#isMaster()">isMaster()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#isMaster()">isMaster()</a></span> - Method in class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#isMaster()">isMaster()</a></span> - Method in class com.amazon.carbonado.repo.map.<a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#isMaster()">isMaster()</a></span> - Method in class com.amazon.carbonado.repo.replicated.<a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isMaster()">isMaster()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryBuilder.html#isMaster()">isMaster()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if repository should assume the role of master, which is + true by default.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isMultiversion()">isMultiversion()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns false by default because multiversion concurrency control (MVCC) + is not enabled.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ExistsFilter.html#isNotExists()">isNotExists()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#isNullable()">isNullable()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns true if any property in the chain can be null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isNullable()">isNullable()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property can be null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#isNullable()">isNullable()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> +<div class="block">Returns true of property can be set to null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#isNullable()">isNullable()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> +<div class="block">Returns true of property value can be set to null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html#isNullable()">isNullable()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#isNullable()">isNullable()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#isNullable()">isNullable()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/IsolationLevel.html" title="enum in com.amazon.carbonado"><span class="strong">IsolationLevel</span></a> - Enum in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Describes a transaction isolation level.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isOneToOneJoin()">isOneToOneJoin()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property is one-to-one joined to another Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#isOpen()">isOpen()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns true if filter allows all results to pass through.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#isOpen()">isOpen()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> +<div class="block">Always returns true.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#isOuterJoin(int)">isOuterJoin(int)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns true if the property at the given index should be treated as an + outer join.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isPartitionKeyMember()">isPartitionKeyMember()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property is a member of a partition key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableKey.html#isPrimary()">isPrimary()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a></dt> +<dd> +<div class="block">Returns true if this key is primary, false otherwise.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isPrimaryKeyMember()">isPrimaryKeyMember()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property is a member of a primary key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#isPrimaryKeyMember()">isPrimaryKeyMember()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> +<div class="block">Returns true if property is a member of the primary key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#isPrimaryKeyMember()">isPrimaryKeyMember()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> +<div class="block">Returns true if property is a member of the primary key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isPrivate()">isPrivate()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if BDB environment is private.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#isPropertyClean(java.lang.String)">isPropertyClean(String)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Returns true if the given property of this Storable is clean.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#isPropertyDirty(java.lang.String)">isPropertyDirty(String)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Returns true if the given property of this Storable has been set, but no + load or store operation has been performed yet.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/StorableInfoCapability.html#isPropertySupported(java.lang.Class, java.lang.String)">isPropertySupported(Class<Storable>, String)</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability">StorableInfoCapability</a></dt> +<dd> +<div class="block">Returns true if the given property exists and is supported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableSupport.html#isPropertySupported(java.lang.String)">isPropertySupported(String)</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</a></dt> +<dd> +<div class="block">Returns true if the given property exists and is supported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#isPropertySupported(java.lang.String)">isPropertySupported(String)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Returns true if the given property exists and is supported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#isPropertyUninitialized(java.lang.String)">isPropertyUninitialized(String)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Returns true if the given property of this Storable has never been + loaded or set.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#isPublicMethodFinal(java.lang.Class, java.lang.String, org.cojen.classfile.TypeDesc, org.cojen.classfile.TypeDesc[])">isPublicMethodFinal(Class, String, TypeDesc, TypeDesc[])</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Returns true if a public final method exists which matches the given + specification.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isQuery()">isQuery()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property is a query, which also implies that it is + a join property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#isReverseSplitOff()">isReverseSplitOff()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#isSelectable()">isSelectable()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns true if property is both supported and not a join.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/StorableInfoCapability.html#isSupported(java.lang.Class)">isSupported(Class<Storable>)</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability">StorableInfoCapability</a></dt> +<dd> +<div class="block">Returns true if the given storable type is supported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#isSupported(java.lang.Class)">isSupported(Class<?>)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Returns true if the type of the given property type is supported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#isSupported(org.cojen.classfile.TypeDesc)">isSupported(TypeDesc)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Returns true if the type of the given property type is supported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#isSupported()">isSupported()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> +<div class="block">Returns false only if storable type is <a href="../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>independent</code></a> + and no matching table was found.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#isSupported()">isSupported()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns false only if property is independent and no matching column was + found.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#isTransactionForUpdate()">isTransactionForUpdate()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></dt> +<dd> +<div class="block">Returns true if a transaction is in progress and it is for update.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/IndexInfo.html#isUnique()">isUnique()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></dt> +<dd> +<div class="block">Returns true if index entries are unique.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#isUnique()">isUnique()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/IndexInfoImpl.html#isUnique()">isUnique()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#isUnique()">isUnique()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> +<div class="block">True if the generated derived class should be considered unique.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#isUniqueConstraintError(java.sql.SQLException)">isUniqueConstraintError(SQLException)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></dt> +<dd> +<div class="block">Examines the SQLSTATE code of the given SQL exception and determines if + it is a unique constaint violation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#isVersion()">isVersion()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns true if this property is the designated version number for the + Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#isVersion()">isVersion()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> +<div class="block">Returns true if this property is the designated version number for the + Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#isVersion()">isVersion()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> +<div class="block">Returns true if this property is the designated version number for the + Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#isVersion()">isVersion()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html#isVersioned()">isVersioned()</a></span> - Method in interface com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></dt> +<dd> +<div class="block">Returns true if a property with the version attribute has been addded</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#isVersioned()">isVersioned()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#isVersioned()">isVersioned()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#isWrapperFor(java.lang.Class)">isWrapperFor(Class<?>)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#isWrapperFor(java.lang.Class)">isWrapperFor(Class<?>)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">IterableQueryExecutor</span></a><<a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="type parameter in IterableQueryExecutor">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">QueryExecutor which fully scans an iterable collection.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html#IterableQueryExecutor(java.lang.Class, java.lang.Iterable)">IterableQueryExecutor(Class<S>, Iterable<S>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html#IterableQueryExecutor(java.lang.Class, java.lang.Iterable, java.util.concurrent.locks.Lock)">IterableQueryExecutor(Class<S>, Iterable<S>, Lock)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html#iterator()">iterator()</a></span> - Method in class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/MergeSortBuffer.html" title="class in com.amazon.carbonado.cursor">MergeSortBuffer</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">IteratorCursor</span></a><<a href="../com/amazon/carbonado/cursor/IteratorCursor.html" title="type parameter in IteratorCursor">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Adapts an Iterator into a Cursor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/IteratorCursor.html#IteratorCursor(java.lang.Iterable)">IteratorCursor(Iterable<S>)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor">IteratorCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/IteratorCursor.html#IteratorCursor(java.lang.Iterable, java.util.concurrent.locks.Lock)">IteratorCursor(Iterable<S>, Lock)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor">IteratorCursor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/IteratorCursor.html#IteratorCursor(java.util.Iterator)">IteratorCursor(Iterator<S>)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/IteratorCursor.html" title="class in com.amazon.carbonado.cursor">IteratorCursor</a></dt> +<dd> </dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../overview-summary.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="../overview-tree.html">Tree</a></li> +<li><a href="../deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-8.html">Prev Letter</a></li> +<li><a href="index-10.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-9.html" target="_top">Frames</a></li> +<li><a href="index-9.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> |