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-21.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/index-files/index-21.html')
| -rw-r--r-- | apidocs/index-files/index-21.html | 238 |
1 files changed, 238 insertions, 0 deletions
diff --git a/apidocs/index-files/index-21.html b/apidocs/index-files/index-21.html new file mode 100644 index 0000000..819d2b1 --- /dev/null +++ b/apidocs/index-files/index-21.html @@ -0,0 +1,238 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_25) on Tue Dec 03 13:53:45 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>U-Index (Carbonado 1.2.3 API)</title> +<meta name="date" content="2013-12-03"> +<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="U-Index (Carbonado 1.2.3 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../overview-summary.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="../overview-tree.html">Tree</a></li> +<li><a href="../deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-20.html">Prev Letter</a></li> +<li><a href="index-22.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-21.html" target="_top">Frames</a></li> +<li><a href="index-21.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="contentContainer"><a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> <a name="_U_"> +<!-- --> +</a> +<h2 class="title">U</h2> +<dl> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/AndFilter.html#unbind()">unbind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/AndFilter.html" title="class in com.amazon.carbonado.filter">AndFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ClosedFilter.html#unbind()">unbind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/ExistsFilter.html#unbind()">unbind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/Filter.html#unbind()">unbind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a></dt> +<dd> +<div class="block">Undoes the effect of a bind operation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OpenFilter.html#unbind()">unbind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/OrFilter.html#unbind()">unbind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/OrFilter.html" title="class in com.amazon.carbonado.filter">OrFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/filter/PropertyFilter.html#unbind()">unbind()</a></span> - Method in class com.amazon.carbonado.filter.<a href="../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html#uneraseGenericParameter(org.cojen.classfile.CodeBuilder, org.cojen.classfile.TypeDesc, int)">uneraseGenericParameter(CodeBuilder, TypeDesc, int)</a></span> - Static method in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CodeBuilderUtil.html" title="class in com.amazon.carbonado.gen">CodeBuilderUtil</a></dt> +<dd> +<div class="block">Generate code to create a local variable containing the specified parameter coerced + to the specified type.</div> +</dd> +<dt><a href="../com/amazon/carbonado/layout/Unevolvable.html" title="interface in com.amazon.carbonado.layout"><span class="strong">Unevolvable</span></a> - Interface in <a href="../com/amazon/carbonado/layout/package-summary.html">com.amazon.carbonado.layout</a></dt> +<dd> +<div class="block">Marker interface for storables that are not allowed to evolve.</div> +</dd> +<dt><a href="../com/amazon/carbonado/repo/indexed/Unindexed.html" title="interface in com.amazon.carbonado.repo.indexed"><span class="strong">Unindexed</span></a> - Interface in <a href="../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></dt> +<dd> +<div class="block">Marker interface for storables that are not allowed to have indexes.</div> +</dd> +<dt><a href="../com/amazon/carbonado/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor"><span class="strong">UnionCursor</span></a><<a href="../com/amazon/carbonado/cursor/UnionCursor.html" title="type parameter in UnionCursor">S</a>> - Class in <a href="../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></dt> +<dd> +<div class="block">Wraps two Cursors and performs a <i>set union</i> operation.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/cursor/UnionCursor.html#UnionCursor(com.amazon.carbonado.Cursor, com.amazon.carbonado.Cursor, java.util.Comparator)">UnionCursor(Cursor<S>, Cursor<S>, Comparator<S>)</a></span> - Constructor for class com.amazon.carbonado.cursor.<a href="../com/amazon/carbonado/cursor/UnionCursor.html" title="class in com.amazon.carbonado.cursor">UnionCursor</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe"><span class="strong">UnionQueryAnalyzer</span></a><<a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="type parameter in UnionQueryAnalyzer">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">Analyzes a query specification and determines how it can be executed as a + union of smaller queries.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.html#UnionQueryAnalyzer(java.lang.Class, com.amazon.carbonado.qe.RepositoryAccess)">UnionQueryAnalyzer(Class<S>, RepositoryAccess)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.html" title="class in com.amazon.carbonado.qe">UnionQueryAnalyzer</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/UnionQueryAnalyzer.Result.html" title="class in com.amazon.carbonado.qe"><span class="strong">UnionQueryAnalyzer.Result</span></a> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> </dd> +<dt><a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe"><span class="strong">UnionQueryExecutor</span></a><<a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="type parameter in UnionQueryExecutor">S</a> extends <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> - Class in <a href="../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></dt> +<dd> +<div class="block">QueryExecutor which wraps several others and unions the results.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html#UnionQueryExecutor(com.amazon.carbonado.qe.QueryExecutor...)">UnionQueryExecutor(QueryExecutor<S>...)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html#UnionQueryExecutor(java.util.List)">UnionQueryExecutor(List<QueryExecutor<S>>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html#UnionQueryExecutor(java.util.List, com.amazon.carbonado.qe.OrderingList)">UnionQueryExecutor(List<QueryExecutor<S>>, OrderingList<S>)</a></span> - Constructor for class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/UnionQueryExecutor.html" title="class in com.amazon.carbonado.qe">UnionQueryExecutor</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#unique(boolean)">unique(boolean)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns a StorableIndex instance which is unique or not.</div> +</dd> +<dt><a href="../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado"><span class="strong">UniqueConstraintException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">A UniqueConstraintException is thrown if the <a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> storage + layer has a unique constraint check defined for a property, and a violation + has been detected.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/UniqueConstraintException.html#UniqueConstraintException()">UniqueConstraintException()</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado">UniqueConstraintException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/UniqueConstraintException.html#UniqueConstraintException(java.lang.String)">UniqueConstraintException(String)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado">UniqueConstraintException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/UniqueConstraintException.html#UniqueConstraintException(java.lang.String, java.lang.Throwable)">UniqueConstraintException(String, Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado">UniqueConstraintException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/UniqueConstraintException.html#UniqueConstraintException(java.lang.Throwable)">UniqueConstraintException(Throwable)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/UniqueConstraintException.html" title="class in com.amazon.carbonado">UniqueConstraintException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/info/StorableIndex.html#uniquify(com.amazon.carbonado.info.StorableKey)">uniquify(StorableKey<S>)</a></span> - Method in class com.amazon.carbonado.info.<a href="../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a></dt> +<dd> +<div class="block">Returns a StorableIndex which is unique, possibly by appending + properties from the given key.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorableIndexSet.html#uniquify(com.amazon.carbonado.info.StorableInfo)">uniquify(StorableInfo<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></dt> +<dd> +<div class="block">Augment non-unique indexes with primary key properties, thus making them + unique.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/qe/StorableIndexSet.html#uniquify(com.amazon.carbonado.info.StorableKey)">uniquify(StorableKey<S>)</a></span> - Method in class com.amazon.carbonado.qe.<a href="../com/amazon/carbonado/qe/StorableIndexSet.html" title="class in com.amazon.carbonado.qe">StorableIndexSet</a></dt> +<dd> +<div class="block">Augment non-unique indexes with key properties, thus making them unique.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/spi/AbstractRepository.html#unlockoutShutdown()">unlockoutShutdown()</a></span> - Method in class com.amazon.carbonado.spi.<a href="../com/amazon/carbonado/spi/AbstractRepository.html" title="class in com.amazon.carbonado.spi">AbstractRepository</a></dt> +<dd> +<div class="block">Only call this to release lockoutShutdown.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/txn/TransactionScope.html#unregister(java.lang.Class, com.amazon.carbonado.Cursor)">unregister(Class<S>, Cursor<S>)</a></span> - Method in class com.amazon.carbonado.txn.<a href="../com/amazon/carbonado/txn/TransactionScope.html" title="class in com.amazon.carbonado.txn">TransactionScope</a></dt> +<dd> +<div class="block">Unregisters a previously registered cursor.</div> +</dd> +<dt><a href="../com/amazon/carbonado/UnsupportedTypeException.html" title="class in com.amazon.carbonado"><span class="strong">UnsupportedTypeException</span></a> - Exception in <a href="../com/amazon/carbonado/package-summary.html">com.amazon.carbonado</a></dt> +<dd> +<div class="block">Thrown by a <a href="../com/amazon/carbonado/Repository.html" title="interface in com.amazon.carbonado"><code>Repository</code></a> which cannot support a <a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> which + is declared as <a href="../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>Independent</code></a> or <a href="../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado"><code>Authoritative</code></a>.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/UnsupportedTypeException.html#UnsupportedTypeException(java.lang.String, java.lang.Class)">UnsupportedTypeException(String, Class<? extends Storable>)</a></span> - Constructor for exception com.amazon.carbonado.<a href="../com/amazon/carbonado/UnsupportedTypeException.html" title="class in com.amazon.carbonado">UnsupportedTypeException</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html#unwrap(java.lang.Class)">unwrap(Class<T>)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/LoggingDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">LoggingDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html#unwrap(java.lang.Class)">unwrap(Class<T>)</a></span> - Method in class com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/SimpleDataSource.html" title="class in com.amazon.carbonado.repo.jdbc">SimpleDataSource</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/Storable.html#update()">update()</a></span> - Method in interface com.amazon.carbonado.<a href="../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a></dt> +<dd> +<div class="block">Updates the persistent value of this object, regardless of whether this + object has actually been loaded or not.</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/gen/CommonMethodNames.html#UPDATE_METHOD_NAME">UPDATE_METHOD_NAME</a></span> - Static variable in class com.amazon.carbonado.gen.<a href="../com/amazon/carbonado/gen/CommonMethodNames.html" title="class in com.amazon.carbonado.gen">CommonMethodNames</a></dt> +<dd> +<div class="block">Storable API method name</div> +</dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#updateBlob(com.amazon.carbonado.lob.Blob, com.amazon.carbonado.lob.Blob)">updateBlob(Blob, Blob)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a></dt> +<dd> </dd> +<dt><span class="strong"><a href="../com/amazon/carbonado/repo/jdbc/JDBCSupport.html#updateClob(com.amazon.carbonado.lob.Clob, com.amazon.carbonado.lob.Clob)">updateClob(Clob, Clob)</a></span> - Method in interface com.amazon.carbonado.repo.jdbc.<a href="../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCSupport</a></dt> +<dd> </dd> +</dl> +<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">J</a> <a href="index-11.html">K</a> <a href="index-12.html">L</a> <a href="index-13.html">M</a> <a href="index-14.html">N</a> <a href="index-15.html">O</a> <a href="index-16.html">P</a> <a href="index-17.html">Q</a> <a href="index-18.html">R</a> <a href="index-19.html">S</a> <a href="index-20.html">T</a> <a href="index-21.html">U</a> <a href="index-22.html">V</a> <a href="index-23.html">W</a> <a href="index-24.html">Y</a> </div> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../overview-summary.html">Overview</a></li> +<li>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="../overview-tree.html">Tree</a></li> +<li><a href="../deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="index-20.html">Prev Letter</a></li> +<li><a href="index-22.html">Next Letter</a></li> +</ul> +<ul class="navList"> +<li><a href="../index.html?index-filesindex-21.html" target="_top">Frames</a></li> +<li><a href="index-21.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p> +</body> +</html> |