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/repo/jdbc/JDBCStorableProperty.html | |
Adding javadocs and Carbonado User Guidegh-pages
Diffstat (limited to 'apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html')
| -rw-r--r-- | apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html | 554 |
1 files changed, 554 insertions, 0 deletions
diff --git a/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html new file mode 100644 index 0000000..d8b240a --- /dev/null +++ b/apidocs/com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html @@ -0,0 +1,554 @@ +<!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:41 PST 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>JDBCStorableProperty (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="JDBCStorableProperty (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/JDBCStorableProperty.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/repo/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" target="_top">Frames</a></li> +<li><a href="JDBCStorableProperty.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.repo.jdbc</div> +<h2 title="Interface JDBCStorableProperty" class="title">Interface JDBCStorableProperty<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, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">JDBCStorableProperty<S extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></span> +extends <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><S></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 as needed by JDBCRepository.</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/repo/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc"><code>JDBCStorableIntrospector</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/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> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getCharOctetLength()">getCharOctetLength</a></strong>()</code> +<div class="block">Returns the maximum amount of bytes for property value.</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/repo/jdbc/JDBCStorableProperty.html#getColumnName()">getColumnName</a></strong>()</code> +<div class="block">Returns the table column for this property.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getColumnSize()">getColumnSize</a></strong>()</code> +<div class="block">The column size is either the maximum number of characters or the + numeric precision.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getDataType()">getDataType</a></strong>()</code> +<div class="block">Returns the data type as defined by <code>Types</code>.</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/repo/jdbc/JDBCStorableProperty.html#getDataTypeName()">getDataTypeName</a></strong>()</code> +<div class="block">Returns the data type name.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getDecimalDigits()">getDecimalDigits</a></strong>()</code> +<div class="block">Returns the amount of fractional decimal digits.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><?></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.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/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><?>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.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/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="type parameter in JDBCStorableProperty">S</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.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/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="type parameter in JDBCStorableProperty">S</a>>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.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>java.lang.Integer</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#getOrdinalPosition()">getOrdinalPosition</a></strong>()</code> +<div class="block">Returns the one-based index of the column in the table.</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/repo/jdbc/JDBCStorableProperty.html#getPreparedStatementSetMethod()">getPreparedStatementSetMethod</a></strong>()</code> +<div class="block">Returns the method to use to set this property (by index) into a + PreparedStatement.</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/repo/jdbc/JDBCStorableProperty.html#getResultSetGetMethod()">getResultSetGetMethod</a></strong>()</code> +<div class="block">Returns the method to use to access this property (by index) from a + ResultSet.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#isAutoIncrement()">isAutoIncrement</a></strong>()</code> +<div class="block">Returns true if property is declared as @Automatic and column is + designated as auto-increment.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#isColumnNullable()">isColumnNullable</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/repo/jdbc/JDBCStorableProperty.html#isSelectable()">isSelectable</a></strong>()</code> +<div class="block">Returns true if property is both supported and not a join.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html#isSupported()">isSupported</a></strong>()</code> +<div class="block">Returns false only if property is independent and no matching column was + found.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.amazon.carbonado.info.StorableProperty"> +<!-- --> +</a> +<h3>Methods inherited from interface com.amazon.carbonado.info.<a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a></h3> +<code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getAdapter()">getAdapter</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getAlias(int)">getAlias</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getAliasCount()">getAliasCount</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getAliases()">getAliases</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getBeanName()">getBeanName</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getConstraint(int)">getConstraint</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getConstraintCount()">getConstraintCount</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getConstraints()">getConstraints</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getCovariantTypes()">getCovariantTypes</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getDerivedFromProperties()">getDerivedFromProperties</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getDerivedToProperties()">getDerivedToProperties</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getEnclosingType()">getEnclosingType</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getJoinedType()">getJoinedType</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getJoinElementCount()">getJoinElementCount</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getName()">getName</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getNumber()">getNumber</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getReadMethod()">getReadMethod</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getReadMethodName()">getReadMethodName</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getSequenceName()">getSequenceName</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getType()">getType</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getWriteMethod()">getWriteMethod</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getWriteMethodName()">getWriteMethodName</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isAlternateKeyMember()">isAlternateKeyMember</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isAutomatic()">isAutomatic</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isDerived()">isDerived</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isIndependent()">isIndependent</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isJoin()">isJoin</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isNullable()">isNullable</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isOneToOneJoin()">isOneToOneJoin</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isPartitionKeyMember()">isPartitionKeyMember</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isPrimaryKeyMember()">isPrimaryKeyMember</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isQuery()">isQuery</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#isVersion()">isVersion</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#shouldCopyDerived()">shouldCopyDerived</a>, <a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#toString()">toString</a></code></li> +</ul> +<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="isSupported()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isSupported</h4> +<pre>boolean isSupported()</pre> +<div class="block">Returns false only if property is independent and no matching column was + found.</div> +</li> +</ul> +<a name="isSelectable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isSelectable</h4> +<pre>boolean isSelectable()</pre> +<div class="block">Returns true if property is both supported and not a join. Simply put, + it can appear in a select statement.</div> +</li> +</ul> +<a name="isAutoIncrement()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAutoIncrement</h4> +<pre>boolean isAutoIncrement()</pre> +<div class="block">Returns true if property is declared as @Automatic and column is + designated as auto-increment.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getColumnName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getColumnName</h4> +<pre>java.lang.String getColumnName()</pre> +<div class="block">Returns the table column for this property.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported</dd></dl> +</li> +</ul> +<a name="getDataType()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataType</h4> +<pre>java.lang.Integer getDataType()</pre> +<div class="block">Returns the data type as defined by <code>Types</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported</dd></dl> +</li> +</ul> +<a name="getDataTypeName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataTypeName</h4> +<pre>java.lang.String getDataTypeName()</pre> +<div class="block">Returns the data type name.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported</dd></dl> +</li> +</ul> +<a name="isColumnNullable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isColumnNullable</h4> +<pre>boolean isColumnNullable()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>true if column is nullable</dd><dt><span class="strong">Since:</span></dt> + <dd>1.2</dd></dl> +</li> +</ul> +<a name="getResultSetGetMethod()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getResultSetGetMethod</h4> +<pre>java.lang.reflect.Method getResultSetGetMethod()</pre> +<div class="block">Returns the method to use to access this property (by index) from a + ResultSet.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported</dd></dl> +</li> +</ul> +<a name="getPreparedStatementSetMethod()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPreparedStatementSetMethod</h4> +<pre>java.lang.reflect.Method getPreparedStatementSetMethod()</pre> +<div class="block">Returns the method to use to set this property (by index) into a + PreparedStatement.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported</dd></dl> +</li> +</ul> +<a name="getAppliedAdapter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAppliedAdapter</h4> +<pre><a href="../../../../../com/amazon/carbonado/info/StorablePropertyAdapter.html" title="class in com.amazon.carbonado.info">StorablePropertyAdapter</a> getAppliedAdapter()</pre> +<div class="block">Returns the adapter that needs to be applied to properties returned from + ResultSets and set into PreparedStatements. Is null if not needed.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported or if adapter not needed.</dd></dl> +</li> +</ul> +<a name="getColumnSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getColumnSize</h4> +<pre>java.lang.Integer getColumnSize()</pre> +<div class="block">The column size is either the maximum number of characters or the + numeric precision.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported</dd></dl> +</li> +</ul> +<a name="getDecimalDigits()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDecimalDigits</h4> +<pre>java.lang.Integer getDecimalDigits()</pre> +<div class="block">Returns the amount of fractional decimal digits.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported</dd></dl> +</li> +</ul> +<a name="getCharOctetLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCharOctetLength</h4> +<pre>java.lang.Integer getCharOctetLength()</pre> +<div class="block">Returns the maximum amount of bytes for property value.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported</dd></dl> +</li> +</ul> +<a name="getOrdinalPosition()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrdinalPosition</h4> +<pre>java.lang.Integer getOrdinalPosition()</pre> +<div class="block">Returns the one-based index of the column in the table.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>null if property is unsupported</dd></dl> +</li> +</ul> +<a name="getInternalJoinElement(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInternalJoinElement</h4> +<pre><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="type parameter in JDBCStorableProperty">S</a>> getInternalJoinElement(int index)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElement(int)">StorableProperty</a></code></strong></div> +<div class="block">Returns a specific property in this property's class that participates + in the join.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElement(int)">getInternalJoinElement</a></code> in interface <code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="type parameter in JDBCStorableProperty">S</a> extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +</dl> +</li> +</ul> +<a name="getInternalJoinElements()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInternalJoinElements</h4> +<pre><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="type parameter in JDBCStorableProperty">S</a>>[] getInternalJoinElements()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElements()">StorableProperty</a></code></strong></div> +<div class="block">Returns a new array with all the internal join elements in it.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getInternalJoinElements()">getInternalJoinElements</a></code> in interface <code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="type parameter in JDBCStorableProperty">S</a> extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +</dl> +</li> +</ul> +<a name="getExternalJoinElement(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExternalJoinElement</h4> +<pre><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><?> getExternalJoinElement(int index)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElement(int)">StorableProperty</a></code></strong></div> +<div class="block">Returns a specific property in the joined class that participates in the + join.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElement(int)">getExternalJoinElement</a></code> in interface <code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="type parameter in JDBCStorableProperty">S</a> extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></code></dd> +</dl> +</li> +</ul> +<a name="getExternalJoinElements()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getExternalJoinElements</h4> +<pre><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="interface in com.amazon.carbonado.repo.jdbc">JDBCStorableProperty</a><?>[] getExternalJoinElements()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElements()">StorableProperty</a></code></strong></div> +<div class="block">Returns a new array with all the external join elements in it.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html#getExternalJoinElements()">getExternalJoinElements</a></code> in interface <code><a href="../../../../../com/amazon/carbonado/info/StorableProperty.html" title="interface in com.amazon.carbonado.info">StorableProperty</a><<a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" title="type parameter in JDBCStorableProperty">S</a> extends <a href="../../../../../com/amazon/carbonado/Storable.html" title="interface in com.amazon.carbonado">Storable</a>></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/JDBCStorableProperty.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/repo/jdbc/JDBCStorableIntrospector.html" title="class in com.amazon.carbonado.repo.jdbc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../com/amazon/carbonado/repo/jdbc/JDBCSupport.html" title="interface in com.amazon.carbonado.repo.jdbc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?com/amazon/carbonado/repo/jdbc/JDBCStorableProperty.html" target="_top">Frames</a></li> +<li><a href="JDBCStorableProperty.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> |