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/info | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/info')
26 files changed, 9703 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/info/ChainedProperty.html b/apidocs/com/amazon/carbonado/info/ChainedProperty.html new file mode 100644 index 0000000..de0ae35 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/ChainedProperty.html @@ -0,0 +1,625 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>ChainedProperty (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="ChainedProperty (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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/ChainedProperty.html">Use</a></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 Class</li> +<li><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/ChainedProperty.html" target="_top">Frames</a></li> +<li><a href="ChainedProperty.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.amazon.carbonado.info</div> +<h2 title="Class ChainedProperty" class="title">Class ChainedProperty<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.info.ChainedProperty<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ChainedProperty<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object +implements java.io.Serializable, <a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></pre> +<div class="block">Represents a property to filter on or to order by. Properties may be + specified in a simple form, like "firstName", or in a chained form, like + "address.state". In both forms, the first property is the "prime" + property. All properties that follow are chained.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#com.amazon.carbonado.info.ChainedProperty">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</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> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.ChainedProperty)">append</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?> property)</code> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.StorableProperty)">append</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> property)</code> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.StorableProperty, boolean)">append</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> property, + boolean outerJoin)</code> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#appendTo(java.lang.Appendable)">appendTo</a></strong>(java.lang.Appendable app)</code> +<div class="block">Appends the chained property formatted as "name.subname.subsubname".</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty)">get</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime)</code> +<div class="block">Returns a canonical instance which has no chain.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty...)">get</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>... chain)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty[], boolean[])">get</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>[] chain, + boolean[] outerJoin)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#getChainCount()">getChainCount</a></strong>()</code> +<div class="block">Returns amount of properties chained from prime property, which may be + zero.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#getChainedProperty(int)">getChainedProperty</a></strong>(int index)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#getLastProperty()">getLastProperty</a></strong>()</code> +<div class="block">Returns the last property in the chain, or the prime property if chain + is empty.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#getPrimeProperty()">getPrimeProperty</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#getType()">getType</a></strong>()</code> +<div class="block">Returns the type of the last property in the chain, or of the prime + property if the chain is empty.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#isDerived()">isDerived</a></strong>()</code> +<div class="block">Returns true if any property in the chain is derived.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#isNullable()">isNullable</a></strong>()</code> +<div class="block">Returns true if any property in the chain can be null.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#isOuterJoin(int)">isOuterJoin</a></strong>(int index)</code> +<div class="block">Returns true if the property at the given index should be treated as an + outer join.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)">parse</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str)</code> +<div class="block">Parses a chained property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#tail()">tail</a></strong>()</code> +<div class="block">Returns a new ChainedProperty which contains everything that follows + this ChainedProperty's prime property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#toString()">toString</a></strong>()</code> +<div class="block">Returns the chained property formatted as "name.subname.subsubname".</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html#trim()">trim</a></strong>()</code> +<div class="block">Returns a new ChainedProperty with the last property in the chain removed.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="get(com.amazon.carbonado.info.StorableProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S> get(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime)</pre> +<div class="block">Returns a canonical instance which has no chain.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if prime is null</dd></dl> +</li> +</ul> +<a name="get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty...)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S> get(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>... chain)</pre> +<div class="block">Returns a canonical instance.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if prime is null or if chained + properties are not formed properly</dd></dl> +</li> +</ul> +<a name="get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty[], boolean[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S> get(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>[] chain, + boolean[] outerJoin)</pre> +<div class="block">Returns a canonical instance.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if prime is null or if chained + properties are not formed properly</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parse</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S> parse(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str) + throws java.lang.IllegalArgumentException</pre> +<div class="block">Parses a chained property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>info</code> - Info for Storable type containing property</dd><dd><code>str</code> - string to parse</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any parameter is null or string + format is incorrect</dd></dl> +</li> +</ul> +<a name="getPrimeProperty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrimeProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>> getPrimeProperty()</pre> +</li> +</ul> +<a name="getType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</h4> +<pre>public java.lang.Class<?> getType()</pre> +<div class="block">Returns the type of the last property in the chain, or of the prime + property if the chain is empty.</div> +</li> +</ul> +<a name="isNullable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNullable</h4> +<pre>public boolean isNullable()</pre> +<div class="block">Returns true if any property in the chain can be null.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado"><code>Nullable</code></a></dd></dl> +</li> +</ul> +<a name="isDerived()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isDerived</h4> +<pre>public boolean isDerived()</pre> +<div class="block">Returns true if any property in the chain is derived.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Derived.html" title="annotation in com.amazon.carbonado"><code>Derived</code></a></dd></dl> +</li> +</ul> +<a name="getLastProperty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLastProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> getLastProperty()</pre> +<div class="block">Returns the last property in the chain, or the prime property if chain + is empty.</div> +</li> +</ul> +<a name="getChainCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getChainCount</h4> +<pre>public int getChainCount()</pre> +<div class="block">Returns amount of properties chained from prime property, which may be + zero.</div> +</li> +</ul> +<a name="getChainedProperty(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getChainedProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> getChainedProperty(int index) + throws java.lang.IndexOutOfBoundsException</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - valid range is 0 to chainCount - 1</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code></dd></dl> +</li> +</ul> +<a name="isOuterJoin(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isOuterJoin</h4> +<pre>public boolean isOuterJoin(int index) + throws java.lang.IndexOutOfBoundsException</pre> +<div class="block">Returns true if the property at the given index should be treated as an + outer join. Index zero is the prime property.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - valid range is 0 to chainCount</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code></dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="append(com.amazon.carbonado.info.StorableProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>append</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>> append(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> property)</pre> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</li> +</ul> +<a name="append(com.amazon.carbonado.info.StorableProperty, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>append</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>> append(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> property, + boolean outerJoin)</pre> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>outerJoin</code> - pass true for outer join</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="append(com.amazon.carbonado.info.ChainedProperty)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>append</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>> append(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?> property)</pre> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</li> +</ul> +<a name="trim()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>trim</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>> trim()</pre> +<div class="block">Returns a new ChainedProperty with the last property in the chain removed.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if chain count is zero</dd></dl> +</li> +</ul> +<a name="tail()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>tail</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?> tail()</pre> +<div class="block">Returns a new ChainedProperty which contains everything that follows + this ChainedProperty's prime property.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if chain count is zero</dd></dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<div class="block">Returns the chained property formatted as "name.subname.subsubname". + This format is parseable only if the chain is composed of valid + many-to-one joins.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="appendTo(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>appendTo</h4> +<pre>public void appendTo(java.lang.Appendable app) + throws java.io.IOException</pre> +<div class="block">Appends the chained property formatted as "name.subname.subsubname". + This format is parseable only if the chain is composed of valid + many-to-one joins.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">appendTo</a></code> in interface <code><a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - Appendable object to receive string representation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if thrown from given Appendable</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/ChainedProperty.html">Use</a></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 Class</li> +<li><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/ChainedProperty.html" target="_top">Frames</a></li> +<li><a href="ChainedProperty.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</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> diff --git a/apidocs/com/amazon/carbonado/info/Direction.html b/apidocs/com/amazon/carbonado/info/Direction.html new file mode 100644 index 0000000..b1e7db0 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/Direction.html @@ -0,0 +1,388 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>Direction (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="Direction (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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/Direction.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/Direction.html" target="_top">Frames</a></li> +<li><a href="Direction.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.amazon.carbonado.info</div> +<h2 title="Enum Direction" class="title">Enum Direction</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Enum<<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>></li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.info.Direction</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.lang.Comparable<<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <span class="strong">Direction</span> +extends java.lang.Enum<<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>></pre> +<div class="block">Describes a property sorting direction.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#ASCENDING">ASCENDING</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#DESCENDING">DESCENDING</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#UNSPECIFIED">UNSPECIFIED</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</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> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#fromCharacter(char)">fromCharacter</a></strong>(char c)</code> +<div class="block">Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything + else.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#reverse()">reverse</a></strong>()</code> +<div class="block">Returns the reverse direction of this.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>char</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#toCharacter()">toCharacter</a></strong>()</code> +<div class="block">Returns '+' for ASCENDING, '-' for DESCENDING, and '~' for UNSPECIFIED.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/Direction.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Enum</h3> +<code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="ASCENDING"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ASCENDING</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> ASCENDING</pre> +</li> +</ul> +<a name="DESCENDING"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DESCENDING</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> DESCENDING</pre> +</li> +</ul> +<a name="UNSPECIFIED"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UNSPECIFIED</h4> +<pre>public static final <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> UNSPECIFIED</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (Direction c : Direction.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in +the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> valueOf(java.lang.String name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant +with the specified name</dd> +<dd><code>java.lang.NullPointerException</code> - if the argument is null</dd></dl> +</li> +</ul> +<a name="reverse()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reverse</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> reverse()</pre> +<div class="block">Returns the reverse direction of this.</div> +</li> +</ul> +<a name="toCharacter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toCharacter</h4> +<pre>public char toCharacter()</pre> +<div class="block">Returns '+' for ASCENDING, '-' for DESCENDING, and '~' for UNSPECIFIED.</div> +</li> +</ul> +<a name="fromCharacter(char)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>fromCharacter</h4> +<pre>public static <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> fromCharacter(char c)</pre> +<div class="block">Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything + else.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/Direction.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/Direction.html" target="_top">Frames</a></li> +<li><a href="Direction.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</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> diff --git a/apidocs/com/amazon/carbonado/info/OrderedProperty.html b/apidocs/com/amazon/carbonado/info/OrderedProperty.html new file mode 100644 index 0000000..48833a5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/OrderedProperty.html @@ -0,0 +1,444 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>OrderedProperty (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="OrderedProperty (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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/OrderedProperty.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/OrderedProperty.html" target="_top">Frames</a></li> +<li><a href="OrderedProperty.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.amazon.carbonado.info</div> +<h2 title="Class OrderedProperty" class="title">Class OrderedProperty<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.info.OrderedProperty<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">OrderedProperty<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object +implements java.io.Serializable, <a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></pre> +<div class="block">Represents a property paired with a preferred ordering direction.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#com.amazon.carbonado.info.OrderedProperty">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</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> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#appendTo(java.lang.Appendable)">appendTo</a></strong>(java.lang.Appendable app)</code> +<div class="block">Append the string representation of this object to the given Appendable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#direction(com.amazon.carbonado.info.Direction)">direction</a></strong>(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.info.Direction)">get</a></strong>(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S> property, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">get</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> property, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#getChainedProperty()">getChainedProperty</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#getDirection()">getDirection</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)">parse</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str)</code> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String, com.amazon.carbonado.info.Direction)">parse</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#reverse()">reverse</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html#toString()">toString</a></strong>()</code> +<div class="block">Returns the chained property in a parseable form.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S> get(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> property, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</pre> +<div class="block">Returns a canonical instance.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property is null</dd></dl> +</li> +</ul> +<a name="get(com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S> get(<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S> property, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</pre> +<div class="block">Returns a canonical instance.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if property is null</dd></dl> +</li> +</ul> +<a name="parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parse</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S> parse(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str) + throws java.lang.IllegalArgumentException</pre> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction. Prefix of '~' indicates unspecified direction. If + ordering prefix not specified, default direction is ascending.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>info</code> - Info for Storable type containing property</dd><dd><code>str</code> - string to parse</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any required parameter is null or + string format is incorrect</dd></dl> +</li> +</ul> +<a name="parse(com.amazon.carbonado.info.StorableInfo, java.lang.String, com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parse</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S> parse(<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection) + throws java.lang.IllegalArgumentException</pre> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction. Prefix of '~' indicates unspecified direction.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>info</code> - Info for Storable type containing property</dd><dd><code>str</code> - string to parse</dd><dd><code>defaultDirection</code> - default direction if not specified in + string. If null, ascending order is defaulted.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any required parameter is null or + string format is incorrect</dd></dl> +</li> +</ul> +<a name="getChainedProperty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getChainedProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>> getChainedProperty()</pre> +</li> +</ul> +<a name="getDirection()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDirection</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> getDirection()</pre> +</li> +</ul> +<a name="reverse()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reverse</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>> reverse()</pre> +</li> +</ul> +<a name="direction(com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>direction</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>> direction(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</pre> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<div class="block">Returns the chained property in a parseable form.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="appendTo(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>appendTo</h4> +<pre>public void appendTo(java.lang.Appendable app) + throws java.io.IOException</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">Appender</a></code></strong></div> +<div class="block">Append the string representation of this object to the given Appendable.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">appendTo</a></code> in interface <code><a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - Appendable object to receive string representation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if thrown from given Appendable</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/OrderedProperty.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/OrderedProperty.html" target="_top">Frames</a></li> +<li><a href="OrderedProperty.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</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> diff --git a/apidocs/com/amazon/carbonado/info/StorableIndex.html b/apidocs/com/amazon/carbonado/info/StorableIndex.html new file mode 100644 index 0000000..863b3bf --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableIndex.html @@ -0,0 +1,791 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>StorableIndex (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="StorableIndex (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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/StorableIndex.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableIndex.html" target="_top">Frames</a></li> +<li><a href="StorableIndex.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.amazon.carbonado.info</div> +<h2 title="Class StorableIndex" class="title">Class StorableIndex<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.info.StorableIndex<S></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">StorableIndex<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.lang.Object +implements <a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></pre> +<div class="block">Represents an index that must be defined for a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Index.html" title="annotation in com.amazon.carbonado"><code>Index</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><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> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.OrderedProperty[], com.amazon.carbonado.info.Direction)">StorableIndex</a></strong>(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Creates a StorableIndex from OrderedProperties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableKey, com.amazon.carbonado.info.Direction)">StorableIndex</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> key, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Creates a StorableIndex from a StorableKey.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[])">StorableIndex</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions)</code> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[], boolean)">StorableIndex</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions, + boolean unique)</code> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[], boolean, boolean)">StorableIndex</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions, + boolean unique, + boolean clustered)</code> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</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> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#addProperty(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">addProperty</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> property, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a StorableIndex with the given property added.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#appendTo(java.lang.Appendable)">appendTo</a></strong>(java.lang.Appendable app)</code> +<div class="block">Appends the same results as toString, but without the "StorableIndex" + prefix.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#clustered(boolean)">clustered</a></strong>(boolean clustered)</code> +<div class="block">Returns a StorableIndex instance which is clustered or not.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getNameDescriptor()">getNameDescriptor</a></strong>()</code> +<div class="block">Converts this index into a parseable name descriptor string, whose + general format is:</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getOrderedProperties()">getOrderedProperties</a></strong>()</code> +<div class="block">Returns a new array with all the properties in it, with directions + folded in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getOrderedProperty(int)">getOrderedProperty</a></strong>(int index)</code> +<div class="block">Returns a specific property in this index, with the direction folded in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getProperties()">getProperties</a></strong>()</code> +<div class="block">Returns a new array with all the properties in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getProperty(int)">getProperty</a></strong>(int index)</code> +<div class="block">Returns a specific property in this index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getPropertyCount()">getPropertyCount</a></strong>()</code> +<div class="block">Returns the count of properties in this index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getPropertyDirection(int)">getPropertyDirection</a></strong>(int index)</code> +<div class="block">Returns the requested direction of a specific property in this index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getPropertyDirections()">getPropertyDirections</a></strong>()</code> +<div class="block">Returns a new array with all the property directions in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the type of storable this index applies to.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getTypeDescriptor()">getTypeDescriptor</a></strong>()</code> +<div class="block">Converts this index into a parseable type descriptor string, which + basically consists of Java type descriptors appended together.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#isClustered()">isClustered</a></strong>()</code> +<div class="block">Returns true if index is known to be clustered, which means it defines + the physical ordering of storables.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#isUnique()">isUnique</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#parseNameDescriptor(java.lang.String, com.amazon.carbonado.info.StorableInfo)">parseNameDescriptor</a></strong>(java.lang.String desc, + <a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info)</code> +<div class="block">Parses an index descriptor and returns an index object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#reverse()">reverse</a></strong>()</code> +<div class="block">Returns a StorableIndex instance with all the properties reversed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#setDefaultDirection(com.amazon.carbonado.info.Direction)">setDefaultDirection</a></strong>(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a StorableIndex instance with all unspecified directions set to + the given direction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#unique(boolean)">unique</a></strong>(boolean unique)</code> +<div class="block">Returns a StorableIndex instance which is unique or not.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#uniquify(com.amazon.carbonado.info.StorableKey)">uniquify</a></strong>(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> key)</code> +<div class="block">Returns a StorableIndex which is unique, possibly by appending + properties from the given key.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>StorableIndex</h4> +<pre>public StorableIndex(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions)</pre> +<div class="block">Creates a StorableIndex from the given properties and matching + directions. Both arrays must match length.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any argument is null, if lengths + do not match, or if any length is zero.</dd></dl> +</li> +</ul> +<a name="StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[], boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>StorableIndex</h4> +<pre>public StorableIndex(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions, + boolean unique)</pre> +<div class="block">Creates a StorableIndex from the given properties and matching + directions. Both arrays must match length. Allows specification of the + uniqueness of the index.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - </dd><dd><code>directions</code> - </dd><dd><code>unique</code> - </dd></dl> +</li> +</ul> +<a name="StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[], boolean, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>StorableIndex</h4> +<pre>public StorableIndex(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions, + boolean unique, + boolean clustered)</pre> +<div class="block">Creates a StorableIndex from the given properties and matching + directions. Both arrays must match length. Allows specification of the + uniqueness of the index as well as clustered option.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>properties</code> - </dd><dd><code>directions</code> - </dd><dd><code>unique</code> - </dd><dd><code>clustered</code> - </dd></dl> +</li> +</ul> +<a name="StorableIndex(com.amazon.carbonado.info.StorableKey, com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>StorableIndex</h4> +<pre>public StorableIndex(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> key, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</pre> +<div class="block">Creates a StorableIndex from a StorableKey.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>direction</code> - optional direction to apply to each key property that + has an unspecified direction</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if key is null or it has + no properties</dd></dl> +</li> +</ul> +<a name="StorableIndex(com.amazon.carbonado.info.OrderedProperty[], com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>StorableIndex</h4> +<pre>public StorableIndex(<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</pre> +<div class="block">Creates a StorableIndex from OrderedProperties.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>direction</code> - optional direction to apply to each property that + has an unspecified direction</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if no properties supplied</dd></dl> +</li> +</ul> +<a name="StorableIndex(java.lang.Class, com.amazon.carbonado.capability.IndexInfo)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StorableIndex</h4> +<pre>public StorableIndex(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)</pre> +<div class="block">Creates a StorableIndex from an IndexInfo.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - type of storable index is defined for</dd><dd><code>indexInfo</code> - IndexInfo returned from storage object</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if any argument is null, if any + properties are invalid, or if index info has no properties</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="parseNameDescriptor(java.lang.String, com.amazon.carbonado.info.StorableInfo)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>parseNameDescriptor</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> parseNameDescriptor(java.lang.String desc, + <a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info) + throws java.lang.IllegalArgumentException</pre> +<div class="block">Parses an index descriptor and returns an index object.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>desc</code> - name descriptor, as created by <a href="../../../../com/amazon/carbonado/info/StorableIndex.html#getNameDescriptor()"><code>getNameDescriptor()</code></a></dd><dd><code>info</code> - info on storable type</dd> +<dt><span class="strong">Returns:</span></dt><dd>index represented by descriptor</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if error in descriptor syntax or if it + refers to unknown properties</dd></dl> +</li> +</ul> +<a name="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>public java.lang.Class<<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> getStorableType()</pre> +<div class="block">Returns the type of storable this index applies to.</div> +</li> +</ul> +<a name="getPropertyCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyCount</h4> +<pre>public int getPropertyCount()</pre> +<div class="block">Returns the count of properties in this index.</div> +</li> +</ul> +<a name="getProperty(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> getProperty(int index)</pre> +<div class="block">Returns a specific property in this index.</div> +</li> +</ul> +<a name="getProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProperties</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] getProperties()</pre> +<div class="block">Returns a new array with all the properties in it.</div> +</li> +</ul> +<a name="getPropertyDirection(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyDirection</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> getPropertyDirection(int index)</pre> +<div class="block">Returns the requested direction of a specific property in this index.</div> +</li> +</ul> +<a name="getPropertyDirections()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPropertyDirections</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] getPropertyDirections()</pre> +<div class="block">Returns a new array with all the property directions in it.</div> +</li> +</ul> +<a name="getOrderedProperty(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrderedProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> getOrderedProperty(int index)</pre> +<div class="block">Returns a specific property in this index, with the direction folded in.</div> +</li> +</ul> +<a name="getOrderedProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrderedProperties</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] getOrderedProperties()</pre> +<div class="block">Returns a new array with all the properties in it, with directions + folded in.</div> +</li> +</ul> +<a name="isUnique()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isUnique</h4> +<pre>public boolean isUnique()</pre> +</li> +</ul> +<a name="isClustered()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isClustered</h4> +<pre>public boolean isClustered()</pre> +<div class="block">Returns true if index is known to be clustered, which means it defines + the physical ordering of storables.</div> +</li> +</ul> +<a name="unique(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unique</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> unique(boolean unique)</pre> +<div class="block">Returns a StorableIndex instance which is unique or not.</div> +</li> +</ul> +<a name="clustered(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clustered</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> clustered(boolean clustered)</pre> +<div class="block">Returns a StorableIndex instance which is clustered or not.</div> +</li> +</ul> +<a name="reverse()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reverse</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> reverse()</pre> +<div class="block">Returns a StorableIndex instance with all the properties reversed.</div> +</li> +</ul> +<a name="setDefaultDirection(com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefaultDirection</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> setDefaultDirection(<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</pre> +<div class="block">Returns a StorableIndex instance with all unspecified directions set to + the given direction. Returns this if all directions are already + specified.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>direction</code> - direction to replace all unspecified directions</dd></dl> +</li> +</ul> +<a name="addProperty(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addProperty</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> addProperty(<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> property, + <a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</pre> +<div class="block">Returns a StorableIndex with the given property added. If this index + already contained the given property (regardless of sort direction), + this index is returned.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>property</code> - property to add unless already in this index</dd><dd><code>direction</code> - direction to apply to property, if added</dd> +<dt><span class="strong">Returns:</span></dt><dd>new index with added property or this if index already contained property</dd></dl> +</li> +</ul> +<a name="uniquify(com.amazon.carbonado.info.StorableKey)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>uniquify</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> uniquify(<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> key)</pre> +<div class="block">Returns a StorableIndex which is unique, possibly by appending + properties from the given key. If index is already unique, it is + returned as-is.</div> +</li> +</ul> +<a name="getNameDescriptor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNameDescriptor</h4> +<pre>public java.lang.String getNameDescriptor()</pre> +<div class="block">Converts this index into a parseable name descriptor string, whose + general format is: + + <p><code><storable type>~<attr><+|-|~><property><+|-|~><property>...</code> + + <p>Attr is "U" for a unique index, "N" for a non-unique index. + + <p>Example: <code>my.pkg.UserInfo~N+lastName+firstName-birthDate</code></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/info/StorableIndex.html#parseNameDescriptor(java.lang.String, com.amazon.carbonado.info.StorableInfo)"><code>parseNameDescriptor(String, StorableInfo)</code></a></dd></dl> +</li> +</ul> +<a name="getTypeDescriptor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTypeDescriptor</h4> +<pre>public java.lang.String getTypeDescriptor()</pre> +<div class="block">Converts this index into a parseable type descriptor string, which + basically consists of Java type descriptors appended together. There is + one slight difference. Types which may be null are prefixed with a 'N' + character.</div> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="appendTo(java.lang.Appendable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>appendTo</h4> +<pre>public void appendTo(java.lang.Appendable app) + throws java.io.IOException</pre> +<div class="block">Appends the same results as toString, but without the "StorableIndex" + prefix.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">appendTo</a></code> in interface <code><a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>app</code> - Appendable object to receive string representation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.io.IOException</code> - if thrown from given Appendable</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/StorableIndex.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableIndex.html" target="_top">Frames</a></li> +<li><a href="StorableIndex.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</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> diff --git a/apidocs/com/amazon/carbonado/info/StorableInfo.html b/apidocs/com/amazon/carbonado/info/StorableInfo.html new file mode 100644 index 0000000..ac528bb --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableInfo.html @@ -0,0 +1,522 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>StorableInfo (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="StorableInfo (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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/StorableInfo.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableInfo.html" target="_top">Frames</a></li> +<li><a href="StorableInfo.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.amazon.carbonado.info</div> +<h2 title="Interface StorableInfo" class="title">Interface StorableInfo<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a><S></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">StorableInfo<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span></pre> +<div class="block">Contains all the metadata describing a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Archit Shivaprakash</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><code>StorableIntrospector</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</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> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getAlias(int)">getAlias</a></strong>(int index)</code> +<div class="block">Returns a specific alias for the Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getAliasCount()">getAliasCount</a></strong>()</code> +<div class="block">Returns the count of aliases for the Storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getAliases()">getAliases</a></strong>()</code> +<div class="block">Returns a new array with all the alias names in it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,? extends <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getAllProperties()">getAllProperties</a></strong>()</code> +<div class="block">Returns all the storable properties in an unmodifiable map.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getAlternateKey(int)">getAlternateKey</a></strong>(int index)</code> +<div class="block">Returns a specific alternate key for the Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getAlternateKeyCount()">getAlternateKeyCount</a></strong>()</code> +<div class="block">Returns the count of alternate keys for the Storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getAlternateKeys()">getAlternateKeys</a></strong>()</code> +<div class="block">Returns a new array with all the alternate keys in it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,? extends <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getDataProperties()">getDataProperties</a></strong>()</code> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getIndex(int)">getIndex</a></strong>(int index)</code> +<div class="block">Returns a specific index for the Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getIndexCount()">getIndexCount</a></strong>()</code> +<div class="block">Returns the count of indexes defined for the Storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getIndexes()">getIndexes</a></strong>()</code> +<div class="block">Returns a new array with all the indexes in it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getName()">getName</a></strong>()</code> +<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> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getPartitionKey()">getPartitionKey</a></strong>()</code> +<div class="block">Returns the partition key for the Storable, or null if none exists.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getPrimaryKey()">getPrimaryKey</a></strong>()</code> +<div class="block">Returns the primary key for the Storable, never null.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,? extends <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getPrimaryKeyProperties()">getPrimaryKeyProperties</a></strong>()</code> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the primary key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getStorableType()">getStorableType</a></strong>()</code> +<div class="block">Returns the type of Storable described by this StorableInfo.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#getVersionProperty()">getVersionProperty</a></strong>()</code> +<div class="block">Returns the designated version property, or null if none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#isAuthoritative()">isAuthoritative</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableInfo.html#isIndependent()">isIndependent</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>java.lang.String getName()</pre> +<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> +</li> +</ul> +<a name="getStorableType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorableType</h4> +<pre>java.lang.Class<<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>> getStorableType()</pre> +<div class="block">Returns the type of Storable described by this StorableInfo.</div> +</li> +</ul> +<a name="getAllProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllProperties</h4> +<pre>java.util.Map<java.lang.String,? extends <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>> getAllProperties()</pre> +<div class="block">Returns all the storable properties in an unmodifiable map. Properties + are always ordered, case-sensitive, by name. Primary key properties are + grouped first.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>maps property names to property objects</dd></dl> +</li> +</ul> +<a name="getPrimaryKeyProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrimaryKeyProperties</h4> +<pre>java.util.Map<java.lang.String,? extends <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>> getPrimaryKeyProperties()</pre> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the primary key. Properties are always ordered, + case-sensitive, by name.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>maps property names to property objects</dd></dl> +</li> +</ul> +<a name="getDataProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataProperties</h4> +<pre>java.util.Map<java.lang.String,? extends <a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>> getDataProperties()</pre> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties. Primary keys and joins are + excluded. Properties are always ordered, case-sensitive, by name.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>maps property names to property objects</dd></dl> +</li> +</ul> +<a name="getVersionProperty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getVersionProperty</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>> getVersionProperty()</pre> +<div class="block">Returns the designated version property, or null if none.</div> +</li> +</ul> +<a name="getPrimaryKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrimaryKey</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>> getPrimaryKey()</pre> +<div class="block">Returns the primary key for the Storable, never null.</div> +</li> +</ul> +<a name="getAlternateKeyCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAlternateKeyCount</h4> +<pre>int getAlternateKeyCount()</pre> +<div class="block">Returns the count of alternate keys for the Storable.</div> +</li> +</ul> +<a name="getAlternateKey(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAlternateKey</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>> getAlternateKey(int index)</pre> +<div class="block">Returns a specific alternate key for the Storable.</div> +</li> +</ul> +<a name="getAlternateKeys()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAlternateKeys</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>[] getAlternateKeys()</pre> +<div class="block">Returns a new array with all the alternate keys in it.</div> +</li> +</ul> +<a name="getPartitionKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPartitionKey</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>> getPartitionKey()</pre> +<div class="block">Returns the partition key for the Storable, or null if none exists.</div> +</li> +</ul> +<a name="getAliasCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAliasCount</h4> +<pre>int getAliasCount()</pre> +<div class="block">Returns the count of aliases for the Storable.</div> +</li> +</ul> +<a name="getAlias(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAlias</h4> +<pre>java.lang.String getAlias(int index) + throws java.lang.IndexOutOfBoundsException</pre> +<div class="block">Returns a specific alias for the Storable.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code></dd></dl> +</li> +</ul> +<a name="getAliases()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAliases</h4> +<pre>java.lang.String[] getAliases()</pre> +<div class="block">Returns a new array with all the alias names in it.</div> +</li> +</ul> +<a name="getIndexCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexCount</h4> +<pre>int getIndexCount()</pre> +<div class="block">Returns the count of indexes defined for the Storable.</div> +</li> +</ul> +<a name="getIndex(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndex</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>> getIndex(int index) + throws java.lang.IndexOutOfBoundsException</pre> +<div class="block">Returns a specific index for the Storable.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code></dd></dl> +</li> +</ul> +<a name="getIndexes()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIndexes</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>[] getIndexes()</pre> +<div class="block">Returns a new array with all the indexes in it.</div> +</li> +</ul> +<a name="isIndependent()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIndependent</h4> +<pre>boolean isIndependent()</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>Independent</code></a></dd></dl> +</li> +</ul> +<a name="isAuthoritative()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isAuthoritative</h4> +<pre>boolean isAuthoritative()</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Authoritative.html" title="annotation in com.amazon.carbonado"><code>Authoritative</code></a></dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/StorableInfo.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableInfo.html" target="_top">Frames</a></li> +<li><a href="StorableInfo.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</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> diff --git a/apidocs/com/amazon/carbonado/info/StorableIntrospector.html b/apidocs/com/amazon/carbonado/info/StorableIntrospector.html new file mode 100644 index 0000000..61f6695 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableIntrospector.html @@ -0,0 +1,319 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>StorableIntrospector (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="StorableIntrospector (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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/StorableIntrospector.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableIntrospector.html" target="_top">Frames</a></li> +<li><a href="StorableIntrospector.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.amazon.carbonado.info</div> +<h2 title="Class StorableIntrospector" class="title">Class StorableIntrospector</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.info.StorableIntrospector</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCStorableIntrospector</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">StorableIntrospector</span> +extends java.lang.Object</pre> +<div class="block">Supports examination of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types, returning all metadata + associated with it. As part of the examination, all annotations are gathered + up. All examined data is cached, so repeat examinations are fast, unless the + examination failed.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Fang Chen, Tobias Holgers, Archit Shivaprakash</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html#StorableIntrospector()">StorableIntrospector</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</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> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html#examine(java.lang.Class)">examine</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Examines the given class and returns a StorableInfo describing it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html#inferType(java.lang.Class)">inferType</a></strong>(java.lang.Class clazz)</code> +<div class="block">Examines a class and determines what Storable type it implements.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html#main(java.lang.String[])">main</a></strong>(java.lang.String[] args)</code> +<div class="block">Test program which examines candidate Storable classes.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="StorableIntrospector()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StorableIntrospector</h4> +<pre>public StorableIntrospector()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="main(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>main</h4> +<pre>public static void main(java.lang.String[] args) + throws java.lang.Exception</pre> +<div class="block">Test program which examines candidate Storable classes. If any fail, an + exception is thrown.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - names of classes to examine</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.Exception</code></dd></dl> +</li> +</ul> +<a name="examine(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>examine</h4> +<pre>public static <S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> examine(java.lang.Class<S> type)</pre> +<div class="block">Examines the given class and returns a StorableInfo describing it. A + MalformedTypeException is thrown for a variety of reasons if the given + class is an invalid Storable type.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - Storable type to examine</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../com/amazon/carbonado/MalformedTypeException.html" title="class in com.amazon.carbonado">MalformedTypeException</a></code> - if Storable type is invalid</dd> +<dd><code>java.lang.IllegalArgumentException</code> - if type is null</dd></dl> +</li> +</ul> +<a name="inferType(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>inferType</h4> +<pre>public static java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> inferType(java.lang.Class clazz)</pre> +<div class="block">Examines a class and determines what Storable type it implements. If it + cannot be unambiguously inferred, null is returned. A non-null return + value does not imply that the Storable type is valid, however. It must + be <a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html#examine(java.lang.Class)"><code>examined</code></a> to check validity.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/StorableIntrospector.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableIntrospector.html" target="_top">Frames</a></li> +<li><a href="StorableIntrospector.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</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> diff --git a/apidocs/com/amazon/carbonado/info/StorableKey.html b/apidocs/com/amazon/carbonado/info/StorableKey.html new file mode 100644 index 0000000..5dc66cb --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableKey.html @@ -0,0 +1,245 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>StorableKey (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="StorableKey (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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/StorableKey.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableKey.html" target="_top">Frames</a></li> +<li><a href="StorableKey.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.amazon.carbonado.info</div> +<h2 title="Interface StorableKey" class="title">Interface StorableKey<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">StorableKey<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></pre> +<div class="block">Represents a primary, alternate or partition key of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><code>StorableIntrospector</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</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> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Set<? extends <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="type parameter in StorableKey">S</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableKey.html#getProperties()">getProperties</a></strong>()</code> +<div class="block">Returns all the properties of the key in a properly ordered, + unmodifiable set.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableKey.html#isPrimary()">isPrimary</a></strong>()</code> +<div class="block">Returns true if this key is primary, false otherwise.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.util.Appender"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></h3> +<code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">appendTo</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isPrimary()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPrimary</h4> +<pre>boolean isPrimary()</pre> +<div class="block">Returns true if this key is primary, false otherwise.</div> +</li> +</ul> +<a name="getProperties()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getProperties</h4> +<pre>java.util.Set<? extends <a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="type parameter in StorableKey">S</a>>> getProperties()</pre> +<div class="block">Returns all the properties of the key in a properly ordered, + unmodifiable set.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/StorableKey.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableKey.html" target="_top">Frames</a></li> +<li><a href="StorableKey.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</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> diff --git a/apidocs/com/amazon/carbonado/info/StorableProperty.html b/apidocs/com/amazon/carbonado/info/StorableProperty.html new file mode 100644 index 0000000..66cdb58 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorableProperty.html @@ -0,0 +1,929 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>StorableProperty (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="StorableProperty (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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/StorableProperty.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableProperty.html" target="_top">Frames</a></li> +<li><a href="StorableProperty.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.amazon.carbonado.info</div> +<h2 title="Interface StorableProperty" class="title">Interface StorableProperty<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable</dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><S></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">StorableProperty<S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends java.io.Serializable, <a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></pre> +<div class="block">Contains all the metadata describing a property of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill, Tobias Holgers, Archit Shivaprakash</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><code>StorableIntrospector</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</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> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getAdapter()">getAdapter</a></strong>()</code> +<div class="block">Returns this property's adapter, or null if none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getAlias(int)">getAlias</a></strong>(int index)</code> +<div class="block">Returns a specific alias for this property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getAliasCount()">getAliasCount</a></strong>()</code> +<div class="block">Returns the count of aliases for this property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getAliases()">getAliases</a></strong>()</code> +<div class="block">Returns a new array with all the alias names in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getBeanName()">getBeanName</a></strong>()</code> +<div class="block">Returns the bean name of this property, which is derived from the read + and write method names.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getConstraint(int)">getConstraint</a></strong>(int index)</code> +<div class="block">Returns a specific constraint for this property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getConstraintCount()">getConstraintCount</a></strong>()</code> +<div class="block">Returns the count of constraints for this property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getConstraints()">getConstraints</a></strong>()</code> +<div class="block">Returns a new array with all the constraints in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<?>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getCovariantTypes()">getCovariantTypes</a></strong>()</code> +<div class="block">Returns additional types of this property, all of which are assignable + by the primary type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getDerivedFromProperties()">getDerivedFromProperties</a></strong>()</code> +<div class="block">Returns a new array with all the derived-from properties, which is empty + if this is not a derived property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getDerivedToProperties()">getDerivedToProperties</a></strong>()</code> +<div class="block">Returns a new array with all the properties which are derived from this + one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getEnclosingType()">getEnclosingType</a></strong>()</code> +<div class="block">Returns the enclosing type of this property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElement(int)">getExternalJoinElement</a></strong>(int index)</code> +<div class="block">Returns a specific property in the joined class that participates in the + join.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElements()">getExternalJoinElements</a></strong>()</code> +<div class="block">Returns a new array with all the external join elements in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElement(int)">getInternalJoinElement</a></strong>(int index)</code> +<div class="block">Returns a specific property in this property's class that participates + in the join.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElements()">getInternalJoinElements</a></strong>()</code> +<div class="block">Returns a new array with all the internal join elements in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getJoinedType()">getJoinedType</a></strong>()</code> +<div class="block">Returns the type of property this is joined to, or null if not joined.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getJoinElementCount()">getJoinElementCount</a></strong>()</code> +<div class="block">Returns the count of properties that participate in this property's + join.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getName()">getName</a></strong>()</code> +<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> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getNumber()">getNumber</a></strong>()</code> +<div class="block">Returns the zero-based numerical position of this property within its + enclosing type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getReadMethod()">getReadMethod</a></strong>()</code> +<div class="block">Returns a no-arg method used to read the property value, or null if + reading is not allowed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getReadMethodName()">getReadMethodName</a></strong>()</code> +<div class="block">Returns the name of the read method, even if no read method was actually + declared.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getSequenceName()">getSequenceName</a></strong>()</code> +<div class="block">Returns the property's sequence name, or null if none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class<?></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getType()">getType</a></strong>()</code> +<div class="block">Returns the primary type of this property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getWriteMethod()">getWriteMethod</a></strong>()</code> +<div class="block">Returns a one argument method used to write the property value, or null + if writing is not allowed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getWriteMethodName()">getWriteMethodName</a></strong>()</code> +<div class="block">Returns the name of the write method, even if no write method was + actually declared.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isAlternateKeyMember()">isAlternateKeyMember</a></strong>()</code> +<div class="block">Returns true if this property is a member of an alternate key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isAutomatic()">isAutomatic</a></strong>()</code> +<div class="block">Returns true of this property is given an automatic value upon insert.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isDerived()">isDerived</a></strong>()</code> +<div class="block">Returns true if this property is derived.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isIndependent()">isIndependent</a></strong>()</code> +<div class="block">Returns true if this property has been designated independent.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isJoin()">isJoin</a></strong>()</code> +<div class="block">Returns true if this property is joined in any way to another Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isNullable()">isNullable</a></strong>()</code> +<div class="block">Returns true if this property can be null.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isOneToOneJoin()">isOneToOneJoin</a></strong>()</code> +<div class="block">Returns true if this property is one-to-one joined to another Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isPartitionKeyMember()">isPartitionKeyMember</a></strong>()</code> +<div class="block">Returns true if this property is a member of a partition key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isPrimaryKeyMember()">isPrimaryKeyMember</a></strong>()</code> +<div class="block">Returns true if this property is a member of a primary key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isQuery()">isQuery</a></strong>()</code> +<div class="block">Returns true if this property is a query, which also implies that it is + a join property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#isVersion()">isVersion</a></strong>()</code> +<div class="block">Returns true if this property is the designated version number for the + Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#shouldCopyDerived()">shouldCopyDerived</a></strong>()</code> +<div class="block">Returns true if this derived property should be included when copying a + storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#toString()">toString</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.util.Appender"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a></h3> +<code><a href="../../../../com/amazon/carbonado/util/Appender.html#appendTo(java.lang.Appendable)">appendTo</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>java.lang.String getName()</pre> +<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> +</li> +</ul> +<a name="getBeanName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBeanName</h4> +<pre>java.lang.String getBeanName()</pre> +<div class="block">Returns the bean name of this property, which is derived from the read + and write method names.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</h4> +<pre>java.lang.Class<?> getType()</pre> +<div class="block">Returns the primary type of this property.</div> +</li> +</ul> +<a name="getCovariantTypes()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCovariantTypes</h4> +<pre>java.lang.Class<?>[] getCovariantTypes()</pre> +<div class="block">Returns additional types of this property, all of which are assignable + by the primary type.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2.1</dd></dl> +</li> +</ul> +<a name="getNumber()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumber</h4> +<pre>int getNumber()</pre> +<div class="block">Returns the zero-based numerical position of this property within its + enclosing type.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getEnclosingType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEnclosingType</h4> +<pre>java.lang.Class<<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>> getEnclosingType()</pre> +<div class="block">Returns the enclosing type of this property.</div> +</li> +</ul> +<a name="getReadMethod()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReadMethod</h4> +<pre>java.lang.reflect.Method getReadMethod()</pre> +<div class="block">Returns a no-arg method used to read the property value, or null if + reading is not allowed. The return type matches the type of this + property.</div> +</li> +</ul> +<a name="getReadMethodName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReadMethodName</h4> +<pre>java.lang.String getReadMethodName()</pre> +<div class="block">Returns the name of the read method, even if no read method was actually + declared. That is, this method always returns a method name, but + getReadMethod may still return null.</div> +</li> +</ul> +<a name="getWriteMethod()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWriteMethod</h4> +<pre>java.lang.reflect.Method getWriteMethod()</pre> +<div class="block">Returns a one argument method used to write the property value, or null + if writing is not allowed. The first argument is the value to set, which + is the type of this property.</div> +</li> +</ul> +<a name="getWriteMethodName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWriteMethodName</h4> +<pre>java.lang.String getWriteMethodName()</pre> +<div class="block">Returns the name of the write method, even if no write method was + actually declared. That is, this method always returns a method name, + but getWriteMethod may still return null.</div> +</li> +</ul> +<a name="isNullable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isNullable</h4> +<pre>boolean isNullable()</pre> +<div class="block">Returns true if this property can be null.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Nullable.html" title="annotation in com.amazon.carbonado"><code>Nullable</code></a></dd></dl> +</li> +</ul> +<a name="isPrimaryKeyMember()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPrimaryKeyMember</h4> +<pre>boolean isPrimaryKeyMember()</pre> +<div class="block">Returns true if this property is a member of a primary key.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/PrimaryKey.html" title="annotation in com.amazon.carbonado"><code>PrimaryKey</code></a></dd></dl> +</li> +</ul> +<a name="isAlternateKeyMember()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAlternateKeyMember</h4> +<pre>boolean isAlternateKeyMember()</pre> +<div class="block">Returns true if this property is a member of an alternate key.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/AlternateKeys.html" title="annotation in com.amazon.carbonado"><code>AlternateKeys</code></a></dd></dl> +</li> +</ul> +<a name="isPartitionKeyMember()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPartitionKeyMember</h4> +<pre>boolean isPartitionKeyMember()</pre> +<div class="block">Returns true if this property is a member of a partition key.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/PartitionKey.html" title="annotation in com.amazon.carbonado"><code>PartitionKey</code></a></dd></dl> +</li> +</ul> +<a name="getAliasCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAliasCount</h4> +<pre>int getAliasCount()</pre> +<div class="block">Returns the count of aliases for this property.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado"><code>Alias</code></a></dd></dl> +</li> +</ul> +<a name="getAlias(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAlias</h4> +<pre>java.lang.String getAlias(int index) + throws java.lang.IndexOutOfBoundsException</pre> +<div class="block">Returns a specific alias for this property.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado"><code>Alias</code></a></dd></dl> +</li> +</ul> +<a name="getAliases()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAliases</h4> +<pre>java.lang.String[] getAliases()</pre> +<div class="block">Returns a new array with all the alias names in it.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Alias.html" title="annotation in com.amazon.carbonado"><code>Alias</code></a></dd></dl> +</li> +</ul> +<a name="isJoin()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isJoin</h4> +<pre>boolean isJoin()</pre> +<div class="block">Returns true if this property is joined in any way to another Storable.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Join.html" title="annotation in com.amazon.carbonado"><code>Join</code></a></dd></dl> +</li> +</ul> +<a name="isOneToOneJoin()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isOneToOneJoin</h4> +<pre>boolean isOneToOneJoin()</pre> +<div class="block">Returns true if this property is one-to-one joined to another Storable.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Join.html" title="annotation in com.amazon.carbonado"><code>Join</code></a></dd></dl> +</li> +</ul> +<a name="getJoinedType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getJoinedType</h4> +<pre>java.lang.Class<? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> getJoinedType()</pre> +<div class="block">Returns the type of property this is joined to, or null if not joined.</div> +</li> +</ul> +<a name="getJoinElementCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getJoinElementCount</h4> +<pre>int getJoinElementCount()</pre> +<div class="block">Returns the count of properties that participate in this property's + join. If this property is not a join, then zero is returned.</div> +</li> +</ul> +<a name="getInternalJoinElement(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInternalJoinElement</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>> getInternalJoinElement(int index) + throws java.lang.IndexOutOfBoundsException</pre> +<div class="block">Returns a specific property in this property's class that participates + in the join.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code></dd></dl> +</li> +</ul> +<a name="getInternalJoinElements()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInternalJoinElements</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>>[] getInternalJoinElements()</pre> +<div class="block">Returns a new array with all the internal join elements in it.</div> +</li> +</ul> +<a name="getExternalJoinElement(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExternalJoinElement</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> getExternalJoinElement(int index) + throws java.lang.IndexOutOfBoundsException</pre> +<div class="block">Returns a specific property in the joined class that participates in the + join.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code></dd></dl> +</li> +</ul> +<a name="getExternalJoinElements()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExternalJoinElements</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>[] getExternalJoinElements()</pre> +<div class="block">Returns a new array with all the external join elements in it.</div> +</li> +</ul> +<a name="isQuery()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isQuery</h4> +<pre>boolean isQuery()</pre> +<div class="block">Returns true if this property is a query, which also implies that it is + a join property.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado"><code>Query</code></a></dd></dl> +</li> +</ul> +<a name="getConstraintCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConstraintCount</h4> +<pre>int getConstraintCount()</pre> +<div class="block">Returns the count of constraints for this property.</div> +</li> +</ul> +<a name="getConstraint(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConstraint</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a> getConstraint(int index) + throws java.lang.IndexOutOfBoundsException</pre> +<div class="block">Returns a specific constraint for this property.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code></dd></dl> +</li> +</ul> +<a name="getConstraints()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConstraints</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a>[] getConstraints()</pre> +<div class="block">Returns a new array with all the constraints in it.</div> +</li> +</ul> +<a name="getAdapter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdapter</h4> +<pre><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a> getAdapter()</pre> +<div class="block">Returns this property's adapter, or null if none.</div> +</li> +</ul> +<a name="getSequenceName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSequenceName</h4> +<pre>java.lang.String getSequenceName()</pre> +<div class="block">Returns the property's sequence name, or null if none.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Sequence.html" title="annotation in com.amazon.carbonado"><code>Sequence</code></a></dd></dl> +</li> +</ul> +<a name="isAutomatic()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAutomatic</h4> +<pre>boolean isAutomatic()</pre> +<div class="block">Returns true of this property is given an automatic value upon insert.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Automatic.html" title="annotation in com.amazon.carbonado"><code>Automatic</code></a></dd></dl> +</li> +</ul> +<a name="isVersion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isVersion</h4> +<pre>boolean isVersion()</pre> +<div class="block">Returns true if this property is the designated version number for the + Storable.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Version.html" title="annotation in com.amazon.carbonado"><code>Version</code></a></dd></dl> +</li> +</ul> +<a name="isIndependent()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isIndependent</h4> +<pre>boolean isIndependent()</pre> +<div class="block">Returns true if this property has been designated independent.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Independent.html" title="annotation in com.amazon.carbonado"><code>Independent</code></a></dd></dl> +</li> +</ul> +<a name="isDerived()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isDerived</h4> +<pre>boolean isDerived()</pre> +<div class="block">Returns true if this property is derived.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/Derived.html" title="annotation in com.amazon.carbonado"><code>Derived</code></a></dd></dl> +</li> +</ul> +<a name="getDerivedFromProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDerivedFromProperties</h4> +<pre><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>>[] getDerivedFromProperties()</pre> +<div class="block">Returns a new array with all the derived-from properties, which is empty + if this is not a derived property. Otherwise, the set is the transitive + closure of all dependent properties. This set may include joins and + other derived properties.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getDerivedToProperties()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDerivedToProperties</h4> +<pre><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?>[] getDerivedToProperties()</pre> +<div class="block">Returns a new array with all the properties which are derived from this + one. The set is the transitive closure of all derived properties which + depend on this one. + + <p>Each property in the set is represented as a chain, where the prime + property is the actual dependent property, and the tail is the path to + reach this property's enclosing type. If a derived property resides in + the same enclosing type as this one, the chain count is zero.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="shouldCopyDerived()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shouldCopyDerived</h4> +<pre>boolean shouldCopyDerived()</pre> +<div class="block">Returns true if this derived property should be included when copying a + storable. Copying of a derived property uses the "get" and "set" methods + and requires the "set" method to be defined.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/StorableProperty.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorableProperty.html" target="_top">Frames</a></li> +<li><a href="StorableProperty.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</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> diff --git a/apidocs/com/amazon/carbonado/info/StorablePropertyAdapter.html b/apidocs/com/amazon/carbonado/info/StorablePropertyAdapter.html new file mode 100644 index 0000000..fb3e3c2 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorablePropertyAdapter.html @@ -0,0 +1,432 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>StorablePropertyAdapter (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="StorablePropertyAdapter (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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/StorablePropertyAdapter.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorablePropertyAdapter.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyAdapter.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.amazon.carbonado.info</div> +<h2 title="Class StorablePropertyAdapter" class="title">Class StorablePropertyAdapter</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.info.StorablePropertyAdapter</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">StorablePropertyAdapter</span> +extends java.lang.Object</pre> +<div class="block">Information about an <a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><code>adapter</code></a> annotation applied to a property.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#StorablePropertyAdapter(java.lang.String, java.lang.Class, java.lang.Class)">StorablePropertyAdapter</a></strong>(java.lang.String propertyName, + java.lang.Class<?> propertyType, + java.lang.Class<? extends java.lang.annotation.Annotation> adapterType)</code> +<div class="block">Construct a generic StorablePropertyAdapter instance not attached to a + storable definition.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</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> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#findAdaptMethod(java.lang.Class, java.lang.Class)">findAdaptMethod</a></strong>(java.lang.Class from, + java.lang.Class to)</code> +<div class="block">Returns an adapt method that supports the given conversion, or null if + none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.reflect.Method[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#findAdaptMethodsFrom(java.lang.Class)">findAdaptMethodsFrom</a></strong>(java.lang.Class from)</code> +<div class="block">Returns all the adapt methods that convert from the given type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.reflect.Method[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#findAdaptMethodsTo(java.lang.Class)">findAdaptMethodsTo</a></strong>(java.lang.Class to)</code> +<div class="block">Returns all the adapt methods that convert to the given type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.reflect.Constructor</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdapterConstructor()">getAdapterConstructor</a></strong>()</code> +<div class="block">Returns the constructor for the adapter class.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdapterInstance()">getAdapterInstance</a></strong>()</code> +<div class="block">Returns an instance of the adapter, for which an adapt method is applied to.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdaptMethod(int)">getAdaptMethod</a></strong>(int index)</code> +<div class="block">Returns a specific adapt method.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdaptMethodCount()">getAdaptMethodCount</a></strong>()</code> +<div class="block">Returns the count of all defined adapt methods.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.reflect.Method[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAdaptMethods()">getAdaptMethods</a></strong>()</code> +<div class="block">Returns a new array with all the adapt methods in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAnnotation()">getAnnotation</a></strong>()</code> +<div class="block">Returns the annotation that applied this adapter, or null if none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Class[]</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getStorageTypePreferences()">getStorageTypePreferences</a></strong>()</code> +<div class="block">Returns the adapter's storage type preferences.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="StorablePropertyAdapter(java.lang.String, java.lang.Class, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StorablePropertyAdapter</h4> +<pre>public StorablePropertyAdapter(java.lang.String propertyName, + java.lang.Class<?> propertyType, + java.lang.Class<? extends java.lang.annotation.Annotation> adapterType)</pre> +<div class="block">Construct a generic StorablePropertyAdapter instance not attached to a + storable definition. Call <a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getAdapter()"><code>StorableProperty.getAdapter()</code></a> to gain + access to adapter information on actual storable definitions.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - name of property with adapter</dd><dd><code>propertyType</code> - declated type of adapted property</dd><dd><code>adapterType</code> - adapter type</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if adapterType is not an adapter + definition.</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getAnnotation()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAnnotation</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a> getAnnotation()</pre> +<div class="block">Returns the annotation that applied this adapter, or null if none.</div> +</li> +</ul> +<a name="getAdapterConstructor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdapterConstructor</h4> +<pre>public java.lang.reflect.Constructor getAdapterConstructor()</pre> +<div class="block">Returns the constructor for the adapter class. It has the signature + <code>(Class type, String propertyName, <i>Annotation</i>)</code>, where + <i>Annotation</i> is the fully resolved annotation.</div> +</li> +</ul> +<a name="getAdapterInstance()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdapterInstance</h4> +<pre>public java.lang.Object getAdapterInstance()</pre> +<div class="block">Returns an instance of the adapter, for which an adapt method is applied to.</div> +</li> +</ul> +<a name="getStorageTypePreferences()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStorageTypePreferences</h4> +<pre>public java.lang.Class[] getStorageTypePreferences()</pre> +<div class="block">Returns the adapter's storage type preferences.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html#storageTypePreferences()"><code>AdapterDefinition.storageTypePreferences()</code></a></dd></dl> +</li> +</ul> +<a name="findAdaptMethod(java.lang.Class, java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findAdaptMethod</h4> +<pre>public java.lang.reflect.Method findAdaptMethod(java.lang.Class from, + java.lang.Class to)</pre> +<div class="block">Returns an adapt method that supports the given conversion, or null if + none.</div> +</li> +</ul> +<a name="findAdaptMethodsFrom(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findAdaptMethodsFrom</h4> +<pre>public java.lang.reflect.Method[] findAdaptMethodsFrom(java.lang.Class from)</pre> +<div class="block">Returns all the adapt methods that convert from the given type.</div> +</li> +</ul> +<a name="findAdaptMethodsTo(java.lang.Class)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>findAdaptMethodsTo</h4> +<pre>public java.lang.reflect.Method[] findAdaptMethodsTo(java.lang.Class to)</pre> +<div class="block">Returns all the adapt methods that convert to the given type.</div> +</li> +</ul> +<a name="getAdaptMethodCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdaptMethodCount</h4> +<pre>public int getAdaptMethodCount()</pre> +<div class="block">Returns the count of all defined adapt methods.</div> +</li> +</ul> +<a name="getAdaptMethod(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdaptMethod</h4> +<pre>public java.lang.reflect.Method getAdaptMethod(int index) + throws java.lang.IndexOutOfBoundsException</pre> +<div class="block">Returns a specific adapt method.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IndexOutOfBoundsException</code></dd></dl> +</li> +</ul> +<a name="getAdaptMethods()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAdaptMethods</h4> +<pre>public java.lang.reflect.Method[] getAdaptMethods()</pre> +<div class="block">Returns a new array with all the adapt methods in it.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/StorablePropertyAdapter.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorablePropertyAdapter.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyAdapter.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</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> diff --git a/apidocs/com/amazon/carbonado/info/StorablePropertyAnnotation.html b/apidocs/com/amazon/carbonado/info/StorablePropertyAnnotation.html new file mode 100644 index 0000000..331aad5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorablePropertyAnnotation.html @@ -0,0 +1,324 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>StorablePropertyAnnotation (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="StorablePropertyAnnotation (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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/StorablePropertyAnnotation.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorablePropertyAnnotation.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyAnnotation.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.amazon.carbonado.info</div> +<h2 title="Class StorablePropertyAnnotation" class="title">Class StorablePropertyAnnotation</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.info.StorablePropertyAnnotation</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">StorablePropertyAnnotation</span> +extends java.lang.Object</pre> +<div class="block">Information about a custom annotation applied to a property.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html#StorablePropertyAnnotation(java.lang.annotation.Annotation, java.lang.reflect.Method)">StorablePropertyAnnotation</a></strong>(java.lang.annotation.Annotation annotation, + java.lang.reflect.Method method)</code> +<div class="block">Use this constructor if an annotation was actually defined.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html#StorablePropertyAnnotation(java.lang.Class, java.lang.reflect.Method)">StorablePropertyAnnotation</a></strong>(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType, + java.lang.reflect.Method method)</code> +<div class="block">Use this constructor if an annotation was not defined, but instead is + being automatically applied.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</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> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html#getAnnotatedMethod()">getAnnotatedMethod</a></strong>()</code> +<div class="block">Returns the method that has the annotation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.annotation.Annotation</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html#getAnnotation()">getAnnotation</a></strong>()</code> +<div class="block">Returns the actual annotation instance, which may be null if annotation + was automatically applied.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Class<? extends java.lang.annotation.Annotation></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html#getAnnotationType()">getAnnotationType</a></strong>()</code> +<div class="block">Returns the type of annotation that was applied to the property method.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="StorablePropertyAnnotation(java.lang.annotation.Annotation, java.lang.reflect.Method)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>StorablePropertyAnnotation</h4> +<pre>public StorablePropertyAnnotation(java.lang.annotation.Annotation annotation, + java.lang.reflect.Method method)</pre> +<div class="block">Use this constructor if an annotation was actually defined.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>annotation</code> - annotation on method</dd><dd><code>method</code> - method with annotation</dd></dl> +</li> +</ul> +<a name="StorablePropertyAnnotation(java.lang.Class, java.lang.reflect.Method)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StorablePropertyAnnotation</h4> +<pre>public StorablePropertyAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType, + java.lang.reflect.Method method)</pre> +<div class="block">Use this constructor if an annotation was not defined, but instead is + being automatically applied.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>annotationType</code> - annotation type on method</dd><dd><code>method</code> - method with annotation</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getAnnotation()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAnnotation</h4> +<pre>public java.lang.annotation.Annotation getAnnotation()</pre> +<div class="block">Returns the actual annotation instance, which may be null if annotation + was automatically applied.</div> +</li> +</ul> +<a name="getAnnotationType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAnnotationType</h4> +<pre>public java.lang.Class<? extends java.lang.annotation.Annotation> getAnnotationType()</pre> +<div class="block">Returns the type of annotation that was applied to the property method.</div> +</li> +</ul> +<a name="getAnnotatedMethod()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAnnotatedMethod</h4> +<pre>public java.lang.reflect.Method getAnnotatedMethod()</pre> +<div class="block">Returns the method that has the annotation.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/StorablePropertyAnnotation.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorablePropertyAnnotation.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyAnnotation.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</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> diff --git a/apidocs/com/amazon/carbonado/info/StorablePropertyConstraint.html b/apidocs/com/amazon/carbonado/info/StorablePropertyConstraint.html new file mode 100644 index 0000000..5d682cb --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/StorablePropertyConstraint.html @@ -0,0 +1,264 @@ +<!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:43 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>StorablePropertyConstraint (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="StorablePropertyConstraint (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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/StorablePropertyConstraint.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorablePropertyConstraint.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyConstraint.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">com.amazon.carbonado.info</div> +<h2 title="Class StorablePropertyConstraint" class="title">Class StorablePropertyConstraint</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.amazon.carbonado.info.StorablePropertyConstraint</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">StorablePropertyConstraint</span> +extends java.lang.Object</pre> +<div class="block">Information about a <a href="../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint"><code>constraint</code></a> annotation applied to a property.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Brian S O'Neill</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</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> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html#getAnnotation()">getAnnotation</a></strong>()</code> +<div class="block">Returns the annotation that applied this constraint.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.reflect.Method</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html#getConstrainMethod()">getConstrainMethod</a></strong>()</code> +<div class="block">Returns the best matching property checking method in the validator.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.reflect.Constructor</code></td> +<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html#getConstraintConstructor()">getConstraintConstructor</a></strong>()</code> +<div class="block">Returns the constructor for the constraint class.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getAnnotation()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAnnotation</h4> +<pre>public <a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a> getAnnotation()</pre> +<div class="block">Returns the annotation that applied this constraint.</div> +</li> +</ul> +<a name="getConstraintConstructor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConstraintConstructor</h4> +<pre>public java.lang.reflect.Constructor getConstraintConstructor()</pre> +<div class="block">Returns the constructor for the constraint class. It has the signature + <code>(Class type, String propertyName, <i>Annotation</i>)</code>, where + <i>Annotation</i> is the fully resolved annotation.</div> +</li> +</ul> +<a name="getConstrainMethod()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getConstrainMethod</h4> +<pre>public java.lang.reflect.Method getConstrainMethod()</pre> +<div class="block">Returns the best matching property checking method in the validator.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= 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 class="navBarCell1Rev">Class</li> +<li><a href="class-use/StorablePropertyConstraint.html">Use</a></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><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/StorablePropertyConstraint.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyConstraint.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/ChainedProperty.html b/apidocs/com/amazon/carbonado/info/class-use/ChainedProperty.html new file mode 100644 index 0000000..5b8c49d --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/ChainedProperty.html @@ -0,0 +1,385 @@ +<!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 Class com.amazon.carbonado.info.ChainedProperty (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 Class com.amazon.carbonado.info.ChainedProperty (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/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">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/info/class-use/ChainedProperty.html" target="_top">Frames</a></li> +<li><a href="ChainedProperty.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 Class com.amazon.carbonado.info.ChainedProperty" class="title">Uses of Class<br>com.amazon.carbonado.info.ChainedProperty</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/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</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.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</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.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a> in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</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/filter/package-summary.html">com.amazon.carbonado.filter</a> that return <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</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/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="type parameter in PropertyFilter">S</a>></code></td> +<td class="colLast"><span class="strong">PropertyFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html#getChainedProperty()">getChainedProperty</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="type parameter in ExistsFilter">S</a>></code></td> +<td class="colLast"><span class="strong">ExistsFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html#getChainedProperty()">getChainedProperty</a></strong>()</code> +<div class="block">Returns the join property that is being checked for existence or + non-existence.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</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><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">asJoinedFrom</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> +<div class="block">Prepends a join property to all properties of this filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html" title="class in com.amazon.carbonado.filter">PropertyFilter</a><T></code></td> +<td class="colLast"><span class="strong">PropertyFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/PropertyFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><span class="strong">OrFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OrFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html" title="class in com.amazon.carbonado.filter">ClosedFilter</a><T></code></td> +<td class="colLast"><span class="strong">ClosedFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ClosedFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><span class="strong">AndFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/AndFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> +<div class="block">Allows join from any property type, including one-to-many joins.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html" title="class in com.amazon.carbonado.filter">ExistsFilter</a><T></code></td> +<td class="colLast"><span class="strong">ExistsFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/ExistsFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html" title="class in com.amazon.carbonado.filter">OpenFilter</a><T></code></td> +<td class="colLast"><span class="strong">OpenFilter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/OpenFilter.html#asJoinedFromAny(com.amazon.carbonado.info.ChainedProperty)">asJoinedFromAny</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> joinProperty)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/filter/Filter.NotJoined.html" title="class in com.amazon.carbonado.filter">Filter.NotJoined</a></code></td> +<td class="colLast"><span class="strong">Filter.</span><code><strong><a href="../../../../../com/amazon/carbonado/filter/Filter.html#notJoinedFrom(com.amazon.carbonado.info.ChainedProperty)">notJoinedFrom</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="type parameter in Filter">S</a>> joinProperty)</code> +<div class="block">Removes a join property prefix from all applicable properties of this + filter.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</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 methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</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/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.ChainedProperty)">append</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?> property)</code> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.StorableProperty)">append</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> property)</code> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.StorableProperty, boolean)">append</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> property, + boolean outerJoin)</code> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime)</code> +<div class="block">Returns a canonical instance which has no chain.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty...)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>... chain)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty[], boolean[])">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>[] chain, + boolean[] outerJoin)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#getChainedProperty()">getChainedProperty</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>>[]</code></td> +<td class="colLast"><span class="strong">StorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getDerivedFromProperties()">getDerivedFromProperties</a></strong>()</code> +<div class="block">Returns a new array with all the derived-from properties, which is empty + if this is not a derived property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?>[]</code></td> +<td class="colLast"><span class="strong">StorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getDerivedToProperties()">getDerivedToProperties</a></strong>()</code> +<div class="block">Returns a new array with all the properties which are derived from this + one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)">parse</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str)</code> +<div class="block">Parses a chained property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#tail()">tail</a></strong>()</code> +<div class="block">Returns a new ChainedProperty which contains everything that follows + this ChainedProperty's prime property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#trim()">trim</a></strong>()</code> +<div class="block">Returns a new ChainedProperty with the last property in the chain removed.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</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/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.ChainedProperty)">append</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><?> property)</code> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.info.Direction)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S> property, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</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/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</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/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getForeignProperty()">getForeignProperty</a></strong>()</code> +<div class="block">Returns the simple or chained property that maps to the selected + foreign index.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</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>static <T extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/QueryExecutor.html" title="interface in com.amazon.carbonado.qe">QueryExecutor</a><T></code></td> +<td class="colLast"><span class="strong">JoinedQueryExecutor.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/JoinedQueryExecutor.html#build(com.amazon.carbonado.qe.RepositoryAccess, com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList, com.amazon.carbonado.qe.QueryHints)">build</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/RepositoryAccess.html" title="interface in com.amazon.carbonado.qe">RepositoryAccess</a> repoAccess, + <a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><T> targetToSourceProperty, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><T> targetFilter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><T> targetOrdering, + <a href="../../../../../com/amazon/carbonado/qe/QueryHints.html" title="class in com.amazon.carbonado.qe">QueryHints</a> hints)</code> +<div class="block">Builds and returns a complex joined excutor against a chained property, + supporting multi-way joins.</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/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">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/info/class-use/ChainedProperty.html" target="_top">Frames</a></li> +<li><a href="ChainedProperty.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/Direction.html b/apidocs/com/amazon/carbonado/info/class-use/Direction.html new file mode 100644 index 0000000..8e942f8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/Direction.html @@ -0,0 +1,432 @@ +<!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 Class com.amazon.carbonado.info.Direction (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 Class com.amazon.carbonado.info.Direction (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/info/Direction.html" title="enum in com.amazon.carbonado.info">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/info/class-use/Direction.html" target="_top">Frames</a></li> +<li><a href="Direction.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 Class com.amazon.carbonado.info.Direction" class="title">Uses of Class<br>com.amazon.carbonado.info.Direction</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/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</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.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="rowColor"> +<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> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic</a></td> +<td class="colLast"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</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/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</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/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</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/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[]</code></td> +<td class="colLast"><span class="strong">IndexInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/capability/IndexInfo.html#getPropertyDirections()">getPropertyDirections</a></strong>()</code> +<div class="block">Returns the directions of all the properties in this index.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</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 methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</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>static <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><span class="strong">Direction.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/Direction.html#fromCharacter(char)">fromCharacter</a></strong>(char c)</code> +<div class="block">Returns ASCENDING for '+', DESCENDING for '-', UNSPECIFIED for anything + else.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#getDirection()">getDirection</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#getPropertyDirection(int)">getPropertyDirection</a></strong>(int index)</code> +<div class="block">Returns the requested direction of a specific property in this index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[]</code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#getPropertyDirections()">getPropertyDirections</a></strong>()</code> +<div class="block">Returns a new array with all the property directions in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><span class="strong">Direction.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/Direction.html#reverse()">reverse</a></strong>()</code> +<div class="block">Returns the reverse direction of this.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></code></td> +<td class="colLast"><span class="strong">Direction.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/Direction.html#valueOf(java.lang.String)">valueOf</a></strong>(java.lang.String name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[]</code></td> +<td class="colLast"><span class="strong">Direction.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/Direction.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</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/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#addProperty(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">addProperty</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> property, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a StorableIndex with the given property added.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#direction(com.amazon.carbonado.info.Direction)">direction</a></strong>(<a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.info.Direction)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S> property, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> property, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String, com.amazon.carbonado.info.Direction)">parse</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#setDefaultDirection(com.amazon.carbonado.info.Direction)">setDefaultDirection</a></strong>(<a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a StorableIndex instance with all unspecified directions set to + the given direction.</div> +</td> +</tr> +</tbody> +</table> +<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/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</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(com.amazon.carbonado.info.OrderedProperty[], com.amazon.carbonado.info.Direction)">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Creates a StorableIndex from OrderedProperties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableKey, com.amazon.carbonado.info.Direction)">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> key, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Creates a StorableIndex from a StorableKey.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[])">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions)</code> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[], boolean)">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions, + boolean unique)</code> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[], boolean, boolean)">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions, + boolean unique, + boolean clustered)</code> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</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/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</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>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addIndexes(com.amazon.carbonado.info.StorableInfo, com.amazon.carbonado.info.Direction)">addIndexes</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Adds all the indexes of the given storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#reduce(com.amazon.carbonado.info.Direction)">reduce</a></strong>(<a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Reduces the size of the set by removing redundant indexes, and merges + others together.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#setDefaultDirection(com.amazon.carbonado.info.Direction)">setDefaultDirection</a></strong>(<a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Set the default direction for all index properties.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</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 methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> that return <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</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/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[]</code></td> +<td class="colLast"><span class="strong">IndexInfoImpl.</span><code><strong><a href="../../../../../com/amazon/carbonado/spi/IndexInfoImpl.html#getPropertyDirections()">getPropertyDirections</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</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/spi/IndexInfoImpl.html#IndexInfoImpl(java.lang.String, boolean, boolean, java.lang.String[], com.amazon.carbonado.info.Direction[])">IndexInfoImpl</a></strong>(java.lang.String name, + boolean unique, + boolean clustered, + java.lang.String[] propertyNames, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] propertyDirections)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.synthetic"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</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/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</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/synthetic/SyntheticProperty.html" title="class in com.amazon.carbonado.synthetic">SyntheticProperty</a></code></td> +<td class="colLast"><span class="strong">SyntheticStorableReferenceBuilder.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticStorableReferenceBuilder.html#addKeyProperty(java.lang.String, com.amazon.carbonado.info.Direction)">addKeyProperty</a></strong>(java.lang.String name, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Add a property to the primary key which is a member of the Storable type + being referenced by this one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">SyntheticPropertyList.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticPropertyList.html#addProperty(java.lang.String, com.amazon.carbonado.info.Direction)">addProperty</a></strong>(java.lang.String propertyName, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Adds a property to this index, with the specified direction.</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/info/Direction.html" title="enum in com.amazon.carbonado.info">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/info/class-use/Direction.html" target="_top">Frames</a></li> +<li><a href="Direction.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/OrderedProperty.html b/apidocs/com/amazon/carbonado/info/class-use/OrderedProperty.html new file mode 100644 index 0000000..7567255 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/OrderedProperty.html @@ -0,0 +1,447 @@ +<!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 Class com.amazon.carbonado.info.OrderedProperty (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 Class com.amazon.carbonado.info.OrderedProperty (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/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">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/info/class-use/OrderedProperty.html" target="_top">Frames</a></li> +<li><a href="OrderedProperty.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 Class com.amazon.carbonado.info.OrderedProperty" class="title">Uses of Class<br>com.amazon.carbonado.info.OrderedProperty</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/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</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.cursor">com.amazon.carbonado.cursor</a></td> +<td class="colLast"> +<div class="block">Support for advanced processing of cursor results, including basic set + theory operations.</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.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.cursor"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a> in <a href="../../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</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/cursor/package-summary.html">com.amazon.carbonado.cursor</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</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>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.util.Comparator<S></code></td> +<td class="colLast"><span class="strong">SortedCursor.</span><code><strong><a href="../../../../../com/amazon/carbonado/cursor/SortedCursor.html#createComparator(com.amazon.carbonado.info.OrderedProperty...)">createComparator</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>... properties)</code> +<div class="block">Convenience method to create a comparator which orders storables by the + given properties.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Method parameters in <a href="../../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a> with type arguments of type <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</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>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br>java.util.Comparator<S></code></td> +<td class="colLast"><span class="strong">SortedCursor.</span><code><strong><a href="../../../../../com/amazon/carbonado/cursor/SortedCursor.html#createComparator(java.util.List)">createComparator</a></strong>(java.util.List<<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>> properties)</code> +<div class="block">Convenience method to create a comparator which orders storables by the + given properties.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</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 methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</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/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#direction(com.amazon.carbonado.info.Direction)">direction</a></strong>(<a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.ChainedProperty, com.amazon.carbonado.info.Direction)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S> property, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> property, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[]</code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#getOrderedProperties()">getOrderedProperties</a></strong>()</code> +<div class="block">Returns a new array with all the properties in it, with directions + folded in.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#getOrderedProperty(int)">getOrderedProperty</a></strong>(int index)</code> +<div class="block">Returns a specific property in this index, with the direction folded in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)">parse</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str)</code> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String, com.amazon.carbonado.info.Direction)">parse</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="type parameter in OrderedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#reverse()">reverse</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</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>java.util.Set<? extends <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="type parameter in StorableKey">S</a>>></code></td> +<td class="colLast"><span class="strong">StorableKey.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableKey.html#getProperties()">getProperties</a></strong>()</code> +<div class="block">Returns all the properties of the key in a properly ordered, + unmodifiable set.</div> +</td> +</tr> +</tbody> +</table> +<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/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</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(com.amazon.carbonado.info.OrderedProperty[], com.amazon.carbonado.info.Direction)">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Creates a StorableIndex from OrderedProperties.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</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/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</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/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#get(int)">get</a></strong>(int index)</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</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/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#concat(com.amazon.carbonado.info.OrderedProperty)">concat</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> property)</code> +<div class="block">Returns a list which concatenates this one with the given property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</code> +<div class="block">Evaluates the given index properties for its filtering capabilities + against the given filter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its filtering and ordering + capabilities against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.OrderedProperty[], boolean, boolean, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>[] indexProperties, + boolean unique, + boolean clustered, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index properties for its ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#get(com.amazon.carbonado.info.OrderedProperty...)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>... orderings)</code> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#replace(int, com.amazon.carbonado.info.OrderedProperty)">replace</a></strong>(int index, + <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="type parameter in OrderingList">S</a>> property)</code> +<div class="block">Returns a list with the given element replaced.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Method parameters in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with type arguments of type <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</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>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S></code></td> +<td class="colLast"><span class="strong">OrderingList.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingList.html#get(java.util.List)">get</a></strong>(java.util.List<<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S>> orderings)</code> +<div class="block">Returns a canonical instance composed of the given orderings.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</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/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</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>protected <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[]</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#gatherAllKeyProperties()">gatherAllKeyProperties</a></strong>()</code> +<div class="block">Returns all key properties as ordered properties, possibly with + unspecified directions.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</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>void</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildKeyDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.OrderedProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, org.cojen.classfile.LocalVariable)">buildKeyDecoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useWriteMethods, + org.cojen.classfile.LocalVariable encodedVar)</code> +<div class="block">Generates bytecode instructions to decode properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.cojen.classfile.LocalVariable</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildKeyEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.OrderedProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, org.cojen.classfile.LocalVariable, org.cojen.classfile.LocalVariable)">buildKeyEncoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useReadMethods, + org.cojen.classfile.LocalVariable partialStartVar, + org.cojen.classfile.LocalVariable partialEndVar)</code> +<div class="block">Generates bytecode instructions to encode properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.SearchKeyFactory.html" title="interface in com.amazon.carbonado.raw">GenericStorableCodec.SearchKeyFactory</a><<a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>></code></td> +<td class="colLast"><span class="strong">GenericStorableCodec.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#getSearchKeyFactory(com.amazon.carbonado.info.OrderedProperty[])">getSearchKeyFactory</a></strong>(<a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>>[] properties)</code> +<div class="block">Returns a search key factory, which is useful for implementing indexes + and queries.</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/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">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/info/class-use/OrderedProperty.html" target="_top">Frames</a></li> +<li><a href="OrderedProperty.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorableIndex.html b/apidocs/com/amazon/carbonado/info/class-use/StorableIndex.html new file mode 100644 index 0000000..16c5fe8 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorableIndex.html @@ -0,0 +1,544 @@ +<!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 Class com.amazon.carbonado.info.StorableIndex (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 Class com.amazon.carbonado.info.StorableIndex (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/info/StorableIndex.html" title="class in com.amazon.carbonado.info">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/info/class-use/StorableIndex.html" target="_top">Frames</a></li> +<li><a href="StorableIndex.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 Class com.amazon.carbonado.info.StorableIndex" class="title">Uses of Class<br>com.amazon.carbonado.info.StorableIndex</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/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</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.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</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 methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</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/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#addProperty(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">addProperty</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> property, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a StorableIndex with the given property added.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#clustered(boolean)">clustered</a></strong>(boolean clustered)</code> +<div class="block">Returns a StorableIndex instance which is clustered or not.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getIndex(int)">getIndex</a></strong>(int index)</code> +<div class="block">Returns a specific index for the Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>[]</code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getIndexes()">getIndexes</a></strong>()</code> +<div class="block">Returns a new array with all the indexes in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#parseNameDescriptor(java.lang.String, com.amazon.carbonado.info.StorableInfo)">parseNameDescriptor</a></strong>(java.lang.String desc, + <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info)</code> +<div class="block">Parses an index descriptor and returns an index object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#reverse()">reverse</a></strong>()</code> +<div class="block">Returns a StorableIndex instance with all the properties reversed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#setDefaultDirection(com.amazon.carbonado.info.Direction)">setDefaultDirection</a></strong>(<a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a StorableIndex instance with all unspecified directions set to + the given direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#unique(boolean)">unique</a></strong>(boolean unique)</code> +<div class="block">Returns a StorableIndex instance which is unique or not.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#uniquify(com.amazon.carbonado.info.StorableKey)">uniquify</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> key)</code> +<div class="block">Returns a StorableIndex which is unique, possibly by appending + properties from the given key.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</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/qe/package-summary.html">com.amazon.carbonado.qe</a> that return <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</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/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#findKeyIndex(com.amazon.carbonado.info.StorableKey)">findKeyIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</code> +<div class="block">Finds the best index to represent the given key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#findPrimaryKeyIndex(com.amazon.carbonado.info.StorableInfo)">findPrimaryKeyIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Finds the best index to represent the primary key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><?></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getForeignIndex()">getForeignIndex</a></strong>()</code> +<div class="block">Returns the foreign index that was selected, or null if a local + index was selected.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.html" title="type parameter in IndexedQueryAnalyzer">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryAnalyzer.Result.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryAnalyzer.Result.html#getLocalIndex()">getLocalIndex</a></strong>()</code> +<div class="block">Returns the local index that was selected, or null if a foreign + index was selected.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</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>java.util.Collection<<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>>></code></td> +<td class="colLast"><span class="strong">StorageAccess.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html#getAllIndexes()">getAllIndexes</a></strong>()</code> +<div class="block">Returns all the available indexes.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</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>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><S></code></td> +<td class="colLast"><span class="strong">FilteringScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter)</code> +<div class="block">Evaluates the given index for its filtering capabilities against the + given filter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><S></code></td> +<td class="colLast"><span class="strong">CompositeScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its filtering and ordering capabilities + against the given filter and order-by properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html" title="class in com.amazon.carbonado.qe">OrderingScore</a><S></code></td> +<td class="colLast"><span class="strong">OrderingScore.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/OrderingScore.html#evaluate(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.filter.Filter, com.amazon.carbonado.qe.OrderingList)">evaluate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> index, + <a href="../../../../../com/amazon/carbonado/filter/Filter.html" title="class in com.amazon.carbonado.filter">Filter</a><S> filter, + <a href="../../../../../com/amazon/carbonado/qe/OrderingList.html" title="class in com.amazon.carbonado.qe">OrderingList</a><S> ordering)</code> +<div class="block">Evaluates the given index for its ordering capabilities against the + given filter and order-by properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query)">fetchFromIndexEntryQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + <a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery)</code> +<div class="block">Fetch Storables referenced by the given index entry query.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchFromIndexEntryQuery(com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.Query, com.amazon.carbonado.Query.Controller)">fetchFromIndexEntryQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + <a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?> indexEntryQuery, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Fetch Storables referenced by the given index entry query.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html#fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[])">fetchOne</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues)</code> +<div class="block">Select at most one Storable referenced by an index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">KeyQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html#fetchOne(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.Query.Controller)">fetchOne</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="type parameter in KeyQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Select at most one Storable referenced by an index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean)">fetchSubset</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder)</code> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Cursor.html" title="interface in com.amazon.carbonado">Cursor</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#fetchSubset(com.amazon.carbonado.info.StorableIndex, java.lang.Object[], com.amazon.carbonado.qe.BoundaryType, java.lang.Object, com.amazon.carbonado.qe.BoundaryType, java.lang.Object, boolean, boolean, com.amazon.carbonado.Query.Controller)">fetchSubset</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index, + java.lang.Object[] identityValues, + <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeStartBoundary, + java.lang.Object rangeStartValue, + <a href="../../../../../com/amazon/carbonado/qe/BoundaryType.html" title="enum in com.amazon.carbonado.qe">BoundaryType</a> rangeEndBoundary, + java.lang.Object rangeEndValue, + boolean reverseRange, + boolean reverseOrder, + <a href="../../../../../com/amazon/carbonado/Query.Controller.html" title="interface in com.amazon.carbonado">Query.Controller</a> controller)</code> +<div class="block">Perform an index scan of a subset of Storables referenced by an + index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Query.html" title="interface in com.amazon.carbonado">Query</a><?></code></td> +<td class="colLast"><span class="strong">IndexedQueryExecutor.Support.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html#indexEntryQuery(com.amazon.carbonado.info.StorableIndex)">indexEntryQuery</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="type parameter in IndexedQueryExecutor.Support">S</a>> index)</code> +<div class="block">Returns an open query if the given index supports query access.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/Storage.html" title="interface in com.amazon.carbonado">Storage</a><<a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>></code></td> +<td class="colLast"><span class="strong">StorageAccess.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html#storageDelegate(com.amazon.carbonado.info.StorableIndex)">storageDelegate</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/StorageAccess.html" title="type parameter in StorageAccess">S</a>> index)</code> +<div class="block">If the given index is not directly supported by storage, queries should + be delegated.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</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/qe/IndexedQueryExecutor.html#IndexedQueryExecutor(com.amazon.carbonado.qe.IndexedQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.CompositeScore)">IndexedQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">IndexedQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> index, + <a href="../../../../../com/amazon/carbonado/qe/CompositeScore.html" title="class in com.amazon.carbonado.qe">CompositeScore</a><<a href="../../../../../com/amazon/carbonado/qe/IndexedQueryExecutor.html" title="type parameter in IndexedQueryExecutor">S</a>> score)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html#KeyQueryExecutor(com.amazon.carbonado.qe.KeyQueryExecutor.Support, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.qe.FilteringScore)">KeyQueryExecutor</a></strong>(<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.Support.html" title="interface in com.amazon.carbonado.qe">KeyQueryExecutor.Support</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> support, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> index, + <a href="../../../../../com/amazon/carbonado/qe/FilteringScore.html" title="class in com.amazon.carbonado.qe">FilteringScore</a><<a href="../../../../../com/amazon/carbonado/qe/KeyQueryExecutor.html" title="type parameter in KeyQueryExecutor">S</a>> score)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</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/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</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/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>></code></td> +<td class="colLast"><span class="strong">CustomStorableCodec.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html#buildPkIndex(java.lang.String...)">buildPkIndex</a></strong>(java.lang.String... propertyNames)</code> +<div class="block">Convenient way to define the clustered primary key index + descriptor.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html" title="type parameter in StorableCodec">S</a>></code></td> +<td class="colLast"><span class="strong">StorableCodec.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/StorableCodec.html#getPrimaryKeyIndex()">getPrimaryKeyIndex</a></strong>()</code> +<div class="block">Returns the sequence and directions of properties that make up the + primary key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>></code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#getPrimaryKeyIndex()">getPrimaryKeyIndex</a></strong>()</code> +<div class="block">Returns all key properties in the form of an index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html" title="type parameter in GenericStorableCodec">S</a>></code></td> +<td class="colLast"><span class="strong">GenericStorableCodec.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodec.html#getPrimaryKeyIndex()">getPrimaryKeyIndex</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</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/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<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/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<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/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout)</code> </td> +</tr> +<tr class="rowColor"> +<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/raw/CustomStorableCodec.html" title="class in com.amazon.carbonado.raw">CustomStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">CustomStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<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/raw/StorableCodec.html" title="interface in com.amazon.carbonado.raw">StorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">StorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/StorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="rowColor"> +<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/raw/GenericStorableCodec.html" title="class in com.amazon.carbonado.raw">GenericStorableCodec</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createCodec(java.lang.Class, com.amazon.carbonado.info.StorableIndex, boolean, com.amazon.carbonado.layout.Layout, com.amazon.carbonado.raw.RawSupport)">createCodec</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a> pkIndex, + boolean isMaster, + <a href="../../../../../com/amazon/carbonado/layout/Layout.html" title="class in com.amazon.carbonado.layout">Layout</a> layout, + <a href="../../../../../com/amazon/carbonado/raw/RawSupport.html" title="interface in com.amazon.carbonado.raw">RawSupport</a> support)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex)</code> +<div class="block">Override to return a different EncodingStrategy.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><span class="strong">CompressedStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CompressedStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex, + <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="class in com.amazon.carbonado.raw">GenericEncodingStrategy</a><S></code></td> +<td class="colLast"><span class="strong">GenericStorableCodecFactory.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericStorableCodecFactory.html#createStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.layout.LayoutOptions)">createStrategy</a></strong>(java.lang.Class<S> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S> pkIndex, + <a href="../../../../../com/amazon/carbonado/layout/LayoutOptions.html" title="class in com.amazon.carbonado.layout">LayoutOptions</a> options)</code> +<div class="block">Override to return a different EncodingStrategy.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</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/raw/CompressedEncodingStrategy.html#CompressedEncodingStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, com.amazon.carbonado.raw.CompressionType)">CompressedEncodingStrategy</a></strong>(java.lang.Class<<a href="../../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="type parameter in CompressedEncodingStrategy">S</a>> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/raw/CompressedEncodingStrategy.html" title="type parameter in CompressedEncodingStrategy">S</a>> pkIndex, + <a href="../../../../../com/amazon/carbonado/raw/CompressionType.html" title="enum in com.amazon.carbonado.raw">CompressionType</a> compressionType)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#GenericEncodingStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex)">GenericEncodingStrategy</a></strong>(java.lang.Class<<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> pkIndex)</code> </td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#GenericEncodingStrategy(java.lang.Class, com.amazon.carbonado.info.StorableIndex, int, int, int, int)">GenericEncodingStrategy</a></strong>(java.lang.Class<<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> type, + <a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> pkIndex, + int keyPrefixPadding, + int keySuffixPadding, + int dataPrefixPadding, + int dataSuffixPadding)</code> </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/info/StorableIndex.html" title="class in com.amazon.carbonado.info">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/info/class-use/StorableIndex.html" target="_top">Frames</a></li> +<li><a href="StorableIndex.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorableInfo.html b/apidocs/com/amazon/carbonado/info/class-use/StorableInfo.html new file mode 100644 index 0000000..dc7e131 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorableInfo.html @@ -0,0 +1,288 @@ +<!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.info.StorableInfo (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.info.StorableInfo (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/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">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/info/class-use/StorableInfo.html" target="_top">Frames</a></li> +<li><a href="StorableInfo.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.info.StorableInfo" class="title">Uses of Interface<br>com.amazon.carbonado.info.StorableInfo</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/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</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.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="altColor"> +<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> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</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 methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</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>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S></code></td> +<td class="colLast"><span class="strong">StorableIntrospector.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIntrospector.html#examine(java.lang.Class)">examine</a></strong>(java.lang.Class<S> type)</code> +<div class="block">Examines the given class and returns a StorableInfo describing it.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</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>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)">parse</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str)</code> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String)">parse</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str)</code> +<div class="block">Parses a chained property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#parse(com.amazon.carbonado.info.StorableInfo, java.lang.String, com.amazon.carbonado.info.Direction)">parse</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info, + java.lang.String str, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Parses an ordering property, which may start with a '+' or '-' to + indicate direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#parseNameDescriptor(java.lang.String, com.amazon.carbonado.info.StorableInfo)">parseNameDescriptor</a></strong>(java.lang.String desc, + <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S> info)</code> +<div class="block">Parses an index descriptor and returns an index object.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</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/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</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>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addAlternateKeys(com.amazon.carbonado.info.StorableInfo)">addAlternateKeys</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Adds all of the alternate keys of the given storable as indexes by + calling <a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addIndexes(com.amazon.carbonado.info.StorableInfo)">addIndexes</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Adds all the indexes of the given storable.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addIndexes(com.amazon.carbonado.info.StorableInfo, com.amazon.carbonado.info.Direction)">addIndexes</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> defaultDirection)</code> +<div class="block">Adds all the indexes of the given storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addPrimaryKey(com.amazon.carbonado.info.StorableInfo)">addPrimaryKey</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Adds the primary key of the given storable as indexes by calling <a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)"><code>addKey</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#findPrimaryKeyIndex(com.amazon.carbonado.info.StorableInfo)">findPrimaryKeyIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Finds the best index to represent the primary key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#uniquify(com.amazon.carbonado.info.StorableInfo)">uniquify</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> info)</code> +<div class="block">Augment non-unique indexes with primary key properties, thus making them + unique.</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/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</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 subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</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/jdbc/JDBCStorableInfo.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableInfo</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Contains all the metadata describing a specific <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type as + needed by JDBCRepository.</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/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">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/info/class-use/StorableInfo.html" target="_top">Frames</a></li> +<li><a href="StorableInfo.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorableIntrospector.html b/apidocs/com/amazon/carbonado/info/class-use/StorableIntrospector.html new file mode 100644 index 0000000..bb3e29d --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorableIntrospector.html @@ -0,0 +1,163 @@ +<!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 Class com.amazon.carbonado.info.StorableIntrospector (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 Class com.amazon.carbonado.info.StorableIntrospector (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/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">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/info/class-use/StorableIntrospector.html" target="_top">Frames</a></li> +<li><a href="StorableIntrospector.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 Class com.amazon.carbonado.info.StorableIntrospector" class="title">Uses of Class<br>com.amazon.carbonado.info.StorableIntrospector</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/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">StorableIntrospector</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.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> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">StorableIntrospector</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 subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">StorableIntrospector</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</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/repo/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc">JDBCStorableIntrospector</a></strong></code> +<div class="block">Provides additional metadata for a <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type needed by + JDBCRepository.</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/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">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/info/class-use/StorableIntrospector.html" target="_top">Frames</a></li> +<li><a href="StorableIntrospector.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorableKey.html b/apidocs/com/amazon/carbonado/info/class-use/StorableKey.html new file mode 100644 index 0000000..377457c --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorableKey.html @@ -0,0 +1,247 @@ +<!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.info.StorableKey (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.info.StorableKey (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/info/StorableKey.html" title="interface in com.amazon.carbonado.info">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/info/class-use/StorableKey.html" target="_top">Frames</a></li> +<li><a href="StorableKey.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.info.StorableKey" class="title">Uses of Interface<br>com.amazon.carbonado.info.StorableKey</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/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</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.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</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 methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</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/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getAlternateKey(int)">getAlternateKey</a></strong>(int index)</code> +<div class="block">Returns a specific alternate key for the Storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>[]</code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getAlternateKeys()">getAlternateKeys</a></strong>()</code> +<div class="block">Returns a new array with all the alternate keys in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getPartitionKey()">getPartitionKey</a></strong>()</code> +<div class="block">Returns the partition key for the Storable, or null if none exists.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getPrimaryKey()">getPrimaryKey</a></strong>()</code> +<div class="block">Returns the primary key for the Storable, never null.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</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/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#uniquify(com.amazon.carbonado.info.StorableKey)">uniquify</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> key)</code> +<div class="block">Returns a StorableIndex which is unique, possibly by appending + properties from the given key.</div> +</td> +</tr> +</tbody> +</table> +<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/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</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(com.amazon.carbonado.info.StorableKey, com.amazon.carbonado.info.Direction)">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> key, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Creates a StorableIndex from a StorableKey.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a> in <a href="../../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</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/qe/package-summary.html">com.amazon.carbonado.qe</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</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>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#addKey(com.amazon.carbonado.info.StorableKey)">addKey</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</code> +<div class="block">Adds the key as a unique index, preserving the property arrangement.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#findKeyIndex(com.amazon.carbonado.info.StorableKey)">findKeyIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</code> +<div class="block">Finds the best index to represent the given key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">StorableIndexSet.</span><code><strong><a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html#uniquify(com.amazon.carbonado.info.StorableKey)">uniquify</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><<a href="../../../../../com/amazon/carbonado/qe/StorableIndexSet.html" title="type parameter in StorableIndexSet">S</a>> key)</code> +<div class="block">Augment non-unique indexes with key properties, thus making them unique.</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/info/StorableKey.html" title="interface in com.amazon.carbonado.info">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/info/class-use/StorableKey.html" target="_top">Frames</a></li> +<li><a href="StorableKey.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorableProperty.html b/apidocs/com/amazon/carbonado/info/class-use/StorableProperty.html new file mode 100644 index 0000000..f71a060 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorableProperty.html @@ -0,0 +1,479 @@ +<!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.info.StorableProperty (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.info.StorableProperty (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/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">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/info/class-use/StorableProperty.html" target="_top">Frames</a></li> +<li><a href="StorableProperty.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.info.StorableProperty" class="title">Uses of Interface<br>com.amazon.carbonado.info.StorableProperty</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/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</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.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="altColor"> +<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> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</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 methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</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/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#getChainedProperty(int)">getChainedProperty</a></strong>(int index)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?></code></td> +<td class="colLast"><span class="strong">StorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElement(int)">getExternalJoinElement</a></strong>(int index)</code> +<div class="block">Returns a specific property in the joined class that participates in the + join.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>[]</code></td> +<td class="colLast"><span class="strong">StorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElements()">getExternalJoinElements</a></strong>()</code> +<div class="block">Returns a new array with all the external join elements in it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>></code></td> +<td class="colLast"><span class="strong">StorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElement(int)">getInternalJoinElement</a></strong>(int index)</code> +<div class="block">Returns a specific property in this property's class that participates + in the join.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>>[]</code></td> +<td class="colLast"><span class="strong">StorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElements()">getInternalJoinElements</a></strong>()</code> +<div class="block">Returns a new array with all the internal join elements in it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#getLastProperty()">getLastProperty</a></strong>()</code> +<div class="block">Returns the last property in the chain, or the prime property if chain + is empty.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#getPrimeProperty()">getPrimeProperty</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[]</code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#getProperties()">getProperties</a></strong>()</code> +<div class="block">Returns a new array with all the properties in it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#getProperty(int)">getProperty</a></strong>(int index)</code> +<div class="block">Returns a specific property in this index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>></code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getVersionProperty()">getVersionProperty</a></strong>()</code> +<div class="block">Returns the designated version property, or null if none.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</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>java.util.Map<java.lang.String,? extends <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>></code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getAllProperties()">getAllProperties</a></strong>()</code> +<div class="block">Returns all the storable properties in an unmodifiable map.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,? extends <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>></code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getDataProperties()">getDataProperties</a></strong>()</code> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Map<java.lang.String,? extends <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableInfo.html" title="type parameter in StorableInfo">S</a>>></code></td> +<td class="colLast"><span class="strong">StorableInfo.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableInfo.html#getPrimaryKeyProperties()">getPrimaryKeyProperties</a></strong>()</code> +<div class="block">Returns a subset of the storable properties in an unmodifiable map + that define the primary key.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</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/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>></code></td> +<td class="colLast"><span class="strong">StorableIndex.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#addProperty(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">addProperty</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>> property, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a StorableIndex with the given property added.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.StorableProperty)">append</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> property)</code> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><<a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="type parameter in ChainedProperty">S</a>></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#append(com.amazon.carbonado.info.StorableProperty, boolean)">append</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?> property, + boolean outerJoin)</code> +<div class="block">Returns a new ChainedProperty with another property appended.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime)</code> +<div class="block">Returns a canonical instance which has no chain.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S></code></td> +<td class="colLast"><span class="strong">OrderedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/OrderedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.Direction)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> property, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a> direction)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty...)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>... chain)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty...)">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>... chain)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty[], boolean[])">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>[] chain, + boolean[] outerJoin)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>> <br><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S></code></td> +<td class="colLast"><span class="strong">ChainedProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/ChainedProperty.html#get(com.amazon.carbonado.info.StorableProperty, com.amazon.carbonado.info.StorableProperty[], boolean[])">get</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S> prime, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><?>[] chain, + boolean[] outerJoin)</code> +<div class="block">Returns a canonical instance.</div> +</td> +</tr> +</tbody> +</table> +<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/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</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(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[])">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions)</code> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[], boolean)">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions, + boolean unique)</code> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableIndex.html#StorableIndex(com.amazon.carbonado.info.StorableProperty[], com.amazon.carbonado.info.Direction[], boolean, boolean)">StorableIndex</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/info/StorableIndex.html" title="type parameter in StorableIndex">S</a>>[] properties, + <a href="../../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a>[] directions, + boolean unique, + boolean clustered)</code> +<div class="block">Creates a StorableIndex from the given properties and matching + directions.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a> in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</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/raw/package-summary.html">com.amazon.carbonado.raw</a> that return <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</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>protected <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[]</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#gatherAllDataProperties()">gatherAllDataProperties</a></strong>()</code> +<div class="block">Returns all non-derived data properties for storable.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[]</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#gatherAllProperties()">gatherAllProperties</a></strong>()</code> +<div class="block">Returns all non-join, non-derived properties for storable.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> that return types with arguments of type <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</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>java.util.Map<java.lang.String,? extends <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html" title="type parameter in CustomStorableCodec">S</a>>></code></td> +<td class="colLast"><span class="strong">CustomStorableCodec.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/CustomStorableCodec.html#getAllProperties()">getAllProperties</a></strong>()</code> +<div class="block">Convenient access to all the storable properties.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</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>void</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildDataDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, int, org.cojen.classfile.Label, org.cojen.classfile.LocalVariable)">buildDataDecoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useWriteMethods, + int generation, + org.cojen.classfile.Label altGenerationHandler, + org.cojen.classfile.LocalVariable encodedVar)</code> +<div class="block">Generates bytecode instructions to decode properties.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.cojen.classfile.LocalVariable</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildDataEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable, java.lang.Class, boolean, int)">buildDataEncoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable instanceVar, + java.lang.Class<?> adapterInstanceClass, + boolean useReadMethods, + int generation)</code> +<div class="block">Generates bytecode instructions to encode properties.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildSerialDecoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[], org.cojen.classfile.LocalVariable)">buildSerialDecoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties, + org.cojen.classfile.LocalVariable encodedVar)</code> +<div class="block">Generates bytecode instructions to decode properties and their states.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.cojen.classfile.LocalVariable</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#buildSerialEncoding(org.cojen.classfile.CodeAssembler, com.amazon.carbonado.info.StorableProperty[])">buildSerialEncoding</a></strong>(org.cojen.classfile.CodeAssembler assembler, + <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties)</code> +<div class="block">Generates bytecode instructions to encode properties and their + states.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a></code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#checkSupport(com.amazon.carbonado.info.StorableProperty)">checkSupport</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>> property)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../com/amazon/carbonado/raw/StorablePropertyInfo.html" title="class in com.amazon.carbonado.raw">StorablePropertyInfo</a>[]</code></td> +<td class="colLast"><span class="strong">GenericEncodingStrategy.</span><code><strong><a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html#checkSupport(com.amazon.carbonado.info.StorableProperty[])">checkSupport</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/raw/GenericEncodingStrategy.html" title="type parameter in GenericEncodingStrategy">S</a>>[] properties)</code> </td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</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 subinterfaces, and an explanation"> +<caption><span>Subinterfaces of <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a> in <a href="../../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</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/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></strong></code> +<div class="block">Contains all the metadata describing a property of a specific <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type as needed by JDBCRepository.</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/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">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/info/class-use/StorableProperty.html" target="_top">Frames</a></li> +<li><a href="StorableProperty.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorablePropertyAdapter.html b/apidocs/com/amazon/carbonado/info/class-use/StorablePropertyAdapter.html new file mode 100644 index 0000000..f3a6673 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorablePropertyAdapter.html @@ -0,0 +1,229 @@ +<!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 Class com.amazon.carbonado.info.StorablePropertyAdapter (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 Class com.amazon.carbonado.info.StorablePropertyAdapter (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/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">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/info/class-use/StorablePropertyAdapter.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyAdapter.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 Class com.amazon.carbonado.info.StorablePropertyAdapter" class="title">Uses of Class<br>com.amazon.carbonado.info.StorablePropertyAdapter</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/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</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.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</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.synthetic">com.amazon.carbonado.synthetic</a></td> +<td class="colLast"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</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 methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</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/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></code></td> +<td class="colLast"><span class="strong">StorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getAdapter()">getAdapter</a></strong>()</code> +<div class="block">Returns this property's adapter, or null if none.</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/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</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/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</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/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></code></td> +<td class="colLast"><span class="strong">JDBCStorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getAppliedAdapter()">getAppliedAdapter</a></strong>()</code> +<div class="block">Returns the adapter that needs to be applied to properties returned from + ResultSets and set into PreparedStatements.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.synthetic"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a> in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</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/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> that return <a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</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/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></code></td> +<td class="colLast"><span class="strong">SyntheticProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#getAdapter()">getAdapter</a></strong>()</code> </td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a> with parameters of type <a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</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>void</code></td> +<td class="colLast"><span class="strong">SyntheticProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/synthetic/SyntheticProperty.html#setAdapter(com.amazon.carbonado.info.StorablePropertyAdapter)">setAdapter</a></strong>(<a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a> adapter)</code> +<div class="block">Storables cannot currently have more than one adapter per property.</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/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">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/info/class-use/StorablePropertyAdapter.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyAdapter.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorablePropertyAnnotation.html b/apidocs/com/amazon/carbonado/info/class-use/StorablePropertyAnnotation.html new file mode 100644 index 0000000..ac1c091 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorablePropertyAnnotation.html @@ -0,0 +1,167 @@ +<!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 Class com.amazon.carbonado.info.StorablePropertyAnnotation (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 Class com.amazon.carbonado.info.StorablePropertyAnnotation (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/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">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/info/class-use/StorablePropertyAnnotation.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyAnnotation.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 Class com.amazon.carbonado.info.StorablePropertyAnnotation" class="title">Uses of Class<br>com.amazon.carbonado.info.StorablePropertyAnnotation</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/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</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.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</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 methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</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/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></code></td> +<td class="colLast"><span class="strong">StorablePropertyAdapter.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html#getAnnotation()">getAnnotation</a></strong>()</code> +<div class="block">Returns the annotation that applied this adapter, or null if none.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></code></td> +<td class="colLast"><span class="strong">StorablePropertyConstraint.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html#getAnnotation()">getAnnotation</a></strong>()</code> +<div class="block">Returns the annotation that applied this constraint.</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/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">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/info/class-use/StorablePropertyAnnotation.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyAnnotation.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> diff --git a/apidocs/com/amazon/carbonado/info/class-use/StorablePropertyConstraint.html b/apidocs/com/amazon/carbonado/info/class-use/StorablePropertyConstraint.html new file mode 100644 index 0000000..fca5817 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/class-use/StorablePropertyConstraint.html @@ -0,0 +1,167 @@ +<!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 Class com.amazon.carbonado.info.StorablePropertyConstraint (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 Class com.amazon.carbonado.info.StorablePropertyConstraint (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/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">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/info/class-use/StorablePropertyConstraint.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyConstraint.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 Class com.amazon.carbonado.info.StorablePropertyConstraint" class="title">Uses of Class<br>com.amazon.carbonado.info.StorablePropertyConstraint</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/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</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.info">com.amazon.carbonado.info</a></td> +<td class="colLast"> +<div class="block">Introspection support for Storables.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</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 methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> that return <a href="../../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</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/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a></code></td> +<td class="colLast"><span class="strong">StorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getConstraint(int)">getConstraint</a></strong>(int index)</code> +<div class="block">Returns a specific constraint for this property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a>[]</code></td> +<td class="colLast"><span class="strong">StorableProperty.</span><code><strong><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getConstraints()">getConstraints</a></strong>()</code> +<div class="block">Returns a new array with all the constraints in it.</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/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">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/info/class-use/StorablePropertyConstraint.html" target="_top">Frames</a></li> +<li><a href="StorablePropertyConstraint.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> diff --git a/apidocs/com/amazon/carbonado/info/package-frame.html b/apidocs/com/amazon/carbonado/info/package-frame.html new file mode 100644 index 0000000..56882b7 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/package-frame.html @@ -0,0 +1,36 @@ +<!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:44 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>com.amazon.carbonado.info (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> +<h1 class="bar"><a href="../../../../com/amazon/carbonado/info/package-summary.html" target="classFrame">com.amazon.carbonado.info</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="StorableInfo.html" title="interface in com.amazon.carbonado.info" target="classFrame"><i>StorableInfo</i></a></li> +<li><a href="StorableKey.html" title="interface in com.amazon.carbonado.info" target="classFrame"><i>StorableKey</i></a></li> +<li><a href="StorableProperty.html" title="interface in com.amazon.carbonado.info" target="classFrame"><i>StorableProperty</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="ChainedProperty.html" title="class in com.amazon.carbonado.info" target="classFrame">ChainedProperty</a></li> +<li><a href="OrderedProperty.html" title="class in com.amazon.carbonado.info" target="classFrame">OrderedProperty</a></li> +<li><a href="StorableIndex.html" title="class in com.amazon.carbonado.info" target="classFrame">StorableIndex</a></li> +<li><a href="StorableIntrospector.html" title="class in com.amazon.carbonado.info" target="classFrame">StorableIntrospector</a></li> +<li><a href="StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info" target="classFrame">StorablePropertyAdapter</a></li> +<li><a href="StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info" target="classFrame">StorablePropertyAnnotation</a></li> +<li><a href="StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info" target="classFrame">StorablePropertyConstraint</a></li> +</ul> +<h2 title="Enums">Enums</h2> +<ul title="Enums"> +<li><a href="Direction.html" title="enum in com.amazon.carbonado.info" target="classFrame">Direction</a></li> +</ul> +</div> +</body> +</html> diff --git a/apidocs/com/amazon/carbonado/info/package-summary.html b/apidocs/com/amazon/carbonado/info/package-summary.html new file mode 100644 index 0000000..166687d --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/package-summary.html @@ -0,0 +1,230 @@ +<!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:44 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>com.amazon.carbonado.info (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="com.amazon.carbonado.info (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 class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-use.html">Use</a></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><a href="../../../../com/amazon/carbonado/gen/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/layout/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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"> +<h1 title="Package" class="title">Package com.amazon.carbonado.info</h1> +<div class="docSummary"> +<div class="block">Introspection support for Storables.</div> +</div> +<p>See: <a href="#package_description">Description</a></p> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info">StorableInfo</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Contains all the metadata describing a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info">StorableKey</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Represents a primary, alternate or partition key of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Contains all the metadata describing a property of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info">ChainedProperty</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Represents a property to filter on or to order by.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info">OrderedProperty</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Represents a property paired with a preferred ordering direction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info">StorableIndex</a><S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></td> +<td class="colLast"> +<div class="block">Represents an index that must be defined for a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info">StorableIntrospector</a></td> +<td class="colLast"> +<div class="block">Supports examination of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types, returning all metadata + associated with it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a></td> +<td class="colLast"> +<div class="block">Information about an <a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><code>adapter</code></a> annotation applied to a property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info">StorablePropertyAnnotation</a></td> +<td class="colLast"> +<div class="block">Information about a custom annotation applied to a property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info">StorablePropertyConstraint</a></td> +<td class="colLast"> +<div class="block">Information about a <a href="../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint"><code>constraint</code></a> annotation applied to a property.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> +<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Enum</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info">Direction</a></td> +<td class="colLast"> +<div class="block">Describes a property sorting direction.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +<a name="package_description"> +<!-- --> +</a> +<h2 title="Package com.amazon.carbonado.info Description">Package com.amazon.carbonado.info Description</h2> +<div class="block">Introspection support for Storables.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><code>StorableIntrospector</code></a></dd></dl> +</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 class="navBarCell1Rev">Package</li> +<li>Class</li> +<li><a href="package-use.html">Use</a></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><a href="../../../../com/amazon/carbonado/gen/package-summary.html">Prev Package</a></li> +<li><a href="../../../../com/amazon/carbonado/layout/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> diff --git a/apidocs/com/amazon/carbonado/info/package-tree.html b/apidocs/com/amazon/carbonado/info/package-tree.html new file mode 100644 index 0000000..e755e36 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/package-tree.html @@ -0,0 +1,163 @@ +<!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:44 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>com.amazon.carbonado.info Class Hierarchy (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="com.amazon.carbonado.info Class Hierarchy (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>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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><a href="../../../../com/amazon/carbonado/gen/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/layout/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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"> +<h1 class="title">Hierarchy For Package com.amazon.carbonado.info</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/ChainedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">ChainedProperty</span></a><S> (implements com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable)</li> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/OrderedProperty.html" title="class in com.amazon.carbonado.info"><span class="strong">OrderedProperty</span></a><S> (implements com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>, java.io.Serializable)</li> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/StorableIndex.html" title="class in com.amazon.carbonado.info"><span class="strong">StorableIndex</span></a><S> (implements com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>)</li> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/StorableIntrospector.html" title="class in com.amazon.carbonado.info"><span class="strong">StorableIntrospector</span></a></li> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info"><span class="strong">StorablePropertyAdapter</span></a></li> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/StorablePropertyAnnotation.html" title="class in com.amazon.carbonado.info"><span class="strong">StorablePropertyAnnotation</span></a></li> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/StorablePropertyConstraint.html" title="class in com.amazon.carbonado.info"><span class="strong">StorablePropertyConstraint</span></a></li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util"><span class="strong">Appender</span></a> +<ul> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/StorableKey.html" title="interface in com.amazon.carbonado.info"><span class="strong">StorableKey</span></a><S></li> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info"><span class="strong">StorableProperty</span></a><S> (also extends java.io.Serializable)</li> +</ul> +</li> +<li type="circle">java.io.Serializable +<ul> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info"><span class="strong">StorableProperty</span></a><S> (also extends com.amazon.carbonado.util.<a href="../../../../com/amazon/carbonado/util/Appender.html" title="interface in com.amazon.carbonado.util">Appender</a>)</li> +</ul> +</li> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/StorableInfo.html" title="interface in com.amazon.carbonado.info"><span class="strong">StorableInfo</span></a><S></li> +</ul> +<h2 title="Enum Hierarchy">Enum Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +<ul> +<li type="circle">com.amazon.carbonado.info.<a href="../../../../com/amazon/carbonado/info/Direction.html" title="enum in com.amazon.carbonado.info"><span class="strong">Direction</span></a></li> +</ul> +</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>Class</li> +<li>Use</li> +<li class="navBarCell1Rev">Tree</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><a href="../../../../com/amazon/carbonado/gen/package-tree.html">Prev</a></li> +<li><a href="../../../../com/amazon/carbonado/layout/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/amazon/carbonado/info/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> diff --git a/apidocs/com/amazon/carbonado/info/package-use.html b/apidocs/com/amazon/carbonado/info/package-use.html new file mode 100644 index 0000000..5d3c1c5 --- /dev/null +++ b/apidocs/com/amazon/carbonado/info/package-use.html @@ -0,0 +1,443 @@ +<!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 Package com.amazon.carbonado.info (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 Package com.amazon.carbonado.info (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>Class</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/info/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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"> +<h1 title="Uses of Package com.amazon.carbonado.info" class="title">Uses of Package<br>com.amazon.carbonado.info</h1> +</div> +<div class="contentContainer"> +<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/info/package-summary.html">com.amazon.carbonado.info</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.cursor">com.amazon.carbonado.cursor</a></td> +<td class="colLast"> +<div class="block">Support for advanced processing of cursor results, including basic set + theory operations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.filter">com.amazon.carbonado.filter</a></td> +<td class="colLast"> +<div class="block">Contains classes for representing query filters.</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.qe">com.amazon.carbonado.qe</a></td> +<td class="colLast"> +<div class="block">Support for implementing a Query Engine.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.raw">com.amazon.carbonado.raw</a></td> +<td class="colLast"> +<div class="block">Provides support for repositories that encode/decode storables in a raw + binary format.</div> +</td> +</tr> +<tr class="altColor"> +<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="rowColor"> +<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> +<tr class="altColor"> +<td class="colFirst"><a href="#com.amazon.carbonado.synthetic">com.amazon.carbonado.synthetic</a></td> +<td class="colLast"> +<div class="block">Support for dynamic creation of storables, intended for internal use by + repository implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.capability"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> used by <a href="../../../../com/amazon/carbonado/capability/package-summary.html">com.amazon.carbonado.capability</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/Direction.html#com.amazon.carbonado.capability">Direction</a> +<div class="block">Describes a property sorting direction.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.cursor"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> used by <a href="../../../../com/amazon/carbonado/cursor/package-summary.html">com.amazon.carbonado.cursor</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/OrderedProperty.html#com.amazon.carbonado.cursor">OrderedProperty</a> +<div class="block">Represents a property paired with a preferred ordering direction.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.filter"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> used by <a href="../../../../com/amazon/carbonado/filter/package-summary.html">com.amazon.carbonado.filter</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/ChainedProperty.html#com.amazon.carbonado.filter">ChainedProperty</a> +<div class="block">Represents a property to filter on or to order by.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.info"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> used by <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/ChainedProperty.html#com.amazon.carbonado.info">ChainedProperty</a> +<div class="block">Represents a property to filter on or to order by.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/Direction.html#com.amazon.carbonado.info">Direction</a> +<div class="block">Describes a property sorting direction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/OrderedProperty.html#com.amazon.carbonado.info">OrderedProperty</a> +<div class="block">Represents a property paired with a preferred ordering direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableIndex.html#com.amazon.carbonado.info">StorableIndex</a> +<div class="block">Represents an index that must be defined for a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableInfo.html#com.amazon.carbonado.info">StorableInfo</a> +<div class="block">Contains all the metadata describing a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableKey.html#com.amazon.carbonado.info">StorableKey</a> +<div class="block">Represents a primary, alternate or partition key of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableProperty.html#com.amazon.carbonado.info">StorableProperty</a> +<div class="block">Contains all the metadata describing a property of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorablePropertyAdapter.html#com.amazon.carbonado.info">StorablePropertyAdapter</a> +<div class="block">Information about an <a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><code>adapter</code></a> annotation applied to a property.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorablePropertyAnnotation.html#com.amazon.carbonado.info">StorablePropertyAnnotation</a> +<div class="block">Information about a custom annotation applied to a property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorablePropertyConstraint.html#com.amazon.carbonado.info">StorablePropertyConstraint</a> +<div class="block">Information about a <a href="../../../../com/amazon/carbonado/constraint/ConstraintDefinition.html" title="annotation in com.amazon.carbonado.constraint"><code>constraint</code></a> annotation applied to a property.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.qe"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> used by <a href="../../../../com/amazon/carbonado/qe/package-summary.html">com.amazon.carbonado.qe</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/ChainedProperty.html#com.amazon.carbonado.qe">ChainedProperty</a> +<div class="block">Represents a property to filter on or to order by.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/Direction.html#com.amazon.carbonado.qe">Direction</a> +<div class="block">Describes a property sorting direction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/OrderedProperty.html#com.amazon.carbonado.qe">OrderedProperty</a> +<div class="block">Represents a property paired with a preferred ordering direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableIndex.html#com.amazon.carbonado.qe">StorableIndex</a> +<div class="block">Represents an index that must be defined for a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableInfo.html#com.amazon.carbonado.qe">StorableInfo</a> +<div class="block">Contains all the metadata describing a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableKey.html#com.amazon.carbonado.qe">StorableKey</a> +<div class="block">Represents a primary, alternate or partition key of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.raw"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> used by <a href="../../../../com/amazon/carbonado/raw/package-summary.html">com.amazon.carbonado.raw</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/OrderedProperty.html#com.amazon.carbonado.raw">OrderedProperty</a> +<div class="block">Represents a property paired with a preferred ordering direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableIndex.html#com.amazon.carbonado.raw">StorableIndex</a> +<div class="block">Represents an index that must be defined for a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableProperty.html#com.amazon.carbonado.raw">StorableProperty</a> +<div class="block">Contains all the metadata describing a property of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.repo.jdbc"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> used by <a href="../../../../com/amazon/carbonado/repo/jdbc/package-summary.html">com.amazon.carbonado.repo.jdbc</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableInfo.html#com.amazon.carbonado.repo.jdbc">StorableInfo</a> +<div class="block">Contains all the metadata describing a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableIntrospector.html#com.amazon.carbonado.repo.jdbc">StorableIntrospector</a> +<div class="block">Supports examination of <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> types, returning all metadata + associated with it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorableProperty.html#com.amazon.carbonado.repo.jdbc">StorableProperty</a> +<div class="block">Contains all the metadata describing a property of a specific <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado"><code>Storable</code></a> type.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorablePropertyAdapter.html#com.amazon.carbonado.repo.jdbc">StorablePropertyAdapter</a> +<div class="block">Information about an <a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><code>adapter</code></a> annotation applied to a property.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.spi"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> used by <a href="../../../../com/amazon/carbonado/spi/package-summary.html">com.amazon.carbonado.spi</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/Direction.html#com.amazon.carbonado.spi">Direction</a> +<div class="block">Describes a property sorting direction.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="com.amazon.carbonado.synthetic"> +<!-- --> +</a> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../com/amazon/carbonado/info/package-summary.html">com.amazon.carbonado.info</a> used by <a href="../../../../com/amazon/carbonado/synthetic/package-summary.html">com.amazon.carbonado.synthetic</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/Direction.html#com.amazon.carbonado.synthetic">Direction</a> +<div class="block">Describes a property sorting direction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../com/amazon/carbonado/info/class-use/StorablePropertyAdapter.html#com.amazon.carbonado.synthetic">StorablePropertyAdapter</a> +<div class="block">Information about an <a href="../../../../com/amazon/carbonado/adapter/AdapterDefinition.html" title="annotation in com.amazon.carbonado.adapter"><code>adapter</code></a> annotation applied to a property.</div> +</td> +</tr> +</tbody> +</table> +</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>Class</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/info/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> |