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-7.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/index-files/index-7.html')
| -rw-r--r-- | apidocs/index-files/index-7.html | 2226 |
1 files changed, 2226 insertions, 0 deletions
diff --git a/apidocs/index-files/index-7.html b/apidocs/index-files/index-7.html new file mode 100644 index 0000000..d2b4ac9 --- /dev/null +++ b/apidocs/index-files/index-7.html @@ -0,0 +1,2226 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_25) on Tue Dec 03 13:53:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>G-Index (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="G-Index (Carbonado 1.2.3 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../overview-summary.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="../overview-tree.html">Tree</a></li> +<li><a href="../deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-6.html">Prev Letter</a></li> +<li><a href="index-8.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-7.html" target="_top">Frames</a></li> +<li><a href="index-7.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_G_"> +<!-- --> +</a> +<h2 class="title">G</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#gatherAllBridgeTypes(java.util.Set, java.lang.Class)">gatherAllBridgeTypes(Set<Class>, Class)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Collect a set of all the interfaces and recursively all superclasses for the leaf + (genericised class) and root (genericised base class).</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#gatherAllDataProperties()">gatherAllDataProperties()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Returns all non-derived data properties for storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#gatherAllKeyProperties()">gatherAllKeyProperties()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Returns all key properties as ordered properties, possibly with + unspecified directions.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#gatherAllProperties()">gatherAllProperties()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Returns all non-join, non-derived properties for storable.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw"><span class="strong">GenericEncodingStrategy</span></a><<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Generates bytecode instructions for encoding/decoding Storable properties + to/from raw bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#GenericEncodingStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex)">GenericEncodingStrategy(Class<S>, StorableIndex<S>)</a></span> - Constructor for class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#GenericEncodingStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, int, int, int, int)">GenericEncodingStrategy(Class<S>, StorableIndex<S>, int, int, int, int)</a></span> - Constructor for class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/raw/GenericInstanceFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">GenericInstanceFactory</span></a> - Interface in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Can be used with <a href="../com/amazon/carbonado/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util"><code>QuickConstructorGenerator</code></a> + for instantiating generic storable instances.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw"><span class="strong">GenericPropertyInfo</span></a> - Interface in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Minimal information required by <a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw"><code>GenericEncodingStrategy</code></a> to encode + and decode a storable property.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw"><span class="strong">GenericStorableCodec</span></a><<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Generic codec that supports any kind of storable by auto-generating and + caching storable implementations.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="interface in com.amazon.carbonado.raw"><span class="strong">GenericStorableCodec.Decoder</span></a><<a href="../com/amazon/carbonado/raw/GenericStorableCodec.Decoder.html" title="type parameter in GenericStorableCodec.Decoder">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Used for decoding different generations of Storable.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw"><span class="strong">GenericStorableCodec.SearchKeyFactory</span></a><<a href="../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="type parameter in GenericStorableCodec.SearchKeyFactory">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Interface in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Creates custom raw search keys for <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types.</div> +</dd> +<dt><a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw"><span class="strong">GenericStorableCodecFactory</span></a> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Factory for generic codec that supports any kind of storable by + auto-generating and caching storable implementations.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#GenericStorableCodecFactory()">GenericStorableCodecFactory()</a></span> - Constructor for class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorablePropertyMap.html#get(java.lang.Object)">get(Object)</a></span> - Method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorablePropertyMap.html" title="class in com.amazon.carbonado.gen">StorablePropertyMap</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty)">get(StorableProperty<S>)</a></span> - Static method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns a canonical instance which has no chain.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty...)">get(StorableProperty<S>, StorableProperty<?>...)</a></span> - Static method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns a canonical instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty[], boolean[])">get(StorableProperty<S>, StorableProperty<?>[], boolean[])</a></span> - Static method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns a canonical instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">get(StorableProperty<S>, Direction)</a></span> - Static method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></dt> +<dd> +<div class="block">Returns a canonical instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.info.Direction)">get(ChainedProperty<S>, Direction)</a></span> - Static method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></dt> +<dd> +<div class="block">Returns a canonical instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#get(java.lang.Class, java.lang.String)">get(Class<S>, String)</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> +<div class="block">Returns a canonical instance composed of the given ordering.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#get(java.lang.Class, java.lang.String...)">get(Class<S>, String...)</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#get(com.amazon.carbonado.info.OrderedProperty...)">get(OrderedProperty<S>...)</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#get(java.util.List)">get(List<OrderedProperty<S>>)</a></span> - Static method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingList.html#get(int)">get(int)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryHints.html#get(com.amazon.carbonado.qe.QueryHint)">get(QueryHint)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a></dt> +<dd> +<div class="block">Returns null if hint is not provided.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceValueProducerPool.html#get(java.lang.String)">get(String)</a></span> - Method in class com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceValueProducerPool.html" title="class in com.amazon.carbonado.sequence">SequenceValueProducerPool</a></dt> +<dd> +<div class="block">Returns a SequenceValueProducer instance for the given name, which is + lazily created and pooled.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/AbstractPool.html#get(K)">get(K)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/AbstractPool.html" title="class in com.amazon.carbonado.util">AbstractPool</a></dt> +<dd> +<div class="block">Returns a value for the given key, which is lazily created and + pooled.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/BelatedCreator.html#get(int)">get(int)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/BelatedCreator.html" title="class in com.amazon.carbonado.util">BelatedCreator</a></dt> +<dd> +<div class="block">Returns real or bogus object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/SoftValuedCache.html#get(K)">get(K)</a></span> - Method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/SoftValuedCache.html" title="class in com.amazon.carbonado.util">SoftValuedCache</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#GET_PROPERTY_VALUE">GET_PROPERTY_VALUE</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#GET_TRANSACTION_ISOLATION_LEVEL_METHOD_NAME">GET_TRANSACTION_ISOLATION_LEVEL_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Repository API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/MasterStorableGenerator.html#getAbstractClass(java.lang.Class, java.util.EnumSet)">getAbstractClass(Class<S>, EnumSet<MasterFeature>)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/MasterStorableGenerator.html" title="class in com.amazon.carbonado.gen">MasterStorableGenerator</a></dt> +<dd> +<div class="block">Returns an abstract implementation of the given Storable type, which + is fully thread-safe.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableGenerator.html#getAbstractClass(java.lang.Class)">getAbstractClass(Class<S>)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableGenerator.html" title="class in com.amazon.carbonado.gen">StorableGenerator</a></dt> +<dd> +<div class="block">Returns an abstract implementation of the given Storable type, which is + fully thread-safe.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawStorableGenerator.html#getAbstractClass(java.lang.Class, boolean)">getAbstractClass(Class<S>, boolean)</a></span> - Static method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawStorableGenerator.html" title="class in com.amazon.carbonado.raw">RawStorableGenerator</a></dt> +<dd> +<div class="block">Returns an abstract implementation of the given Storable type, which is + fully thread-safe.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#getAccessorAnnotationDescriptors()">getAccessorAnnotationDescriptors()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> +<div class="block">Returns all the added accessor annotation descriptors in an unmodifiable list.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#getActualRepositoryBuilder()">getActualRepositoryBuilder()</a></span> - Method in class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the Repository that all calls are wrapped to.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getAdapter()">getAdapter()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns this property's adapter, or null if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#getAdapter()">getAdapter()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdapterConstructor()">getAdapterConstructor()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></dt> +<dd> +<div class="block">Returns the constructor for the adapter class.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdapterInstance()">getAdapterInstance()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></dt> +<dd> +<div class="block">Returns an instance of the adapter, for which an adapt method is applied to.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#getAdapterParams()">getAdapterParams()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> +<div class="block">Parameters for adapter, or null if property has no explicit adapter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#getAdapterParams()">getAdapterParams()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> +<div class="block">Parameters for adapter, or null if property has no explicit adapter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#getAdapterTypeName()">getAdapterTypeName()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> +<div class="block">Adapter type name is a fully qualified Java class name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#getAdapterTypeName()">getAdapterTypeName()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> +<div class="block">Adapter type name is a fully qualified Java class name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdaptMethod(int)">getAdaptMethod(int)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></dt> +<dd> +<div class="block">Returns a specific adapt method.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdaptMethodCount()">getAdaptMethodCount()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></dt> +<dd> +<div class="block">Returns the count of all defined adapt methods.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdaptMethods()">getAdaptMethods()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></dt> +<dd> +<div class="block">Returns a new array with all the adapt methods in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getAlias(int)">getAlias(int)</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns a specific alias for the Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getAlias(int)">getAlias(int)</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a specific alias for this property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getAliasCount()">getAliasCount()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns the count of aliases for the Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getAliasCount()">getAliasCount()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the count of aliases for this property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getAliases()">getAliases()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns a new array with all the alias names in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getAliases()">getAliases()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a new array with all the alias names in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorageAccess.html#getAllIndexes()">getAllIndexes()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a></dt> +<dd> +<div class="block">Returns all the available indexes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getAllProperties()">getAllProperties()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns all the storable properties in an unmodifiable map.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getAllProperties()">getAllProperties()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns all the properties of this layout, in their proper order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#getAllProperties()">getAllProperties()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> +<div class="block">Convenient access to all the storable properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getAllProperties()">getAllProperties()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getAlternateKey(int)">getAlternateKey(int)</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns a specific alternate key for the Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getAlternateKeyCount()">getAlternateKeyCount()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns the count of alternate keys for the Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getAlternateKeys()">getAlternateKeys()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns a new array with all the alternate keys in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAnnotation.html#getAnnotatedMethod()">getAnnotatedMethod()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></dt> +<dd> +<div class="block">Returns the method that has the annotation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAnnotation()">getAnnotation()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></dt> +<dd> +<div class="block">Returns the annotation that applied this adapter, or null if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAnnotation.html#getAnnotation()">getAnnotation()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></dt> +<dd> +<div class="block">Returns the actual annotation instance, which may be null if annotation + was automatically applied.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyConstraint.html#getAnnotation()">getAnnotation()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a></dt> +<dd> +<div class="block">Returns the annotation that applied this constraint.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAnnotation.html#getAnnotationType()">getAnnotationType()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></dt> +<dd> +<div class="block">Returns the type of annotation that was applied to the property method.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getAppliedAdapter()">getAppliedAdapter()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns the adapter that needs to be applied to properties returned from + ResultSets and set into PreparedStatements.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getArrangementScore()">getArrangementScore()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns a value which indicates how well the index property order + matches the property filter specification order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#getAssignedValue(com.amazon.carbonado.filter.PropertyFilter)">getAssignedValue(PropertyFilter<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns the value assigned to the given PropertyFilter, throwing an + exception if not assigned.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getBDBProduct()">getBDBProduct()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the BDB product to use, which is JE by default.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html#getBDBProduct()">getBDBProduct()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">EnvironmentCapability</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getBeanName()">getBeanName()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the bean name of this property, which is derived from the read + and write method names.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#getBindID()">getBindID()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> +<div class="block">Bind ID is used to distinguish this PropertyFilter instance from another + against the same property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#getBlankParameterCount()">getBlankParameterCount()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns the amount of values yet to be assigned.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#getBlankParameterCount()">getBlankParameterCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns zero.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#getBlankParameterCount()">getBlankParameterCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#getBlankParameterCount()">getBlankParameterCount()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns the amount of blank parameters that need to be filled in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawSupport.html#getBlob(S, java.lang.String, long)">getBlob(S, String, long)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></dt> +<dd> +<div class="block">Returns the Blob for the given locator, returning null if not found.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/LobEngine.html#getBlobValue(long)">getBlobValue(long)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></dt> +<dd> +<div class="block">Loads a Blob value, without checking if it exists or not.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.html#getBlockCount()">getBlockCount()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></dt> +<dd> +<div class="block">Returns number of blocks required to store Lob.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.Block.html#getBlockNumber()">getBlockNumber()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></dt> +<dd> +<div class="block">First block number is logically zero, but subtract 0x80000000 to get + actual number.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.html#getBlockSize()">getBlockSize()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#getBoxedType()">getBoxedType()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> +<div class="block">Returns the type of the ChainedProperty property, boxed into an object + if primitive.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCachePercent()">getCachePercent()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the percent of JVM heap used by the repository cache, or + null if default should be selected.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCacheSize()">getCacheSize()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the repository cache size, or null if default should be + selected.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Repository.html#getCapability(java.lang.Class)">getCapability(Class<C>)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></dt> +<dd> +<div class="block">Requests a specific capability of this Repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#getCapability(java.lang.Class)">getCapability(Class<C>)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> +<div class="block">Default implementation checks if Repository implements Capability + interface, and if so, returns the Repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getCatalog()">getCatalog()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the optional catalog to search for metadata.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getCatalogName()">getCatalogName()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> +<div class="block">Returns the optional catalog name for the Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#getChainCount()">getChainCount()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns amount of properties chained from prime property, which may be + zero.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ExistsFilter.html#getChainedProperty()">getChainedProperty()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></dt> +<dd> +<div class="block">Returns the join property that is being checked for existence or + non-existence.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#getChainedProperty()">getChainedProperty()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#getChainedProperty(int)">getChainedProperty(int)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/OrderedProperty.html#getChainedProperty()">getChainedProperty()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getCharOctetLength()">getCharOctetLength()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns the maximum amount of bytes for property value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCheckpointInterval()">getCheckpointInterval()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCheckpointThresholdKB()">getCheckpointThresholdKB()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCheckpointThresholdMinutes()">getCheckpointThresholdMinutes()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getChecksumEnabled()">getChecksumEnabled()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if checksum verification is enabled.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/ClassFileBuilder.html#getClassFile()">getClassFile()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#getClassNameProvider()">getClassNameProvider()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawSupport.html#getClob(S, java.lang.String, long)">getClob(S, String, long)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></dt> +<dd> +<div class="block">Returns the Clob for the given locator, returning null if not found.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/LobEngine.html#getClobValue(long)">getClobValue(long)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></dt> +<dd> +<div class="block">Loads a Clob value, without checking if it exists or not.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#getClosedFilter(java.lang.Class)">getClosedFilter(Class<S>)</a></span> - Static method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns a cached filter instance that operates on the given type, which + prevents any results from passing through.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getColumnName()">getColumnName()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns the table column for this property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getColumnSize()">getColumnSize()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">The column size is either the maximum number of characters or the + numeric precision.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#getComparator()">getComparator()</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a></dt> +<dd> +<div class="block">Returns a comparator for ordering index entries.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#getComparator()">getComparator()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceAccess</a></dt> +<dd> +<div class="block">Returns a comparator for ordering storable reference instances.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#getComparator()">getComparator()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>call getReferenceAccess</i></div> +</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getCompositeScore()">getCompositeScore()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns the score on how well the selected index performs the + desired filtering and ordering.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutOptions.html#getCompressionType()">getCompressionType()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#getCompressionType(java.lang.Class)">getCompressionType(Class<? extends Storable>)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CompressedStorableCodecFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getCompressor(java.lang.String)">getCompressor(String)</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Return the compressor used for the given storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#getConnection()">getConnection()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></dt> +<dd> +<div class="block">Any connection returned by this method must be closed by calling + yieldConnection.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#getConnection()">getConnection()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#getConnection(java.lang.String, java.lang.String)">getConnection(String, String)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#getConnection()">getConnection()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#getConnection(java.lang.String, java.lang.String)">getConnection(String, String)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getConstantKeyPrefixLength()">getConstantKeyPrefixLength()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Returns amount of prefix key bytes that encoding strategy instance + produces which are always the same.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyConstraint.html#getConstrainMethod()">getConstrainMethod()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a></dt> +<dd> +<div class="block">Returns the best matching property checking method in the validator.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getConstraint(int)">getConstraint(int)</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a specific constraint for this property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyConstraint.html#getConstraintConstructor()">getConstraintConstructor()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a></dt> +<dd> +<div class="block">Returns the constructor for the constraint class.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getConstraintCount()">getConstraintCount()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the count of constraints for this property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getConstraints()">getConstraints()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a new array with all the constraints in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getCovariantTypes()">getCovariantTypes()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns additional types of this property, all of which are assignable + by the primary type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getCoveringCount()">getCoveringCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns number of covering property filters which are supported by the + evaluated index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getCoveringFilter()">getCoveringFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the composite covering filter supported by the evaluated index, + or null if the covering count is zero.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getCoveringFilter()">getCoveringFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getCoveringFilters()">getCoveringFilters()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the covering filters which are supported by the evaluated index, + which is a subset of the remainder filters.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getCoveringRemainderFilter()">getCoveringRemainderFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the composite remainder filter without including the covering + filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getCreationDateTime()">getCreationDateTime()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns the date and time for when this layout generation was created.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getCreationHost()">getCreationHost()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns the host machine that created this generation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#getCreationHost()">getCreationHost()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> +<div class="block">Returns the host machine that created this generation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#getCreationTimestamp()">getCreationTimestamp()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> +<div class="block">Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getCreationTimestamp()">getCreationTimestamp()</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></dt> +<dd> +<div class="block">Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getCreationTimestamp()">getCreationTimestamp()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> +<div class="block">Returns the milliseconds from 1970-01-01T00:00:00Z when this record was + created.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getCreationUser()">getCreationUser()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns the user that created this layout generation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#getCreationUser()">getCreationUser()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> +<div class="block">Returns the user that created this generation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedFilterException.html#getCulpritIndex()">getCulpritIndex()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado">MalformedFilterException</a></dt> +<dd> +<div class="block">Returns the index into the query filter string that is malformed, or a + negative value if not known.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#getCurrentKey()">getCurrentKey()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Returns the contents of the current key being referenced, or null + otherwise.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawCursor.html#getCurrentValue()">getCurrentValue()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawCursor.html" title="class in com.amazon.carbonado.raw">RawCursor</a></dt> +<dd> +<div class="block">Returns the contents of the current value being referenced, or null + otherwise.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.Block.html#getData()">getData()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getDatabaseHook()">getDatabaseHook()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the custom open database hook, or null if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getDatabaseName()">getDatabaseName()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html#getDatabaseProductName()">getDatabaseProductName()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCConnectionCapability.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCConnectionCapability</a></dt> +<dd> +<div class="block">Returns the name of the database product connected to.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getDatabasesTransactional()">getDatabasesTransactional()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if the databases are configured to be transactional, + false if configured to not be transactional, null if this override was never set</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#getDataFiles()">getDataFiles()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></dt> +<dd> +<div class="block">Returns all the data files to be copied.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getDataHome()">getDataHome()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the directory to store data files.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html#getDataHome()">getDataHome()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">EnvironmentCapability</a></dt> +<dd> +<div class="block">Returns the directory where data files are stored, which is the same as + the home directory by default.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getDataHomeFile()">getDataHomeFile()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the optional directory to store data files.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getDataPrefixPadding()">getDataPrefixPadding()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getDataProperties()">getDataProperties()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getDataProperties()">getDataProperties()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns all the non-primary key properties of this layout, in their + proper order.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getDataProperties()">getDataProperties()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDataSource()">getDataSource()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the source of JDBC connections, which defaults to a non-pooling + source if driver class, driver URL, username, and password are all + supplied.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDataSourceCloseOnShutdown()">getDataSourceCloseOnShutdown()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if DataSource is closed when the repository is closed or + shutdown.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDataSourceLogging()">getDataSourceLogging()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if debug logging is enabled.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getDataSuffixPadding()">getDataSuffixPadding()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getDataType()">getDataType()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns the data type as defined by <code>Types</code>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getDataTypeName()">getDataTypeName()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns the data type name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html#getDeadlockCount()">getDeadlockCount()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getDecimalDigits()">getDecimalDigits()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns the amount of fractional decimal digits.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#getDecoder(int)">getDecoder(int)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>use direct decode method</i></div> +</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDefaultFetchSize()">getDefaultFetchSize()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the default fetch size when running queries, or null if driver + default is used instead.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/DelegateStorableGenerator.html#getDelegateClass(java.lang.Class, java.util.EnumSet)">getDelegateClass(Class<S>, EnumSet<MasterFeature>)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/DelegateStorableGenerator.html" title="class in com.amazon.carbonado.gen">DelegateStorableGenerator</a></dt> +<dd> +<div class="block">Delegate class has a constructor that accepts a <a href="../com/amazon/carbonado/gen/DelegateSupport.html" title="interface in com.amazon.carbonado.gen"><code>DelegateSupport</code></a> + instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/TriggerSupport.html#getDeleteTrigger()">getDeleteTrigger()</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a></dt> +<dd> +<div class="block">Returns a trigger which must be run for all delete operations.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#getDeleteTrigger()">getDeleteTrigger()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> +<div class="block">Returns a consolidated trigger to call for delete operations, or null if + none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getDerivedFromProperties()">getDerivedFromProperties()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a new array with all the derived-from properties, which is empty + if this is not a derived property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getDerivedToProperties()">getDerivedToProperties()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a new array with all the properties which are derived from this + one.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/OrderedProperty.html#getDirection()">getDirection()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDriverClassName()">getDriverClassName()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the driver class name, which may be null if a DataSource was provided.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getDriverURL()">getDriverURL()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the connection URL, which may be null if a DataSource was + provided.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getEnclosingType()">getEnclosingType()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the enclosing type of this property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html#getEnvironment()">getEnvironment()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">EnvironmentCapability</a></dt> +<dd> +<div class="block">Returns the BDB environment object, which must be cast to the expected + type, depending on the BDB product and version being used.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getEnvironmentHome()">getEnvironmentHome()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the repository environment home directory.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getEnvironmentHomeFile()">getEnvironmentHomeFile()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the repository environment home directory.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getEvolutionStrategy()">getEvolutionStrategy()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> +<div class="block">Returns EVOLUTION_NONE if evolution of records is not supported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getExclusiveRangeEndFilters()">getExclusiveRangeEndFilters()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the range end property filters supported by the evaluated + index whose operator is only <a href="../com/amazon/carbonado/filter/RelOp.html#LT"><code>RelOp.LT</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getExclusiveRangeStartFilters()">getExclusiveRangeStartFilters()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the range start property filters supported by the evaluated + index whose operator is only <a href="../com/amazon/carbonado/filter/RelOp.html#GT"><code>RelOp.GT</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElement(int)">getExternalJoinElement(int)</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a specific property in the joined class that participates in the + join.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getExternalJoinElement(int)">getExternalJoinElement(int)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElements()">getExternalJoinElements()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a new array with all the external join elements in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getExternalJoinElements()">getExternalJoinElements()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#getExtraData()">getExtraData()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> +<div class="block">Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#getExtraData()">getExtraData()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#getExtraData()">getExtraData()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> +<div class="block">Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getExtraData()">getExtraData()</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></dt> +<dd> +<div class="block">Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getExtraData()">getExtraData()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> +<div class="block">Since this record cannot evolve, this property allows it to be extended + without conflicting with existing records.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#getFiles()">getFiles()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span> +<div class="block"><i>use getDataFiles and getLogFiles</i></div> +</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns the Filter that this FilterValues instance applies to.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedFilterException.html#getFilter()">getFilter()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedFilterException.html" title="class in com.amazon.carbonado">MalformedFilterException</a></dt> +<dd> +<div class="block">Returns the malformed query filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns a <a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter"><code>ClosedFilter</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</a></dt> +<dd> +<div class="block">Returns the combined filter of the wrapped executor and the extra filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a></dt> +<dd> +<div class="block">Returns an open filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns combined handled and remainder filter for this result.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a></dt> +<dd> +<div class="block">Returns an open filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/JoinedQueryExecutor.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutor.html#getFilter()">getFilter()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></dt> +<dd> +<div class="block">Returns the filter used by this QueryExecutor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html#getFilter()">getFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a></dt> +<dd> +<div class="block">Returns the combined filter of the wrapped executors.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#getFilter()">getFilter()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns the query's filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/CompositeScore.html#getFilteringScore()">getFilteringScore()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></dt> +<dd> +<div class="block">Returns the score on how well the evaluated index performs the desired + filtering.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#getFilterValues()">getFilterValues()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> +<div class="block">Always returns null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#getFilterValues()">getFilterValues()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#getFilterValues()">getFilterValues()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns the query's filter values, which is null if filter has no + parameters.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getForeignIndex()">getForeignIndex()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns the foreign index that was selected, or null if a local + index was selected.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getForeignProperty()">getForeignProperty()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns the simple or chained property that maps to the selected + foreign index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#getFreeOrdering()">getFreeOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns potential ordering properties that the evaluated index can + handle, if arranged to immediately follow the handled orderings.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html#getFromStorageAdapter()">getFromStorageAdapter()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></dt> +<dd> +<div class="block">Returns the optional method used to adapt the property from the + storage supported type to the user visible type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#getFromStorageAdapter()">getFromStorageAdapter()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getGeneration()">getGeneration()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns the generation of this layout, where zero represents the first + generation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getGeneration(int)">getGeneration(int)</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns the layout for a particular generation of this layout's type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#getGeneration()">getGeneration()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> +<div class="block">Generation of storable, where 0 represents the first generation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#getGeneration()">getGeneration()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></dt> +<dd> +<div class="block">Generation of storable, where 0 represents the first generation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/GroupAccessCapability.html#getGroupMembers()">getGroupMembers()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability">GroupAccessCapability</a></dt> +<dd> +<div class="block">Return all replication group members, including this repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getHandledCount()">getHandledCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the count of all handled property filters.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#getHandledCount()">getHandledCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns the number of desired orderings the evaluated index + supports.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getHandledFilter()">getHandledFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the composite handled filter, or null if no matches at all.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#getHandledOrdering()">getHandledOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns the ordering properties that the evaluated index supports.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html#getHome()">getHome()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">EnvironmentCapability</a></dt> +<dd> +<div class="block">Returns the home directory for the BDB environment.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getIdentityCount()">getIdentityCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns number of consecutive left-aligned index properties which match + property filters with an operator of <a href="../com/amazon/carbonado/filter/RelOp.html#EQ"><code>RelOp.EQ</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getIdentityFilter()">getIdentityFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the composite identity filter, or null if no identity property + filters.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getIdentityFilters()">getIdentityFilters()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the identity property filters supported by the evaluated + index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getIdentityProperties()">getIdentityProperties()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> +<div class="block">Returns auto-increment properties which are primary key members.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getInclusiveRangeEndFilters()">getInclusiveRangeEndFilters()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the range end property filters supported by the evaluated + index whose operator is only <a href="../com/amazon/carbonado/filter/RelOp.html#LE"><code>RelOp.LE</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getInclusiveRangeStartFilters()">getInclusiveRangeStartFilters()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the range start property filters supported by the evaluated + index whose operator is only <a href="../com/amazon/carbonado/filter/RelOp.html#GE"><code>RelOp.GE</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getIndex(int)">getIndex(int)</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns a specific index for the Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getIndexCount()">getIndexCount()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns the count of indexes defined for the Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html#getIndexEntryAccessors(java.lang.Class)">getIndexEntryAccessors(Class<S>)</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessCapability.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessCapability</a></dt> +<dd> +<div class="block">Returns index entry accessors for the known indexes of the given + storable type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html#getIndexEntryStorage()">getIndexEntryStorage()</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a></dt> +<dd> +<div class="block">Returns the index entry storage.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getIndexes()">getIndexes()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns a new array with all the indexes in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/IndexInfoCapability.html#getIndexInfo(java.lang.Class)">getIndexInfo(Class<S>)</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/IndexInfoCapability.html" title="interface in com.amazon.carbonado.capability">IndexInfoCapability</a></dt> +<dd> +<div class="block">Returns information about the known indexes for the given storable + type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getIndexInfo()">getIndexInfo()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getIndexName()">getIndexName()</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></dt> +<dd> +<div class="block">Returns the index name, which is also a valid index name + descriptor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getIndexNameDescriptor()">getIndexNameDescriptor()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> +<div class="block">Returns the index name descriptor for the keys of this database.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getIndexPropertyCount()">getIndexPropertyCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the amount of properties in the evaluated index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#getIndexPropertyCount()">getIndexPropertyCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns the amount of properties in the evaluated index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#getIndexRepairThrottle()">getIndexRepairThrottle()</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the throttle parameter used when indexes are added, dropped or + bulk repaired.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getIndexRepairThrottle()">getIndexRepairThrottle()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the throttle parameter used when indexes are added, dropped or + bulk repaired.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getIndexSupport()">getIndexSupport()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if indexes are supported, which is true by default.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getIndexTypeDescriptor()">getIndexTypeDescriptor()</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></dt> +<dd> +<div class="block">Returns the types of the index properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getIndexTypeDescriptor()">getIndexTypeDescriptor()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> +<div class="block">Returns the types of the index properties.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getInitialDatabaseConfig()">getInitialDatabaseConfig()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the optional BDB specific database configuration to use + for all databases created.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getInitialEnvironmentConfig()">getInitialEnvironmentConfig()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the optional BDB specific environment configuration to use.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getInitializeLogging()">getInitializeLogging()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/StoredSequence.html#getInitialValue()">getInitialValue()</a></span> - Method in interface com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</a></dt> +<dd> +<div class="block">Returns the initial value for the sequence.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredSequence.html#getInitialValue()">getInitialValue()</a></span> - Method in interface com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> +<div class="block">Returns the initial value for the sequence.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/ClassFileBuilder.html#getInjector()">getInjector()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/ClassFileBuilder.html" title="class in com.amazon.carbonado.synthetic">ClassFileBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/TriggerSupport.html#getInsertTrigger()">getInsertTrigger()</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a></dt> +<dd> +<div class="block">Returns a trigger which must be run for all insert operations.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#getInsertTrigger()">getInsertTrigger()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> +<div class="block">Returns a consolidated trigger to call for insert operations, or null if + none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/ExceptionTransformer.html#getInstance()">getInstance()</a></span> - Static method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/ExceptionTransformer.html" title="class in com.amazon.carbonado.spi">ExceptionTransformer</a></dt> +<dd> +<div class="block">Returns a generic instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/util/QuickConstructorGenerator.html#getInstance(java.lang.Class, java.lang.Class)">getInstance(Class<?>, Class<F>)</a></span> - Static method in class com.amazon.carbonado.util.<a href="../com/amazon/carbonado/util/QuickConstructorGenerator.html" title="class in com.amazon.carbonado.util">QuickConstructorGenerator</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> +<div class="block">Returns a factory instance for one type of object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElement(int)">getInternalJoinElement(int)</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a specific property in this property's class that participates + in the join.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getInternalJoinElement(int)">getInternalJoinElement(int)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElements()">getInternalJoinElements()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a new array with all the internal join elements in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getInternalJoinElements()">getInternalJoinElements()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Transaction.html#getIsolationLevel()">getIsolationLevel()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Transaction.html" title="interface in com.amazon.carbonado">Transaction</a></dt> +<dd> +<div class="block">Returns the isolation level of this transaction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionPair.html#getIsolationLevel()">getIsolationLevel()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionPair.html" title="class in com.amazon.carbonado.txn">TransactionPair</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionScope.html#getIsolationLevel()">getIsolationLevel()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a></dt> +<dd> +<div class="block">Returns the isolation level of the active transaction, or null if there + is no active transaction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getJoinedType()">getJoinedType()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the type of property this is joined to, or null if not joined.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getJoinElementCount()">getJoinElementCount()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the count of properties that participate in this property's + join.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getKeepOldLogFiles()">getKeepOldLogFiles()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns false by default.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getKeyPrefixPadding()">getKeyPrefixPadding()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getKeySuffixPadding()">getKeySuffixPadding()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.html#getLastBlockLength()">getLastBlockLength()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></dt> +<dd> +<div class="block">Returns expected length of last block.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#getLastLogNumber()">getLastLogNumber()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></dt> +<dd> +<div class="block">Can be called after a backup has been performed to find the last log file + that has been backed up.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#getLastProperty()">getLastProperty()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns the last property in the chain, or the prime property if chain + is empty.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getLayoutID()">getLayoutID()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns a unique identifier for this layout.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#getLayoutID()">getLayoutID()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#getLayoutID()">getLayoutID()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions(Class<? extends Storable>)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CompressedStorableCodecFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions(Class<? extends Storable>)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></dt> +<dd> +<div class="block">Returns null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodecFactory.html#getLayoutOptions(java.lang.Class)">getLayoutOptions(Class<? extends Storable>)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></dt> +<dd> +<div class="block">Optionally return additional information regarding storable encoding.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/BinaryOpFilter.html#getLeftFilter()">getLeftFilter()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Blob.html#getLength()">getLength()</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Blob.html" title="interface in com.amazon.carbonado.lob">Blob</a></dt> +<dd> +<div class="block">Returns the length of this Blob, in bytes.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/BlobClob.html#getLength()">getLength()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/ByteArrayBlob.html#getLength()">getLength()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/CharArrayClob.html#getLength()">getLength()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Clob.html#getLength()">getLength()</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Clob.html" title="interface in com.amazon.carbonado.lob">Clob</a></dt> +<dd> +<div class="block">Returns the length of this Clob, in characters.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/FileBlob.html#getLength()">getLength()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/StringClob.html#getLength()">getLength()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.html#getLength()">getLength()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html#getLevels()">getLevels()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/TriggerSupport.html#getLoadTrigger()">getLoadTrigger()</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a></dt> +<dd> +<div class="block">Returns a trigger which must be run for all load and fetch operations.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#getLoadTrigger()">getLoadTrigger()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> +<div class="block">Returns a consolidated trigger to call for load operations, or null if + none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getLocalIndex()">getLocalIndex()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns the local index that was selected, or null if a foreign + index was selected.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/BlobClob.html#getLocator()">getLocator()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/ByteArrayBlob.html#getLocator()">getLocator()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/ByteArrayBlob.html" title="class in com.amazon.carbonado.lob">ByteArrayBlob</a></dt> +<dd> +<div class="block">Always returns null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/CharArrayClob.html#getLocator()">getLocator()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/CharArrayClob.html" title="class in com.amazon.carbonado.lob">CharArrayClob</a></dt> +<dd> +<div class="block">Always returns null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/FileBlob.html#getLocator()">getLocator()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/FileBlob.html" title="class in com.amazon.carbonado.lob">FileBlob</a></dt> +<dd> +<div class="block">Always returns null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/Lob.html#getLocator()">getLocator()</a></span> - Method in interface com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/Lob.html" title="interface in com.amazon.carbonado.lob">Lob</a></dt> +<dd> +<div class="block">Returns an object which identifies the Lob data, which may be null if + not supported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/StringClob.html#getLocator()">getLocator()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/StringClob.html" title="class in com.amazon.carbonado.lob">StringClob</a></dt> +<dd> +<div class="block">Always returns null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawSupport.html#getLocator(com.amazon.carbonado.lob.Blob)">getLocator(Blob)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></dt> +<dd> +<div class="block">Returns the locator for the given Blob, returning zero if null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/RawSupport.html#getLocator(com.amazon.carbonado.lob.Clob)">getLocator(Clob)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a></dt> +<dd> +<div class="block">Returns the locator for the given Clob, returning zero if null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/LobEngine.html#getLocator(com.amazon.carbonado.lob.Lob)">getLocator(Lob)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></dt> +<dd> +<div class="block">Returns the locator for the given Lob, or zero if null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.Block.html#getLocator()">getLocator()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.html#getLocator()">getLocator()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionScope.html#getLock()">getLock()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a></dt> +<dd> +<div class="block">Returns lock used by TransactionScope.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLockConflictDeadlockDetectMode()">getLockConflictDeadlockDetectMode()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if deadlock detection is run whenever a lock conflict occurs.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#getLockTimeout()">getLockTimeout()</a></span> - Method in class com.amazon.carbonado.repo.map.<a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the lock timeout.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLockTimeout()">getLockTimeout()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the lock timeout, in seconds.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLockTimeoutInMicroseconds()">getLockTimeoutInMicroseconds()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the lock timeout, in microseconds, limited to max long value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#getLockTimeoutUnit()">getLockTimeoutUnit()</a></span> - Method in class com.amazon.carbonado.repo.map.<a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the lock timeout unit.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/LogAccessCapability.html#getLog()">getLog()</a></span> - Method in interface com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/LogAccessCapability.html" title="interface in com.amazon.carbonado.repo.logging">LogAccessCapability</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#getLog()">getLog()</a></span> - Method in class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a></dt> +<dd> +<div class="block">Return the Log to use.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#getLog()">getLog()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> +<div class="block">Return the main Log object for this Repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLogFileMaxSize()">getLogFileMaxSize()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns null if default size will be used.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html#getLogFiles()">getLogFiles()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/HotBackupCapability.Backup.html" title="interface in com.amazon.carbonado.repo.sleepycat">HotBackupCapability.Backup</a></dt> +<dd> +<div class="block">Returns all the transaction log files to be copied, in the exact + order in which they must be copied.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLogInMemory()">getLogInMemory()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns false by default, indicating that transaction logs are persisted.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#getLoginTimeout()">getLoginTimeout()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#getLoginTimeout()">getLoginTimeout()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getLogRegionSize()">getLogRegionSize()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the repository log region size, or null if the default + should be selected.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#getLogWriter()">getLogWriter()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#getLogWriter()">getLogWriter()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedTypeException.html#getMalformedType()">getMalformedType()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#getMasterClass()">getMasterClass()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceAccess</a></dt> +<dd> +<div class="block">Returns the storable class which is referenced.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/ResyncCapability.html#getMasterRepository()">getMasterRepository()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/ResyncCapability.html" title="interface in com.amazon.carbonado.capability">ResyncCapability</a></dt> +<dd> +<div class="block">Returns the immediate master Repository, for manual comparison.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#getMasterRepositoryBuilder()">getMasterRepositoryBuilder()</a></span> - Method in class com.amazon.carbonado.repo.replicated.<a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#getMatchedGeneration()">getMatchedGeneration()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></dt> +<dd> +<div class="block">Generation of matched layout.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getMaxLocks()">getMaxLocks()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/CorruptEncodingException.html#getMessage()">getMessage()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedArgumentException.html#getMessage()">getMessage()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">MalformedArgumentException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedTypeException.html#getMessage()">getMessage()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></dt> +<dd> +<div class="block">Returns first message, prefixed with the malformed type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MismatchException.html#getMessage()">getMessage()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado">MismatchException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/UnsupportedTypeException.html#getMessage()">getMessage()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/UnsupportedTypeException.html" title="class in com.amazon.carbonado">UnsupportedTypeException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MalformedArgumentException.html#getMessages()">getMessages()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MalformedArgumentException.html" title="class in com.amazon.carbonado">MalformedArgumentException</a></dt> +<dd> +<div class="block">Multiple error messages may be embedded in a MalformedArgumentException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/MismatchException.html#getMessages()">getMessages()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/MismatchException.html" title="class in com.amazon.carbonado">MismatchException</a></dt> +<dd> +<div class="block">Multiple error messages may be embedded in a MismatchException.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/IndexInfo.html#getName()">getName()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></dt> +<dd> +<div class="block">Returns the name of this index, or null if not applicable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getName()">getName()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns the name of the Storable described by this StorableInfo, + which is an abbreviated form of the type's class name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getName()">getName()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the name of this property, which is the same as the bean name + unless it has been <a href="../com/amazon/carbonado/Name.html" title="annotation in com.amazon.carbonado"><code>renamed</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.repo.logging.<a href="../com/amazon/carbonado/repo/logging/LoggingRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.logging">LoggingRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.repo.map.<a href="../com/amazon/carbonado/repo/map/MapRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.map">MapRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.repo.replicated.<a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Repository.html#getName()">getName()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></dt> +<dd> +<div class="block">Returns the name of this repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryBuilder.html#getName()">getName()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the name of the repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/StoredSequence.html#getName()">getName()</a></span> - Method in interface com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/IndexInfoImpl.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredSequence.html#getName()">getName()</a></span> - Method in interface com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> + </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html#getName()">getName()</a></span> - Method in interface com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder.ClassNameProvider</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> +<div class="block">Frequently used by the <a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic"><code>SyntheticBuilder.ClassNameProvider</code></a> as a + basis for the generated classname</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#getName()">getName()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getNameDescriptor()">getNameDescriptor()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Converts this index into a parseable name descriptor string, whose + general format is:</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/StoredSequence.html#getNextValue()">getNextValue()</a></span> - Method in interface com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</a></dt> +<dd> +<div class="block">Returns the pre-adjusted next value of the sequence.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredSequence.html#getNextValue()">getNextValue()</a></span> - Method in interface com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredSequence.html" title="interface in com.amazon.carbonado.spi">StoredSequence</a></dt> +<dd> +<div class="block"><span class="strong">Deprecated.</span></div> +<div class="block">Returns the pre-adjusted next value of the sequence.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.NotJoined.html#getNotJoinedFilter()">getNotJoinedFilter()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></dt> +<dd> +<div class="block">Returns the filter which is no longer as from a join.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getNumber()">getNumber()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the zero-based numerical position of this property within its + enclosing type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#getOpenFilter(java.lang.Class)">getOpenFilter(Class<S>)</a></span> - Static method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns a cached filter instance that operates on the given type, which + allows all results to pass through.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#getOperator()">getOperator()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getOptions()">getOptions()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Returns additional options, or null if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getOrderedProperties()">getOrderedProperties()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns a new array with all the properties in it, with directions + folded in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getOrderedProperty(int)">getOrderedProperty(int)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns a specific property in this index, with the direction folded in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteredQueryExecutor.html" title="class in com.amazon.carbonado.qe">FilteredQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.html" title="class in com.amazon.carbonado.qe">FullScanQueryExecutor</a></dt> +<dd> +<div class="block">Returns an empty list.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns combined handled and remainder orderings for this result.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IterableQueryExecutor.html" title="class in com.amazon.carbonado.qe">IterableQueryExecutor</a></dt> +<dd> +<div class="block">Returns an empty list.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/JoinedQueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/JoinedQueryExecutor.html" title="class in com.amazon.carbonado.qe">JoinedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a></dt> +<dd> +<div class="block">Returns an empty list.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></dt> +<dd> +<div class="block">Returns the result ordering of this QueryExecutor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/SortedQueryExecutor.html" title="class in com.amazon.carbonado.qe">SortedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html#getOrdering()">getOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/CompositeScore.html#getOrderingScore()">getOrderingScore()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a></dt> +<dd> +<div class="block">Returns the score on how well the evaluated index performs the desired + ordering.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#getOrdinal()">getOrdinal()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> +<div class="block">Ordinal defines the order in which this property appears in it enclosing + layout.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getOrdinalPosition()">getOrdinalPosition()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns the one-based index of the column in the table.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html#getPagesExamine()">getPagesExamine()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html#getPagesFree()">getPagesFree()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html#getPagesTruncated()">getPagesTruncated()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/CompactionCapability.Result.html" title="interface in com.amazon.carbonado.repo.sleepycat">CompactionCapability.Result</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getPanicHandler()">getPanicHandler()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Return the panic handler to call if the database panics.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#getParentLogger()">getParentLogger()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#getParentLogger()">getParentLogger()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getPartitionKey()">getPartitionKey()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns the partition key for the Storable, or null if none exists.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getPassword()">getPassword()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the optional password to use with DataSource.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getPreferenceScore()">getPreferenceScore()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns a value which indicates user index preference, based on the + original ordering of elements in the filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getPreparedStatementSetMethod()">getPreparedStatementSetMethod()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns the method to use to set this property (by index) into a + PreparedStatement.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getPreShutdownHook()">getPreShutdownHook()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the custom shutdown hook that runs before the repository has + finished running its own shutdown hooks, or null if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getPrimaryKey()">getPrimaryKey()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns the primary key for the Storable, never null.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getPrimaryKeyIndex()">getPrimaryKeyIndex()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Returns all key properties in the form of an index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#getPrimaryKeyIndex()">getPrimaryKeyIndex()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#getPrimaryKeyIndex()">getPrimaryKeyIndex()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Returns the sequence and directions of properties that make up the + primary key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#getPrimaryKeyPrefixLength()">getPrimaryKeyPrefixLength()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#getPrimaryKeyPrefixLength()">getPrimaryKeyPrefixLength()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Returns the number of prefix bytes in the primary key, which may be + zero.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getPrimaryKeyProperties()">getPrimaryKeyProperties()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the primary key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getPrimaryKeyProperties()">getPrimaryKeyProperties()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#getPrimeProperty()">getPrimeProperty()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getProduct()">getProduct()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the BDB product to use, which is JE by default.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getProperties()">getProperties()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns a new array with all the properties in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableKey.html#getProperties()">getProperties()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a></dt> +<dd> +<div class="block">Returns all the properties of the key in a properly ordered, + unmodifiable set.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticPropertyList.html#getProperties()">getProperties()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic">SyntheticPropertyList</a></dt> +<dd> +<div class="block">Returns all the properties in this index, optionally prefixed with a '+' + or '-' to indicate direction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getProperty(int)">getProperty(int)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns a specific property in this index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getPropertyCount()">getPropertyCount()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns the count of properties in this index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticPropertyList.html#getPropertyCount()">getPropertyCount()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticPropertyList.html" title="class in com.amazon.carbonado.synthetic">SyntheticPropertyList</a></dt> +<dd> +<div class="block">Returns the count of properties in this index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getPropertyDirection(int)">getPropertyDirection(int)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns the requested direction of a specific property in this index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/IndexInfo.html#getPropertyDirections()">getPropertyDirections()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></dt> +<dd> +<div class="block">Returns the directions of all the properties in this index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getPropertyDirections()">getPropertyDirections()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns a new array with all the property directions in it.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/IndexInfoImpl.html#getPropertyDirections()">getPropertyDirections()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#getPropertyList()">getPropertyList()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> +<div class="block">Frequently used by the <a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.ClassNameProvider.html" title="interface in com.amazon.carbonado.synthetic"><code>SyntheticBuilder.ClassNameProvider</code></a> as a + basis for the generated classname</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#getPropertyName()">getPropertyName()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#getPropertyName()">getPropertyName()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html#getPropertyName()">getPropertyName()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#getPropertyName()">getPropertyName()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/IndexInfo.html#getPropertyNames()">getPropertyNames()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></dt> +<dd> +<div class="block">Returns the properties in this index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/IndexInfoImpl.html#getPropertyNames()">getPropertyNames()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#getPropertyType()">getPropertyType()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#getPropertyType(java.lang.ClassLoader)">getPropertyType(ClassLoader)</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html#getPropertyType()">getPropertyType()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></dt> +<dd> +<div class="block">Returns the user specified property type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#getPropertyType()">getPropertyType()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/LayoutProperty.html#getPropertyTypeDescriptor()">getPropertyTypeDescriptor()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/LayoutProperty.html" title="class in com.amazon.carbonado.layout">LayoutProperty</a></dt> +<dd> +<div class="block">Property type descriptor is a Java type descriptor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#getPropertyTypeDescriptor()">getPropertyTypeDescriptor()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> +<div class="block">Property type descriptor is a Java type descriptor.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#getPropertyValue(java.lang.String)">getPropertyValue(String)</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Returns a Storable property value by name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getQualifiedTableName()">getQualifiedTableName()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> +<div class="block">Returns the qualified table name for the Storable or null if + unsupported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorageAccess.html#getQueryExecutorFactory()">getQueryExecutorFactory()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a></dt> +<dd> +<div class="block">Returns a QueryExecutorFactory instance for storage.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getRangeEndFilters()">getRangeEndFilters()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the range end property filters supported by the evaluated + index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getRangeStartFilters()">getRangeStartFilters()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the range start property filters supported by the evaluated + index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getReadMethod()">getReadMethod()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a no-arg method used to read the property value, or null if + reading is not allowed.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getReadMethodName()">getReadMethodName()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the name of the read method, even if no read method was actually + declared.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#getReadMethodName()">getReadMethodName()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#getReadMethodName()">getReadMethodName()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> +<div class="block">Returns the name of the read method.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getReadOnly()">getReadOnly()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if repository should be opened read-only.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/GroupMembers.html#getReadWriteMembers()">getReadWriteMembers()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability">GroupMembers</a></dt> +<dd> +<div class="block">Returns members intended for read and write access.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#getReferenceAccess()">getReferenceAccess()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> +<div class="block">Build and return access to the generated storable reference class.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html#getReferenceClass()">getReferenceClass()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceAccess.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceAccess</a></dt> +<dd> +<div class="block">Returns the generated storable reference class.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getRemainderCount()">getRemainderCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns number of property filters not supported by the evaluated index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#getRemainderCount()">getRemainderCount()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns the number of desired orderings the evaluated index does not + support.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.NotJoined.html#getRemainderFilter()">getRemainderFilter()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></dt> +<dd> +<div class="block">Returns the filter which could not be separated.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getRemainderFilter()">getRemainderFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the composite remainder filter not supported by the evaluated + index, or null if no remainder.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getRemainderFilter()">getRemainderFilter()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Remainder filter which overrides that in composite score.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FilteringScore.html#getRemainderFilters()">getRemainderFilters()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a></dt> +<dd> +<div class="block">Returns the filters not supported by the evaluated index.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getRemainderOrdering()">getRemainderOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Remainder orderings which override that in composite score.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#getRemainderOrdering()">getRemainderOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns the ordering properties that the evaluated index does not + support.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html#getReplicaRepositoryBuilder()">getReplicaRepositoryBuilder()</a></span> - Method in class com.amazon.carbonado.repo.replicated.<a href="../com/amazon/carbonado/repo/replicated/ReplicatedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.replicated">ReplicatedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getResultSetGetMethod()">getResultSetGetMethod()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a></dt> +<dd> +<div class="block">Returns the method to use to access this property (by index) from a + ResultSet.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/BinaryOpFilter.html#getRightFilter()">getRightFilter()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/BinaryOpFilter.html" title="class in com.amazon.carbonado.filter">BinaryOpFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryException.html#getRootCause()">getRootCause()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryException.html" title="class in com.amazon.carbonado">RepositoryException</a></dt> +<dd> +<div class="block">Recursively calls getCause, until the root cause is found.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/StorableSupport.html#getRootRepository()">getRootRepository()</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/StorableSupport.html" title="interface in com.amazon.carbonado.gen">StorableSupport</a></dt> +<dd> +<div class="block">Returns the root parent Repository that the Storable came from.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/RepositoryAccess.html#getRootRepository()">getRootRepository()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getRunCheckpointer()">getRunCheckpointer()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if checkpointer is run automatically.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getRunDeadlockDetector()">getRunDeadlockDetector()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if deadlock detector is configured to run.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getRunFullRecovery()">getRunFullRecovery()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if a full (catastrophic) recovery should be performed when + environment is opened.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getSchema()">getSchema()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the optional schema to search for metadata.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getSchemaName()">getSchemaName()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> +<div class="block">Returns the optional schema name for the Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#getSearchKeyFactory(com.amazon.carbonado.info.OrderedProperty[])">getSearchKeyFactory(OrderedProperty<S>[])</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> +<div class="block">Returns a search key factory, which is useful for implementing indexes + and queries.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getSequenceName()">getSequenceName()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the property's sequence name, or null if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getSequenceSelectStatement()">getSequenceSelectStatement()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the native sequence select statement, which is null if the + default is chosen.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/MasterSupport.html#getSequenceValueProducer(java.lang.String)">getSequenceValueProducer(String)</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/MasterSupport.html" title="interface in com.amazon.carbonado.gen">MasterSupport</a></dt> +<dd> +<div class="block">Returns a sequence value producer by name, or throw PersistException if not found.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/SequenceCapability.html#getSequenceValueProducer(java.lang.String)">getSequenceValueProducer(String)</a></span> - Method in interface com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/SequenceCapability.html" title="interface in com.amazon.carbonado.sequence">SequenceCapability</a></dt> +<dd> +<div class="block">Retrieve and/or generate a SequenceValueProducer for the given name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#getSequenceValueProducer(java.lang.String)">getSequenceValueProducer(String)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getShutdownHook()">getShutdownHook()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the custom shutdown hook that runs after the repository has + finished running its own shutdown hooks, or null if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getSingleFileName()">getSingleFileName()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the single file that all BDB databases should reside in.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/OptimisticLockException.html#getStorable()">getStorable()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/OptimisticLockException.html" title="class in com.amazon.carbonado">OptimisticLockException</a></dt> +<dd> +<div class="block">Returns the Storable which was acted upon, or null if not available.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#getStorableClass()">getStorableClass()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> +<div class="block">Returns a concrete Storable implementation, which is fully + thread-safe.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html#getStorableClass()">getStorableClass()</a></span> - Method in interface com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticBuilder.html" title="interface in com.amazon.carbonado.synthetic">SyntheticBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html#getStorableClass()">getStorableClass()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#getStorableClass()">getStorableClass()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getStorableCodecFactory()">getStorableCodecFactory()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the storable codec factory used.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Returns the storable type that this filter operates on.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns the type of storable this index applies to.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getStorableType()">getStorableType()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns the type of Storable described by this StorableInfo.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/AbstractQueryExecutor.html" title="class in com.amazon.carbonado.qe">AbstractQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutor.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/DelegatedQueryExecutorFactory.html" title="class in com.amazon.carbonado.qe">DelegatedQueryExecutorFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/EmptyQuery.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/EmptyQuery.html" title="class in com.amazon.carbonado.qe">EmptyQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html#getStorableType()">getStorableType()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/FullScanQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">FullScanQueryExecutor.Support</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">IndexedQueryAnalyzer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="class in com.amazon.carbonado.qe">IndexedQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="class in com.amazon.carbonado.qe">KeyQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutor.html#getStorableType()">getStorableType()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a></dt> +<dd> +<div class="block">Returns the storable type that this executor operates on.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutorCache.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutorCache.html" title="class in com.amazon.carbonado.qe">QueryExecutorCache</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryExecutorFactory.html#getStorableType()">getStorableType()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryExecutorFactory.html" title="interface in com.amazon.carbonado.qe">QueryExecutorFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/QueryFactory.html#getStorableType()">getStorableType()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/QueryFactory.html" title="interface in com.amazon.carbonado.qe">QueryFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQuery.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQuery.html" title="class in com.amazon.carbonado.qe">StandardQuery</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StandardQueryFactory.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StandardQueryFactory.html" title="class in com.amazon.carbonado.qe">StandardQueryFactory</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorageAccess.html#getStorableType()">getStorableType()</a></span> - Method in interface com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorageAccess.html" title="interface in com.amazon.carbonado.qe">StorageAccess</a></dt> +<dd> +<div class="block">Returns the specific type of Storable managed by this object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.html#getStorableType()">getStorableType()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a></dt> +<dd> +<div class="block">Returns the specific type of Storable managed by this object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#getStorableType()">getStorableType()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> +<div class="block">Returns the type of Storable that code is generated for.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#getStorableType()">getStorableType()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Returns the type of Storable produced by this codec.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storage.html#getStorableType()">getStorableType()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a></dt> +<dd> +<div class="block">Returns the specific type of Storable managed by this object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/Layout.html#getStorableTypeName()">getStorableTypeName()</a></span> - Method in class com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a></dt> +<dd> +<div class="block">Storable type name is a fully qualified Java class name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#getStorableTypeName()">getStorableTypeName()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> +<div class="block">Storable type name is a fully qualified Java class name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#getStorableTypeName()">getStorableTypeName()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></dt> +<dd> +<div class="block">Storable type name is a fully qualified Java class name.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/CorruptEncodingException.html#getStorableWithPrimaryKey()">getStorableWithPrimaryKey()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/CorruptEncodingException.html" title="class in com.amazon.carbonado">CorruptEncodingException</a></dt> +<dd> +<div class="block">If the decoder was able to extract the primary key, it will be available in the + returned Storable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoragePool.html#getStorage(java.lang.Class)">getStorage(Class<S>)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoragePool.html" title="class in com.amazon.carbonado.spi">StoragePool</a></dt> +<dd> +<div class="block">Returns a Storage instance for the given Storable type, which is lazily + created and pooled.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#getStorageName(java.lang.Class)">getStorageName(Class<? extends Storable>)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">CustomStorableCodecFactory</a></dt> +<dd> +<div class="block">Returns null to let repository decide what the name should be.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#getStorageName(java.lang.Class)">getStorageName(Class<? extends Storable>)</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodecFactory.html" title="class in com.amazon.carbonado.raw">GenericStorableCodecFactory</a></dt> +<dd> +<div class="block">Returns null to let repository decide what the name should be.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodecFactory.html#getStorageName(java.lang.Class)">getStorageName(Class<? extends Storable>)</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodecFactory.html" title="interface in com.amazon.carbonado.raw">StorableCodecFactory</a></dt> +<dd> +<div class="block">Returns the preferred storage/database name for the given type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html#getStorageType()">getStorageType()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></dt> +<dd> +<div class="block">Returns the storage supported type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#getStorageType()">getStorageType()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html#getStorageTypePreferences()">getStorageTypePreferences()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></dt> +<dd> +<div class="block">Returns the adapter's storage type preferences.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ExistsFilter.html#getSubFilter()">getSubFilter()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></dt> +<dd> +<div class="block">Returns the filter applied to the join, which might be open.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#getSubResults()">getSubResults()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns results for each sub-query to be executed in the union.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#getSuppliedValues()">getSuppliedValues()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns all supplied values in this object.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#getSuppliedValuesFor(com.amazon.carbonado.filter.Filter)">getSuppliedValuesFor(Filter<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns all supplied values in this object, as required by the given + Filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/CustomStorableCodec.html#getSupport()">getSupport()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericStorableCodec.html#getSupport()">getSupport()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorableCodec.html#getSupport()">getSupport()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a></dt> +<dd> +<div class="block">Returns the default <a href="../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw"><code>RawSupport</code></a> object that is supplied to + Storable instances produced by this codec.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/LobEngine.html#getSupportTrigger(java.lang.Class, int)">getSupportTrigger(Class<S>, int)</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/LobEngine.html" title="class in com.amazon.carbonado.spi">LobEngine</a></dt> +<dd> +<div class="block">Returns a Trigger for binding to this LobEngine.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getTableName()">getTableName()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> +<div class="block">Returns the table name for the Storable or null if unsupported.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Controller.html#getTimeout()">getTimeout()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></dt> +<dd> +<div class="block">Returns a non-negative value if controller imposes an absolute upper + bound on query execution time.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Timeout.html#getTimeout()">getTimeout()</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Controller.html#getTimeoutUnit()">getTimeoutUnit()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a></dt> +<dd> +<div class="block">Returns the unit for the timeout, if applicable.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Query.Timeout.html#getTimeoutUnit()">getTimeoutUnit()</a></span> - Method in class com.amazon.carbonado.<a href="../com/amazon/carbonado/Query.Timeout.html" title="class in com.amazon.carbonado">Query.Timeout</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html#getToStorageAdapter()">getToStorageAdapter()</a></span> - Method in interface com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericPropertyInfo.html" title="interface in com.amazon.carbonado.raw">GenericPropertyInfo</a></dt> +<dd> +<div class="block">Returns the optional method used to adapt the property from the user + visible type to the storage supported type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#getToStorageAdapter()">getToStorageAdapter()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html#getTotalOrdering()">getTotalOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer.Result</a></dt> +<dd> +<div class="block">Returns a total ordering, if one was imposed.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Repository.html#getTransactionIsolationLevel()">getTransactionIsolationLevel()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado">Repository</a></dt> +<dd> +<div class="block">Returns the isolation level of the current transaction, or null if there + is no transaction in the current thread.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#getTransactionIsolationLevel()">getTransactionIsolationLevel()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionMaxActive()">getTransactionMaxActive()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the maximum number of concurrent transactions, or null if the + default is used.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionNoSync()">getTransactionNoSync()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if transactions are not written or flushed to disk.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionTimeout()">getTransactionTimeout()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the repository transaction timeout, in seconds.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionTimeoutInMicroseconds()">getTransactionTimeoutInMicroseconds()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the repository transaction timeout, in microseconds, limited to + max long value.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html#getTransactionWriteNoSync()">getTransactionWriteNoSync()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/BDBRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.sleepycat">BDBRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns true if transactions are not flushed to disk.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/RepositoryBuilder.html#getTriggerFactories()">getTriggerFactories()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/RepositoryBuilder.html" title="interface in com.amazon.carbonado">RepositoryBuilder</a></dt> +<dd> +<div class="block">Returns all the TriggerFactories which were added.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html#getTriggerFactories()">getTriggerFactories()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepositoryBuilder.html" title="class in com.amazon.carbonado.spi">AbstractRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManagerCapability.html#getTriggerManagerFor(java.lang.Class)">getTriggerManagerFor(Class<S>)</a></span> - Method in interface com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManagerCapability.html" title="interface in com.amazon.carbonado.spi">TriggerManagerCapability</a></dt> +<dd> +<div class="block">Returns the <a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi"><code>TriggerManager</code></a> for the given <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionScope.html#getTxn()">getTxn()</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a></dt> +<dd> +<div class="block">Returns the implementation for the active transaction, or null if there + is no active transaction.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#getType()">getType()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> +<div class="block">Returns the type of the ChainedProperty.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/ChainedProperty.html#getType()">getType()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a></dt> +<dd> +<div class="block">Returns the type of the last property in the chain, or of the prime + property if the chain is empty.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getType()">getType()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the primary type of this property.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getType()">getType()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a></dt> +<dd> +<div class="block">Returns the type of Storable that code is generated for.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#getType()">getType()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/UnsupportedTypeException.html#getType()">getType()</a></span> - Method in exception com.amazon.carbonado.<a href="../com/amazon/carbonado/UnsupportedTypeException.html" title="class in com.amazon.carbonado">UnsupportedTypeException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#getTypeDescriptor()">getTypeDescriptor()</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Converts this index into a parseable type descriptor string, which + basically consists of Java type descriptors appended together.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/OrderingScore.html#getUnusedOrdering()">getUnusedOrdering()</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a></dt> +<dd> +<div class="block">Returns unused ordering properties of the evaluated index because they + were filtered out.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/TriggerSupport.html#getUpdateTrigger()">getUpdateTrigger()</a></span> - Method in interface com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/TriggerSupport.html" title="interface in com.amazon.carbonado.gen">TriggerSupport</a></dt> +<dd> +<div class="block">Returns a trigger which must be run for all update operations.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/TriggerManager.html#getUpdateTrigger()">getUpdateTrigger()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/TriggerManager.html" title="class in com.amazon.carbonado.spi">TriggerManager</a></dt> +<dd> +<div class="block">Returns a consolidated trigger to call for update operations, or null if + none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html#getUserName()">getUserName()</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCRepositoryBuilder</a></dt> +<dd> +<div class="block">Returns the optional username to use with DataSource.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#getUserProps()">getUserProps()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html" title="class in com.amazon.carbonado.synthetic">SyntheticStorableReferenceBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/capability/StorableInfoCapability.html#getUserStorableTypeNames()">getUserStorableTypeNames()</a></span> - Method in interface com.amazon.carbonado.capability.<a href="../com/amazon/carbonado/capability/StorableInfoCapability.html" title="interface in com.amazon.carbonado.capability">StorableInfoCapability</a></dt> +<dd> +<div class="block">Returns an array of storable type class names for user-level storables + known to the repository.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#getValue(com.amazon.carbonado.filter.PropertyFilter)">getValue(PropertyFilter<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns the value assigned to the given PropertyFilter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#getValues()">getValues()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns all values in this object, including those provided by filter + constants.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/FilterValues.html#getValuesFor(com.amazon.carbonado.filter.Filter)">getValuesFor(Filter<S>)</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/FilterValues.html" title="class in com.amazon.carbonado.filter">FilterValues</a></dt> +<dd> +<div class="block">Returns all values in this object, as required by the given Filter.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html#getVersion()">getVersion()</a></span> - Method in interface com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/EnvironmentCapability.html" title="interface in com.amazon.carbonado.repo.sleepycat">EnvironmentCapability</a></dt> +<dd> +<div class="block">Returns the major, minor, and patch version numbers.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/sequence/StoredSequence.html#getVersion()">getVersion()</a></span> - Method in interface com.amazon.carbonado.sequence.<a href="../com/amazon/carbonado/sequence/StoredSequence.html" title="interface in com.amazon.carbonado.sequence">StoredSequence</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.Block.html#getVersion()">getVersion()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.Block.html" title="class in com.amazon.carbonado.spi">StoredLob.Block</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/StoredLob.html#getVersion()">getVersion()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/StoredLob.html" title="class in com.amazon.carbonado.spi">StoredLob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayout.html#getVersionNumber()">getVersionNumber()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayout.html" title="interface in com.amazon.carbonado.layout">StoredLayout</a></dt> +<dd> +<div class="block">Record version number for this StoredTypeLayout instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html#getVersionNumber()">getVersionNumber()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutEquivalence.html" title="interface in com.amazon.carbonado.layout">StoredLayoutEquivalence</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html#getVersionNumber()">getVersionNumber()</a></span> - Method in interface com.amazon.carbonado.layout.<a href="../com/amazon/carbonado/layout/StoredLayoutProperty.html" title="interface in com.amazon.carbonado.layout">StoredLayoutProperty</a></dt> +<dd> +<div class="block">Record version number for this StoredPropertyLayout instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html#getVersionNumber()">getVersionNumber()</a></span> - Method in interface com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/StoredIndexInfo.html" title="interface in com.amazon.carbonado.repo.indexed">StoredIndexInfo</a></dt> +<dd> +<div class="block">Record version number for this StoredIndexInfo instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html#getVersionNumber()">getVersionNumber()</a></span> - Method in class com.amazon.carbonado.repo.sleepycat.<a href="../com/amazon/carbonado/repo/sleepycat/StoredDatabaseInfo.html" title="class in com.amazon.carbonado.repo.sleepycat">StoredDatabaseInfo</a></dt> +<dd> +<div class="block">Record version number for this StoredDatabaseInfo instance.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableInfo.html#getVersionProperty()">getVersionProperty()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a></dt> +<dd> +<div class="block">Returns the designated version property, or null if none.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getVersionProperty()">getVersionProperty()</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/lob/BlobClob.html#getWrappedBlob()">getWrappedBlob()</a></span> - Method in class com.amazon.carbonado.lob.<a href="../com/amazon/carbonado/lob/BlobClob.html" title="class in com.amazon.carbonado.lob">BlobClob</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html#getWrappedRepository()">getWrappedRepository()</a></span> - Method in class com.amazon.carbonado.repo.indexed.<a href="../com/amazon/carbonado/repo/indexed/IndexedRepositoryBuilder.html" title="class in com.amazon.carbonado.repo.indexed">IndexedRepositoryBuilder</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getWriteMethod()">getWriteMethod()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns a one argument method used to write the property value, or null + if writing is not allowed.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableProperty.html#getWriteMethodName()">getWriteMethodName()</a></span> - Method in interface com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></dt> +<dd> +<div class="block">Returns the name of the write method, even if no write method was + actually declared.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html#getWriteMethodName()">getWriteMethodName()</a></span> - Method in class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html#getWriteMethodName()">getWriteMethodName()</a></span> - Method in class com.amazon.carbonado.synthetic.<a href="../com/amazon/carbonado/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></dt> +<dd> +<div class="block">Returns the name of the write method.</div> +</dd> +<dt><a href="../com/amazon/carbonado/capability/GroupAccessCapability.html" title="interface in com.amazon.carbonado.capability"><span class="strong">GroupAccessCapability</span></a> - Interface in <a href="../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></dt> +<dd> +<div class="block">Capability for gaining access to replication group members.</div> +</dd> +<dt><a href="../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">GroupedCursor</span></a><<a href="../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">S</a>,<a href="../com/amazon/carbonado/cursor/GroupedCursor.html" title="type parameter in GroupedCursor">G</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Abstract cursor for aggregation and finding distinct data.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/GroupedCursor.html#GroupedCursor(com.amazon.carbonado.Cursor, java.util.Comparator)">GroupedCursor(Cursor<S>, Comparator<S>)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor">GroupedCursor</a></dt> +<dd> +<div class="block">Create a GroupedCursor with an existing group comparator.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/GroupedCursor.html#GroupedCursor(com.amazon.carbonado.Cursor, java.lang.Class, java.lang.String...)">GroupedCursor(Cursor<S>, Class<S>, String...)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/GroupedCursor.html" title="class in com.amazon.carbonado.cursor">GroupedCursor</a></dt> +<dd> +<div class="block">Create a GroupedCursor using properties to define the group + comparator.</div> +</dd> +<dt><a href="../com/amazon/carbonado/capability/GroupMembers.html" title="interface in com.amazon.carbonado.capability"><span class="strong">GroupMembers</span></a> - Interface in <a href="../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/raw/GzipCompressor.html" title="class in com.amazon.carbonado.raw"><span class="strong">GzipCompressor</span></a> - Class in <a href="../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></dt> +<dd> +<div class="block">Raw-level data compression using gzip.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/raw/GzipCompressor.html#GzipCompressor()">GzipCompressor()</a></span> - Constructor for class com.amazon.carbonado.raw.<a href="../com/amazon/carbonado/raw/GzipCompressor.html" title="class in com.amazon.carbonado.raw">GzipCompressor</a></dt> +<dd> </dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../overview-summary.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="../overview-tree.html">Tree</a></li> +<li><a href="../deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-6.html">Prev Letter</a></li> +<li><a href="index-8.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-7.html" target="_top">Frames</a></li> +<li><a href="index-7.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> |