summaryrefslogtreecommitdiff
path: root/apidocs/com/amazon/carbonado/info/StorableProperty.html
diff options
context:
space:
mode:
Diffstat (limited to 'apidocs/com/amazon/carbonado/info/StorableProperty.html')
-rw-r--r--apidocs/com/amazon/carbonado/info/StorableProperty.html929
1 files changed, 929 insertions, 0 deletions
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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</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&lt;S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</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>&lt;S&gt;</dd>
+</dl>
+<hr>
+<br>
+<pre>public interface <span class="strong">StorableProperty&lt;S extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</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">&nbsp;</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&nbsp;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&nbsp;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&lt;?&gt;[]</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>&lt;<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>&gt;[]</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>&lt;?&gt;[]</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&lt;<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>&gt;</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>&lt;?&gt;</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElement(int)">getExternalJoinElement</a></strong>(int&nbsp;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>&lt;?&gt;[]</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>&lt;<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>&gt;</code></td>
+<td class="colLast"><code><strong><a href="../../../../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElement(int)">getInternalJoinElement</a></strong>(int&nbsp;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>&lt;<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>&gt;[]</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&lt;? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;</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&lt;?&gt;</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>&nbsp;</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&nbsp;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&nbsp;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&nbsp;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&lt;?&gt;&nbsp;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&lt;?&gt;[]&nbsp;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&nbsp;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&lt;<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>&gt;&nbsp;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&nbsp;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&nbsp;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&nbsp;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&nbsp;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&nbsp;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&nbsp;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&nbsp;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&nbsp;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&nbsp;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&nbsp;getAlias(int&nbsp;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[]&nbsp;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&nbsp;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&nbsp;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&lt;? extends <a href="../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>&gt;&nbsp;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&nbsp;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>&lt;<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>&gt;&nbsp;getInternalJoinElement(int&nbsp;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>&lt;<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>&gt;[]&nbsp;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>&lt;?&gt;&nbsp;getExternalJoinElement(int&nbsp;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>&lt;?&gt;[]&nbsp;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&nbsp;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&nbsp;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>&nbsp;getConstraint(int&nbsp;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>[]&nbsp;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>&nbsp;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&nbsp;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&nbsp;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&nbsp;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&nbsp;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&nbsp;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>&lt;<a href="../../../../com/amazon/carbonado/info/StorableProperty.html" title="type parameter in StorableProperty">S</a>&gt;[]&nbsp;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>&lt;?&gt;[]&nbsp;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&nbsp;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&nbsp;toString()</pre>
+<dl>
+<dt><strong>Overrides:</strong></dt>
+<dd><code>toString</code>&nbsp;in class&nbsp;<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:&nbsp;</li>
+<li>Nested&nbsp;|&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail:&nbsp;</li>
+<li>Field&nbsp;|&nbsp;</li>
+<li>Constr&nbsp;|&nbsp;</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 &#169; 2006-2013 <a href="https://github.com/Carbonado/Carbonado">Amazon Technologies, Inc.</a>. All Rights Reserved.</small></p>
+</body>
+</html>