diff options
Diffstat (limited to 'apidocs/com/amazon/carbonado/info/ChainedProperty.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/info/ChainedProperty.html | 625 |
1 files changed, 625 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> |