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/com/amazon/carbonado/capability/class-use/IndexInfo.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/capability/class-use/IndexInfo.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/capability/class-use/IndexInfo.html | 266 |
1 files changed, 266 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/capability/class-use/IndexInfo.html b/apidocs/com/amazon/carbonado/capability/class-use/IndexInfo.html new file mode 100644 index 0000000..08d3155 --- /dev/null +++ b/apidocs/com/amazon/carbonado/capability/class-use/IndexInfo.html @@ -0,0 +1,266 @@ +<!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>Uses of Interface com.amazon.carbonado.capability.IndexInfo (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="Uses of Interface com.amazon.carbonado.capability.IndexInfo (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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/IndexInfo.html" target="_top">Frames</a></li> +<li><a href="IndexInfo.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="header"> +<h2 title="Uses of Interface com.amazon.carbonado.capability.IndexInfo" class="title">Uses of Interface<br>com.amazon.carbonado.capability.IndexInfo</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.capability">com.amazon.carbonado.capability</a></td> +<td class="colLast"> +<div class="block">Common capabilities for repositories.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.indexed">com.amazon.carbonado.repo.indexed</a></td> +<td class="colLast"> +<div class="block">Repository implementation that adds index support for repositories that have + little or no index support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.repo.jdbc">com.amazon.carbonado.repo.jdbc</a></td> +<td class="colLast"> +<div class="block">Repository implementation that connects to an external SQL database via + JDBC.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.spi">com.amazon.carbonado.spi</a></td> +<td class="colLast"> +<div class="block">Service Provider Interface for Carbonado.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a> that return <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a>[]</code></td> +<td class="colLast"><span class="strong">IndexInfoCapability.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/IndexInfoCapability.html#getIndexInfo(java.lang.Class)">getIndexInfo</a></strong>(java.lang.Class<S> storableType)</code> +<div class="block">Returns information about the known indexes for the given storable + type.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> with parameters of type <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(java.lang.Class, com.amazon.carbonado.capability.IndexInfo)">StorableIndex</a></strong>(java.lang.Class<<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> type, + <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> indexInfo)</code> +<div class="block">Creates a StorableIndex from an IndexInfo.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.indexed"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> in <a href="../../../../../com/amazon/carbonado/repo/indexed/package-summary.html">com.amazon.carbonado.repo.indexed</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Interface and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>interface </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/indexed/IndexEntryAccessor.html" title="interface in com.amazon.carbonado.repo.indexed">IndexEntryAccessor</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Provides low-level access to index data, which can be used for manual + inspection and repair.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a> that return <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a>[]</code></td> +<td class="colLast"><span class="strong">JDBCStorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html#getIndexInfo()">getIndexInfo</a></strong>()</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a> in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that implement <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">IndexInfo</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/spi/IndexInfoImpl.html" title="class in com.amazon.carbonado.spi">IndexInfoImpl</a></strong></code> +<div class="block">Basic implementation of an <a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability"><code>IndexInfo</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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><a href="../package-summary.html">Package</a></li> +<li><a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html" title="interface in com.amazon.carbonado.capability">Class</a></li> +<li class="navBarCell1Rev">Use</li> +<li><a href="../package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-files/index-1.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/capability/class-use/IndexInfo.html" target="_top">Frames</a></li> +<li><a href="IndexInfo.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> |